babel-plugin-kirei

v2.0.2
babel-plugin-kirei ==========================
vue vue3 composition frontend web components custom elements shadow dom

babel-plugin-kirei

GitHub Workflow Status Codecov Codacy grade Codacy coverage npm (scoped) npm bundle size (scoped) npm bundle size (scoped)

Babel plugin for Kirei to instrument Kirei components to add Hot Module Replacement

Installation

npm i -D babel-plugin-kirei

or if you use yarn

yarn add -D babel-plugin-kirei

API

import babelPlugin from 'babel-plugin-kirei';

babelPlugin( [ opts ] )

Creates the Babel plugin from a set of optional plugin options.

Returns: Babel Plugin

Parameters:

  • opts {KireiPluginOptions} - Object of optional options to pass to the plugin
    • include {string|string[]} - Optional string or array of strings of glob patterns to include
    • exclude {string|string[]} - Optional string or array of strings of glob patterns to exclude
    • extension {string|string[]} - Optional string or array of strings of extensions to include (dot prefixed like .js or .ts)

Examples

To use this plugin define it using vite.config.js


// vite.config.js
const kirei = require('babel-plugin-kirei');

module.exports = {
  open: true,
  port: 3000,
  plugins: [
    kirei({
      include: 'src/*',
      exclude: [/node_modules/, 'test/'],
      extension: [ '.js', '.ts' ],
    }),
  ],
};

Testing (TODO: not yet finished)

npm run test

License

MIT

npm i babel-plugin-kirei

Metadata

  • MIT
  • Whatever
  • iFaxity
  • released 7/19/2021

Downloads

Maintainers