amarcruz / 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.

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

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.

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!

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.
lineEndings	unix	Type of Line-ending for normalization: "unix", "mac", "win".
maxEmptyLines	0	Maximum successive empty lines to preserve in the output. Use a positive value, or -1 to keep all the lines.
sourcemap	true	Should a sourcemap be generated?
extensions	['js', 'jsx', 'mjs']	String or array of strings with extensions of files to process.
exclude	(none)	picomatch or array of picomatch patterns for paths to exclude of the process.
include	(none)	picomatch or array of picomatch patterns for paths to include in the 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.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

License

The MIT License (MIT)

© 2018-2020 Alberto Martínez

rollup-plugin-cleanup's Issues

Does not remove comments generated by Babel

For example, the following type of comments are not removed:

/*#__PURE__*/

Doesn't work for d.ts files

For some reason, it didn't work for d.ts files (output.file = '*.d.ts') with folowing options:

cleanup({
    comments: 'none',
    extensions: ['ts', 'd.ts']
}),

Rollup.js: cleanup didn't generate a sourcemap for the transformation

I am using cleanup for four rollup'ed files in the same project; they share cleanup logic by importing the same configuration. Two of the files worked as intended, two gave the same sourcemap warning. Here's my cleanup configuration.

cleanup({
    maxEmptyLines: -1,
    comments: [
        // NOTE: remove per-file copyright notices. It will be re-added as a single banner.
        // NOTE: keeping everything else not matching.
        /^(?!\*\s*This file is part of Talkie)/,
    ],
})

Narrowed down the issue to having files missing the (correctly formatted) license notice, which was of course positive as it's an improvement for my code.

As my regexp is basically inverted, blocking if the pattern is found, it meant that if all comments matched, then the below warning was given. Does that make sense? Either way, this shows that there are cases where cleanup will generate the below sourcemap warning.

See the original files in the Talkie, text-to-speech for the browser and specifically look at the commit adding cleanup as well as the commit fixing the warning by formatting/adding the copyright notice.

---

Original rollup.js warning:

⚠️ Sourcemap is likely to be incorrect: a plugin ('cleanup') was used to transform files, but didn't generate a sourcemap for the transformation. Consult the plugin documentation for help
https://github.com/rollup/rollup/wiki/Troubleshooting#sourcemap-is-likely-to-be-incorrect

From the documentation in the link:

You'll see this warning if you generate a sourcemap with your bundle (sourceMap: true or sourceMap: 'inline') but you're using one or more plugins that transformed code without generating a sourcemap for the transformation.

Usually, a plugin will only omit the sourcemap if it (the plugin, not the bundle) was configured with sourceMap: false – so all you need to do is change that. If the plugin doesn't generate a sourcemap, consider raising an issue with the plugin author.

Not cleaning up properly /**/ comments

input examples:

   return function (/* ...args */) {
    return fn.apply(that, arguments);
  };
 ....
 catch (e) { /* empty */ }

output:

  return function (             ) {
    return fn.apply(that, arguments);
  };
 ....
 catch (e) {             }

expected:

  return function () {
    return fn.apply(that, arguments);
  };
  ....
  catch (e) {}

Pass more options to acorn parser

I am trying to 'rollup' the monaco-editor. I get an error with cleanup,

node_modules/monaco-editor/esm/vs/language/typescript/monaco.contribution.js
SyntaxError: Unexpected token (157:31)
at Parser.pp$4.raise (.../node_modules/acorn/dist/acorn.js:2756:13)

the offending line in monaco.contribution.js is

return monaco.Promise.wrap(import('./tsMode.js'));

i.e. use of an import statement.

the documentation for the acorn parser options has an entry

allowImportExportEverywhere: By default, import and export declarations can only appear at a program's top level. Setting this option to true allows them anywhere where a statement is allowed.

I think I need to be able to set this option, and maybe some others.

Errors out on spread operator

[!] (cleanup plugin) SyntaxError: Unexpected token (14:18)

