neo-cmp-cli 1.5.5 → 1.5.6

package/README.md

@@ -37,6 +37,9 @@ neo init -t=react-ts
 # 创建自定义组件项目
 neo createProject
 
+# 也可以根据模板创建自定义组件项目
+neo init
+
 # 在当前项目中创建一个自定义组件
 neo createCmp
 
@@ -79,10 +82,12 @@ npm run pushCmp
 
 ## 常用命令说明
 - **neo init**: 交互式创建自定义组件（支持 -t、--name）。
-- **neo preview**: 本地预览自定义组件内容，默认支持热更新与接口代理。
+- **neo createProject**: 创建自定义组件项目（支持 --name）。
+- **neo createCmp**: 在当前项目中创建一个自定义组件（支持 --name）。
+- **neo preview**: 本地预览自定义组件内容（支持 --name），默认支持热更新与接口代理。
 - **neo linkDebug**: 外链调试模式，在平台端页面设计器中调试自定义组件。
-- **neo publish2oss**: 构建并上传到对象存储（可自定义配置对象存储）。
-- **neo pushCmp**: 构建并发布到NeoCRM平台（需自行添加授权配置）。
+- **neo publish2oss**: 构建并上传到对象存储（支持 --name，可自定义配置对象存储）。
+- **neo pushCmp**: 构建并发布到NeoCRM平台（支持 --name，需自行添加授权配置）。
 
 ## 开发须知
 #### 1）默认自动识别自定义组件

package/package.json

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

package/src/cmpUtils/pushCmp.js

@@ -1,48 +1,17 @@
 const fs = require('fs');
 const path = require('path');
-const AdmZip = require('adm-zip');
 const _ = require('lodash');
 const { catchCurPackageJson } = require('../utils/pathUtils');
 const getConfigObj = require('../utils/getConfigObj');
 const ora = require('ora');
 const NeoService = require('../neo/neoService');
 const { consoleTag } = require('../utils/neoParams');
+const createCmpProjectZip = require('../projectUtils/createCmpProjectZip');
 
 // 获取当前项目的package文件
 const currentPackageJsonDir = catchCurPackageJson();
 const currentPackageJson = getConfigObj(currentPackageJsonDir);
 
-/**
- * 将构建产物打包成 zip 文件
- * @param {string} assetsRoot 构建产物的目录
- * @returns {Promise<string>} zip 文件路径
- */
-const createZipPackage = async (assetsRoot) => {
-  if (!fs.existsSync(assetsRoot)) {
-    throw new Error(`assetsRoot 不存在: ${assetsRoot}`);
-  }
-
-  const files = fs.readdirSync(assetsRoot);
-  const zip = new AdmZip();
-
-  files.forEach((file) => {
-    const filePath = path.join(assetsRoot, file);
-    const fileStat = fs.statSync(filePath);
-    if (fileStat.isFile()) {
-      // 只添加 .js 文件
-      if (file.endsWith('.js')) {
-        zip.addLocalFile(filePath);
-      }
-    }
-  });
-
-  const zipPath = path.join(assetsRoot, `${currentPackageJson.name}.zip`);
-  zip.writeZip(zipPath);
-  console.info(`已创建 zip 文件: ${zipPath}`);
-
-  return zipPath;
-};
-
 /**
  * 获取技术栈标识
  * 目的：兼容用户非标准写法
@@ -202,24 +171,22 @@ const pushCmp = async (config, cmpType) => {
     spinner.text = '发布自定义组件：初始化 NeoService...';
     const neoService = new NeoService(config);
 
-    // 步骤 2: 上传构建后资源文件
+    // 步骤 2: 打包源码文件（打包单个自定义组件源码）
+    spinner.text = '发布自定义组件：打包源码文件（含单个自定义组件源码）...';
+    createCmpProjectZip(cmpType, process.cwd(), config.assetsRoot);
+
+    // 步骤 3: 上传构建后资源文件
     spinner.text = '发布自定义组件：上传自定义组件构建产物到 OSS...';
     const cmpInfo = await neoService.publish2oss(cmpType);
 
-    /*
-    // 步骤 3: 打包文件（打包单个自定义组件源码）
-    spinner.text = '发布自定义组件：打包文件（打包单个自定义组件源码）...';
-    const zipPath = await createZipPackage(assetsRoot);
-    */
-
-    // 步骤 4: 构建组件数据
+    // 步骤 5: 构建组件数据
     spinner.text = '发布自定义组件：构建组件数据...';
     const componentInfo = await buildComponentData(config.assetsRoot, cmpInfo);
     if (!componentInfo) {
       throw new Error(`构建组件数据失败，未获取到自定义组件模型信息。（${cmpType}）`);
     }
 
