Skip to content

A rollup plugin to remove the descriptions of Symbols.

License

Notifications You must be signed in to change notification settings

RedKenrok/rollup-plugin-strip-symbol-description

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

rollup-plugin-strip-symbol-description

A rollup plugin to remove the descriptions of Symbols.

Install

Using npm:

npm install rollup-plugin-strip-symbol-description --save-dev

Usage

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

import stripSymbolDescription from 'rollup-plugin-strip-symbol-description';

export default {
  input: 'src/index.js',
  output: {
    dir: 'output',
    format: 'cjs'
  },
  plugins: [
    stripSymbolDescription({
      /* Options */
    })
  ]
};

Then call rollup either via the CLI or the API.

Options

include

Type: String | RegExp | Array[...String|RegExp]
Default: ['**/*.js']
Example: include: '**/*.(mjs|js)',

A pattern, or array of patterns, which specify the files in the build the plugin should operate on.

exclude

Type: String | RegExp | Array[...String|RegExp]
Default: []
Example: exlude: 'tests/**/*',

A pattern, or array of patterns, which specify the files in the build the plugin should ignore.

sourceMap

Type: Boolean
Default: true
Example: sourceMap: false,

If true, instructs the plugin to update source maps accordingly after removing configured targets from the bundle.

Meta

LICENSE (MIT)

About

A rollup plugin to remove the descriptions of Symbols.

Resources

License

Stars

Watchers

Forks

Packages

No packages published