README

@kirei/vite-plugin

Vite plugin for Kirei to instrument Kirei elements to add Hot Module Replacement via Babel (babel-plugin-kirei).

Installation

npm i -D @kirei/vite-plugin

or if you use yarn

yarn add -D @kirei/vite-plugin

API

import kireiPlugin from '@kirei/vite-plugin';

kireiPlugin( [ opts ] )

Constructs the vite plugin from a set of optional plugin options.

Returns: Vite 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('@kirei/vite-plugin');
const kireiOptions = {
  include: 'src/*',
  extension: [ '.js', '.ts' ],
};

module.exports = {
  // ...options
  plugins: [
    kirei(kireiOptions),
  ],
};

Testing (TODO: not yet finished)

npm run test

License

MIT

Usage no npm install needed!