remove-comments-plugin 1.0.0-beta-1

package/README.md

@@ -0,0 +1,102 @@
+# remove-comments-plugin
+
+A tool to remove comments from JavaScript, CSS, and HTML files.
+
+## Installation
+
+```bash
+npm install remove-comments-plugin
+```
+
+## Usage
+
+### Command Line
+
+```bash
+# 使用默认配置
+remove-comments
+
+# 指定目录
+remove-comments --distPath ./dist
+
+# 指定文件类型
+remove-comments --fileTypes .js,.css,.html
+
+# 指定文件名过滤规则
+remove-comments --fileIncludePatterns chunk-vendors,app
+
+# 指定版本信息过滤规则
+remove-comments --versionPatterns Vue.js,vuex
+
+# 禁用详细日志
+remove-comments --verbose false
+```
+
+### Package.json Scripts
+
+在package.json中配置脚本，方便项目中使用：
+
+```json
+{
+  "scripts": {
+    "remove-comments": "remove-comments -v Vue.js,vuex"
+  }
+}
+```
+
+然后运行：
+
+```bash
+npm run remove-comments
+```
+
+### Programmatic Usage
+
+```javascript
+const { main, removeJavaScriptComments, removeCssComments, removeHtmlComments } = require('remove-comments-plugin');
+
+// 使用默认配置
+main();
+
+// 使用自定义配置
+main({
+    distPath: './dist',
+    fileTypes: ['.js', '.css'],
+    fileIncludePatterns: ['chunk-vendors'],
+    verbose: true,
+    versionPatterns: ['Vue.js v2.6.11', 'vuex v3.6.2']
+});
+
+// 单独使用注释移除函数
+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
+- Provides detailed logging
+- Can be used both as a command-line tool and as a library
+
+## Configuration Options
+
+| Option | Description | Default |
+| ------ | ----------- | ------- |
+| distPath | The directory path to process | `./dist` |
+| 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']` |
+| verbose | Whether to print detailed logs | `true` |
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "remove-comments-plugin",
+  "version": "1.0.0-beta-1",
+  "description": "A tool to remove comments from JavaScript, CSS, and HTML files",
+  "main": "remove-comments.js",
+  "bin": {
+    "remove-comments": "./remove-comments.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "remove",
+    "comments",
+    "javascript",
+    "css",
+    "html"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "commander": "^6.2.0"
+  },
+  "engines": {
+    "node": ">=10"
+  }
+}

package/remove-comments.js

