js-cleanup

WebJar for js-cleanup

License

License

MIT
Categories

Categories

JavaScript Languages
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

js-cleanup
Last Version

Last Version

1.2.0
Release Date

Release Date

Type

Type

jar
Description

Description

js-cleanup
WebJar for js-cleanup
Project URL

Project URL

https://www.webjars.org
Source Code Management

Source Code Management

https://github.com/aMarCruz/js-cleanup

Download js-cleanup

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/js-cleanup/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>js-cleanup</artifactId>
    <version>1.2.0</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/js-cleanup/
implementation 'org.webjars.npm:js-cleanup:1.2.0'
// https://jarcasting.com/artifacts/org.webjars.npm/js-cleanup/
implementation ("org.webjars.npm:js-cleanup:1.2.0")
'org.webjars.npm:js-cleanup:jar:1.2.0'
<dependency org="org.webjars.npm" name="js-cleanup" rev="1.2.0">
  <artifact name="js-cleanup" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='js-cleanup', version='1.2.0')
)
libraryDependencies += "org.webjars.npm" % "js-cleanup" % "1.2.0"
[org.webjars.npm/js-cleanup "1.2.0"]

Dependencies

compile (3)

Group / Artifact Type Version
org.webjars.npm : magic-string jar [0.25.7,0.26)
org.webjars.npm : perf-regexes jar [1.0.1,2)
org.webjars.npm : skip-regex jar [1.0.2,2)

Project Modules

There are no modules declared in this project.

js-cleanup

License npm Version Travis AppVeyor Coverage Code Quality Maintainability

Smart comment and whitespace cleaner for JavaScript-like files.

With js-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.

Although js-cleanup is not locked to a particular JavaScript dialect and can handle any JS-like file: TypeScript, Flow, React, ES9, etc, it is mainly a postprocessor, so it should be runned in a later stage of your toolchain, after any preprocessor or transpiler.

js-cleanup requires node v10.14.2 or above, but avoid the buggy v11.x

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 js-cleanup -D
# or
$ yarn add js-cleanup -D

Usage

jsCleanup(sourceCode: string, fileName?: string | null, options?: Options): Result;

Result

The result is a plain JS object of this type:

type Result = {
  code: string;
  map?: object | null;
};
Name Description
code The processed code.
map A raw sourcemap object, or null if the text did not change.
Undefined if sourcemap:false.

Options

Type definition:

type Options = {
  comments?: string | RegExp;
  compactComments?: boolean;
  maxEmptyLines?: number; // use -1 to preserve all the lines
  lineEndings?: string; // 'mac' | 'unix' | 'win'
  sourcemap?: boolean;
  sourcemapOptions: {
    includeContent?: boolean;
    inlineMap?: boolean;
    hires?: boolean;
  };
};
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 preserve all the lines
lineEndings 'unix' Type of Line-ending for normalization: "unix", "mac", "win".
sourcemap true Should js-cleanup generate a sourcemap?
sourcemapOptions -
includeContent false Include the original source text in the sourcemap?
inlineMap false Inline the sourcemap in the processed text?
hires true Should a hi-res sourcemap be generated?

Note:
If you want to keep JSDoc comments, you should also set compactComments: false.
Since the JSDoc presentation depends on empty lines, these should be controlled by you.

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.

Note:
Since none of this filters is really accurate (js-cleanup is not a parser), they are suitable for the job without introducing greater complexity.

See the regexes in src/predef-filters.ts

Custom Filters

A custom filter is a regex that must match the content of the comments that you want to preserve.

The content of the comments tested by each filter 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", /^\*-/],
});

License

The MIT License

© 2018-2020 Alberto Martínez

Versions

Version
1.2.0