-    // 步骤 5: 保存组件信息
+    // 步骤 6: 保存组件信息
     spinner.text = '发布自定义组件：保存组件信息...';
     await neoService.updateCustomComponent(componentInfo);
 

package/src/neo/neoService.js

@@ -334,9 +334,9 @@ class NeoService {
    * 将构建产物上传到 NeoCRM 平台端
    *
    * @param {object} cmpType 自定义组件名称
-   * @param {array} fileExtensions 需要上传的文件类型，默认 ['.js', '.css']
+   * @param {array} fileExtensions 需要上传的文件类型，默认 ['.js', '.css', '.zip']
    */
-  async publish2oss(cmpType, fileExtensions = ['.js', '.css']) {
+  async publish2oss(cmpType, fileExtensions = ['.js', '.css', '.zip']) {
     if (!cmpType) {
       console.error(`自定义组件名称不能为空: ${cmpType}`);
       return;
@@ -375,6 +375,8 @@ class NeoService {
             curCmpInfo.modelAsset = fileUrl;
           } else if (file.endsWith('.css')) {
             curCmpInfo.cssAsset = fileUrl;
+          } else if (file.endsWith('.zip')) {
+            curCmpInfo.codeLib = fileUrl;
           } else {
             curCmpInfo.asset = fileUrl;
           }

package/src/projectUtils/createCmpProjectZip.js

@@ -0,0 +1,122 @@
+const fs = require('fs-extra');
+const path = require('path');
+const AdmZip = require('adm-zip');
+const _ = require('lodash');
+const { consoleTag } = require('../utils/neoParams'); // 输出标记
+const hasNeoProject = require('./hasNeoProject');
+
+/**
+ * 创建自定义组件源码 zip 包
+ * @param {*} cmpType 自定义组件名称
+ * @returns {string} zip 文件路径
+ */
+module.exports = function (cmpType, _projectPath, assetsRoot) {
+  const projectRoot = _projectPath || process.cwd();
+  const finalAssetsRoot = assetsRoot || path.join(projectRoot, 'dist');
+  
+  if (!hasNeoProject(_projectPath)) {
+    console.error(`${consoleTag}当前目录不是自定义组件项目，请在自定义组件项目目录下执行。`);
+    process.exit(1);
+  }
+
+  if (!cmpType) {
+    console.error(`${consoleTag}自定义组件名称不能为空`);
+    process.exit(1);
+  }
+
+  const zip = new AdmZip();
+  
+  // 需要排除的目录和文件
+  const excludeDirs = ['node_modules', '.neo-cli', 'dist'];
+  const excludeFiles = ['.eslintcache', 'auth.config.js'];
+  
+  /**
+   * 判断文件/目录是否应该被排除
+   * @param {string} filePath 文件路径
+   * @param {string} relativePath 相对路径
+   * @returns {boolean} 是否应该排除
+   */
+  const shouldExclude = (filePath, relativePath) => {
+    const name = path.basename(filePath);
+    const stat = fs.statSync(filePath);
+    
+    // 排除指定的目录
+    if (stat.isDirectory() && excludeDirs.includes(name)) {
+      return true;
+    }
+    
+    // 排除指定的文件
+    if (stat.isFile() && excludeFiles.includes(name)) {
+      return true;
+    }
+    
+    // 对于 src/components 目录，只包含 cmpType 子目录
+    // 处理逻辑：如果路径是 src/components/xxx，且 xxx 不是 cmpType，则排除
+    if (relativePath.startsWith('src/components')) {
+      const relativeToComponents = path.relative('src/components', relativePath);
+      // 如果相对路径不为空，说明已经在 components 的子目录中
+      if (relativeToComponents && relativeToComponents !== '.') {
+        const firstPart = relativeToComponents.split(path.sep)[0];
+        // 如果第一个部分不是 cmpType，则排除
+        if (firstPart !== cmpType) {
+          return true;
+        }
+      }
+    }
+    
+    return false;
+  };
+  
+  /**
+   * 递归遍历目录并添加到 zip
+   * @param {string} dirPath 目录路径
+   * @param {string} relativePath 相对路径（用于 zip 中的路径）
+   */
+  const addDirectoryToZip = (dirPath, relativePath = '') => {
+    try {
+      const items = fs.readdirSync(dirPath);
+      
+      items.forEach((item) => {
+        const itemPath = path.join(dirPath, item);
+        const itemRelativePath = relativePath ? path.join(relativePath, item) : item;
+        
+        // 检查是否应该排除
+        if (shouldExclude(itemPath, itemRelativePath)) {
+          return;
+        }
+        
+        const stat = fs.statSync(itemPath);
+        
+        if (stat.isDirectory()) {
+          // 递归处理子目录
+          addDirectoryToZip(itemPath, itemRelativePath);
+        } else if (stat.isFile()) {
+          // 添加文件到 zip，保持相对路径结构
+          const fileContent = fs.readFileSync(itemPath);
+          zip.addFile(itemRelativePath, fileContent);
+        }
+      });
+    } catch (error) {
+      console.error(`${consoleTag}遍历目录失败 (${dirPath}):`, error.message);
+    }
+  };
+  
+  // 开始遍历项目根目录
+  addDirectoryToZip(projectRoot);
+  
+  // 生成 zip 文件名
+  const zipFileName = `${_.camelCase(cmpType)}Source.zip`;
+  const zipPath = path.join(finalAssetsRoot, zipFileName);
+  
+  // 如果已存在同名 zip 文件，先删除
+  if (fs.existsSync(zipPath)) {
+    fs.removeSync(zipPath);
+  }
+  
+  // 写入 zip 文件
+  zip.writeZip(zipPath);
+  
+  console.log(`${consoleTag}已创建自定义组件源码 zip 包: ${zipFileName}`);
+  
+  return zipPath;
+};

package/src/projectUtils/hasNeoProject.js

@@ -5,9 +5,10 @@ const path = require('path');
  * 判断当前是否存在 neo 项目
  * 备注：neo.config.js 和 package.json 必须同时存在才算作 neo 项目
  */
-module.exports = function () {
-  const neoConfigPath = path.resolve(process.cwd(), 'neo.config.js');
-  const packagePath = path.resolve(process.cwd(), 'package.json');
+module.exports = function (_projectPath) {
+  const projectPath = _projectPath || process.cwd();
+  const neoConfigPath = path.resolve(projectPath, 'neo.config.js');
+  const packagePath = path.resolve(projectPath, 'package.json');
 
   if (fs.existsSync(neoConfigPath) && fs.existsSync(packagePath)) {
     return true;

package/src/template/antd-custom-cmp-template/package.json

@@ -47,7 +47,7 @@
     "@commitlint/config-conventional": "^9.1.1",
     "@types/react": "^16.9.11",
     "@types/react-dom": "^16.9.15",
-    "neo-cmp-cli": "^1.5.5",
+    "neo-cmp-cli": "^1.5.6",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5"

package/src/template/echarts-custom-cmp-template/package.json

@@ -47,7 +47,7 @@
     "@commitlint/config-conventional": "^9.1.1",
     "@types/react": "^16.9.11",
     "@types/react-dom": "^16.9.15",
-    "neo-cmp-cli": "^1.5.5",
+    "neo-cmp-cli": "^1.5.6",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5",

package/src/template/empty-custom-cmp-template/package.json

@@ -45,7 +45,7 @@
     "@commitlint/config-conventional": "^9.1.1",
     "@types/react": "^16.9.11",
     "@types/react-dom": "^16.9.15",
-    "neo-cmp-cli": "^1.5.5",
+    "neo-cmp-cli": "^1.5.6",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5"

package/src/template/react-custom-cmp-template/package.json

@@ -44,7 +44,7 @@
   "devDependencies": {
     "@commitlint/cli": "^8.3.5",
     "@commitlint/config-conventional": "^9.1.1",
-    "neo-cmp-cli": "^1.5.5",
+    "neo-cmp-cli": "^1.5.6",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5"

package/src/template/react-ts-custom-cmp-template/package.json

@@ -46,7 +46,7 @@
     "@commitlint/config-conventional": "^9.1.1",
     "@types/react": "^16.9.11",
     "@types/react-dom": "^16.9.15",
-    "neo-cmp-cli": "^1.5.5",
+    "neo-cmp-cli": "^1.5.6",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5"

package/src/template/vue2-custom-cmp-template/package.json

@@ -44,7 +44,7 @@
   "devDependencies": {
     "@commitlint/cli": "^8.3.5",
     "@commitlint/config-conventional": "^9.1.1",
-    "neo-cmp-cli": "^1.5.5",
+    "neo-cmp-cli": "^1.5.6",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5",