m8-mcp-server 1.0.0 → 1.0.2

package/resources/standards/javascript.json

@@ -0,0 +1,129 @@
+{
+  "id": "js-style",
+  "category": "javascript",
+  "title": "JavaScript/TypeScript 编码规范",
+  "version": "1.0.0",
+  "lastUpdated": "2024-12-19",
+  "description": "M8 框架项目中 JavaScript/TypeScript 的编码标准",
+  "rules": [
+    {
+      "id": "js-camelcase",
+      "title": "变量和函数使用 camelCase",
+      "description": "变量名和函数名应该使用小驼峰命名法。",
+      "correctExample": "const userName = 'John';\nconst itemCount = 10;\nfunction getUserInfo() { }\nfunction handleClick() { }",
+      "incorrectExample": "const user_name = 'John';\nconst ItemCount = 10;\nfunction GetUserInfo() { }"
+    },
+    {
+      "id": "js-constants",
+      "title": "常量使用 UPPER_SNAKE_CASE",
+      "description": "常量应该使用全大写加下划线的命名方式。",
+      "correctExample": "const MAX_COUNT = 100;\nconst API_BASE_URL = '/api';\nconst DEFAULT_PAGE_SIZE = 20;",
+      "incorrectExample": "const maxCount = 100;\nconst apiBaseUrl = '/api';"
+    },
+    {
+      "id": "js-class-pascalcase",
+      "title": "类和组件使用 PascalCase",
+      "description": "类名和组件名应该使用大驼峰命名法。",
+      "correctExample": "class UserService { }\nclass DataManager { }\nconst UserProfile = defineComponent({ });",
+      "incorrectExample": "class userService { }\nclass data_manager { }"
+    },
+    {
+      "id": "js-single-responsibility",
+      "title": "函数应该只做一件事",
+      "description": "每个函数应该只负责一个功能，保持函数的单一职责。",
+      "correctExample": "function validateEmail(email) {\n  return /^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$/.test(email);\n}\n\nfunction formatUserName(user) {\n  return `${user.firstName} ${user.lastName}`;\n}",
+      "incorrectExample": "function processUser(user) {\n  // 验证、格式化、保存、发送通知都在一个函数里\n}"
+    },
+    {
+      "id": "js-default-params",
+      "title": "使用默认参数",
+      "description": "使用 ES6 默认参数语法代替手动检查和赋值。",
+      "correctExample": "function createUser(name, role = 'user', active = true) {\n  return { name, role, active };\n}",
+      "incorrectExample": "function createUser(name, role, active) {\n  role = role || 'user';\n  active = active !== undefined ? active : true;\n}"
+    },
+    {
+      "id": "js-destructuring",
+      "title": "使用解构参数",
+      "description": "当函数参数较多时，使用对象解构使代码更清晰。",
+      "correctExample": "function updateUser({ id, name, email }) {\n  // ...\n}\n\nupdateUser({ id: 1, name: 'John', email: 'john@example.com' });",
+      "incorrectExample": "function updateUser(id, name, email) {\n  // ...\n}"
+    },
+    {
+      "id": "js-async-await",
+      "title": "优先使用 async/await",
+      "description": "异步操作优先使用 async/await 语法，避免回调地狱。",
+      "correctExample": "async function fetchUserData(userId) {\n  try {\n    const response = await Util.ajax({\n      url: `${Config.serverUrl}/api/user/${userId}`,\n      type: 'GET'\n    });\n    return response.data;\n  } catch (error) {\n    console.error('获取用户数据失败:', error);\n    throw error;\n  }\n}",
+      "incorrectExample": "function fetchUserData(userId, callback) {\n  Util.ajax({\n    url: url,\n    success: (response) => {\n      Util.ajax({\n        // 嵌套回调...\n      });\n    }\n  });\n}"
+    },
+    {
+      "id": "js-promise-all",
+      "title": "并发请求使用 Promise.all",
+      "description": "多个独立的异步请求应该使用 Promise.all 并发执行。",
+      "correctExample": "async function loadPageData() {\n  const [users, products, orders] = await Promise.all([\n    fetchUsers(),\n    fetchProducts(),\n    fetchOrders()\n  ]);\n  return { users, products, orders };\n}",
+      "incorrectExample": "async function loadPageData() {\n  const users = await fetchUsers();\n  const products = await fetchProducts();\n  const orders = await fetchOrders();\n}"
+    },
+    {
+      "id": "js-try-catch",
+      "title": "使用 try-catch 处理异步错误",
+      "description": "异步操作必须使用 try-catch 进行错误处理。",
+      "correctExample": "async function submitForm(data) {\n  try {\n    const result = await Util.ajax({\n      url: Config.serverUrl + '/api/submit',\n      type: 'POST',\n      data: { params: JSON.stringify(data) }\n    });\n    return result.data;\n  } catch (error) {\n    console.error('表单提交失败:', error);\n    ejs.ui.toast({ message: error.message || '网络错误，请重试' });\n    throw error;\n  }\n}",
+      "incorrectExample": "async function submitForm(data) {\n  const result = await Util.ajax({ ... });\n  return result.data;\n}"
+    },
+    {
+      "id": "js-meaningful-errors",
+      "title": "提供有意义的错误信息",
+      "description": "抛出的错误应该包含有意义的描述信息。",
+      "correctExample": "function validateAge(age) {\n  if (typeof age !== 'number') {\n    throw new TypeError(`年龄必须是数字，收到: ${typeof age}`);\n  }\n  if (age < 0 || age > 150) {\n    throw new RangeError(`年龄必须在 0-150 之间，收到: ${age}`);\n  }\n}",
+      "incorrectExample": "function validateAge(age) {\n  if (typeof age !== 'number' || age < 0 || age > 150) {\n    throw new Error('Invalid');\n  }\n}"
+    },
+    {
+      "id": "js-util-ajax",
+      "title": "使用 Util.ajax 进行 HTTP 请求",
+      "description": "M8 框架中必须使用 Util.ajax 进行网络请求，禁止使用 fetch 或 axios。",
+      "correctExample": "const result = await Util.ajax({\n  url: Config.serverUrl + '/api/data',\n  type: 'POST',\n  data: { params: JSON.stringify(params) },\n  dataPath: 'data'\n});",
+      "incorrectExample": "const result = await fetch('/api/data');\nconst result = await axios.get('/api/data');"
+    },
+    {
+      "id": "js-config-url",
+      "title": "使用 Config 管理配置",
+      "description": "API 地址等配置必须使用 Config 对象，禁止硬编码。",
+      "correctExample": "const apiUrl = Config.serverUrl + '/api/users';",
+      "incorrectExample": "const apiUrl = 'http://localhost:3000/api/users';"
+    },
+    {
+      "id": "js-no-var",
+      "title": "避免使用 var",
+      "description": "使用 const 和 let 代替 var。",
+      "correctExample": "const name = 'John';  // 不会重新赋值\nlet count = 0;  // 会重新赋值",
+      "incorrectExample": "var count = 0;\nvar name = 'John';"
+    },
+    {
+      "id": "js-no-mutate-params",
+      "title": "避免修改函数参数",
+      "description": "不要直接修改函数参数，应该返回新对象。",
+      "correctExample": "function updateUser(user) {\n  return {\n    ...user,\n    name: 'New Name'\n  };\n}",
+      "incorrectExample": "function updateUser(user) {\n  user.name = 'New Name';\n  return user;\n}"
+    },
+    {
+      "id": "js-strict-equality",
+      "title": "避免使用 == 进行比较",
+      "description": "使用严格相等 === 代替宽松相等 ==。",
+      "correctExample": "if (count === 0) { }",
+      "incorrectExample": "if (value == null) { }\nif (count == '0') { }"
+    },
+    {
+      "id": "js-util-string",
+      "title": "使用 Util.string 进行字符串校验",
+      "description": "优先使用 Util.string 提供的校验方法，而不是手写正则。",
+      "correctExample": "Util.string.isMobile('13800000000');\nUtil.string.isEmail('test@example.com');\nUtil.string.isIdCard('110101199001011234');",
+      "incorrectExample": "/^1[3-9]\\d{9}$/.test('13800000000');"
+    },
+    {
+      "id": "js-console-log",
+      "title": "日志输出规范",
+      "description": "禁止使用无参数的 console.log，必须包含日志信息描述。",
+      "correctExample": "console.log('提交表单数据:', data);\nconsole.error('接口请求失败:', err);",
+      "incorrectExample": "console.log(data);"
+    }
+  ]
+}

