snakeskinify

Using Snakeskin with Browserify.

Usage no npm install needed!

<script type="module">
  import snakeskinify from 'https://cdn.skypack.dev/snakeskinify';
</script>

README

snakeskinify

Using Snakeskin with Browserify.

NPM version Build Status NPM dependencies NPM devDependencies NPM peerDependencies

Install

npm install snakeskinify --save-dev

Setup

When creating your browserify bundle, just add this line:

bundle.transform(require('snakeskinify'));

or if you are a command line cowboy, something along the lines of

browserify -t snakeskinify entry.js -o bundle.js

Configuration

As with most browserify transforms, you can configure snakeskinify via the second argument to bundle.transform:

bundle.transform(require('snakeskinify'), {prettyPrint: true});

or inside your package.json configuration:

{
  "name": "my-spiffy-package",
  "browserify": {
    "transform": [
      ["snakeskinify", {"prettyPrint": true}]
    ]
  }
}

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.