chore: 🚀 重构 types 类型包

axelulu · axelulu · commit 7112e31cfb41 · 2024-11-07T01:54:30.000+08:00
diff --git a/packages/designer/markdown/designer.menu.md b/packages/designer/markdown/designer.menu.md
@@ -60,7 +60,7 @@ Description
 
 </td><td>
 
-string
+MaterType
 
 
 </td><td>
diff --git a/packages/designer/markdown/designer.menu.name.md b/packages/designer/markdown/designer.menu.name.md
@@ -7,5 +7,5 @@
 **Signature:**
 
 ```typescript
-name: string;
+name: MaterType;
 ```
diff --git a/packages/schemas/element-plus/markdown/schemas-element-plus.compschema.children.md b/packages/schemas/element-plus/markdown/schemas-element-plus.compschema.children.md
@@ -4,6 +4,8 @@
 
 ## CompSchema.children property
 
+是否配有子组件，例如 row，col
+
 **Signature:**
 
 ```typescript
diff --git a/packages/schemas/element-plus/markdown/schemas-element-plus.compschema.events.md b/packages/schemas/element-plus/markdown/schemas-element-plus.compschema.events.md
@@ -4,6 +4,8 @@
 
 ## CompSchema.events property
 
+组件绑定事件
+
 **Signature:**
 
 ```typescript
diff --git a/packages/schemas/element-plus/markdown/schemas-element-plus.compschema.icon.md b/packages/schemas/element-plus/markdown/schemas-element-plus.compschema.icon.md
@@ -4,6 +4,8 @@
 
 ## CompSchema.icon property
 
+组件图标
+
 **Signature:**
 
 ```typescript
diff --git a/packages/schemas/element-plus/markdown/schemas-element-plus.compschema.label.md b/packages/schemas/element-plus/markdown/schemas-element-plus.compschema.label.md
@@ -4,6 +4,8 @@
 
 ## CompSchema.label property
 
+组件名称
+
 **Signature:**
 
 ```typescript
diff --git a/packages/schemas/element-plus/markdown/schemas-element-plus.compschema.md b/packages/schemas/element-plus/markdown/schemas-element-plus.compschema.md
@@ -50,7 +50,7 @@ string
 
 </td><td>
 
-_(Optional)_
+_(Optional)_ 是否配有子组件，例如 row，col
 
 
 </td></tr>
@@ -69,7 +69,7 @@ _(Optional)_
 
 </td><td>
 
-_(Optional)_
+_(Optional)_ 组件绑定事件
 
 
 </td></tr>
@@ -88,7 +88,7 @@ string
 
 </td><td>
 
-_(Optional)_
+_(Optional)_ 组件图标
 
 
 </td></tr>
@@ -107,7 +107,7 @@ string
 
 </td><td>
 
-_(Optional)_
+_(Optional)_ 组件名称
 
 
 </td></tr>
@@ -121,12 +121,12 @@ _(Optional)_
 
 </td><td>
 
-string
+MaterType
 
 
 </td><td>
 
-_(Optional)_
+_(Optional)_ 组件分类
 
 
 </td></tr>
@@ -145,6 +145,8 @@ string
 
 </td><td>
 
+组件 id 不能重复
+
 
 </td></tr>
 <tr><td>
@@ -162,6 +164,8 @@ string
 
 </td><td>
 
+组件属性配置规则
+
 
 </td></tr>
 <tr><td>
@@ -179,6 +183,8 @@ string
 
 </td><td>
 
+组件生产规则
+
 
 </td></tr>
 <tr><td>
@@ -196,7 +202,7 @@ string
 
 </td><td>
 
-_(Optional)_
+_(Optional)_ 组件插槽
 
 
 </td></tr>
diff --git a/packages/schemas/element-plus/markdown/schemas-element-plus.compschema.menu.md b/packages/schemas/element-plus/markdown/schemas-element-plus.compschema.menu.md
@@ -4,8 +4,10 @@
 
 ## CompSchema.menu property
 
+组件分类
+
 **Signature:**
 
 ```typescript
-menu?: string;
+menu?: MaterType;
 ```
diff --git a/packages/schemas/element-plus/markdown/schemas-element-plus.compschema.name.md b/packages/schemas/element-plus/markdown/schemas-element-plus.compschema.name.md
@@ -4,6 +4,8 @@
 
 ## CompSchema.name property
 
+组件 id 不能重复
+
 **Signature:**
 
 ```typescript
diff --git a/packages/schemas/element-plus/markdown/schemas-element-plus.compschema.props.md b/packages/schemas/element-plus/markdown/schemas-element-plus.compschema.props.md
@@ -4,6 +4,8 @@
 
 ## CompSchema.props property
 
+组件属性配置规则
+
 **Signature:**
 
 ```typescript
diff --git a/packages/schemas/element-plus/markdown/schemas-element-plus.compschema.schema.md b/packages/schemas/element-plus/markdown/schemas-element-plus.compschema.schema.md
@@ -4,6 +4,8 @@
 
 ## CompSchema.schema property
 
