neo-cmp-cli 1.2.3 → 1.2.6

package/package.json

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

package/src/module/index.js

@@ -181,10 +181,9 @@ yargs
       }
     }
   )
-  /*
   .command(
-    'preview',
-    '开启组件预览模式（仅预览组件本身内容）',
+    'dev',
+    '开启组件预览模式',
     (yargs) => {
       yargs
         .reset()
@@ -192,10 +191,9 @@ yargs
         .alias('h', 'help');
     },
     () => {
-      mainAction.preview();
+      mainAction.dev();
     }
   )
-  */
   .command(
     'linkDebug',
     '开启外链调试模式（在线上页面设计器端调试）',

package/src/module/main.js

@@ -29,15 +29,11 @@ module.exports = {
   neoInitByCopy,
   inspect,
   neoConfigInit,
-  preview: () => {
-    // 预览组件本身内容
-    if (!curConfig.preview) {
-      console.error('未找到 preview 相关配置。');
+  dev: () => {
+    if (!curConfig.dev) {
+      console.error('未找到 dev 相关配置。');
       process.exit(1);
     }
-    curConfig.dev = Object.assign(curConfig.dev, curConfig.preview); // 将 preview 设置给 dev
-    delete curConfig.preview;
-
     akfun.dev(curConfig, consoleTag);
   },
   previewCmp: (cmpName) => {

package/src/neo/neoRequire.js

@@ -87,6 +87,24 @@ const initNeoRequire = () => {
   }
 };
 
+/**
+ * 用于加载 Neo 共享出来的依赖模块
+ * @param moduleName 模块名称
+ * @returns 模块对象或 undefined
+ */
+const neoRequire = (moduleName) => {
+  const defaultModule = { cmpType: moduleName, __esModule: true }; // 默认模块
+  if (!window.__NeoCommonModules) {
+    window.__NeoCommonModules = {}
+  }
+  if (window.__NeoCommonModules[moduleName]) {
+    return window.__NeoCommonModules[moduleName]
+  } else {
+    window.__NeoCommonModules[moduleName] = defaultModule;
+    return window.__NeoCommonModules[moduleName];
+  }
+}
+
 module.exports = {
   initNeoRequire,
   addNeoCommonModules,

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

@@ -1,6 +1,6 @@
 {
   "name": "antd-custom-cmp-template",
-  "version": "1.1.8",
+  "version": "1.1.9",
   "description": "neo自定义组件模板（react&ts技术栈）",
   "keywords": [
     "自定义组件模板",
@@ -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.2.2",
+    "neo-cmp-cli": "^1.2.3",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5"

package/src/template/antd-custom-cmp-template/src/assets/img/custom-widget.svg

@@ -0,0 +1 @@
+<?xml version="1.0" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg t="1756957113315" class="icon" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="5395" xmlns:xlink="http://www.w3.org/1999/xlink" width="200" height="200"><path d="M288 768v115.2c0 25.6 19.2 44.8 44.8 44.8h556.8c25.6 0 44.8-19.2 44.8-44.8v-198.4s0-6.4-6.4-6.4h-83.2c-38.4 0-70.4-32-70.4-70.4 0-38.4 32-70.4 70.4-70.4h83.2s6.4 0 6.4-6.4V332.8c0-25.6-19.2-44.8-44.8-44.8H768C768 198.4 697.6 128 608 128S448 198.4 448 288H332.8c-25.6 0-44.8 19.2-44.8 44.8V448C198.4 448 128 518.4 128 608S198.4 768 288 768z m0-249.6h70.4V358.4h160V288c0-51.2 38.4-89.6 89.6-89.6 51.2 0 89.6 38.4 89.6 89.6v70.4h160v108.8h-19.2c-76.8 0-140.8 64-140.8 140.8 0 76.8 64 140.8 140.8 140.8h19.2v108.8H358.4v-160H288c-51.2 0-89.6-38.4-89.6-89.6 0-51.2 38.4-89.6 89.6-89.6z" p-id="5396" fill="#0764f5"></path></svg>

package/src/template/develop/neo-custom-cmp-template/.prettierrc.js

@@ -0,0 +1,12 @@
+/*
+  prettier 配置文件
+  更多配置信息：https://prettier.io/docs/en/options.html
+ */
+module.exports = {
+  semi: true, // Semicolons 分号，默认需要分号
+  tabWidth: 2, // 空格，默认 2,
+  useTabs: false,
+  singleQuote: true, // 单引号还是双引号，默认为false 双引号
+  trailingComma: 'all', // 逗号
+  jsxBracketSameLine: false, // 默认为false，Put the > of a multi-line JSX element at the end of the last line instead of being alone on the next line (does not apply to self closing elements).
+};

package/src/template/develop/neo-custom-cmp-template/README.md

@@ -0,0 +1,48 @@
+### 目录说明
+- src: 自定义组件源码；
+- src/assets: 存放组件静态资源，比如 css、img等；
+- src/components: 存放自定义组件代码，每个自定义组件以自身名称（cmpType 数值）作为目录进行存放；
+- src/components/contact-form/index.tsx: 自定义组件的内容文件；
+- src/components/contact-form/model.ts: 自定义组件的模型文件，用于对接页面设计器；
+- neo.config.js: neo-cmp-cli 配置文件。
+
+### 组件开发规范
+- 存放在 src/components 目录下的自定义组件，默认 index 为自定义组件源码入口文件，register.[tj]s 为注册 自定义组件的脚本文件，model.[tj]s 为自定义组件的模型文件（对接页面设计器需要）；
+- 当 neo.config.js 中的 entry 为空或者不存在时，cli 将根据 src/components 目录下的自定义组件结构生成对应的 entry 配置（可在命令控制台查看生成的 entry 配置）；
+- 自定义组件中可用的配置项类型 请见 [当前可用表单项](https://github.com/wibetter/neo-register/blob/master/docs/FormItemType.md)；
+- 自定义组件最外层请设置一个唯一的 ClassName（比如 xx-cmpType-container），所有内容样式请放在该 ClassName 中，避免自定义组件样式相互干扰；
+- 默认开启代码规范检测（含样式内容），如需关闭，请调整 neo.config.js 相关配置；
+- 请使用 react 16版本；
+- 支持在自定义组件中使用 Open API，详细见[使用说明](./docs/README.md)。
+
+### 自定义组件注册器使用说明
+- [neo-register 使用说明](https://www.npmjs.com/package/neo-register?activeTab=readme)
+备注：预览、调试（linkDebug）和构建发布时 cli 会自动创建对应的注册文件（含 neo-register 的使用），用户无需关注 neo-register。
+
+### 开发说明
+
+1. **安装依赖**
+```bash
+$ npm i 或者 yarn
+```
+
+2. **preview: 组件预览模式（带热更新）**
+> preview模式：用于预览自定义组件内容。
+```bash
+$ npm run preview
+```
+
+3. **linkDebug: 外链调试（在线上页面设计器端预览自定义组件）**
+> linkDebug模式：用于在线上页面设计器中预览和调试自定义组件。
+```bash
+$ npm run linkDebug
+```
+
+4. **发布到对象存储服务中**
+> 需要确保 package.json 中的 name 值唯一，version 值不重复。
+```bash
+$ npm run publish2oss
+```
+
+### 配置项说明（neo-cmp-cli）
+[请查看neo-cmp-cli](https://github.com/wibetter/neo-cmp-cli)

package/src/template/develop/neo-custom-cmp-template/commitlint.config.js

@@ -0,0 +1,59 @@
+/**
+ * https://www.npmjs.com/package/@commitlint/config-conventional\
+ *
+ * Git提交规范-配置文件
+ * Commit message 由Header、Body 和 Footer三个部分组成，其格式如下：
+ *  <type>(<scope>): <subject>
+ *  <BLANK LINE>
+ *   <body>
+ *  <BLANK LINE>
+ *  <footer>
+ *
+ *【备注】
+ * type 用于说明 commit 的类别，常用下面 7 个标识：
+ * scope 用于说明当前功能点作用于哪个页面或者哪个功能模块；
+ * subject 用于简短的描述当前commit，不超过50个字符；
+ * body 用于填写对本次 commit 的详细描述，可以分成多行；
+ * footer 不兼容变动声明，或者关闭 Issue。
+ *
+ * 【type类型取值类型】
+ * feat：新功能（feature）
+ * fix：功能优化
+ * bug：修补bug
+ * docs：文档（documentation）
+ * style：格式（不影响代码运行的变动）
+ * refactor：重构（即不是新增功能，也不是修改bug的代码变动）
+ * test：增加测试
+ * chore：构建过程或辅助工具的变动
+ * build：影响构建系统或外部依赖项的更改（示例范围：gulp，broccoli，npm）
+ * ci：对 CI 配置文件和脚本的更改（示例范围：Travis，Circle，BrowserStack，SauceLabs）
+ * perf：改进性能的代码更改
+ *
+ */
+
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'type-enum': [
+      2,
+      'always',
+      [
+        'feat',
+        'fix',
+        'bug',
+        'docs',
+        'style',
+        'refactor',
+        'test',
+        'chore',
+        'perf',
+        'build',
+        'ci',
+      ],
+    ],
+    'type-empty': [2, 'never'],
+    'scope-empty': [1, 'never'],
+    'subject-full-stop': [0, 'never'],
+    'subject-case': [0, 'never'],
+  },
+};

package/src/template/develop/neo-custom-cmp-template/docs/README.md

@@ -0,0 +1,13 @@
+## Open api 文档
+- [Open API 简介](https://doc.xiaoshouyi.com/#/proMan/workplaceDetailApi?url=%2F%2Fconcepts%2Fapi_apiIntroduction.html&id=1405&dir=output_1757929564205)。
+
+## Neo 自定义组件中可用的 open api 接口
+- [查询对象列表](https://doc.xiaoshouyi.com/#/proMan/workplaceDetailApi?url=%2F%2Fconcepts%2FpaasQueryObjectList.html&id=1405&dir=output_1757929564205&time=1758780224026): /rest/metadata/v2.0/xobjects/filter；
+- 查询标准对象列表: /rest/metadata/v2.0/xobjects/filter?custom=false&active=true；
+- 查询自定义对象列表: /rest/metadata/v2.0/xobjects/filter?custom=true&active=true；
+- [创建业务数据](https://doc.xiaoshouyi.com/#/proMan/workplaceDetailApi?url=%2F%2Fconcepts%2Fapi_paas_customObject_create.html&id=1405&dir=output_1757929564205&time=1758782257815): /rest/data/v2.0/xobjects/{xObjectApiKey};
+- [更新业务数据](https://doc.xiaoshouyi.com/#/proMan/workplaceDetailApi?url=%2F%2Fconcepts%2Fapi_paas_customObject_update.html&id=1405&dir=output_1757929564205&time=1758782321910): /rest/data/v2.0/xobjects/{xObjectApiKey}/{id};
+- [获取业务数据信息（单个数据）](https://doc.xiaoshouyi.com/#/proMan/workplaceDetailApi?url=%2F%2Fconcepts%2Fapi_paas_customObject_getBusinessDataInformation.html&id=1405&dir=output_1757929564205&time=1758781533725): /rest/data/v2.0/xobjects/{xObjectApiKey}/{id};
+- [查询接口（通用查询接口）](https://doc.xiaoshouyi.com/#/proMan/workplaceDetailApi?url=%2F%2Fconcepts%2Fapi_queryInterfaceDescription.html&id=1405&dir=output_1757929564205&time=1758784491846): /rest/data/v2/query;
+- [获取业务类型描述](https://doc.xiaoshouyi.com/?sso-domain=login-cd.xiaoshouyi.com#/proMan/workplaceDetailApi?url=%2F%2Fconcepts%2Fapi_paas_customObject_getBusinessTypeDescription.html&id=1405&dir=output_1757929564205&time=1758798530511): /rest/data/v2.0/xobjects/{xObjectApiKey}/busiType;
+- 更多可用接口见[文档](https://doc.xiaoshouyi.com/#/proMan/workplaceDetailApi?url=%2F%2Fconcepts%2Fapi_apiIntroduction.html&id=1405&dir=output_1757929564205)。

package/src/template/develop/neo-custom-cmp-template/neo.config.js

@@ -0,0 +1,121 @@
+'use strict';
+const path = require('path');
+
+// 统一路径解析
+function resolve(dir) {
+  return path.resolve(__dirname, dir);
+}
+
+// 包括生产和开发的环境配置信息
+module.exports = {
+  settings: {
+    enableESLint: true, // 调试模式是否开启ESLint，默认开启ESLint检测代码格式
+    enableESLintFix: true, // 是否自动修正代码格式，默认不自动修正
+    enableStyleLint: false, // 是否开启StyleLint，默认开启ESLint检测代码格式
+    enableStyleLintFix: false, // 是否需要StyleLint自动修正代码格式
+  },
+  webpack: {
+    target: ['web', 'es5'], // 指定目标环境为 web 和 es5，确保兼容性
+    resolve: {
+      // webpack的resolve配置
+      extensions: ['.js', '.jsx', '.ts', '.tsx', '.umd.js', '.min.js', '.json'], // 用于配置webpack在尝试过程中用到的后缀列表
+      alias: {
+        '@': resolve('src'),
+        $assets: resolve('src/assets'),
+        $public: resolve('public'),
+      },
+    },
+    // sassResources中的sass文件会自动注入每一个sass文件中
+    sassResources: [
+      resolve('./src/assets/css/common.scss'),
+      resolve('./src/assets/css/mixin.scss'),
+    ],
+    // createDeclaration: true, // 打包时是否创建ts声明文件
+    ignoreNodeModules: false, // 打包时是否忽略 node_modules
+    // allowList: [], // ignoreNodeModules为true时生效
+    // projectDir: ['src'],
+    // template: resolve('./public/template.html'), // 自定义html模板
+    // plugins: [],
+    // babelPlugins: [],
+  },
+  // 用于添加 Neo 共享依赖模块的配置信息
+  /*
+  neoCommonModule: {
+    // neoExports: ['xxModule'], // 自定义组件 共享出来的模块，支持数组和对象形式
+    neoExports: { // 对象写法
+      'chart-widget': path.resolve('./src/components/chart-widget'), // 导出图表自定义组件
+      'neo-register': 'neo-register', // 导出 Neo 注册模块
+    },
+    // neoExternals: ['xxModule'], // 自定义组件中需要剔除的模块，仅支持数组写法
+    // remotes: ['xxModule'], // 远程组件，表示当前自定义组件会用到的远程组件，需要和 neoExternals 配合使用
+  },
+  */
+  preview: {
+    // 用于开启本地预览模式的相关配置信息
+    /*
+    【特别说明】以下配置项都自带默认值，非必填。如需自定义请自行配置。
+    entry: { // 根据 src/components 目录下的文件自动生成 entry 相关配置
+      // 本地预览自定义组件内容
+      index: './src/preview.jsx',
+    },
+    NODE_ENV: 'development',
+    port: 80, // 设置基础端口，如果被占用则自动寻找可用端口
+    assetsPublicPath: '/', // 设置静态资源的引用路径（根域名+路径）
+    assetsSubDirectory: '',
+    hostname: 'localhost',
+    proxyTable: {
+      '/apiTest': {
+        target: 'http://api-test.com.cn', // 不支持跨域的接口根地址
+        ws: true,
+        changeOrigin: true,
+      },
+    },
+    */
+  },
+  linkDebug: {
+    // 用于开启本地调试模式的相关配置信息
+    /*
+    【特别说明】以下配置项都自带默认值，非必填。如需自定义请自行配置。
+    entry: { // 根据 src/components 目录下的文件自动生成 entry 相关配置
+      // 外链调试（在线上页面设计器端预览自定义组件）
+      index: [
+        './src/components/info-card/register.ts',
+        './src/components/info-card/model.ts',
+      ],
+    },
+    NODE_ENV: 'development',
+    port: 80, // 设置基础端口，如果被占用则自动寻找可用端口
+    closeHotReload: true, // 是否关闭热更新
+    assetsPublicPath: '/', // 设置静态资源的引用路径（根域名+路径）
+    assetsSubDirectory: '',
+    hostname: 'localhost',
+    proxyTable: {
+      '/apiTest': {
+        target: 'http://api-test.com.cn', // 不支持跨域的接口根地址
+        ws: true,
+        changeOrigin: true,
+      },
+    }
+    */
+  },
+  publish2oss: {
+    // 用于构建并发布至 OSS 的相关配置
+    /*
+    【特别说明】以下配置项都自带默认值，非必填。如需自定义请自行配置。
+    NODE_ENV: 'production',
+    entry: { // 根据 src/components 目录下的文件自动生成 entry 相关配置
+      InfoCardModel: './src/components/info-card/model.ts',
+      infoCard: './src/components/info-card/register.ts'
+    },
+    cssExtract: false, // 不额外提取css文件
+    ossType: 'ali', // oss类型：ali、baidu
+    ossConfig: {
+      endpoint: 'https://oss-cn-beijing.aliyuncs.com',
+      AccessKeyId: 'xxx',
+      AccessKeySecret: 'xx',
+      bucket: 'neo-widgets' // 存储桶名称
+    },
+    assetsRoot: resolve('dist') // 上传指定目录下的脚本文件
+    */
+  },
+};

package/src/template/develop/neo-custom-cmp-template/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "neo-custom-cmp-template",
+  "version": "1.1.0",
+  "description": "neo自定义组件模板（react&ts技术栈）",
+  "keywords": [
+    "自定义组件模板",
+    "react&ts技术栈",
+    "neo自定义组件"
+  ],
+  "author": "wibetter",
+  "license": "MIT",
+  "scripts": {
+    "preview": "neo preview --cmpType=contact-form",
+    "preview2": "neo preview --cmpType=contact-card-list",
+    "linkDebug": "neo linkDebug",
+    "publish2oss": "neo publish2oss",
+    "format": "prettier --write \"src/**/**/*.{js,jsx,ts,tsx,vue,scss,json}\""
+  },
+  "files": [
+    "dist/*"
+  ],
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged",
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
+    }
+  },
+  "lint-staged": {
+    "src/**/**/*.{js,jsx,ts,tsx,vue,scss,json}": [
+      "prettier --write"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://git@github.com:wibetter/neo-custom-cmp-template.git"
+  },
+  "bugs": {
+    "url": "https://github.com/wibetter/neo-custom-cmp-template/issues"
+  },
+  "dependencies": {
+    "neo-register": "^1.0.2",
+    "react": "^16.9.0",
+    "react-dom": "^16.9.0",
+    "axios": "^0.27.2",
+    "antd": "^4.9.4",
+    "lodash": "^4.17.21"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^8.3.5",
+    "@commitlint/config-conventional": "^9.1.1",
+    "@types/react": "^16.9.11",
+    "@types/react-dom": "^16.9.15",
+    "@types/axios": "^0.14.0",
+    "neo-cmp-cli": "^1.2.3",
+    "husky": "^4.2.5",
+    "lint-staged": "^10.2.9",
+    "prettier": "^2.0.5"
+  },
+  "engines": {
+    "node": ">= 10.13.0",
+    "npm": ">= 6.4.1"
+  }
+}