Line of the file:
info.push({ ...profiles.splice(pos, 1)[0].output, index });

Char 18 is the space before the three dots...

Maintain comments starting with /*!

It's normal for post-processors working on code to maintain comment blocks which start with /*! (note the !). Take a look as jQuery sizzle or other popular libraries, and you'll see this. Please consider adding or just close this. Thanks!

Fails to process jsx file if there are multiple file extensions in the extensions array

For example, while processing this file:

import React, { Component } from 'react';

export default class App extends Component {
    render() {
        return (
            <h1>Some super important stuff.</h1>
        );
    }
}

with the options set like so:

cleanup({
    extensions: ['.jsx']
})

it works fine. But if I add .js:

cleanup({
    extensions: ['.js', '.jsx']
})

It fails to compile and complains about an unexpected token (the jsx)

when i use comments: 'none', but comments still removed

when i use comments: 'none', but comments still removed

comments: 'none' not removing all comments

My plugins section looks like this:

plugins: [
    typescript({
      typescript: require('typescript'),
      importHelpers: true
    }),
    hypothetical({
      allowFallthrough: true
    }),
    resolve(),
    commonJS({
      include: 'node_modules/**'
    }),
    buble(),
    cleanup({
      comments: 'none'
    })
  ]

but in the output code I have things like this:

  // check type
...
  /**
   * blablabla
   */

I basically want to remove any kind of comment, is it possible with this plugin?

'lineEndings: "mac"' disrupts generated sourcemap

Building a chromium browser extension, and as in the title, if I use the option lineEndings: "mac", the generated sourcemap no longer works - all line numbers in the console refer to the generated file rather than the source.

Not a dealbreaker - for now I've just turned the option off and made peace with my generated bundled output file looking a bit strange, but at least I can pinpoint errors and logged data correctly while building and testing.

Version 3.1.0 fails for certain template literals

Version 3.1.0 of the plugin fails if it encounters the following code.

const v = 10;
const s = `${v}$`;

console.log(s); // prints: 10$

index.js → output.js...
[!] (cleanup plugin) Error: Unclosed ES6 Template Literal.
index.js (2:14)
1: const v = 10;
2: const s = `${v}$`;
                 ^
3:
4: console.log(s);
Error: Unclosed ES6 Template Literal.
    at error (C:\Users\stotter\temp\cleanup-test\node_modules\rollup\dist\rollup.js:3597:30)
    at Object.error (C:\Users\stotter\temp\cleanup-test\node_modules\rollup\dist\rollup.js:16497:17)
    at Object.error (C:\Users\stotter\temp\cleanup-test\node_modules\rollup\dist\rollup.js:16906:31)
    at Promise (C:\Users\stotter\temp\cleanup-test\node_modules\rollup-plugin-cleanup\dist\rollup-plugin-cleanup.js:119:20)
    at new Promise (<anonymous>)
    at Object.transform (C:\Users\stotter\temp\cleanup-test\node_modules\rollup-plugin-cleanup\dist\rollup-plugin-cleanup.js:113:16)
    at C:\Users\stotter\temp\cleanup-test\node_modules\rollup\dist\rollup.js:16609:25
    at <anonymous>
    at process._tickCallback (internal/process/next_tick.js:189:7)
    at Function.Module.runMain (module.js:696:11)

It worked fine for version 3.0.0, so this might be related to the switch from acorn to js-cleanup.

The code above works fine in firefox, chrome and node.

I've created a small repo to reproduce the error here: https://github.com/stotter/cleanup-test

feature request: removing arbitrary chunks of code

hello!
First of all thanks for this plugin.
It's awesome but sometimes my console.logs need an extra calculation and I need a way to delete those lines of code too.

Solution would be either

• adding an extra options item where user could provide regex and this plugin would delete all findings of that regex, OR
• at least proprietary, hard-coded comment in the code à la //----CLEANUP DELETE FROM and //----CLEANUP DELETE TO

