neo-cmp-cli 1.8.7 → 1.8.9

package/src/utils/cmpUtils/pushCmp.js

@@ -1,230 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-const _ = require('lodash');
-const { getConfigObj } = require('akfun');
-const { catchCurPackageJson } = require('../pathUtils');
-const ora = require('ora');
-const NeoService = require('../../neo/neoService');
-const { getFramework, errorLog, successLog } = require('../common');
-const createCmpProjectZip = require('../projectUtils/createCmpProjectZip');
-
-// 获取当前项目的package文件
-const currentPackageJsonDir = catchCurPackageJson();
-const currentPackageJson = getConfigObj(currentPackageJsonDir);
-
-// 获取属性 propsSchema 数据结构
-const getPropsSchema = (propsSchema = []) => {
-  return propsSchema.map((item) => {
-    return {
-      label: item.label,
-      description: item.description,
-      propSchema: JSON.stringify(item)
-    };
-  });
-};
-
-/**
- * 构建组件数据映射
- * @param {string} assetsRoot 构建产物的目录
- * @param {object} cmpInfo 自定义组件信息
- * @returns {Promise<object|null>} 自定义组件数据（含自定义组件模型信息）
- */
-const buildComponentData = async (assetsRoot, cmpInfo) => {
-  if (!cmpInfo || !cmpInfo.cmpType) {
-    errorLog('自定义组件信息或组件名称不能为空');
-    return null;
-  }
-
-  const { cmpType } = cmpInfo;
-
-  if (!assetsRoot || !fs.existsSync(assetsRoot)) {
-    errorLog(`未找到自定义组件目录: ${assetsRoot}`);
-    return null;
-  }
-  const widgetName = _.camelCase(cmpType);
-  const modelFile = path.join(assetsRoot, `${widgetName}Model.js`);
-
-  // 为 Node.js 环境设置全局 window 对象（模型文件可能需要）
-  // 使用 globalThis 以确保在 Node.js 和浏览器环境中都能工作
-  const originalWindow = globalThis.window;
-  if (!globalThis.window) {
-    globalThis.window = {
-      console: console,
-      neoRequire: () => {},
-      postMessage: () => {}
-      // 可以添加其他常用的 window 属性
-    };
-  }
-
-  try {
-    // 加载自定义组件模型资源文件
-    if (fs.existsSync(modelFile)) {
-      // 加载自定义组件模型资源文件
-      let modelModule = require(modelFile);
-      // 获取导出的模型类（可能是 default 导出或命名导出）
-      // const CatchCustomCmpModelClass = modelModule.default || modelModule;
-    } else {
-      errorLog(`未找到自定义组件模型文件，请检查以下路径是否存在：${modelFile}`);
-      process.exit(1);
-    }
-    if (!globalThis.window || !globalThis.window.NEOEditorCustomModels) {
-      errorLog(
-        `模型文件未导出有效模型方法（CatchCustomCmpModelClass），模型文件地址： ${modelFile} `
-      );
-      process.exit(1);
-    }
-
-    const ModelClass = globalThis.window.NEOEditorCustomModels[cmpType];
-    if (!ModelClass) {
-      errorLog(`未找到自定义组件模型类（${cmpType}），模型文件地址： ${modelFile} `);
-      process.exit(1);
-    }
-    // 实例化模型类
-    const modelInstance = new ModelClass();
-
-    if (!modelInstance) {
-      errorLog(`未找到自定义组件模型信息（${cmpType}），模型文件地址： ${modelFile} `);
-      process.exit(1);
-    }
-
-    // 构建组件数据，合并模型实例的信息
-    const curCmpInfo = {
-      ...cmpInfo,
-      version: currentPackageJson.version || '1.0.0',
-      // 技术栈标识: 从 package.json / framework 字段获取，没有则默认 为 react ts 技术栈
-      framework: currentPackageJson.framework ? getFramework(currentPackageJson.framework) : 0, // 0: React, 1: vue2, 2: jQuery, 3: vue3
-      // 从模型实例中提取并设置组件信息
-      label: modelInstance.label || cmpType,
-      description: modelInstance.description || '',
-      componentCategory: (modelInstance.tags || ['自定义组件']).join(','),
-      targetPage: modelInstance.targetPage || ['customPage'], // 支持的页面类型
-      targetObject: modelInstance.targetObject || ['all'], // 支持的实体类型
-      targetApplication: modelInstance.targetApplication || ['all'], // 支持的应用类型
-      targetDevice: modelInstance.targetDevice || 'all', // 支持的设备类型。只有这个字段是字符串数值，其他都是数组
-      iconUrl: modelInstance.iconSrc || modelInstance.iconUrl,
-      defaultProps: JSON.stringify(modelInstance.defaultComProps || {}),
-      previewProps: JSON.stringify(modelInstance.previewComProps || {}),
-      props: getPropsSchema(modelInstance.propsSchema || []),
-      events: modelInstance.events || [],
-      functions: modelInstance.functions || modelInstance.actions || [],
-      // 如果模型实例中有其他属性，也可以添加
-      exposedToDesigner:
-        modelInstance.exposedToDesigner !== undefined ? modelInstance.exposedToDesigner : true,
-      namespace: modelInstance.namespace || 'neo-cmp-cli',
-      enableDuplicate:
-        modelInstance.enableDuplicate !== undefined ? modelInstance.enableDuplicate : true
-    };
-
-    console.log(
-      `自定义组件模型信息（${cmpType}）:`,
-      _.omit(curCmpInfo, ['assetFile', 'modelAssetFile', 'cssAssetFile', 'codeLibFile'])
-    );
-    return curCmpInfo;
-  } catch (error) {
-    errorLog(`自定义组件模型文件解析失败 (${modelFile || '未知路径'}): ${error.message}`);
-    errorLog(error.stack);
-    return null;
-  } finally {
-    // 恢复原始的 window 对象（如果之前存在）
-    if (originalWindow === undefined) {
-      delete globalThis.window;
-    } else {
-      globalThis.window = originalWindow;
-    }
-  }
-};
-
-/**
- * 发布组件到 NeoCRM
- * @param {object} config 配置信息
- * @param {string} cmpType 自定义组件类型
- *
- * 发布流程说明
- * 1. 打包源码文件：将自定义组件源码打包成 zip 文件
- * 2. 上传构建产物到 OSS：将构建后的资源文件上传到 NeoCRM 平台提供的 CDN
- * 3. 构建组件数据：从组件模型文件中提取组件信息
- * 4. 保存组件信息到 NeoCRM 平台：将组件信息保存到平台数据库
- */
-const pushCmp = async (config, cmpType) => {
-  const spinner = ora('正在发布组件...').start();
-
-  try {
-    // 步骤 1: 初始化 NeoService
-    let neoService = new NeoService(config);
-    // 获取 token
-    await neoService.ensureValidToken();
-
-    // 步骤 2: 打包源码文件（打包单个自定义组件源码）
-    spinner.start(`[1/4] 打包源码文件（含单个自定义组件源码）...`);
-    let zipPath;
-    try {
-      zipPath = createCmpProjectZip(cmpType, process.cwd(), config.assetsRoot);
-      if (!zipPath) {
-        errorLog('[1/4] 源码文件打包失败，未返回 zip 文件路径。', spinner);
-      } else {
-        successLog(`[1/4] 源码文件打包完成: ${path.basename(zipPath)}。`, spinner);
-      }
-    } catch (error) {
-      errorLog(`[1/4] 源码文件打包失败。`, spinner);
-    }
-
-    /*
-    // 步骤 3: 上传构建后资源文件（改放在保存时直接上传组件资源文件）
-    spinner.start(`[2/4] 上传自定义组件构建产物到 OSS...`);
-    let cmpInfo;
-    try {
-      cmpInfo = await neoService.publish2oss(cmpType);
-      if (!cmpInfo || !cmpInfo.cmpType) {
-        errorLog('[2/4] 上传构建产物失败，未获取到组件信息。', spinner);
-      } else {
-        successLog(`[2/4] 构建产物上传完成。`, spinner);
-      }
-    } catch (error) {
-      errorLog(`[2/4] 构建产物上传失败。`, spinner);
-    }
-    */
-    spinner.start(`[2/4] 获取自定义组件构建产物...`);
-    const cmpInfo = await neoService.getCmpAssets(cmpType);
-
-    // 步骤 4: 构建组件数据
-    spinner.start(`[3/4] 构建组件数据...`);
-    let componentInfo;
-    try {
-      componentInfo = await buildComponentData(config.assetsRoot, cmpInfo);
-      if (!componentInfo) {
-        errorLog(`[3/4] 未获取到自定义组件模型信息（${cmpType}）。`, spinner);
-      } else {
-        successLog(`[3/4] 组件数据构建完成。`, spinner);
-      }
-    } catch (error) {
-      errorLog(`[3/4] 组件数据构建失败: ${error.message}`, spinner);
-    }
-
-    // 步骤 5: 保存组件信息
-    spinner.start(`[4/4] 保存组件信息到 NeoCRM 平台...`);
-    try {
-      await neoService.updateCustomComponent(componentInfo);
-      successLog(`[4/4] 组件信息保存成功`, spinner);
-    } catch (error) {
-      errorLog(`[4/4] 组件信息保存失败`, spinner);
-    }
-
-    // 最终成功提示
-    console.log('\n✅ 自定义组件发布成功！');
-  } catch (error) {
-    // 内层 catch 已经处理了步骤错误并显示了 spinner 失败状态
-    // 这里处理未预期的错误（如果 spinner 还在运行）
-    try {
-      // ora 的 spinner 对象可能没有 isSpinning 属性，使用 try-catch 安全访问
-      if (spinner && spinner.isSpinning) {
-        errorLog(`❌ 自定义组件发布失败: ${error.message}`, spinner);
-      }
-    } catch {
-      // 如果访问失败或 spinner 已停止，直接输出错误信息
-      errorLog(`\n❌ 自定义组件发布失败: ${error.message}`);
-    }
-    throw error;
-  }
-};
-
-module.exports = pushCmp;