+组件生产规则
+
 **Signature:**
 
 ```typescript
diff --git a/packages/schemas/element-plus/markdown/schemas-element-plus.compschema.slots.md b/packages/schemas/element-plus/markdown/schemas-element-plus.compschema.slots.md
@@ -4,6 +4,8 @@
 
 ## CompSchema.slots property
 
+组件插槽
+
 **Signature:**
 
 ```typescript
diff --git a/packages/types/eslint.config.mjs b/packages/types/eslint.config.mjs
@@ -0,0 +1,3 @@
+import esLintConfig from '@al-config/lint/eslint.config.mjs'
+
+export default esLintConfig
diff --git a/packages/types/markdown/index.md b/packages/types/markdown/index.md
@@ -0,0 +1,29 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+<table><thead><tr><th>
+
+Package
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[@ai-lowcode/types](./types.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
diff --git a/packages/types/markdown/types.matertype.md b/packages/types/markdown/types.matertype.md
@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ai-lowcode/types](./types.md) &gt; [MaterType](./types.matertype.md)
+
+## MaterType type
+
+定义物料分组类型。
+
+**Signature:**
+
+```typescript
+export type MaterType = 'basic' | 'display' | 'form' | 'business';
+```
+
+## Remarks
+
+菜单类型主要包括以下四种: - `'basic'`<!-- -->：基础类型菜单,适用于通用功能 - `'display'`<!-- -->：显示类型菜单,主要用于数据展示 - `'form'`<!-- -->：表单类型菜单,用于表单操作 - `'business'`<!-- -->：业务类型菜单,适用于业务逻辑相关
+
diff --git a/packages/types/markdown/types.md b/packages/types/markdown/types.md
@@ -0,0 +1,31 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ai-lowcode/types](./types.md)
+
+## types package
+
+## Type Aliases
+
+<table><thead><tr><th>
+
+Type Alias
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[MaterType](./types.matertype.md)
+
+
+</td><td>
+
+定义物料分组类型。
+
+
+</td></tr>
+</tbody></table>
diff --git a/packages/types/package.json b/packages/types/package.json
@@ -8,15 +8,43 @@
     "url": "https://github.com/ai-lowcode/core"
   },
   "bugs": "https://github.com/ai-lowcode/core/issues",
-  "main": "./src/index.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/ai-lowcode-types.js",
+      "require": "./dist/ai-lowcode-types.cjs"
+    },
+    "./shims/vue.d.ts": {
+      "types": "./shims/vue.d.ts"
+    }
+  },
+  "main": "./dist/ai-lowcode-types.cjs",
+  "module": "./dist/ai-lowcode-types.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "shims"
+  ],
   "scripts": {
-    "clean": "rimraf node_modules"
+    "build": "vite build",
+    "build:all": "vite build && pnpm build:dts",
+    "build:dts": "rimraf temp && tsc -p tsconfig.declaration.json && rollup-dts",
+    "test": "vitest",
+    "clean": "rimraf node_modules",
+    "clean:dist": "rimraf dist"
   },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
     "vue": "^3.5.3"
+  },
+  "devDependencies": {
+    "@al-config/lint": "workspace:^",
+    "@al-config/tsconfig": "workspace:^",
+    "@al-config/vite": "workspace:^",
+    "vite": "^5.4.3",
+    "vitest": "^2.0.4"
   }
 }
diff --git a/packages/types/tsconfig.declaration.json b/packages/types/tsconfig.declaration.json
@@ -0,0 +1,16 @@
+{
+  "extends": "@al-config/tsconfig/tsconfig.base.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "rootDir": ".",
+    "paths": {
+      "@/*": [
+        "src/*"
+      ]
+    },
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "outDir": "temp",
+    "stripInternal": true
+  }
+}
diff --git a/packages/types/tsconfig.json b/packages/types/tsconfig.json
@@ -0,0 +1,7 @@
+{
+  "extends": "@al-config/tsconfig/tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "dist"
+  },
+  "include": ["src"]
+}
diff --git a/packages/types/vite.config.ts b/packages/types/vite.config.ts
@@ -0,0 +1,10 @@
+import { definePkgConfig } from '@al-config/vite'
+import { defineConfig } from 'vite'
+
+export default defineConfig(async () => {
+  return definePkgConfig({
+    name: 'AiLowcodeTypes',
+    defaultFormats: ['es', 'cjs'],
+    externalDeps: false,
+  })
+})
diff --git a/packages/types/vitest.config.ts b/packages/types/vitest.config.ts
@@ -0,0 +1,5 @@
+import { defineProject } from 'vitest/config'
+
+export default defineProject({
+  test: {},
+})
diff --git a/scripts/package-init.js b/scripts/package-init.js
@@ -3,6 +3,7 @@ import { execa } from 'execa'
 const buildPkg = [
   '@al-config/vite',
   '@ai-lowcode/styles',
+  '@ai-lowcode/types',
   '@ai-lowcode/utils',
   '@ai-lowcode/element-plus',
   '@ai-lowcode/hooks',