package/resources/standards/project-structure.json

@@ -0,0 +1,101 @@
+{
+  "id": "project-structure",
+  "category": "project-structure",
+  "title": "项目结构规范",
+  "version": "1.0.0",
+  "lastUpdated": "2024-12-19",
+  "description": "M8 框架项目的目录结构和文件组织标准",
+  "rules": [
+    {
+      "id": "project-standard-structure",
+      "title": "标准项目结构",
+      "description": "M8 项目应该遵循标准的目录结构，包括 src/api、src/assets、src/components、src/pages、src/router、src/store、src/utils 等目录。",
+      "correctExample": "project/\n├── src/\n│   ├── api/              # API 接口定义\n│   ├── assets/           # 静态资源\n│   ├── components/       # 公共组件\n│   ├── pages/            # 页面组件\n│   ├── router/           # 路由配置\n│   ├── store/            # 状态管理\n│   ├── utils/            # 工具函数\n│   ├── App.vue\n│   └── main.js",
+      "incorrectExample": "project/\n├── src/\n│   ├── all-files-in-one-folder/"
+    },
+    {
+      "id": "project-component-naming",
+      "title": "组件文件命名使用 PascalCase",
+      "description": "组件文件使用 PascalCase 命名。",
+      "correctExample": "components/\n├── UserProfile.vue\n├── TodoList.vue\n└── common/\n    ├── BaseButton.vue\n    └── BaseInput.vue",
+      "incorrectExample": "components/\n├── userProfile.vue\n├── todo-list.vue"
+    },
+    {
+      "id": "project-page-structure",
+      "title": "页面文件按模块划分",
+      "description": "页面文件应严格按照模块划分，每个模块对应一个文件夹。",
+      "correctExample": "pages/\n├── home/\n│   └── index.vue\n├── user/\n│   ├── index.vue\n│   ├── profile.vue\n│   └── settings.vue\n└── order/\n    ├── list.vue\n    └── detail.vue",
+      "incorrectExample": "pages/\n├── home.vue\n├── user.vue\n├── user-profile.vue"
+    },
+    {
+      "id": "project-utils-naming",
+      "title": "工具函数文件使用 kebab-case",
+      "description": "工具函数文件使用 kebab-case 命名。",
+      "correctExample": "utils/\n├── date-format.js\n├── string-utils.js\n├── validate.js\n└── index.js",
+      "incorrectExample": "utils/\n├── dateFormat.js\n├── StringUtils.js"
+    },
+    {
+      "id": "project-api-organization",
+      "title": "按模块组织 API",
+      "description": "API 接口应该按模块组织，并在 index.js 中统一导出。",
+      "correctExample": "// api/user.js\nexport function getUserInfo(userId) {\n  return request({\n    url: `/api/user/${userId}`,\n    method: 'GET'\n  });\n}\n\n// api/index.js\nexport * from './user';\nexport * from './order';",
+      "incorrectExample": "// 所有 API 都写在一个文件里"
+    },
+    {
+      "id": "project-request-wrapper",
+      "title": "请求封装",
+      "description": "应该封装统一的请求方法，使用 Util.ajax 和 Config.serverUrl。",
+      "correctExample": "// api/request.js\nexport function request(options) {\n  return Util.ajax({\n    url: Config.serverUrl + options.url,\n    type: options.method || 'POST',\n    data: options.data ? { params: JSON.stringify(options.data) } : undefined\n  });\n}",
+      "incorrectExample": "// 每个 API 都直接调用 fetch 或 axios"
+    },
+    {
+      "id": "project-common-components",
+      "title": "公共组件使用 Base 或 Ne 前缀",
+      "description": "公共组件放在 components/common/ 目录下，使用 Base 或 Ne 前缀。",
+      "correctExample": "components/\n├── common/\n│   ├── BaseButton.vue\n│   ├── BaseInput.vue\n│   └── index.js\n└── business/\n    ├── UserCard.vue\n    └── OrderItem.vue",
+      "incorrectExample": "components/\n├── Button.vue\n├── Input.vue"
+    },
+    {
+      "id": "project-page-components",
+      "title": "页面级组件放在页面目录下",
+      "description": "页面特有的组件放在页面目录下的 components/ 子目录中。",
+      "correctExample": "pages/\n└── order/\n    ├── index.vue\n    ├── detail.vue\n    └── components/\n        ├── OrderHeader.vue\n        └── OrderItems.vue",
+      "incorrectExample": "// 页面特有组件放在全局 components 目录"
+    },
+    {
+      "id": "project-vuex-modules",
+      "title": "Vuex 模块化 (M8.3)",
+      "description": "Vuex 状态管理应该按模块划分。",
+      "correctExample": "store/\n├── index.js\n└── modules/\n    ├── user.js\n    ├── cart.js\n    └── order.js",
+      "incorrectExample": "store/\n└── index.js  // 所有状态都在一个文件里"
+    },
+    {
+      "id": "project-pinia-modules",
+      "title": "Pinia 模块化 (M8.4)",
+      "description": "Pinia 状态管理应该按模块划分，使用 useXxxStore 命名。",
+      "correctExample": "store/\n├── index.js\n└── modules/\n    ├── useUserStore.js\n    ├── useCartStore.js\n    └── useOrderStore.js",
+      "incorrectExample": "store/\n└── index.js  // 所有状态都在一个文件里"
+    },
+    {
+      "id": "project-styles-organization",
+      "title": "全局样式组织",
+      "description": "全局样式应该放在 assets/styles/ 目录下统一管理。",
+      "correctExample": "assets/\n└── styles/\n    ├── index.scss\n    ├── variables.scss\n    ├── mixins.scss\n    ├── reset.scss\n    └── utils.scss",
+      "incorrectExample": "// 样式文件散落在各处"
+    },
+    {
+      "id": "project-no-deep-nesting",
+      "title": "避免过深的目录嵌套",
+      "description": "目录结构应该保持扁平化，避免过深的嵌套。",
+      "correctExample": "src/pages/user/profile.vue\nsrc/components/UserAvatar.vue",
+      "incorrectExample": "src/modules/user/pages/profile/components/header/UserAvatar.vue"
+    },
+    {
+      "id": "project-no-circular-deps",
+      "title": "避免循环依赖",
+      "description": "模块之间不应该存在循环依赖，应该提取公共依赖。",
+      "correctExample": "// constants.js\nexport const BASE = 1;\n\n// a.js\nimport { BASE } from './constants';\nexport const a = BASE + 1;\n\n// b.js\nimport { BASE } from './constants';\nexport const b = BASE + 2;",
+      "incorrectExample": "// a.js\nimport { b } from './b';\nexport const a = b + 1;\n\n// b.js\nimport { a } from './a';\nexport const b = a + 1;"
+    }
+  ]
+}