package/src/utils/common.js

@@ -1,107 +0,0 @@
-const chalk = require('chalk');
-const ts = require('typescript');
-const { consoleTag } = require('./neoParams');
-
-/**
- * 获取技术栈标识
- * 目的：兼容用户非标准写法
- * 0: React, 1: vue2, 2: jQuery, 3: vue3
- */
-function getFramework(_framework) {
-  let defaultFramework = 0; // 默认 React 技术栈
-  if (!_framework) {
-    return defaultFramework;
-  }
-  let curFramework = _framework.toLowerCase().trim();
-  switch (curFramework) {
-    case 'jquery':
-    case 'jq':
-      curFramework = 2;
-      break;
-    case 'vue2':
-    case 'vue 2':
-    case 'vue2.0':
-    case 'vue 2.0':
-      curFramework = 1;
-      break;
-    case 'vue':
-    case 'vue3':
-    case 'vue 3':
-    case 'vue3.0':
-    case 'vue 3.0':
-      curFramework = 3;
-      errorLog('暂不支持 vue3.0 技术栈。');
-      break;
-    case 'react-js':
-      errorLog('暂不支持 react-js 技术栈。');
-      curFramework = 0;
-      break;
-    case 'react':
-    case 'react-ts':
-      curFramework = 0;
-      break;
-    default:
-      curFramework = 0;
-  }
-  return curFramework;
-}
-
-// 输出红色字体的错误日志
-function errorLog(message, spinner) {
-  const errorMessage = `${consoleTag} ${chalk.red(message)}`;
-  if (spinner) {
-    spinner.fail(errorMessage);
-  } else {
-    console.error(errorMessage);
-  }
-}
-
-// 输出黄色字体的警告日志
-function warningLog(message, spinner) {
-  const warningMessage = `${consoleTag} ${chalk.yellow(message)}`;
-  if (spinner) {
-    spinner.warn(warningMessage);
-  } else {
-    console.warn(warningMessage);
-  }
-}
-
-// 输出绿色字体的成功日志
-function successLog(message, spinner) {
-  const successMessage = `${consoleTag} ${chalk.green(message)}`;
-  if (spinner) {
-    spinner.succeed(successMessage);
-  } else {
-    console.log(successMessage);
-  }
-}
-
-/**
- * 使用 TypeScript 官方 API 解析 tsconfig.json（推荐）
- * 需要安装: npm install typescript --save-dev
- * 优点: 官方支持，能正确处理 extends、注释等所有特性
- */
-function parseTsConfigWithTypeScript(configPath) {
-  try {
-    const configFile = ts.readConfigFile(configPath, ts.sys.readFile);
-
-    if (configFile.error) {
-      throw new Error(`解析 tsconfig.json 失败: ${configFile.error.messageText}`);
-    }
-
-    return configFile.config;
-  } catch (error) {
-    if (error.code === 'MODULE_NOT_FOUND') {
-      throw new Error('请先安装 typescript: npm install typescript --save-dev');
-    }
-    throw error;
-  }
-}
-
-module.exports = {
-  getFramework,
-  errorLog,
-  warningLog,
-  successLog,
-  parseTsConfigWithTypeScript
-};

