https://github.com/redkenrok/rollup-plugin-strip-symbol-description

A rollup plugin to remove the descriptions of Symbols.
https://github.com/redkenrok/rollup-plugin-strip-symbol-description

Last synced: 20 days ago
JSON representation

A rollup plugin to remove the descriptions of Symbols.

• Host: GitHub
• URL: https://github.com/redkenrok/rollup-plugin-strip-symbol-description
• Owner: RedKenrok
• License: mit
• Created: 2021-04-23T15:39:52.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-06-12T09:29:35.000Z (over 3 years ago)
• Last Synced: 2024-11-30T17:03:09.833Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 165 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# rollup-plugin-strip-symbol-description

A rollup plugin to remove the descriptions of `Symbol`s.

## Install

Using npm:

```console

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

```

## Usage

Create a `rollup.config.js` [configuration file](https://www.rollupjs.org/guide/en/#configuration-files) and import the plugin:

```js

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](https://www.rollupjs.org/guide/en/#command-line-reference) or the [API](https://www.rollupjs.org/guide/en/#javascript-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)](/LICENSE)