neo-cmp-cli 1.2.10 → 1.2.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "neo-cmp-cli",
-  "version": "1.2.10",
+  "version": "1.2.11",
   "description": "前端脚手架：自定义组件开发工具，支持react 和 vue2.0技术栈。",
   "keywords": [
     "neo-cli",

package/src/cmpUtils/updatePublishLog.js

@@ -1,9 +1,6 @@
 const fs = require('fs');
-const path = require('path');
 const _ = require('lodash');
 const { resolveToCurrentRoot } = require('../utils/pathUtils');
-const getCmpRegister = require('./getCmpRegister');
-const getCmpModelRegister = require('./getCmpModelRegister');
 /**
  * 更新发布日志
  */

package/src/neo/wrapperContent.js

@@ -2,11 +2,11 @@
  * 注入 neoRequire 函数
  * 备注：用于实现和 Neo 平台共享依赖
  */
-(function(cmpFileFactory) {
+(function(NeoCustomCmpFileFactory) {
   if (!window.neoRequire) {
     throw new Error('neoRequire 不存在，请在 NeoCRM 平台中加载此脚本。');
   }
-  cmpFileFactory(window.neoRequire);
+  NeoCustomCmpFileFactory(window.neoRequire);
 })(function(require) {
   /**
    * 这里放自定义组件相关内容代码

package/src/plugins/AddNeoRequirePlugin-v1.js

@@ -0,0 +1,47 @@
+const { ConcatSource } = require('webpack-sources');
+
+/**
+ * 注入 neoRequire 函数
+ * 备注：用于实现和 Neo 平台共享依赖
+ */
+class AddNeoRequirePlugin {
+  apply(compiler) {
+    compiler.hooks.compilation.tap('AddNeoRequirePlugin', (compilation) => {
+      compilation.hooks.processAssets.tap(
+        {
+          name: 'AddNeoRequirePlugin',
+          stage: -100
+        },
+        () => {
+          for (const chunk of compilation.chunks) {
+            if (!chunk.canBeInitial() || !chunk.rendered) {
+              continue;
+            }
+
+            for (const file of chunk.files) {
+              if (/.css$/.test(file)) {
+                // 不处理 css 文件
+                continue;
+              }
+
+              const Header = `
+(function(cmpFileFactory) {
+  if (!window.neoRequire) {
+    throw new Error('neoRequire 不存在，请在 NeoCRM 平台中加载此脚本。');
+  }
+  cmpFileFactory(window.neoRequire);
+})(function(require) {
+                `;
+
+              const Footer = `})`;
+
+              compilation.updateAsset(file, (oldFileContent) => new ConcatSource(Header, oldFileContent, Footer));
+            }
+          }
+        }
+      );
+    });
+  }
+}
+
+module.exports = AddNeoRequirePlugin;

package/src/plugins/AddNeoRequirePlugin.js

@@ -5,6 +5,83 @@ const { ConcatSource } = require('webpack-sources');
  * 备注：用于实现和 Neo 平台共享依赖
  */
 class AddNeoRequirePlugin {
+  constructor(options = {}) {
+    this.options = {
+      // 是否启用详细日志
+      verbose: options.verbose || false,
+      // 是否跳过已注入的文件
+      skipInjected: options.skipInjected !== false,
+      // 需要跳过的文件扩展名
+      skipExtensions: options.skipExtensions || ['.css', '.map', '.txt', '.html'],
+      // 需要跳过的文件名模式
+      skipPatterns: options.skipPatterns || [/\.map$/, /\.LICENSE\.txt$/, /\.html$/],
+      ...options
+    };
+    
+    // 记录已处理的文件，避免重复处理
+    this.processedFiles = new Set();
+  }
+
+  /**
+   * 检查文件是否应该被跳过
+   */
+  shouldSkipFile(filename) {
+    // 检查扩展名
+    for (const ext of this.options.skipExtensions) {
+      if (filename.endsWith(ext)) {
+        return true;
+      }
+    }
+    
+    // 检查文件名模式
+    for (const pattern of this.options.skipPatterns) {
+      if (pattern.test(filename)) {
+        return true;
+      }
+    }
+    
+    return false;
+  }
+
+  /**
+   * 检查文件是否已经被注入过
+   */
+  isAlreadyInjected(content) {
+    if (!content || typeof content !== 'string') {
+      return false;
+    }
+    
+    // 检查是否包含注入的标识
+    return content.includes('NeoCustomCmpFileFactory(window.neoRequire)') && 
+           content.includes('if (!window.neoRequire)');
+  }
+
+  /**
+   * 验证文件内容是否有效
+   */
+  isValidFile(content) {
+    if (!content || typeof content !== 'string') {
+      return false;
+    }
+    
+    // 检查文件是否为空或只包含空白字符
+    if (content.trim().length === 0) {
+      return false;
+    }
+    
+    return true;
+  }
+
+  /**
+   * 记录日志
+   */
+  log(message, level = 'info') {
+    if (this.options.verbose || level === 'error') {
+      const prefix = `[AddNeoRequirePlugin]`;
+      console[level](`${prefix} ${message}`);
+    }
+  }
+
   apply(compiler) {
     compiler.hooks.compilation.tap('AddNeoRequirePlugin', (compilation) => {
       compilation.hooks.processAssets.tap(
@@ -12,36 +89,94 @@ class AddNeoRequirePlugin {
           name: 'AddNeoRequirePlugin',
           stage: -100
         },
-        () => {
-          for (const chunk of compilation.chunks) {
-            if (!chunk.canBeInitial() || !chunk.rendered) {
-              continue;
-            }
+        (assets) => {
+          this.log('开始处理资源文件...');
+          
+          let processedCount = 0;
+          let skippedCount = 0;
+          let errorCount = 0;
 
-            for (const file of chunk.files) {
-              if (/.css$/.test(file)) {
-                // 不处理 css 文件
+          // 遍历所有资源文件
+          for (const [filename, asset] of Object.entries(assets)) {
+            try {
+              // 检查是否应该跳过此文件
+              if (this.shouldSkipFile(filename)) {
+                this.log(`跳过文件: ${filename} (匹配跳过规则)`);
+                skippedCount++;
                 continue;
               }
 
-              const Header = `
-(function(cmpFileFactory) {
-  if (!window.neoRequire) {
-    throw new Error('neoRequire 不存在，请在 NeoCRM 平台中加载此脚本。');
-  }
-  cmpFileFactory(window.neoRequire);
-})(function(require) {
-                `;
+              // 检查是否已经处理过
+              if (this.processedFiles.has(filename)) {
+                this.log(`跳过文件: ${filename} (已处理过)`);
+                skippedCount++;
+                continue;
+              }
 
-              const Footer = `})`;
+              // 获取文件内容
+              const source = asset.source();
+              const content = typeof source === 'string' ? source : source.toString();
 
-              compilation.updateAsset(file, (oldFileContent) => new ConcatSource(Header, oldFileContent, Footer));
+              // 验证文件内容
+              if (!this.isValidFile(content)) {
+                this.log(`跳过文件: ${filename} (内容无效)`, 'warn');
+                skippedCount++;
+                continue;
+              }
+
+              // 检查是否已经注入过
+              if (this.options.skipInjected && this.isAlreadyInjected(content)) {
+                this.log(`跳过文件: ${filename} (已注入过)`);
+                skippedCount++;
+                continue;
+              }
+
+              // 执行注入
+              this.injectNeoRequire(compilation, filename, content);
+              this.processedFiles.add(filename);
+              processedCount++;
+              
+              this.log(`成功处理文件: ${filename}`);
+
+            } catch (error) {
+              errorCount++;
+              this.log(`处理文件失败: ${filename}, 错误: ${error.message}`, 'error');
+              console.error(`[AddNeoRequirePlugin] 详细错误:`, error);
             }
           }
+
+          // 输出处理统计
+          this.log(`处理完成 - 成功: ${processedCount}, 跳过: ${skippedCount}, 错误: ${errorCount}`);
+          
+          if (errorCount > 0) {
+            this.log(`警告: 有 ${errorCount} 个文件处理失败`, 'warn');
+          }
         }
       );
     });
   }
+
+  /**
+   * 执行 neoRequire 注入
+   */
+  injectNeoRequire(compilation, filename, content) {
+    const Header = `
+(function(NeoCustomCmpFileFactory) {
+  if (!window.neoRequire) {
+    throw new Error('neoRequire 不存在，请在 NeoCRM 平台中加载此脚本。');
+  }
+  NeoCustomCmpFileFactory(window.neoRequire);
+})(function(require) {
+                `;
+
+    const Footer = `})`;
+
+    // 创建新的资源
+    const newSource = new ConcatSource(Header, content, Footer);
+    
+    // 更新资源
+    compilation.updateAsset(filename, newSource);
+  }
 }
 
 module.exports = AddNeoRequirePlugin;

package/src/plugins/README.md

@@ -1,2 +1,109 @@
-# 存放 webpack 插件的地方
-暂时没有可用 plugin
+# AddNeoRequirePlugin 使用说明
+
+## 概述
+
+`AddNeoRequirePlugin` 是一个 webpack 插件，用于在构建过程中自动为 JavaScript 文件注入 `neoRequire` 包装代码，实现与 Neo 平台的依赖共享。
+
+## 使用方法
+
+### 基本使用
+
+```javascript
+const AddNeoRequirePlugin = require('./AddNeoRequirePlugin');
+
+module.exports = {
+  // ... 其他配置
+  plugins: [
+    new AddNeoRequirePlugin()
+  ]
+};
+```
+
+### 高级配置
+
+```javascript
+const AddNeoRequirePlugin = require('./AddNeoRequirePlugin');
+
+module.exports = {
+  // ... 其他配置
+  plugins: [
+    new AddNeoRequirePlugin({
+      // 启用详细日志
+      verbose: true,
+      
+      // 跳过已注入的文件（默认: true）
+      skipInjected: true,
+      
+      // 需要跳过的文件扩展名
+      skipExtensions: ['.css', '.map', '.txt', '.html', '.svg'],
+      
+      // 需要跳过的文件名模式（正则表达式）
+      skipPatterns: [
+        /\.map$/,
+        /\.LICENSE\.txt$/,
+        /\.html$/,
+        /vendor\./,
+        /chunk\./
+      ]
+    })
+  ]
+};
+```
+
+## 配置选项
+
+| 选项 | 类型 | 默认值 | 说明 |
+|------|------|--------|------|
+| `verbose` | boolean | false | 是否启用详细日志输出 |
+| `skipInjected` | boolean | true | 是否跳过已经注入过的文件 |
+| `skipExtensions` | string[] | ['.css', '.map', '.txt', '.html'] | 需要跳过的文件扩展名列表 |
+| `skipPatterns` | RegExp[] | [/\.map$/, /\.LICENSE\.txt$/, /\.html$/] | 需要跳过的文件名模式 |
+
+## 注入的代码结构
+
+插件会为每个 JavaScript 文件添加以下包装代码：
+
+```javascript
+(function(NeoCustomCmpFileFactory) {
+  if (!window.neoRequire) {
+    throw new Error('neoRequire 不存在，请在 NeoCRM 平台中加载此脚本。');
+  }
+  NeoCustomCmpFileFactory(window.neoRequire);
+})(function(require) {
+  // 原始文件内容
+});
+```
+
+## 日志输出示例
+
+```
+[AddNeoRequirePlugin] 开始处理资源文件...
+[AddNeoRequirePlugin] 跳过文件: main.css (匹配跳过规则)
+[AddNeoRequirePlugin] 跳过文件: main.js.map (匹配跳过规则)
+[AddNeoRequirePlugin] 成功处理文件: main.js
+[AddNeoRequirePlugin] 成功处理文件: chunk.1.js
+[AddNeoRequirePlugin] 处理完成 - 成功: 2, 跳过: 2, 错误: 0
+```
+
+## 故障排除
+
+### 1. 文件未被注入
+- 检查文件是否匹配跳过规则
+- 启用 `verbose: true` 查看详细日志
+- 确认文件内容有效且不为空
+
+### 2. 重复注入
+- 启用 `skipInjected: true` 选项
+- 检查文件是否已经被处理过
+
+### 3. 构建错误
+- 查看错误日志中的详细错误信息
+- 检查文件内容是否包含特殊字符
+- 确认 webpack 版本兼容性
+
+## 注意事项
+
+1. 插件会在 webpack 的 `processAssets` 阶段执行，优先级为 -100
+2. 只处理 JavaScript 文件，自动跳过 CSS、Map 等非 JS 文件
+3. 支持 SourceMap 文件，但不会修改它们
+4. 建议在生产环境中关闭详细日志以提高性能