npm - neo-cmp-cli - Versions diffs - 1.13.9 → 1.13.10 - Mend

neo-cmp-cli 1.13.9 → 1.13.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (44) hide show

package/template/neo-web-form/README.md ADDED Viewed

@@ -0,0 +1,99 @@
+### 目录说明
+- src: 自定义组件源码；
+- src/assets: 存放组件静态资源，比如 css、img等；
+- src/components: 存放自定义组件代码，每个自定义组件以自身名称（cmpType 数值）作为目录进行存放；
+- src/components/xxCmp/index: 自定义组件的内容文件；
+- src/components/xxCmp/model: 自定义组件的模型文件，用于对接页面设计器；
+- neo.config.js: neo-cmp-cli 配置文件。
+### 组件开发规范
+- 存放在 src/components 目录下的自定义组件，默认 index 为自定义组件源码入口文件，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，详细见[使用说明](https://www.npmjs.com/package/neo-open-api)。
+### 自定义组件注册器使用说明
+- [neo-register 使用说明](https://www.npmjs.com/package/neo-register?activeTab=readme)
+备注：预览、调试（linkDebug）和构建发布时 cli 会自动创建对应的注册文件（含 neo-register 的使用），用户无需关注 neo-register。
+### 开发说明
+1. **安装依赖**
+```bash
+$ npm i 或者 yarn
+```
+2. **linkDebug: 外链调试（在线上页面设计器端预览自定义组件）**
+> linkDebug模式：用于在线上页面设计器中预览和调试自定义组件。
+```bash
+$ npm run linkDebug
+```
+3. **发布到 NeoCRM 平台**
+> 需要确保 package.json 中的 name 值唯一，version 值不重复。
+```bash
+$ npm run pushCmp
+```
+### OAuth2 登录授权
+使用 `neo push cmp`、`neo pull cmp`、`neo delete cmp` 等命令与 NeoCRM 平台交互时，需要进行授权登录。
+#### 使用步骤
+1. **登录 NeoCRM 平台**
+   ```bash
+   neo login
+   ```
+   执行流程：
+   - 自动打开浏览器访问授权页面
+   - 在浏览器中输入 NeoCRM 账号密码进行登录（需选择对应的租户）
+   - 授权成功后自动跳转回本地（附带 code）
+   - cli 端 通过 code 获取 Token，并自动保存到项目的 `.neo-cli/token.json` 文件中
+2. **登出 NeoCRM 平台**
+   ```bash
+   neo logout
+   ```
+   功能：清除本地保存的 token 文件，下次使用需要重新登录。
+#### neo login 选择「自定义环境」时的授权配置示例
+```javascript
+// neo.config.js
+module.exports = {
+  neoConfig: {
+    neoBaseURL: 'https://crm-cd.xiaoshouyi.com', // 平台根地址（默认：https://crm.xiaoshouyi.com）
+    // 登录授权 URL（用于获取 code）
+    loginURL: 'https://login-cd.xiaoshouyi.com/auc/oauth2/auth',
+    tokenAPI: 'https://login-cd.xiaoshouyi.com/auc/oauth2/token', // Token 获取接口地址
+  },
+}
+```
+#### Token 有效期
+- **access_token**：默认有效期 2 小时
+- **refresh_token**：默认有效期 30 天
+- 系统会在 access_token 过期前 5 分钟自动刷新
+- 如果 refresh_token 也过期，需要重新执行 `neo login`
+#### 常见问题
+**Q1: 浏览器无法自动打开怎么办？**
+A: 命令行会输出授权 URL，手动复制到浏览器中打开即可。
+**Q2: Token 刷新失败怎么办？**
+A: 如果 refresh_token 也过期（默认 30 天），需要重新执行 `neo login`。同时检查网络连接是否正常。
+**Q3: 授权登录后没有正常跳回 redirect_uri**
+A: 可能被浏览器安装的插件影响，目前已知会影响授权登录的浏览器插件有：Neo UI Extension，请关闭插件后重试。
+---
+### 配置项说明（neo-cmp-cli）
+[请查看neo-cmp-cli](https://www.npmjs.com/package/neo-cmp-cli)

package/template/neo-web-form/commitlint.config.js ADDED Viewed

@@ -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/template/neo-web-form/neo.config.js ADDED Viewed

@@ -0,0 +1,57 @@
+'use strict';
+const path = require('path');
+const fs = require('fs');
+// 统一路径解析
+function resolve(dir) {
+  return path.resolve(__dirname, dir);
+}
+// 包括生产和开发的环境配置信息
+module.exports = {
+  settings: {
+    enableESLint: false,
+    enableESLintFix: false,
+    enableStyleLint: false,
+    enableStyleLintFix: false
+  },
+  webpack: {
+    target: [
+      "web",
+      "es5"
+    ],
+    resolve: {
+      extensions: [
+        ".js",
+        ".jsx",
+        ".ts",
+        ".tsx",
+        ".umd.js",
+        ".min.js",
+        ".json"
+      ],
+      alias: {
+        "@": resolve("./src"),
+        $assets: resolve("./src/assets"),
+        $public: resolve("./public"),
+        $utils: resolve("./src/utils")
+      }
+    },
+    sassResources: [
+      resolve("./src/assets/css/common.scss"),
+      resolve("./src/assets/css/mixin.scss")
+    ],
+    ignoreNodeModules: false
+  },
+  neoCommonModule: {
+    // remoteDeps: ['entityGrid3__c'], // 远程依赖组件，表示当前自定义组件会用到的依赖组件，需要和 externals 配合使用
+    externals: ['entityGrid3__c'] // 自定义组件中需要剔除的模块（仅支持数组写法）
+  },
+  linkDebug: {},
+  neoConfig: {
+    neoBaseURL: "https://crm-test.xiaoshouyi.com",
+    loginURL: "https://login-test.xiaoshouyi.com/auc/oauth2/auth",
+    tokenURL: "https://login-test.xiaoshouyi.com/auc/oauth2/token"
+  },
+  pushCmp: {}
+};

package/template/neo-web-form/package.json ADDED Viewed

@@ -0,0 +1,66 @@
+{
+  "name": "neo-web-entity-grid",
+  "version": "1.1.0",
+  "description": "Web端列表组件模板: 含基础大列表、Picker 列表等示例组件。",
+  "framework": "react-ts",
+  "keywords": [
+    "react&ts技术栈",
+    "Web端列表组件模板"
+  ],
+  "author": "wibetter",
+  "license": "MIT",
+  "scripts": {
+    "linkDebug": "neo linkDebug",
+    "neoLogin": "neo login",
+    "pushCmp": "neo push cmp",
+    "pullCmp": "neo pull cmp",
+    "deleteCmp": "neo delete cmp",
+    "build2lib": "neo build2lib",
+    "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"
+    ]
+  },
+  "dependencies": {
+    "@ant-design/icons": "^4.8.3",
+    "antd": "^4.9.4",
+    "axios": "^1.7.0",
+    "lodash": "^4.17.23",
+    "neo-open-api": "^1.2.3",
+    "neo-register": "^1.2.0",
+    "react": "^16.9.0",
+    "react-dom": "^16.9.0",
+    "tslib": "2.3.0",
+    "xlsx": "^0.18.5"
+  },
+  "devDependencies": {
+    "@babel/runtime": "^7.26.0",
+    "@commitlint/cli": "^18.0.0",
+    "@commitlint/config-conventional": "^18.0.0",
+    "@types/axios": "^0.14.0",
+    "@types/react": "^16.9.11",
+    "@types/react-dom": "^16.9.15",
+    "husky": "^4.2.5",
+    "lint-staged": "^10.2.9",
+    "neo-cmp-cli": "^1.13.9",
+    "prettier": "^2.0.5"
+  },
+  "overrides": {
+    "typescript": "<6"
+  },
+  "engines": {
+    "node": ">= 16.0.0",
+    "npm": ">= 8.0.0"
+  }
+}

package/template/neo-web-form/public/css/base.css ADDED Viewed

@@ -0,0 +1,283 @@
+@charset "utf-8";
+body {
+  margin: 0;
+  border-width: 0;
+  padding: 0;
+  font-family: PingFangSC-Regular;
+}
+div,
+dl,
+dt,
+dd,
+ul,
+ol,
+li,
+h1,
+h2,
+h3,
+h4,
+h5,
+h6,
+pre,
+code,
+form,
+fieldset,
+legend,
+input,
+textarea,
+p,
+blockquote,
+th,
+td,
+hr,
+i,
+button,
+article,
+aside,
+details,
+figcaption,
+figure,
+footer,
+header,
+hgroup,
+menu,
+nav,
+section {
+  margin: 0;
+  padding: 0;
+  border-width: 0;
+  font-family: PingFangSC-Regular;
+  box-sizing: padding-box;
+  -webkit-box-sizing: padding-box;
+  -moz-box-sizing: padding-box;
+  -webkit-tap-highlight-color: rgba(0, 0, 0, 0);
+}
+body,
+button,
+input,
+select,
+textarea {
+  font-size: 14px;
+  line-height: 1.125;
+}
+[v-cloak] {
+  display: none;
+}
+li,
+ul,
+ol {
+  list-style: none;
+}
+a {
+  text-decoration: none;
+}
+a:active {
+  -webkit-tap-highlight-color: rgba(0, 0, 0, 0);
+}
+sub,
+sup {
+  line-height: 0;
+}
+table {
+  border-collapse: collapse;
+  border-spacing: 0;
+}
+li {
+  list-style: none;
+}
+fieldset,
+img {
+  border: 0;
+}
+input,
+textarea {
+  outline-style: none;
+}
+input[type='text'],
+input[type='search'],
+input[type='password'] {
+  -webkit-border-radius: 0;
+  -moz-border-radius: 0;
+  -o-border-radius: 0;
+  border-radius: 0;
+}
+textarea {
+  resize: none;
+}
+address,
+caption,
+cite,
+code,
+dfn,
+em,
+i,
+th,
+var {
+  font-style: normal;
+  font-weight: normal;
+}
+legend {
+  color: #000;
+}
+abbr,
+acronym {
+  border: 0;
+  font-variant: normal;
+}
+a {
+  text-decoration: none;
+  outline: none;
+}
+a:hover {
+  text-decoration: none;
+}
+.clearit {
+  clear: both;
+  height: 0;
+  font-size: 0;
+  overflow: hidden;
+}
+/* surface下viewport不生效的解决办法 */
+@media screen and (min-width: 767px) and (device-aspect-ratio: 16/9) {
+  @-ms-viewport {
+    zoom: 1;
+    max-zoom: 1;
+    min-zoom: 1;
+  }
+}
+/* surface下IE10 点击链接，背景变色 */
+@media screen and (-ms-high-contrast: active), (-ms-high-contrast: none) {
+  a {
+    background-color: transparent;
+  }
+}
+img {
+  -ms-interpolation-mode: bicubic;
+  image-rendering: optimizeQuality;
+}
+/* portrait：指定输出设备中的页面可见区域高度大于或等于宽度， landscape：横屏*/
+@media not screen and (orientation: landscape),
+  not screen and (orientation: portrait) {
+  body,
+  button,
+  input,
+  select,
+  textarea {
+    font-family: 'Microsoft Yahei', 'Simsun';
+  }
+}
+::-moz-placeholder {
+  color: #767676;
+}
+::-webkit-input-placeholder {
+  color: #767676;
+}
+:-ms-input-placeholder {
+  color: #767676;
+}
+.cont-selected {
+  display: block !important;
+}
+.hidden {
+  visibility: hidden;
+}
+.ellipsis {
+  overflow: hidden;
+  white-space: nowrap;
+  text-overflow: ellipsis;
+}
+.clearfix:after {
+  content: '.';
+  display: block;
+  height: 0;
+  visibility: hidden;
+  clear: both;
+}
+.left {
+  float: left;
+}
+.right {
+  float: right;
+}
+.center {
+  margin: 0 auto;
+}
+.text-center {
+  text-align: center;
+}
+.text-right {
+  text-align: right;
+}
+.text-left {
+  text-align: left;
+}
+.no-border {
+  border: none !important;
+}
+.click-event {
+  cursor: pointer;
+}
+/* 增加iphoneX适配 */
+@media only screen and (device-width: 375px) and (device-height: 812px) and (-webkit-device-pixel-ratio: 3) {
+  .ipx-fixed-bottom {
+    bottom: 34px !important;
+  }
+  .ipx-fixed-top {
+    top: 20px !important;
+  }
+  .ipx-margin-top {
+    margin-top: 20px !important;
+  }
+  .ipx-margin-bottom {
+    margin-bottom: 20px !important;
+  }
+  .ipx-height {
+    height: 34px !important;
+  }
+}
+/* 业务级公用代码 */