almo7aya/rollup-plugin-cleanup

Rollup plugin to remove comments, trim trailing spaces, compact empty lines, and normalize line endings

rollup-plugin-cleanup

Rollup plugin to remove comments, trim trailing spaces, compact empty lines, and normalize line endings in JavaScript files.

With the rollup-plugin-cleanup you have:

• Compaction of empty lines within multiline comments and/or out of them.
• Normalization of line endings to Unix, Mac, or Windows.
• Removal of JavaScript comments through powerful, configurable filters.
• Removal of trailing whitespace of each line.
• TypeScript definitions.
• Sourcemap support.

From v3.1, this plugin no longer uses acorn. See more in the Whats New section.

Important:

rollup-plugin-cleanup is based on js-cleanup and can handle any JS-like file: TypeScript, Flow, React, ES9, etc, but it is mainly a postprocessor, so it should be runned in a later stage of your toolchain, after any preprocessor or transpiler.

Why not Uglify?

Uglify is a excelent minifier but you have little control over the results, while with js-cleanup your coding style remains intact and the removal of comments is strictly under your control.

Install

$ npm install rollup-plugin-cleanup --save-dev
# or with yarn
$ yarn add rollup-plugin-cleanup -D

Usage

import { rollup } from 'rollup';
import awesome from 'rollup-plugin-awesome';
import cleanup from 'rollup-plugin-cleanup';

rollup({
  input: 'src/main.js',
  plugins: [
    awesome(),        // other plugins
    cleanup()         // cleanup here
  ]
}).then(...)

That's it.

By default, only the .js, .jsx, and .tag files are processed, but you can expand or restrict the set of accepted files using the options include, exclude, and extensions (see below).

Options

From v3.1.0 normalizeEols is deprecated in favor of lineEndings and the properties ecmaVersion, sourceType, and acornOptions are ignored. See more in Whats New section.

Name	Default	Description
comments	'some'	Filter or array of filters that determinates which comments should be preserved. Use "all" to keep all, or "none" to remove all the comments.
compactComments	true	Should js-cleanup also compact whitespace and blank lines in the preserved multiline comments? Line-ending normalization is always done.
maxEmptyLines	0	Maximum successive empty lines to preserve in the output. Use a positive value, or -1 to keep all the lines.
lineEndings	unix	Type of Line-ending for normalization: "unix", "mac", "win".
sourcemap	true	Should a sourcemap be generated?
include	''	minimatch or array of minimatch patterns for paths to include in the process.
exclude	''	minimatch or array of minimatch patterns for paths to exclude of the process.
extensions	['js', 'jsx', 'tag']	String or array of strings with extensions of files to process.

Predefined Comment Filters

Instead the special 'all' or 'none' keywords, you can use any combination of custom filters along with any of these predefined ones:

Name	Will preserve...
some	Comments containing "@license", "@preserve", or starting with "!".
license	Comments containing "@license".
eslint	ESLint directives.
flow	Facebook Flow directives, comment types, and flowlint comments.
istanbul	istanbul ignore comments.
jsdoc	JSDoc comments.
jshint	JSHint directives.
jslint	JSLint directives.
sources	Sourcemap directives sourceURL and sourceMappingURL.
ts	MS TypeScript Triple-Slash and @ts-* directives, plus the @jsx pragma.
ts3s	TypeScript Triple-Slash directives.

From v3.1.0, some does not includes '@cc_on' and the jscs filter was deprecated. See more in Whats New section.

'srcmaps' will be preserved as an alias to the 'sources' filter.

See the regexes in the js-cleanup src/predef-filters.ts file.

Custom Filters

You can set custom filters through regexes that matches the content of the comments that you want to preserve.

The string to which the regex is applied does not includes the first slash, nor the */ terminator of the multiline comments, so the multiline comments begins with an asterisk (*) and single-line comments begins with a slash (/).

For example, the following filters will preserve ESLint directives and multiline comments starting with a dash:

const cleanedCode = jsCleanup(code, null, { comments: ['eslint', /^\*-/] })

What's New

Changes in v3.1.1

• Fixed #15: Version 3.1.0 fails for certain template literals. Thanks to @stotter for repoting this issue.

Changes in v3.1.0

Bye, acorn.

Although acorn is an excellent parser, its use in rollup-plugin-cleanup had caused several issues.

v3.1 removes this dependency and now is completely based on js-cleanup, which does not depend on acorn or another similar parser, with the advantage of a relative independency of the version and "dialect" of JavaScript and a little more efficiency, for being a specialized tool.

While js-cleanup is in its first version, I do not expect it to present major problems (the algorithm and the JS rules used for the replacement are fairly simple).

• Added the compactComment option to control the compaction of multiline comments, useful to preserve the format of JSDoc blocks.
• The options ecmaVersion, sourceType, and acornOptions are ignored, acorn was removed in this version.
• The normalizeEols option is deprecated in favor of lineEndings, which have the same behavior.
• The some filter no longer includes @cc_on, but adds comments that begin with '!'.
• The jscs filter is deprecated, jscs no longer exists.
• Added the flow filter for Facebook Flow comments and directives.
• Added the ts filter for MS TypeScript directives.

From v3.0, the minimum supported node version is now 6.14, the oldest maintained LTS version, which includes security fixes and is also supported by ESLint 5.

None of this changes should break your apps, the deprecated features will be handled silently in this version, output a warning in next minor version, and removed in the next major release.

The conditional compilation, used by JScript in oldest non-standard IE mode, can be supported by /^\*@/, but if you really need conditional code, take a look to this plugin.

TODO

• Refactoring Tests

Support my Work

I'm a full-stack developer with more than 20 year of experience and I try to share most of my work for free and help others, but this takes a significant amount of time and effort so, if you like my work, please consider...

Of course, feedback, PRs, and stars are also welcome 🙃

Thanks for your support!

License

The MIT License (MIT)