remove-comments-plugin 1.0.0-beta-1 → 1.0.0-beta-2

package/README.md

@@ -1,6 +1,6 @@
 # remove-comments-plugin
 
-A tool to remove comments from JavaScript, CSS, and HTML files.
+A powerful tool to remove comments from JavaScript, CSS, and HTML files, with support for version information filtering.
 
 ## Installation
 
@@ -13,38 +13,38 @@ npm install remove-comments-plugin
 ### Command Line
 
 ```bash
-# 使用默认配置
+# 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
 
-在package.json中配置脚本，方便项目中使用：
+Configure scripts in package.json for easy use in projects:
 
 ```json
 {
   "scripts": {
-    "remove-comments": "remove-comments -v Vue.js,vuex"
+    "remove-comments": "remove-comments --distPath ./unpackage/dist/build/h5 --versionPatterns Vue.js,vuex"
   }
 }
 ```
 
-然后运行：
+Then run:
 
 ```bash
 npm run remove-comments
@@ -55,10 +55,10 @@ npm run remove-comments
 ```javascript
 const { main, removeJavaScriptComments, removeCssComments, removeHtmlComments } = require('remove-comments-plugin');
 
-// 使用默认配置
+// Use default configuration
 main();
 
-// 使用自定义配置
+// Use custom configuration
 main({
     distPath: './dist',
     fileTypes: ['.js', '.css'],
@@ -67,7 +67,7 @@ main({
     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);
 
@@ -84,19 +84,72 @@ const cleanHtmlCode = removeHtmlComments(htmlCode);
 - 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 | Description | Default |
 | ------ | ----------- | ------- |
 | distPath | The directory path to process | `./dist` |
-| fileTypes | An array of   file extensions to process | `['.js']` |
+| fileTypes | An array of file extensions to process | `['.js']` |
 | fileIncludePatterns | An array of filename patterns to filter files | `['chunk-vendors', 'app']` |
-| versionPatterns | An array of version patterns to filter comments | `['Vue.js v2.6.11', 'vuex v3.6.2']` |
+| versionPatterns | An array of version patterns to filter comments | `['Vue.js', 'vuex']` |
 | verbose | 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

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "remove-comments-plugin",
-  "version": "1.0.0-beta-1",
+  "version": "1.0.0-beta-2",
   "description": "A tool to remove comments from JavaScript, CSS, and HTML files",
-  "main": "remove-comments.js",
+  "main": "remove-comments.min.js",
   "bin": {
-    "remove-comments": "./remove-comments.js"
+    "remove-comments": "./remove-comments.min.js"
   },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "uglifyjs remove-comments.js -o remove-comments.min.js -c -m"
   },
   "keywords": [
     "remove",
@@ -23,5 +24,8 @@
   },
   "engines": {
     "node": ">=10"
+  },
+  "devDependencies": {
+    "uglify-js": "^3.19.3"
   }
-}
+}

package/remove-comments.min.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+let fs=require("fs"),path=require("path"),Command=require("commander").Command,DEFAULT_CONFIG={distPath:path.join(process.cwd(),"unpackage/dist"),fileTypes:[".js"],verbose:!0,fileIncludePatterns:["chunk-vendors","app"],versionPatterns:["Vue.js","vuex"]},program=new Command,opts=(program.version("1.0.0").option("-d, --distPath <path>","指定dist目录路径").option("-t, --fileTypes <types>","指定需要处理的文件类型，用逗号分隔",e=>e.split(",")).option("-v, --verbose","启用详细日志",!0).option("-p, --fileIncludePatterns <patterns>","指定文件名过滤规则，用逗号分隔",e=>e.split(",")).option("-v, --versionPatterns <patterns>","指定版本信息过滤规则，用逗号分隔",e=>e.split(",")).parse(process.argv),program.opts()),CONFIG={...DEFAULT_CONFIG,...opts.distPath&&{distPath:opts.distPath},...opts.fileTypes&&{fileTypes:opts.fileTypes},..."boolean"==typeof opts.verbose&&{verbose:opts.verbose},...opts.fileIncludePatterns&&{fileIncludePatterns:opts.fileIncludePatterns},...opts.versionPatterns&&{versionPatterns:opts.versionPatterns}},COLORS={reset:"",green:"",yellow:"",blue:"",red:""};function traverseDirectory(s,o){try{fs.readdirSync(s).forEach(e=>{var e=path.join(s,e),t=fs.statSync(e);if(t.isDirectory())traverseDirectory(e,o);else if(t.isFile()&&o.fileTypes.includes(path.extname(e))){let t=path.basename(e);(!o.fileIncludePatterns||0===o.fileIncludePatterns.length||o.fileIncludePatterns.some(e=>t.includes(e)))&&(console.log(`${COLORS.green}  匹配成功，${t}${COLORS.reset}-将处理文件: `+e+COLORS.reset),processFile(e,o))}})}catch(e){console.error("遍历目录失败: "+s,e)}}function processFile(t,s){try{console.log(COLORS.blue+"开始处理文件: "+t+COLORS.reset);let e=fs.readFileSync(t,"utf8");var o=e.length,r=path.extname(t).toLowerCase(),n=(".js"===r?(console.log(COLORS.yellow+"检测到JS文件，应用JavaScript注释移除规则"+COLORS.reset),e=removeJavaScriptComments(e,s)):".css"===r?(console.log(COLORS.yellow+"检测到CSS文件，应用CSS注释移除规则"+COLORS.reset),e=removeCssComments(e)):".html"===r&&(console.log(COLORS.yellow+"检测到HTML文件，应用HTML注释移除规则"+COLORS.reset),e=removeHtmlComments(e)),e.length),l=o-n;fs.writeFileSync(t,e,"utf8"),console.log(COLORS.green+`处理完成: ${t}，移除了 ${l} 个字符的注释`+COLORS.reset)}catch(e){console.error(COLORS.red+"处理文件失败: "+t+COLORS.reset,e)}}function removeJavaScriptComments(e,t){let s=t.versionPatterns||[];return e=(e=e.replace(/\/\*[\s\S]*?\*\//g,t=>s.some(e=>t.includes(e))?"":t)).replace(/\n{3,}/g,"\n\n")}function removeCssComments(e){return e=(e=e.replace(/\/\*[^*]*\*+([^/*][^*]*\*+)*\//g,"")).replace(/\n{3,}/g,"\n\n")}function removeHtmlComments(e){return e=(e=e.replace(/<!--[^>]*-->/g,"")).replace(/\n{3,}/g,"\n\n")}function main(e={}){e={...CONFIG,...e};console.log(COLORS.blue+"开始处理目录中的注释..."+COLORS.reset),console.log(COLORS.blue+"目标目录: "+e.distPath+COLORS.reset),console.log(COLORS.blue+"处理文件类型: "+e.fileTypes.join(",")+COLORS.reset),e.fileIncludePatterns&&0<e.fileIncludePatterns.length&&console.log(COLORS.yellow+"文件名过滤规则: 只处理包含以下关键词的文件: "+e.fileIncludePatterns.join(", ")+COLORS.reset),e.versionPatterns&&0<e.versionPatterns.length&&console.log(COLORS.yellow+"注释过滤规则: 只移除包含以下关键词的注释: "+e.versionPatterns.join(", ")+COLORS.reset);try{fs.existsSync(e.distPath)||(console.error(COLORS.red+"错误: 目录不存在 - "+e.distPath+COLORS.reset),console.error(COLORS.red+"请先运行打包命令生成目录"+COLORS.reset),process.exit(1)),traverseDirectory(e.distPath,e),console.log(COLORS.green+"注释清理完成！"+COLORS.reset)}catch(e){console.error(COLORS.red+"处理过程中发生错误:"+COLORS.reset,e),process.exit(1)}}require.main===module&&main(),module.exports={main:main,removeJavaScriptComments:removeJavaScriptComments,removeCssComments:removeCssComments,removeHtmlComments:removeHtmlComments,DEFAULT_CONFIG:DEFAULT_CONFIG};