package/src/utils/configureNeoBuild.js

@@ -1,109 +0,0 @@
-const _ = require('lodash');
-const AddNeoRequirePlugin = require('../plugins/AddNeoRequirePlugin');
-const createCommonModulesCode = require('../utils/cmpUtils/createCommonModulesCode');
-const { getExternalsByNeoCommonModules } = require('../neo/neoRequire');
-const curConfig = require('../config/index'); // 获取当前项目根目录下的配置文件
-
-// neo.config.js 中的添加的 Neo 共享依赖模块配置
-const neoCommonModule = curConfig.neoCommonModule || {};
-// 自定义组件 需要剔除的依赖模块
-const cmpNeoExternals = neoCommonModule.externals || [];
-
-// 组件目录
-const componentsDir = curConfig.componentsDir || './src/components';
-
-/**
- * 添加 AddNeoRequirePlugin 到 webpack 配置
- * @param {object} webpackConfig webpack 配置对象
- * @param {object} [options] 选项
- * @param {boolean} [options.verbose] 是否启用详细日志，默认为 false
- */
-function addNeoRequirePlugin(webpackConfig, options = {}) {
-  const { verbose = false } = options;
-  const plugin = new AddNeoRequirePlugin({ verbose });
-
-  if (webpackConfig && webpackConfig.plugins && Array.isArray(webpackConfig.plugins)) {
-    webpackConfig.plugins.push(plugin);
-  } else {
-    webpackConfig.plugins = [plugin];
-  }
-}
-
-/**
- * 添加 Neo externals 配置
- * @param {object} config 配置对象（dev 或 build2lib）
- * @param {object} externalsConfig 现有的 externals 配置
- */
-function addNeoExternals(config, externalsConfig) {
-  const externals = getExternalsByNeoCommonModules(cmpNeoExternals);
-  if (externalsConfig && _.isPlainObject(externalsConfig)) {
-    config.externals = Object.assign(externalsConfig, externals);
-  } else {
-    config.externals = externals;
-  }
-}
-
-/**
- * 创建并注入 commonModulesCode 到 entry
- * @param {object} config 配置对象（dev 或 build2lib）
- * @param {array} cmpTypes 组件类型列表
- * @param {object} [options] 选项
- * @param {boolean} [options.excludeModel] 是否排除 Model 结尾的 entry，默认为 false
- */
-function injectCommonModulesCode(config, options = {}) {
-  const { cmpTypes, defaultExports, excludeModel = false } = options;
-
-  // 添加默认导出
-  if (defaultExports && _.isPlainObject(defaultExports)) {
-    if (neoCommonModule.exports && _.isPlainObject(neoCommonModule.exports)) {
-      neoCommonModule.exports = Object.assign(neoCommonModule.exports, defaultExports);
-    } else if (neoCommonModule.exports && _.isArray(neoCommonModule.exports)) {
-      // 先将数组格式改成对象格式
-      neoCommonModule.exports.forEach((item) => {
-        if (_.isString(item)) {
-          neoCommonModule.exports[item] = item;
-        }
-      });
-      neoCommonModule.exports = Object.assign(neoCommonModule.exports, defaultExports);
-    } else {
-      neoCommonModule.exports = defaultExports;
-    }
-  }
-
-  const commonModulesFilePath = createCommonModulesCode(neoCommonModule, cmpTypes);
-
-  if (commonModulesFilePath && config.entry) {
-    Object.keys(config.entry).forEach((name) => {
-      // 如果 excludeModel 为 true，排除 Model 结尾的文件
-      if (!excludeModel || !name.endsWith('Model')) {
-        config.entry[name] = [commonModulesFilePath].concat(config.entry[name]);
-      }
-    });
-  }
-}
-
-/**
- * 配置 webpack 插件、externals 和 commonModulesCode（用于 linkDebug、publish2oss、pushCmp）
- * @param {object} config 配置对象（dev 或 build2lib）
- * @param {object} [options] 选项
- * @param {array} [options.cmpTypes] 组件类型列表
- * @param {object} [options.defaultExports] 默认导出
- * @param {boolean} [options.verbose] 是否启用详细日志，默认为 false
- * @param {boolean} [options.excludeModel] 是否排除 Model 结尾的 entry，默认为 false
- */
-function configureNeoBuild(config, options = {}) {
-  const { cmpTypes, defaultExports, verbose = false, excludeModel = false } = options;
-
-  // 添加自定义 webpack 插件
-  addNeoRequirePlugin(curConfig.webpack, { verbose });
-
-  // 添加内置 Neo 的 externals 配置
-  addNeoExternals(config, config.externals);
-
-  // 创建并注入 commonModulesCode
-  injectCommonModulesCode(config, { cmpTypes, defaultExports, excludeModel });
-}
-
-module.exports = {
-  configureNeoBuild
-};

