nessa v0.0.23

nessa

Nessa was an Ainu and a Valië and was ranked the least among the Valar. She was notable for her speed, being fast "as an arrow in movement", for which reason she was called Nessa the Swift.

A Babel plug-in and Webpack loader which translate Pug templates into Hyperscript for virtual-dom diffing/rendering flows.

Installation

Add nessa to dev dependencies in package.json:

npm install --save-dev nessa

Either tell Babel to use this plug-in in .babelrc:

"plugins": [
  "nessa/library/transpiler",
]

Or tell Webpack to use this loader for .pug files in webpack.config.js:

var webpackConfig = {
  module: {
    loaders: [
      {
        test: /\.pug$/,
        loader: 'nessa/library/loader',
      },
    ],
  },

  // ...

};

Configuration

The recommended way to configure Babel options for nessa is with plug-in options, e.g.:

"plugins": [
  [
    "nessa/library/transpiler",
    {
      "isDebugged": true,
      "logPath": "./process/logs/nessa.babel.log",
      "require": {
        "utilities": "./library/utilities"
      },
      "test": "\\.pug$"
    }
  ]
]

The available options are:

• isDebugged
• logPath
• require.utilities
• test

The recommended way to configure Webpack options for nessa is with a top-level nessa object, e.g.:

var webpackConfig = {
  module: {
    // ...
  },

  'nessa': {
    'isDebugged': true,
    'logPath': './process/logs/nessa.webpack.log',
    'require': {
      'utilities': 'nessa/library/utilities'
    }
  }

  // ...
};

The available options are:

• isDebugged
• logPath
• require.utilities

Usage

With Babel or Webpack configured as above, simply import/require (for Webpack) or require (for Babel) a Pug file to access the compiled template function, which returns a virtual-dom VNode instead of HTML:

const template = require('./index.pug');
let vtree = template({foo: 'bar'});

Example

A sample application that uses the Babel plug-in (and custom Utilities) can be found here.

Custom Elements

Custom elements can be included in templates. In the case of the Babel plug-in the custom element name is the variable name of the declared template, e.g.:

const WelcomeElement = require('./welcome.pug')
const Default = require('./default.pug')

... where welcome.pug is ...

h1 Welcome #{name}

... and default.pug is ...

div
  WelcomeElement(name=name)
  p #{name}'s Pug source code!

... and the Default template function is called passing a value for the name local variable only, e.g.:

let virtualNodes = Default({
    'name': 'Forbes'
  })

In the case of the Webpack loader the custom element name is the local name passed to the template function, e.g.:

import WelcomeElement from './welcome.pug'
import Default from './default.pug'

... where welcome.pug and default.pug are as above and the Default template function is called passing values for both the WelcomeElement custom element and the name local variable, e.g.:

let virtualNodes = Default({
    WelcomeElement,
    'name': 'Forbes'
  })

License

ISC