Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aMarCruz/rollup-plugin-cleanup
Rollup plugin to remove comments, trim trailing spaces, compact empty lines, and normalize line endings
https://github.com/aMarCruz/rollup-plugin-cleanup
cleanup es2015 filter javascript modules rollup rollup-plugin
Last synced: 3 months ago
JSON representation
Rollup plugin to remove comments, trim trailing spaces, compact empty lines, and normalize line endings
- Host: GitHub
- URL: https://github.com/aMarCruz/rollup-plugin-cleanup
- Owner: aMarCruz
- License: mit
- Created: 2016-09-05T08:53:00.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-01-13T17:22:17.000Z (almost 3 years ago)
- Last Synced: 2024-07-08T05:37:01.760Z (4 months ago)
- Topics: cleanup, es2015, filter, javascript, modules, rollup, rollup-plugin
- Language: JavaScript
- Homepage:
- Size: 438 KB
- Stars: 100
- Watchers: 4
- Forks: 5
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome - cleanup
README
# rollup-plugin-cleanup
[![npm Version][npm-badge]][npm-url]
[![License][license-badge]][license-url]
[![AppVeyor Status][appveyor-badge]][appveyor-url]
[![Travis Status][travis-badge]][travis-url]
[![Maintainability][climate-badge]][climate-url]
[![Coverage][coverage-badge]][coverage-url]
[Rollup](http://rollupjs.org/) 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](#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](https://github.com/aMarCruz/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...
[
][kofi-url]
Of course, feedback, PRs, and stars are also welcome 🙃
Thanks!
## Install
```bash
npm install rollup-plugin-cleanup --save-dev
# or with yarn
yarn add rollup-plugin-cleanup -D
```
## Usage
```js
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](#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](https://github.com/micromatch/picomatch#globbing-features) or array of picomatch patterns for paths to exclude of the process. |
| include | (none) | [picomatch](https://github.com/micromatch/picomatch#globbing-features) 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](http://eslint.org/docs/user-guide/configuring) directives.
flow | Facebook [Flow](https://flow.org/en/docs) directives, [comment types](https://flow.org/en/docs/types/comments/), and [flowlint](https://flow.org/en/docs/linting/flowlint-comments/) comments.
istanbul | [istanbul](https://github.com/gotwarlost/istanbul/blob/master/ignoring-code-for-coverage.md) ignore comments.
jsdoc | [JSDoc](http://usejsdoc.org/) comments.
jshint | [JSHint](http://jshint.com/docs/#inline-configuration) directives.
jslint | [JSLint](http://www.jslint.com/help.html) directives.
sources | Sourcemap directives [sourceURL](https://www.html5rocks.com/en/tutorials/developertools/sourcemaps/#toc-sourceurl) and [sourceMappingURL](https://docs.google.com/document/d/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k/edit#heading=h.9ppdoan5f016).
ts | MS [TypeScript](http://www.typescriptlang.org/) Triple-Slash and @ts-* directives, plus the @jsx pragma.
ts3s | TypeScript [Triple-Slash](http://www.typescriptlang.org/docs/handbook/triple-slash-directives.html) directives.
From v3.1.0, `some` does not includes '@cc_on' and the `jscs` filter was deprecated. See more in [Whats New](#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](https://github.com/aMarCruz/js-cleanup/blob/master/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:
```js
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][license-url] (MIT)
© 2018-2020 Alberto MartÃnez
[npm-badge]: https://badgen.net/npm/v/rollup-plugin-cleanup
[npm-url]: https://www.npmjs.com/package/rollup-plugin-cleanup
[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat
[license-url]: https://github.com/aMarCruz/rollup-plugin-cleanup/blob/master/LICENSE
[appveyor-badge]: https://ci.appveyor.com/api/projects/status/vuy62d6cbo1uo0be?svg=true
[appveyor-url]: https://ci.appveyor.com/project/aMarCruz/rollup-plugin-cleanup
[travis-badge]: https://travis-ci.org/aMarCruz/rollup-plugin-cleanup.svg?branch=master
[travis-url]: https://travis-ci.org/aMarCruz/rollup-plugin-cleanup
[climate-badge]: https://api.codeclimate.com/v1/badges/a63cdadb2dce668d3e8b/maintainability
[climate-url]: https://codeclimate.com/github/aMarCruz/rollup-plugin-cleanup/maintainability
[coverage-badge]: https://codecov.io/gh/aMarCruz/rollup-plugin-cleanup/branch/master/graph/badge.svg
[coverage-url]: https://codecov.io/gh/aMarCruz/rollup-plugin-cleanup
[kofi-url]: https://ko-fi.com/C0C7LF7I