package/src/utils/generateEntries.js

@@ -1,63 +0,0 @@
-const getEntries = require('./projectUtils/getEntries');
-const getEntriesWithAutoRegister = require('./projectUtils/getEntriesWithAutoRegister');
-
-/**
- * 生成 entry 配置
- * @param {object} options 配置选项
- * @param {object} options.configEntry 当前配置中的 entry（如果已存在则直接返回）
- * @param {boolean} options.disableAutoRegister 是否禁用自动注册
- * @param {string} options.componentsDir 组件目录路径
- * @param {string} options.entryType entry 类型：'widget' | 'linkDebug'，默认为 'widget'
- * @param {string} [options.cmpType] 可选的组件类型，如果指定则只生成该组件的 entry
- */
-function generateEntries({
-  configEntry,
-  disableAutoRegister,
-  componentsDir,
-  entryType = 'widget',
-  cmpType
-}) {
-  // 如果已配置 entry 且不需要强制获取 cmpTypes，直接返回
-  if (configEntry && Object.keys(configEntry).length > 0) {
-    return {
-      entries: configEntry,
-      cmpTypes: []
-    };
-  }
-
-  // 根据 disableAutoRegister 选择不同的生成方法
-  let entriesResult;
-  if (disableAutoRegister) {
-    // disableAutoRegister 为 true 时，仅自动生成入口文件（不自动注册）
-    entriesResult = getEntries(componentsDir, cmpType);
-  } else {
-    // 自动生成入口文件（并自动创建对应的注册文件）
-    entriesResult = getEntriesWithAutoRegister(componentsDir, cmpType);
-  }
-
-  // 根据 entryType 选择对应的 entries
-  let entries;
-  if (entryType === 'linkDebug') {
-    entries = entriesResult.linkDebugEntries || {};
-  } else {
-    entries = entriesResult.widgetEntries || {};
-  }
-
-  const cmpTypes = entriesResult.cmpTypes || [];
-
-  // 验证 entries 是否有效（仅在需要生成新 entry 时验证）
-  if (!entries || Object.keys(entries).length === 0) {
-    const defaultComponentsDir = componentsDir || './src/components';
-    throw new Error(
-      `未识别到自定义组件，请检查 ${defaultComponentsDir} 目录下是否存在自定义组件。`
-    );
-  }
-
-  return {
-    entries: entries || configEntry || {},
-    cmpTypes,
-    defaultExports: entriesResult.defaultExports || {}
-  };
-}
-
-module.exports = generateEntries;

