Repository files navigation

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 theWhats New section.

rollup-plugin-cleanup requires node v10.13 or above, butavoid the buggy v11.x

Important:

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

Why not Uglify?

Uglify is a excelentminifier 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.

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!

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

import{rollup}from'rollup';importawesomefrom'rollup-plugin-awesome';importcleanupfrom'rollup-plugin-cleanup';rollup({input:'src/main.js',plugins:[awesome(),// other pluginscleanup()// 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 optionsinclude,exclude, andextensions (see below).

From v3.1.0normalizeEols is deprecated in favor oflineEndings and the propertiesecmaVersion,sourceType, andacornOptions are ignored. See more inWhats New section.

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

From v3.1.0,some does not includes '@cc_on' and thejscs filter was deprecated. See more inWhats New section.

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

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

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:

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

Changes in v3.2.1

• Fixed #16 ? Thanks to @Aqours, @gevalo1 & @xania for repoting this issue
• Using js-cleanup v1.2.0 and Rollup v2.0+
• Requires NodeJS v10.14.2 or v12.0 and above
• Updated dependencies

TheMIT License (MIT)

© 2018-2020 Alberto Martínez