snakeskin-loader

Using Snakeskin with WebPack.

Usage no npm install needed!

<script type="module">
  import snakeskinLoader from 'https://cdn.skypack.dev/snakeskin-loader';
</script>

README

snakeskin-loader

Using Snakeskin with WebPack.

NPM version Build Status NPM dependencies NPM devDependencies NPM peerDependencies

Install

# WebPack 1
npm install snakeskin snakeskin-loader@webpack1 --save-dev

# WebPack 2+
npm install snakeskin snakeskin-loader --save-dev

Usage

Webpack 1

webpack.config.json

var webpack = require('webpack');

webpack({
  entry: {
      index: './index.js'
  },

  output: {
      filename: '[name].bundle.js'
  },

  module: {
    loaders: [
      {
        test: /\.ss$/,
        exclude: /node_modules/,
        loader: 'snakeskin-loader?localization=false&exec=true'
      }
    ]
  },

  snakeskin: {
    babel: {
      plugins: [require('babel-plugin-transform-async-to-generator')]
    }
  }
}, function (err, stats) {
    // ...
});

Webpack 2+

webpack.config.json

var webpack = require('webpack');

webpack({
  entry: {
      index: './index.js'
  },

  output: {
      filename: '[name].bundle.js'
  },

  module: {
    rules: [
      {
        test: /\.ss$/,
        exclude: /node_modules/,
        use: [
          {
            loader: 'snakeskin-loader',
            options: {
              localization: false,
              exec: true,
              babel: {
                plugins: [require('babel-plugin-transform-async-to-generator')]
              }
            }
          }
        ]
      }
    ]
  }
  
}, function (err, stats) {
    // ...
});

Options

adapter

Type: String

Name of the adaptor, for example:

  • ss2react compiles Snakeskin for React
  • ss2vue compiles Snakeskin for Vue2

adapterOptions

Type: Object

Options for the used adaptor.

exec

Type: Boolean

Default: false

If the parameter is set to true the template will be launched after compiling and the results of it work will be saved.

tpl

Type: String

The name of the executable template (if is set exec), if the parameter is not specified, then uses the rule:

%fileName% || main || index || Object.keys().sort()[0];

data

Type: ?

Data for the executable template (if is set exec).

License

The MIT License.