package/src/utils/neoConfigInit.js

@@ -1,13 +0,0 @@
-const path = require('path');
-const { createFile } = require('akfun');
-
-// 将脚手架的默认配置文件拷贝到当前项目根目录
-const createDefaultConfig = function (_configProjectName) {
-  const configProjectName = _configProjectName || 'neo.config.js';
-  createFile(
-    path.resolve(__dirname, `../initData/${configProjectName}`),
-    path.resolve(process.cwd(), `./${configProjectName}`)
-  );
-};
-
-module.exports = createDefaultConfig;

package/src/utils/neoParams.js

@@ -1,12 +0,0 @@
-let consoleTag = '[neo-cmp-cli]'; // 输出标记
-
-function setConsoleTag(newText) {
-  consoleTag = newText;
-}
-
-module.exports = {
-  get consoleTag() {
-    return consoleTag;
-  },
-  setConsoleTag
-};

package/src/utils/pathUtils.js

@@ -1,23 +0,0 @@
-const path = require('path');
-const fs = require('fs');
-
-// 当前命令执行的路径
-const currentRoot = () => fs.realpathSync(process.cwd());
-const resolveToCurrentRoot = (filePath) => path.resolve(currentRoot(), filePath);
-const resolveToCurrentDist = (filePath, outDir) =>
-  path.resolve(currentRoot(), outDir || 'dist/', filePath);
-const currentSrc = () => resolveToCurrentRoot('src');
-const currentBuild = () => resolveToCurrentRoot('build');
-
-// 获取当前项目的package文件（从当前命令执行的路径下查找）
-const catchCurPackageJson = () => resolveToCurrentRoot('package.json');
-
-module.exports = {
-  currentRoot,
-  resolveToCurrentRoot,
-  resolveToCurrentDist,
-  resolve: resolveToCurrentRoot,
-  currentSrc,
-  currentBuild,
-  catchCurPackageJson
-};