...or something else...

But I'd prefer the regex way.

Maintainers, would you consider adding such feature?

Is this plugin still maintained?

Hello,
i would like to ask, if this plugin is still maintained. It still includes rollup ^0.x dependency and so on.
Thanks

maxEmptyLines doesn't seem to work

Hi,

I'm trying to use your plugin,
cleaning comments seems to work, however, maxEmptyLines doesn't.
tried to use both 0 and then 1, however the output is the same. (10+ empty lines)

Thanks!

rollup hang up when running with this plugin in node.js

(async function build() {
    let b = await rollup.rollup({
        input: 'absolute_path_entry.js',
        plugins: [rollupCleanup()],
    }); // hang up here

    let out = {
        format: 'esm',
        sourcemap: true,
        file: path.resolve(__dirname, "dist/test.js"),
    };

    await b.generate(out);
    await b.write(out);
})();

Using Acorn plugins doesn't work as specified by README

Hey there, I'm having trouble using the acorn-dynamic-import plugin using the example in your README (related #11).

First off, the following line is no longer accurate:

import inject from 'acorn-dynamic-import/lib/inject'

It throws Error: Cannot find module 'acorn-dynamic-import/lib/inject', seemingly because the file was renamed to lib/walk. That can be fixed by updating the import to the following:

import inject from 'acorn-dynamic-import/lib/walk'

However, now I'm getting the following error:

(cleanup plugin) Error: Plugin 'dynamicImport' not found

After doing some digging, it looks like this is the result of a pre-existing issue with acorn: acornjs/acorn#746. The closure compiler Rollup plugin ran into the same problem (ampproject/rollup-plugin-closure-compiler#48), so maybe their solution could be useful.

Steps to Reproduce

1. Clone the following repo (make sure branch is correct): https://github.com/regal/regal-bundler/tree/bug-repro/rollup-plugin-cleanup/1
2. npm install
3. npm run build

Full rollup.config.js:

import typescript from "rollup-plugin-typescript2";
import replace from "rollup-plugin-re";
import cleanup from "rollup-plugin-cleanup";
import json from "rollup-plugin-json";
import acorn from "acorn";
import inject from "acorn-dynamic-import/lib/walk";

import pkg from "./package.json";

const banner = `/**
 * Regal bundler source.
 *
 * Copyright (c) Joe Cowman
 * Licensed under MIT License (see https://github.com/regal/regal-bundler)
 */`

/** Suppress Rollup's circular import warnings for TypeScript files */
const suppressCircularImportWarnings = (message, defaultFunc) => {
    if (message.code === "CIRCULAR_DEPENDENCY") {
        return;
    }
    defaultFunc(message);
}

const tsPlugin = typescript({
    tsconfigOverride: {
        compilerOptions: { module: "esNext" }
    }
});

inject(acorn);

export default [
    {
        input: "./src/index.ts",
        output: [
            { file: pkg.main, format: "cjs", banner },
            { file: pkg.module, format: "esm", banner }
        ],
        external: Object.keys(pkg.dependencies),
        plugins: [
            replace({
                exclude: "node_modules/**",
                replaces: {
                    'import \* as cosmiconfig from "cosmiconfig";': 'import cosmiconfig from "cosmiconfig";',
                    'import \* as filenamify from "filenamify";': 'import filenamify from "filenamify";',
                }
            }),
            tsPlugin,
            json(),
            cleanup({
                extensions: [".js", ".ts"],
                comments: /^((?!(Joseph R Cowman)|tslint)[\s\S])*$/, // Removes file-header comments and tslint comments
                maxEmptyLines: 0,
                acornOptions: {
                    plugins: {
                        dynamicImport: true
                    }
                }
            })
        ],
        onwarn: suppressCircularImportWarnings
    }
]

Full error:

./src/index.ts → dist/regal-bundler.cjs.js, dist/regal-bundler.esm.js...
[!] (cleanup plugin) Error: Plugin 'dynamicImport' not found
src\index.ts
Error: Plugin 'dynamicImport' not found
    at Parser.loadPlugins (C:\Users\Joe\Desktop\Projects\regal\regal-bundler\node_modules\rollup-plugin-cleanup\node_modules\acorn\dist\acorn.js:543:26)
    at new Parser (C:\Users\Joe\Desktop\Projects\regal\regal-bundler\node_modules\rollup-plugin-cleanup\node_modules\acorn\dist\acorn.js:469:8)
    at Object.parse (C:\Users\Joe\Desktop\Projects\regal\regal-bundler\node_modules\rollup-plugin-cleanup\node_modules\acorn\dist\acorn.js:5288:10)
    at blankComments (C:\Users\Joe\Desktop\Projects\regal\regal-bundler\node_modules\rollup-plugin-cleanup\dist\rollup-plugin-cleanup.js:177:9)
    at resolve (C:\Users\Joe\Desktop\Projects\regal\regal-bundler\node_modules\rollup-plugin-cleanup\dist\rollup-plugin-cleanup.js:315:14)
    at new Promise (<anonymous>)
    at cleanup (C:\Users\Joe\Desktop\Projects\regal\regal-bundler\node_modules\rollup-plugin-cleanup\dist\rollup-plugin-cleanup.js:308:10)
    at Object.transform (C:\Users\Joe\Desktop\Projects\regal\regal-bundler\node_modules\rollup-plugin-cleanup\dist\rollup-plugin-cleanup.js:356:16)
    at C:\Users\Joe\Desktop\Projects\regal\regal-bundler\node_modules\rollup\dist\rollup.js:20962:25
    at <anonymous>

Options typing

More spot coverage of types is beg. For example, use none" | 'all' instead of string | 'some', | ... instead of string here

rollup-plugin-cleanup/index.d.ts

Line 16 in 4988f54

comments?: string | RegExp | Array<string | RegExp>

blank lines within template literals are erroneously removed

Thanks a lot for this plugin; we're happily using it for faucet-pipeline.

However, I've noticed that it swallows blank lines within template literals:

// index.js
let txt = `foo

bar`;

console.log(txt);

// rollup.config.js
import { rollup } from "rollup";
import cleanup from "rollup-plugin-cleanup";

export default {
    input: "index.js",
    output: {
        file: "bundle.js",
        format: "cjs"
    },
    plugins: [
        cleanup()
    ]
};

rollup -c rollup.config.js generates the following bundle.js:

'use strict';

let txt = `foo
bar`;
console.log(txt);

As you can see, the string's blank line has been removed. cleanup({ maxEmptyLines: -1 }) avoids this issue.

(Tested with Rollup v0.56.3 and rollup-plugin-cleanup v2.0.0 as well as v0.1.0.)

How to remove specific comments?

Any options?

Empty line after deleting comment

Is it possible to remove an empty line that appears after removing a comment?

Consider config:

cleanup({
  comments: [/^\*-/],
  maxEmptyLines: 1
})

Code:

const helpers = {
/**
 * Very big comment explaning method purpose
 */
 findThing() { ... }
}

And result is:

const helpers = {

 findThing() { ... }
}

Oddly formatted Turf.js jsDoc comments not removed

I have no idea why, but Turf.js's jsDoc comments have multiple initial spaces after the initial /**:

/**
     * Earth Radius used with the Harvesine formula and approximates using a spherical (non-ellipsoid) Earth.
     *
     * @memberof helpers
     * @type {number}
     */

This causes cleanup({ comments: 'none' }), to not remove them.

Is there a reasonable way for cleanup() to handle this?

Or could you post a regex that just might work? I tried it but my regex fu is lacking! :)

Using hooks as filters

For example:

jsCleanup(code, null, {
    comments: [
        (commentContent) => {
            return commentContent.includes("preserve");
        }
    ]
})

This allows more granular control over which comments to keep and which ones to discard.

I think I might be able to do a PR if you like.