remove-blocks
v1.0.3
Published
A library that removes marked blocks from any type of code.
Downloads
477
Maintainers
Readme
Remove Blocks
The remove-blocks
is a library that removes marked blocks from any type of code.
Install
# NPM
npm install --save-dev remove-blocks
# Yarn
yarn add --dev remove-blocks
Usage
It removes blocks of code marked with two paired tags. A pair of tags consists of a start tag and an end tag. The format
of each tag is prefix name:position suffix
(e.g. /* debug:start */
). The name, prefix, and suffix are configurable.
/* debug:start */
console.log('debug');
/* debug:end */
Note: The blocks cannot overlap each other.
Options
options.skips
an array of environments where the processing will be skipped.
options.blocks
an array of blocks' representations. Each element of this array describes a unique pair of tags with
name, prefix, and suffix. These values are represented by a string or an object with the following properties:
name: 'devblock', # string value defines the name of start/end tags (unique)
prefix: '/*', # string value defines the beginning of a tag
suffix: '*/', # string value defines the end of a tag
License
The MIT License (MIT). Please see the License file for more information.