package/resources/standards/vue.json

@@ -0,0 +1,122 @@
+{
+  "id": "vue-style",
+  "category": "vue",
+  "title": "Vue 组件编码规范",
+  "version": "1.2.0",
+  "lastUpdated": "2024-12-22",
+  "description": "M8 框架 Vue 组件的编码标准，适用于 M8.3 (Vue2) 和 M8.4 (Vue3) 项目",
+  "rules": [
+    {
+      "id": "vue-file-header",
+      "title": ".vue 文件必须包含头部注释",
+      "description": "每个 .vue 文件必须在顶部添加标准化的注释块，包含作者、时间、版本、版权和描述信息。",
+      "correctExample": "<!--\n * @作者: 张三\n * @创建时间: 2024-11-11 14:20:03\n * @修改时间: 2024-11-11 14:20:03\n * @版本: [1.0]\n * @版权: 国泰新点软件股份有限公司\n * @描述: 用户信息展示组件\n-->\n<template>\n  <!-- 组件内容 -->\n</template>",
+      "incorrectExample": "<template>\n  <!-- 缺少头部注释 -->\n</template>"
+    },
+    {
+      "id": "vue-component-naming",
+      "title": "组件文件命名使用 PascalCase",
+      "description": "组件文件名应使用 PascalCase 命名法。",
+      "correctExample": "UserProfile.vue\nTodoList.vue\nSearchInput.vue",
+      "incorrectExample": "userProfile.vue\nuser-profile.vue\ntodolist.vue"
+    },
+    {
+      "id": "vue-base-component-prefix",
+      "title": "基础组件使用特定前缀",
+      "description": "应用特定样式和约定的基础组件应该全部以一个特定的前缀开头，比如 Base、App 或 Ne。",
+      "correctExample": "BaseButton.vue\nBaseTable.vue\nNeInput.vue",
+      "incorrectExample": "MyButton.vue\nVueTable.vue"
+    },
+    {
+      "id": "vue-props-type",
+      "title": "Props 必须指定类型",
+      "description": "Props 定义应该尽量详细，至少需要指定其类型。",
+      "correctExample": "// Vue2\nexport default {\n  props: {\n    status: {\n      type: String,\n      required: true\n    },\n    count: {\n      type: Number,\n      default: 0\n    }\n  }\n}\n\n// Vue3\nconst props = defineProps<{\n  status: 'success' | 'warning' | 'error';\n  count?: number;\n}>();",
+      "incorrectExample": "props: ['status', 'count']"
+    },
+    {
+      "id": "vue-props-camelcase",
+      "title": "Props 命名使用 camelCase",
+      "description": "在声明 props 时，其命名应该始终使用 camelCase。",
+      "correctExample": "props: {\n  greetingText: String\n}",
+      "incorrectExample": "props: {\n  'greeting-text': String\n}"
+    },
+    {
+      "id": "vue-event-kebabcase",
+      "title": "事件名使用 kebab-case",
+      "description": "事件名应该使用 kebab-case 命名。",
+      "correctExample": "this.$emit('item-click', item);\nemit('update-value', newValue);",
+      "incorrectExample": "this.$emit('itemClick', item);\nemit('updateValue', newValue);"
+    },
+    {
+      "id": "vue-self-closing",
+      "title": "组件标签自闭合",
+      "description": "没有内容的组件应该自闭合。",
+      "correctExample": "<MyComponent />\n<ne-button type=\"primary\" />",
+      "incorrectExample": "<MyComponent></MyComponent>\n<ne-button type=\"primary\"></ne-button>"
+    },
+    {
+      "id": "vue-multi-attribute",
+      "title": "多属性换行",
+      "description": "当组件有多个属性时，应该每个属性占一行。",
+      "correctExample": "<ne-field\n  v-model=\"formData.name\"\n  label=\"姓名\"\n  placeholder=\"请输入姓名\"\n  required\n  :rules=\"nameRules\"\n/>",
+      "incorrectExample": "<ne-field v-model=\"formData.name\" label=\"姓名\" placeholder=\"请输入姓名\" required :rules=\"nameRules\" />"
+    },
+    {
+      "id": "vue-script-setup",
+      "title": "使用 script setup (Vue3)",
+      "description": "Vue3 项目推荐使用 <script setup> 语法。",
+      "correctExample": "<script setup>\nimport { ref, computed } from 'vue';\n\nconst count = ref(0);\nconst double = computed(() => count.value * 2);\n</script>",
+      "incorrectExample": "<script>\nimport { ref, computed, defineComponent } from 'vue';\n\nexport default defineComponent({\n  setup() {\n    const count = ref(0);\n    return { count };\n  }\n});\n</script>"
+    },
+    {
+      "id": "vue-code-order",
+      "title": "响应式数据声明顺序",
+      "description": "按照以下顺序组织代码：props/emits → refs → computed → watch → 生命周期 → methods",
+      "correctExample": "<script setup>\n// 1. Props 和 Emits\nconst props = defineProps<{ title: string }>();\nconst emit = defineEmits<{ (e: 'update', value: string): void }>();\n\n// 2. 响应式数据\nconst count = ref(0);\n\n// 3. 计算属性\nconst total = computed(() => count.value);\n\n// 4. 侦听器\nwatch(count, (newVal) => { });\n\n// 5. 生命周期\nonMounted(() => { });\n\n// 6. 方法\nfunction loadData() { }\n</script>",
+      "incorrectExample": "// 代码顺序混乱"
+    },
+    {
+      "id": "vue-style-external",
+      "title": "样式必须剥离到外部文件",
+      "description": "Vue 组件的样式必须剥离到独立的 SCSS 文件中，通过 @import 方式引入。",
+      "correctExample": "<style lang=\"scss\" scoped>\n@import './css/login.scss';\n</style>",
+      "incorrectExample": "<style lang=\"scss\" scoped>\n.login_page {\n  // 大量样式代码直接写在 .vue 文件中\n}\n</style>"
+    },
+    {
+      "id": "vue-style-scoped",
+      "title": "style 标签必须使用 scoped",
+      "description": "为避免样式污染，<style> 标签必须添加 scoped 属性。",
+      "correctExample": "<style lang=\"scss\" scoped>\n@import './css/user-profile.scss';\n</style>",
+      "incorrectExample": "<style lang=\"scss\">\n@import './css/user-profile.scss';\n</style>"
+    },
+    {
+      "id": "vue-no-header-refactor",
+      "title": "重构页面时不添加导航栏",
+      "description": "重构现有页面时，不需要添加 em-header 或 nav-bar 导航栏组件。导航栏由框架或原生容器统一管理。",
+      "correctExample": "<template>\n  <div class=\"page-container\">\n    <div class=\"content\">\n      <em-cell title=\"用户信息\" />\n    </div>\n  </div>\n</template>",
+      "incorrectExample": "<template>\n  <div class=\"page-container\">\n    <em-header title=\"页面标题\" />\n    <div class=\"content\">\n      <em-cell title=\"用户信息\" />\n    </div>\n  </div>\n</template>"
+    },
+    {
+      "id": "vue-no-complex-template",
+      "title": "避免在模板中使用复杂表达式",
+      "description": "复杂的逻辑应该使用计算属性，而不是直接写在模板中。",
+      "correctExample": "<template>\n  <div>{{ activeItemNames }}</div>\n</template>\n\n<script setup>\nconst activeItemNames = computed(() =>\n  items.value.filter(i => i.active).map(i => i.name).join(', ')\n);\n</script>",
+      "incorrectExample": "<template>\n  <div>{{ items.filter(i => i.active).map(i => i.name).join(', ') }}</div>\n</template>"
+    },
+    {
+      "id": "vue-no-mutate-props",
+      "title": "避免直接修改 Props",
+      "description": "不要直接修改 props，应该使用 emit 通知父组件。",
+      "correctExample": "emit('update:value', newValue);",
+      "incorrectExample": "props.value = newValue;"
+    },
+    {
+      "id": "vue-field-clickable",
+      "title": "输入框交互规范",
+      "description": "当输入框为 readonly 但需要点击触发操作时，必须同时添加 is-link 和 clickable 属性。",
+      "correctExample": "<em-field\n  v-model=\"date\"\n  readonly\n  clickable\n  is-link\n  label=\"选择日期\"\n  @click=\"showDatePicker\"\n/>",
+      "incorrectExample": "<em-field\n  v-model=\"date\"\n  readonly\n  label=\"选择日期\"\n  @click=\"showDatePicker\"\n/>"
+    }
+  ]
+}

