rollup-plugin-svelte-types

🍣 A Rollup plugin which generates type definitions for Svelte Components, including Props and Events.

Requirements

This plugin requires an LTS Node version (v8.0.0+) and Rollup v1.20.0+.

Install

Using npm:

1npm install rollup-plugin-svelte-types --save-dev

Usage

Create a rollup.config.js configuration file and import the plugin:

1import svelteDts from 'rollup-plugin-svelte-types';
2
3export default {
4  input: 'src/entry.js',
5  // ...
6  plugins: [
7    svelteDts()
8  ]
9};

Then call rollup either via the CLI or the API.

Options

It's possible to use configure a few settings:

1import svelteDts from 'rollup-plugin-svelte-types';
2
3export default {
4  input: 'src/entry.js',
5  // ...
6  plugins: [
7    svelteDts({
8        libRoot: './src', // The root directory to generate the type definitions for. Defaults to './'
9        declarationDir: './dist/types' // The directory to place the generated definitions in. Defaults to './types'
10    })
11  ]
12};

License

MIT