@knot/browserify-plugin

A browserify plugin to automatically handle parsing and transforming knot code.

Integrate knot into your existing browserify build easily using this plugin.

Table of Contents

• Install
• Usage
• Maintainers
• Contributing
• License

Install

npm install @knot/browserify-plugin
# or
yarn add @knot/browserify-plugin

Usage

In order to use knot modules with browserify, add the plugin to your build command.

browserify main.kn -p [ @knot/browserify-plugin ] > bundle.js
# optionally print an exhaustive log of the operation of the compiler
browserify main.kn -p [ @knot/browserify-plugin --debug ] > bundle.js

Usage with programmatic API

// browserify.js
import browserify from 'browserify';
import knotify from '@knot/browserify-plugin';

browserify()
  // add the plugin to your exsiting configuration
  .plugin(knotify, {
    // optionally print an exhaustive log of the operation of the compiler
    // debug: true,
  });

You will now be able to import a .kn file from any normal javascript file. When running browserify, these files will be automatically converted into native javascript modules.

There is also a more robust example.

Maintainers

@effervescentia

Contributing

PRs accepted.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT © 2019 Ben Teichman