package/src/utils/projectNameValidator.js

@@ -1,76 +0,0 @@
-/**
- * 文件名验证工具
- * 验证规则：
- * 1. 至少5个字符
- * 2. 必须以字母开头
- * 3. 只能包含字母、数字、连字符(-)
- */
-
-/**
- * 验证文件名是否符合规范
- * @param {string} ProjectName 文件名（不包含路径和扩展名）
- * @returns {Object} 验证结果对象
- */
-function validateProjectName(ProjectName) {
-  const errors = [];
-
-  // 检查文件名是否为空
-  if (!ProjectName || ProjectName.trim().length === 0) {
-    errors.push('文件名不能为空');
-    return { isValid: false, errors };
-  }
-
-  // 检查长度是否至少5个字符
-  if (ProjectName.length < 5) {
-    errors.push(`文件名长度必须至少5个字符，当前长度: ${ProjectName.length}`);
-  }
-
-  // 检查是否以字母开头
-  if (!/^[a-zA-Z]/.test(ProjectName)) {
-    errors.push('文件名必须以字母开头');
-  }
-
-  // 检查是否只包含字母、数字、连字符
-  if (!/^[a-zA-Z][a-zA-Z0-9-]*$/.test(ProjectName)) {
-    errors.push('文件名只能包含字母、数字和连字符(-)，且必须以字母开头');
-  }
-
-  // 检查是否包含连续连字符
-  if (ProjectName.includes('--')) {
-    errors.push('文件名不能包含连续连字符(--)');
-  }
-
-  // 检查是否以连字符结尾
-  if (ProjectName.endsWith('-')) {
-    errors.push('文件名不能以连字符结尾');
-  }
-
-  return {
-    isValid: errors.length === 0,
-    errors
-  };
-}
-
-/**
- * 验证文件名并返回布尔值
- * @param {string} ProjectName 文件名
- * @returns {boolean} 是否有效
- */
-function isValidProjectName(ProjectName) {
-  return validateProjectName(ProjectName).isValid;
-}
-
-/**
- * 获取文件名验证的错误信息
- * @param {string} ProjectName 文件名
- * @returns {Array} 错误信息数组
- */
-function getProjectNameErrors(ProjectName) {
-  return validateProjectName(ProjectName).errors;
-}
-
-module.exports = {
-  validateProjectName,
-  isValidProjectName,
-  getProjectNameErrors
-};