@@ -0,0 +1,231 @@
+#!/usr/bin/env node
+const fs = require('fs');
+const path = require('path');
+const { Command } = require('commander');
+
+// 默认配置项
+const DEFAULT_CONFIG = {
+    // dist目录路径
+    // distPath: path.join(__dirname, 'unpackage', 'dist', 'build'),
+    distPath: path.join(process.cwd(), 'unpackage/dist'),
+    // 需要处理的文件类型
+    fileTypes: ['.js'],
+    // 是否打印详细日志
+    verbose: true,
+    // 文件名过滤规则 - 只处理包含以下关键词的文件
+    fileIncludePatterns: ['chunk-vendors', 'app'],
+    // 版本信息过滤规则 - 只处理包含以下关键词的注释
+    versionPatterns: ['Vue.js','vuex']
+};
+
+// 解析命令行参数
+const program = new Command();
+program
+    .version('1.0.0')
+    .option('-d, --distPath <path>', '指定dist目录路径')
+    .option('-t, --fileTypes <types>', '指定需要处理的文件类型，用逗号分隔', (value) => value.split(','))
+    .option('-v, --verbose', '启用详细日志', true)
+    .option('-p, --fileIncludePatterns <patterns>', '指定文件名过滤规则，用逗号分隔', (value) => value.split(','))
+    .option('-v, --versionPatterns <patterns>', '指定版本信息过滤规则，用逗号分隔', (value) => value.split(','))
+    .parse(process.argv);
+
+// 合并配置
+const opts = program.opts();
+const CONFIG = {
+    ...DEFAULT_CONFIG,
+    // 只有当命令行参数存在时才覆盖默认值
+    ...(opts.distPath && { distPath: opts.distPath }),
+    ...(opts.fileTypes && { fileTypes: opts.fileTypes }),
+    ...(typeof opts.verbose === 'boolean' && { verbose: opts.verbose }),
+    ...(opts.fileIncludePatterns && { fileIncludePatterns: opts.fileIncludePatterns }),
+    ...(opts.versionPatterns && { versionPatterns: opts.versionPatterns })
+};
+
+// 颜色代码
+const COLORS = {
+    reset: '\x1b[0m',
+    green: '\x1b[32m',
+    yellow: '\x1b[33m',
+    blue: '\x1b[34m',
+    red: '\x1b[31m'
+};
+
+/**
+ * 递归遍历目录，处理所有匹配的文件
+ * @param {string} dirPath - 目录路径
+ * @param {Object} config - 配置选项
+ */
+function traverseDirectory(dirPath, config) {
+    try {
+        const files = fs.readdirSync(dirPath);
+
+        files.forEach(file => {
+            const filePath = path.join(dirPath, file);
+            const stats = fs.statSync(filePath);
+
+            if (stats.isDirectory()) {
+                // 递归处理子目录
+                traverseDirectory(filePath, config);
+            } else if (stats.isFile() && config.fileTypes.includes(path.extname(filePath))) {
+                // 获取文件名
+                const fileName = path.basename(filePath);
+
+                // 检查文件名是否匹配过滤规则
+                const shouldProcess = !config.fileIncludePatterns || config.fileIncludePatterns.length === 0 ||
+                    config.fileIncludePatterns.some(pattern => {
+                        const match = fileName.includes(pattern);
+                        return match;
+                    });
+
+                if (shouldProcess) {
+                    console.log(`${COLORS.green}  匹配成功，${fileName}${COLORS.reset}-将处理文件: ${filePath}${COLORS.reset}`);
+                    // 处理匹配的文件
+                    processFile(filePath, config);
+                }
+            }
+        });
+    } catch (error) {
+        console.error(`遍历目录失败: ${dirPath}`, error);
+    }
+}
+
+/**
+ * 处理单个文件，删除注释
+ * @param {string} filePath - 文件路径
+ * @param {Object} config - 配置选项
+ */
+function processFile(filePath, config) {
+    try {
+        // 读取文件内容
+        console.log(`${COLORS.blue}开始处理文件: ${filePath}${COLORS.reset}`);
+        let content = fs.readFileSync(filePath, 'utf8');
+        const originalSize = content.length;
+
+        // 获取文件扩展名
+        const ext = path.extname(filePath).toLowerCase();
+
+        // 根据文件类型删除注释
+        if (ext === '.js') {
+            console.log(`${COLORS.yellow}检测到JS文件，应用JavaScript注释移除规则${COLORS.reset}`);
+            content = removeJavaScriptComments(content, config);
+        } else if (ext === '.css') {
+            console.log(`${COLORS.yellow}检测到CSS文件，应用CSS注释移除规则${COLORS.reset}`);
+            content = removeCssComments(content);
+        } else if (ext === '.html') {
+            console.log(`${COLORS.yellow}检测到HTML文件，应用HTML注释移除规则${COLORS.reset}`);
+            content = removeHtmlComments(content);
+        }
+
+        const newSize = content.length;
+        const removedSize = originalSize - newSize;
+
+        // 写回文件
+        fs.writeFileSync(filePath, content, 'utf8');
+
+        console.log(`${COLORS.green}处理完成: ${filePath}，移除了 ${removedSize} 个字符的注释${COLORS.reset}`);
+    } catch (error) {
+        console.error(`${COLORS.red}处理文件失败: ${filePath}${COLORS.reset}`, error);
+    }
+}
+
+/**
+ * 移除JavaScript注释
+ * @param {string} code - JavaScript代码
+ * @param {Object} config - 配置选项
+ * @returns {string} - 移除注释后的代码
+ */
+function removeJavaScriptComments(code, config) {
+    // 确保 versionPatterns 存在
+    const versionPatterns = config.versionPatterns || [];
+    
+    // 只移除包含特定版本信息的多行注释
+    // 找出所有多行注释
+    const commentRegex = /\/\*[\s\S]*?\*\//g;
+    code = code.replace(commentRegex, (match) => {
+        // 检查注释是否包含版本信息
+        const containsVersion = versionPatterns.some(pattern => match.includes(pattern));
+        // 如果包含版本信息，则移除；否则保留
+        return containsVersion ? '' : match;
+    });
+    
+    // 移除多余的空白行
+    code = code.replace(/\n{3,}/g, '\n\n');
+    return code;
+}
+
+/**
+ * 移除CSS注释
+ * @param {string} code - CSS代码
+ * @returns {string} - 移除注释后的代码
+ */
+function removeCssComments(code) {
+    // 移除CSS注释，但保留含有 @charset 的注释
+    code = code.replace(/\/\*[^*]*\*+([^/*][^*]*\*+)*\//g, '');
+    // 移除多余的空白行
+    code = code.replace(/\n{3,}/g, '\n\n');
+    return code;
+}
+
+/**
+ * 移除HTML注释
+ * @param {string} code - HTML代码
+ * @returns {string} - 移除注释后的代码
+ */
+function removeHtmlComments(code) {
+    // 移除HTML注释，但保留IE条件注释
+    code = code.replace(/<!--[^>]*-->/g, '');
+    // 移除多余的空白行
+    code = code.replace(/\n{3,}/g, '\n\n');
+    return code;
+}
+
+/**
+ * 主函数
+ * @param {Object} options - 配置选项
+ */
+function main(options = {}) {
+    // 合并配置
+    const config = {
+        ...CONFIG,
+        ...options
+    };
+    console.log(`${COLORS.blue}开始处理目录中的注释...${COLORS.reset}`);
+    console.log(`${COLORS.blue}目标目录: ${config.distPath}${COLORS.reset}`);
+    console.log(`${COLORS.blue}处理文件类型: ${config.fileTypes.join(',')}${COLORS.reset}`);
+    if (config.fileIncludePatterns && config.fileIncludePatterns.length > 0) {
+        console.log(`${COLORS.yellow}文件名过滤规则: 只处理包含以下关键词的文件: ${config.fileIncludePatterns.join(', ')}${COLORS.reset}`);
+    }
+    if(config.versionPatterns && config.versionPatterns.length > 0) {
+        console.log(`${COLORS.yellow}注释过滤规则: 只移除包含以下关键词的注释: ${config.versionPatterns.join(', ')}${COLORS.reset}`);
+    }
+
+    try {
+        // 检查目录是否存在
+        if (!fs.existsSync(config.distPath)) {
+            console.error(`${COLORS.red}错误: 目录不存在 - ${config.distPath}${COLORS.reset}`);
+            console.error(`${COLORS.red}请先运行打包命令生成目录${COLORS.reset}`);
+            process.exit(1);
+        }
+
+        // 开始遍历处理
+        traverseDirectory(config.distPath, config);
+
+        console.log(`${COLORS.green}注释清理完成！${COLORS.reset}`);
+    } catch (error) {
+        console.error(`${COLORS.red}处理过程中发生错误:${COLORS.reset}`, error);
+        process.exit(1);
+    }
+}
+
+// 执行主函数
+if (require.main === module) {
+    main();
+}
+
+module.exports = {
+    main,
+    removeJavaScriptComments,
+    removeCssComments,
+    removeHtmlComments,
+    DEFAULT_CONFIG
+};