remove-comments-plugin

A powerful tool to remove comments from JavaScript, CSS, and HTML files, with support for version information filtering.

Installation

npm install remove-comments-plugin

Usage

Command Line

# Use default configuration
remove-comments

# Specify directory
remove-comments --distPath ./dist

# Specify file types
remove-comments --fileTypes .js,.css,.html

# Specify filename filtering patterns
remove-comments --fileIncludePatterns chunk-vendors,app

# Specify version information filtering patterns
remove-comments --versionPatterns Vue.js,vuex

# Disable verbose logging
remove-comments --verbose false

Package.json Scripts

Configure scripts in package.json for easy use in projects:

{
  "scripts": {
    "remove-comments": "remove-comments --distPath ./unpackage/dist/build/h5 --versionPatterns Vue.js,vuex"
  }
}

Then run:

npm run remove-comments

Programmatic Usage

const { main, removeJavaScriptComments, removeCssComments, removeHtmlComments } = require('remove-comments-plugin');

// Use default configuration
main();

// Use custom configuration
main({
    distPath: './dist',
    fileTypes: ['.js', '.css'],
    fileIncludePatterns: ['chunk-vendors'],
    verbose: true,
    versionPatterns: ['Vue.js v2.6.11', 'vuex v3.6.2']
});

// Use comment removal functions individually
const jsCode = '// This is a comment\nconsole.log("Hello World");';
const cleanJsCode = removeJavaScriptComments(jsCode);

const cssCode = '/* This is a comment */\nbody { margin: 0; }';
const cleanCssCode = removeCssComments(cssCode);

const htmlCode = '<!-- This is a comment -->\n<div>Hello World</div>';
const cleanHtmlCode = removeHtmlComments(htmlCode);

Features

• Removes comments from JavaScript, CSS, and HTML files
• Supports custom directory paths
• Supports custom file types
• Supports custom filename filtering patterns
• Supports version information filtering (only removes comments containing specific version patterns)
• Provides detailed logging
• Can be used both as a command-line tool and as a library
• Compatible with Node.js 10 and above

Configuration Options

| Option | Short | Description | Default | | ------ | ----- | ----------- | ------- | | distPath | -d | The directory path to process | ./dist | | fileTypes | -t | An array of file extensions to process | ['.js'] | | fileIncludePatterns | -p | An array of filename patterns to filter files | ['chunk-vendors', 'app'] | | versionPatterns | -V | An array of version patterns to filter comments | ['Vue.js', 'vuex'] | | verbose | -v | Whether to print detailed logs | true |

Common Issues and Solutions

1. Directory Not Found Error

Error message:

Error: Directory does not exist - ./dist
Please run the build command first to generate the directory

Solution:

• Ensure you have run the build command to generate the target directory
• Check that the directory path is correct

2. Plugin Not Found Error

Error message:

'remove-comments' is not recognized as an internal or external command, operable program or batch file.

Solution:

• Ensure the remove-comments-plugin dependency is correctly installed
• Try using npx remove-comments instead

3. Comments Not Removed

Error message:

Processing completed: xxx.js, removed 0 characters of comments

Solution:

• Check if the version information comments contain the specified keywords (e.g., Vue.js or vuex)
• Check if the files match the filename filtering patterns

Complete Workflow

1. Install the plugin: npm install remove-comments-plugin
2. Configure the plugin in package.json or use it directly via command line
3. Run your build process (e.g., HBuilderX build)
4. Run the plugin to remove version information comments
5. Deploy the processed files

Notes

• Ensure the target directory exists before running the plugin
• The plugin only removes comments containing specified version information, not other comments
• If you need to modify filtering rules, adjust the script parameters in package.json
• For more detailed information, refer to the project documentation

License

MIT