package/resources/utils/ajax.json

@@ -0,0 +1,76 @@
+{
+  "category": "ajax",
+  "title": "Ajax 与文件上传",
+  "description": "核心工具集中内置的 Ajax 与 Upload，用于接口请求和文件上传",
+  "methods": [
+    {
+      "name": "ajax",
+      "description": "进行 ajax 请求，支持普通版本和 Promise 版本",
+      "parameters": [
+        { "name": "url", "type": "String", "required": true, "description": "请求的 url" },
+        { "name": "data", "type": "String/JSON", "required": true, "description": "请求的数据" },
+        { "name": "type", "type": "String", "required": false, "description": "请求类别，GET 或 POST，默认为 POST" },
+        { "name": "isAutoProxy", "type": "Boolean", "required": false, "description": "默认为 true，是否在请求头中携带用户 token" },
+        { "name": "isAutoErrToast", "type": "Boolean", "required": false, "description": "默认为 false，是否开启错误状态码自动弹窗提示" },
+        { "name": "success", "type": "Function", "required": false, "description": "成功回调" },
+        { "name": "error", "type": "Function", "required": false, "description": "失败回调" },
+        { "name": "complete", "type": "Function", "required": false, "description": "请求完成后的回调" },
+        { "name": "dataPath", "type": "String/Array", "required": false, "description": "需要获取的路径指令，例如 custom.infolist" },
+        { "name": "headers", "type": "Object", "required": false, "description": "设置请求的 header" },
+        { "name": "timeout", "type": "Number", "required": false, "description": "请求超时的毫秒数" },
+        { "name": "cancelKey", "type": "String", "required": false, "description": "中断请求的自定义 key 值" }
+      ],
+      "returnValue": { "type": "Promise", "description": "返回 Promise 对象，支持链式调用" },
+      "examples": [
+        {
+          "title": "Promise 版本",
+          "code": "Util.ajax({\n  url: Config.serverUrl + '/api/list',\n  type: 'POST',\n  data: {\n    params: JSON.stringify({ keyword: 'test' })\n  },\n  dataPath: 'custom.infolist'\n}).then((res) => {\n  if (res.code === 1) {\n    console.log(res.data);\n  }\n}).catch((err) => {\n  console.error(err);\n});",
+          "description": "使用 Promise 方式进行 ajax 请求"
+        },
+        {
+          "title": "回调版本",
+          "code": "Util.ajax({\n  url: Config.serverUrl + '/api/detail',\n  data: {\n    params: JSON.stringify({ guid: '12345' })\n  },\n  dataPath: 'custom',\n  success: (result) => {\n    if (result.code === 1) {\n      // 处理数据\n    }\n  },\n  error: (err) => {\n    console.error(err);\n  }\n});",
+          "description": "使用回调方式进行 ajax 请求"
+        }
+      ]
+    },
+    {
+      "name": "ajaxAll",
+      "description": "控制多个 Ajax 请求并发执行",
+      "parameters": [
+        { "name": "...requests", "type": "Promise[]", "required": true, "description": "多个 ajax 请求的 Promise 对象" }
+      ],
+      "returnValue": { "type": "Promise<Array>", "description": "返回所有请求结果的数组" },
+      "examples": [
+        {
+          "title": "并发请求",
+          "code": "const ajax1 = Util.ajax({ url: Config.serverUrl + '/api/users' });\nconst ajax2 = Util.ajax({ url: Config.serverUrl + '/api/products' });\n\nUtil.ajaxAll(ajax1, ajax2).then((response) => {\n  const users = response[0];\n  const products = response[1];\n});",
+          "description": "同时发起多个请求并等待所有请求完成"
+        }
+      ]
+    },
+    {
+      "name": "upload",
+      "description": "将本地资源上传到开发者服务器",
+      "parameters": [
+        { "name": "url", "type": "String", "required": true, "description": "开发者服务器 url" },
+        { "name": "filePath", "type": "String", "required": true, "description": "要上传文件资源的路径（推荐使用）" },
+        { "name": "name", "type": "String", "required": true, "description": "文件对应的 key" },
+        { "name": "files", "type": "Array", "required": false, "description": "需要上传的文件列表（仅 H5 支持）" },
+        { "name": "headers", "type": "Object", "required": false, "description": "设置请求的 header" },
+        { "name": "formData", "type": "Object", "required": false, "description": "HTTP 请求中其他额外的 form data" },
+        { "name": "success", "type": "Function", "required": false, "description": "接口调用成功的回调函数" },
+        { "name": "error", "type": "Function", "required": false, "description": "接口调用失败的回调函数" },
+        { "name": "uploading", "type": "Function", "required": false, "description": "文件上传时，进度回调" }
+      ],
+      "returnValue": { "type": "Promise", "description": "返回 Promise 对象" },
+      "examples": [
+        {
+          "title": "文件上传",
+          "code": "Util.upload({\n  url: Config.serverUrl + '/api/upload',\n  filePath: file.path,\n  name: file.name,\n  formData: {\n    user: 'test'\n  },\n  success: (res) => {\n    console.log(res);\n  }\n});",
+          "description": "上传文件到服务器"
+        }
+      ]
+    }
+  ]
+}

