https://github.com/unassert-js/rollup-plugin-unassert

A Rollup plugin to remove assertion calls via Unassert
https://github.com/unassert-js/rollup-plugin-unassert

plugin rollup testing unassert

Last synced: 25 days ago
JSON representation

A Rollup plugin to remove assertion calls via Unassert

• Host: GitHub
• URL: https://github.com/unassert-js/rollup-plugin-unassert
• Owner: unassert-js
• Created: 2019-03-23T16:05:03.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-07-19T08:36:22.000Z (over 1 year ago)
• Last Synced: 2024-05-11T23:42:43.333Z (7 months ago)
• Topics: plugin, rollup, testing, unassert
• Language: JavaScript
• Homepage:
• Size: 248 KB
• Stars: 5
• Watchers: 3
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome - unassert - Remove assertion calls. (Plugins / Code Quality)

README

        
# rollup-plugin-unassert

A [Rollup](http://www.rollupjs.org) plugin to remove assertion calls via [Unassert](https://github.com/unassert-js/unassert).

## Usage

Install (`npm install --save-dev rollup-plugin-unassert` or `yarn add --dev rollup-plugin-unassert`),

then add it to the `plugins` section of your Rollup config as follows:

```js

import unassert from 'rollup-plugin-unassert';

export default {

    ...

    plugins: [

        unassert()

    ]

};

```

### Available options

This plugin accepts the following options:

* `include`: A minimatch pattern or array of minimatch patterns, controlling which files are to be handled by this plugin. By default matches `*.js` only.

* `exclude`: A minimatch pattern or array of minimatch patterns, controlling which files are to be ignored by this plugin. By default it's empty.

* `sourcemap`: A boolean controlling whether to handle any existing sourcemaps, defaults to `true`. Setting this to `false` will hide the assert calls when debugging the generated bundle.

* `assertionPatterns`: as per [unassert options](https://github.com/unassert-js/unassert#options).

* `requirePatterns`: as per [unassert options](https://github.com/unassert-js/unassert#options).

* `importPatterns`: as per [unassert options](https://github.com/unassert-js/unassert#options).

### Example Rollup config

```js

import unassert from 'rollup-plugin-unassert';

export default {

    input: 'src/index.js',

    output: {

        file: 'dist/my-lib.js',

    },

    plugins: [

        unassert({

            exclude: 'test/**/**.js',

            requirePatterns: ['assert = require("assert")']

        })

    ]

};

```

## License

"THE BEER-WARE LICENSE":

 wrote this file. As long as you retain this notice you

can do whatever you want with this stuff. If we meet some day, and you think

this stuff is worth it, you can buy me a beer in return.

Also, thanks to Takuto Wada for https://github.com/unassert-js/unassertify, from

which this project takes a lot of the code to wrap unassert.