package/resources/utils/common.json

@@ -0,0 +1,129 @@
+{
+  "category": "common",
+  "title": "通用工具方法",
+  "description": "Util 提供的通用工具方法，包括 uuid 生成、对象合并、数据处理等",
+  "methods": [
+    {
+      "name": "uuid",
+      "description": "生成一个随机 uuid",
+      "parameters": [
+        { "name": "len", "type": "Number", "required": false, "description": "长度，默认为 32 位，最大不能超过 36，最小不能小于 4" },
+        { "name": "radix", "type": "Number", "required": false, "description": "随机的基数，如果小于等于 10 代表只用纯数字，最大为 62，默认为 62" },
+        { "name": "type", "type": "String", "required": false, "description": "类别，默认为 default 代表 a-c-c-d-e 的连线模式，如果为 noline 代表不会有连线" }
+      ],
+      "returnValue": { "type": "String", "description": "生成的 uuid 字符串" },
+      "examples": [
+        {
+          "title": "生成默认 uuid",
+          "code": "const uuid = Util.uuid();\n// 例如: yczYoFSp-ooru-ANjl-Hrgg-XgXmMxSN",
+          "description": "生成一个 8-4-4-4-12 格式的 32 位 uuid"
+        },
+        {
+          "title": "生成纯数字 uuid",
+          "code": "const uuid = Util.uuid({ len: 36, radix: 10 });\n// 例如: 52616056-5161-7170-8460-802618729824",
+          "description": "生成一个只有数字的 36 位 uuid"
+        }
+      ]
+    },
+    {
+      "name": "getExtraDataByKey",
+      "description": "通过传入 key 值，得到页面 key 的初始化传值",
+      "parameters": [
+        { "name": "key", "type": "String", "required": true, "description": "对应的 key 值" }
+      ],
+      "returnValue": { "type": "String", "description": "返回 href 中对应的 key 的 value" },
+      "examples": [
+        {
+          "title": "获取页面参数",
+          "code": "const value = Util.getExtraDataByKey('id');\nconsole.log(value);",
+          "description": "获取 URL 中的参数值"
+        }
+      ]
+    },
+    {
+      "name": "getFullUrlByParams",
+      "description": "将 json 参数拼接到 url 中",
+      "parameters": [
+        { "name": "url", "type": "String", "required": true, "description": "需要拼接的 url" },
+        { "name": "data", "type": "JSON", "required": true, "description": "对应需要拼接的 JSON 参数" },
+        { "name": "isType", "type": "Boolean", "required": false, "description": "是否相对路径，默认 false" }
+      ],
+      "returnValue": { "type": "String", "description": "拼接后的完整 URL" },
+      "examples": [
+        {
+          "title": "拼接 URL 参数",
+          "code": "const url = 'http://app.epoint.com.cn/api';\nconst data = { key1: 'value1' };\nconst finalUrl = Util.getFullUrlByParams(url, data);\n// 返回: http://app.epoint.com.cn/api?key1=value1",
+          "description": "将 JSON 参数拼接到 URL 中"
+        }
+      ]
+    },
+    {
+      "name": "extend",
+      "description": "合并多个对象",
+      "parameters": [
+        { "name": "deep", "type": "Boolean", "required": false, "description": "为 true 时会进行递归合并" },
+        { "name": "target", "type": "Object", "required": true, "description": "需要合并的目标对象" },
+        { "name": "source1", "type": "Object", "required": true, "description": "需要合并的源对象" },
+        { "name": "sourceN", "type": "Object", "required": false, "description": "更多需要合并的源对象" }
+      ],
+      "returnValue": { "type": "Object", "description": "合并后的对象" },
+      "examples": [
+        {
+          "title": "浅合并",
+          "code": "const target = { a: 1 };\nconst source = { b: 2 };\nconst result = Util.extend({}, target, source);\n// { a: 1, b: 2 }",
+          "description": "浅合并多个对象"
+        },
+        {
+          "title": "深合并",
+          "code": "const target = { product: { ejs: 'ejs' } };\nconst source = { product: { m7: 'm7' } };\nconst result = Util.extend(true, {}, target, source);\n// { product: { ejs: 'ejs', m7: 'm7' } }",
+          "description": "递归合并多个对象"
+        }
+      ]
+    },
+    {
+      "name": "each",
+      "description": "遍历对象或数组",
+      "parameters": [
+        { "name": "object", "type": "Object/Array", "required": true, "description": "需要遍历的对象或数组" },
+        { "name": "handler", "type": "Function", "required": true, "description": "每个元素执行的回调函数" }
+      ],
+      "returnValue": { "type": "void", "description": "无返回值" },
+      "examples": [
+        {
+          "title": "遍历数组",
+          "code": "const array = [1, 2, 3];\nUtil.each(array, function(index, item) {\n  console.log(item * item);\n});",
+          "description": "遍历数组并处理每个元素"
+        }
+      ]
+    },
+    {
+      "name": "dataProcess",
+      "description": "处理返回数据，返回按指令处理过后的最终数据",
+      "parameters": [
+        { "name": "response", "type": "JSON", "required": true, "description": "需要处理的数据" },
+        { "name": "options.dataPath", "type": "String/Array", "required": false, "description": "需要获取的路径指令" }
+      ],
+      "returnValue": { "type": "Object", "description": "包含 code、message、data 的处理结果" },
+      "examples": [
+        {
+          "title": "处理接口返回数据",
+          "code": "const response = {\n  custom: { infolist: [{ title: '测试' }] },\n  status: { code: 1, text: '成功' }\n};\nconst result = Util.dataProcess(response, {\n  dataPath: 'custom.infolist'\n});\nconsole.log(result.data);",
+          "description": "从接口返回数据中提取指定路径的数据"
+        }
+      ]
+    },
+    {
+      "name": "os",
+      "description": "判断当前的运行环境",
+      "parameters": [],
+      "returnValue": { "type": "Object", "description": "包含 android、ios、ejs、h5、wechat 等环境判断属性" },
+      "examples": [
+        {
+          "title": "判断运行环境",
+          "code": "if (Util.os.android) {\n  console.log('Android 环境');\n}\nif (Util.os.ios) {\n  console.log('iOS 环境');\n}\nif (Util.os.h5) {\n  console.log('H5 环境');\n}",
+          "description": "判断当前代码运行的平台环境"
+        }
+      ]
+    }
+  ]
+}

package/resources/utils/index.json

@@ -0,0 +1,7 @@
+{
+  "categories": [
+    { "id": "ajax", "title": "Ajax 与文件上传", "file": "ajax.json" },
+    { "id": "string", "title": "字符串校验工具", "file": "string.json" },
+    { "id": "common", "title": "通用工具方法", "file": "common.json" }
+  ]
+}