king-design-analyzer 2.1.7 → 2.2.0

package/hooks/useTableSort.json

@@ -0,0 +1,43 @@
+{
+  "id": "useTableSort",
+  "name": "useTableSort",
+  "displayName": "表格排序状态",
+  "category": "table",
+  "description": "统一管理表格排序字段和方向，并提供多种派生排序状态，适合请求参数、UI 高亮和布尔/整数映射场景。",
+  "importStatement": "import { useTableSort } from '@ksyun-internal/versatile';",
+  "source": "@ksyun-internal/versatile",
+  "params": [
+    {
+      "name": "page",
+      "type": "Ref<number | undefined>",
+      "required": false,
+      "description": "分页页码，传入后在切换排序时可联动重置页码"
+    }
+  ],
+  "returnType": "{ sort: Ref<TableSortValue>; curSortKey: ComputedRef<string | undefined>; curSortType: ComputedRef<'desc' | 'asc' | undefined>; curSortTypeByInt: ComputedRef<0 | 1 | -1>; curSortTypeByBoolean: ComputedRef<boolean | ''>; changeSort: Function; }",
+  "examples": [
+    {
+      "id": "table_sort",
+      "title": "列表排序状态",
+      "description": "将排序状态集中管理，并把变更方法绑定给表格",
+      "code": "<script setup lang=\"ts\">\nimport { usePagination, useTableSort } from '@ksyun-internal/versatile';\n\nconst { page } = usePagination();\nconst { sort, curSortKey, curSortType, changeSort } = useTableSort(page);\n</script>"
+    }
+  ],
+  "commonMistakes": [
+    {
+      "id": "manual_sort_mapping",
+      "description": "自己维护 asc/desc 和 0/1/-1 的映射，重复实现 hook 已有能力",
+      "wrongCode": "const sortType = computed(() => sort.value.type === 'asc' ? 1 : -1);",
+      "correctCode": "const { curSortTypeByInt } = useTableSort(page);",
+      "explanation": "hook 已经提供多种派生排序表示，优先复用。"
+    }
+  ],
+  "searchKeywords": [
+    "useTableSort",
+    "排序",
+    "TableSortValue",
+    "ProTable",
+    "列表排序",
+    "sort"
+  ]
+}

package/hooks/useUser.json

@@ -0,0 +1,36 @@
+{
+  "id": "useUser",
+  "name": "useUser",
+  "displayName": "当前用户信息",
+  "category": "auth",
+  "description": "获取当前登录用户信息，适合在业务组件中读取 root 权限、当前用户 ID 或账号属性。",
+  "importStatement": "import { useUser } from '@ksyun-internal/versatile';",
+  "source": "@ksyun-internal/versatile",
+  "params": [],
+  "returnType": "Ref<UserInfo | undefined>",
+  "examples": [
+    {
+      "id": "read_user",
+      "title": "读取当前用户信息",
+      "description": "在页面初始化时获取当前用户及权限信息",
+      "code": "<script setup lang=\"ts\">\nimport { useUser } from '@ksyun-internal/versatile';\n\nconst user = useUser();\n</script>\n\n<template>\n  <div v-if=\"user\">{{ user.curUserId }}</div>\n</template>"
+    }
+  ],
+  "commonMistakes": [
+    {
+      "id": "skip_undefined_guard",
+      "description": "直接访问 user.value 的属性，没有处理未加载完成的情况",
+      "wrongCode": "const isRoot = user.value.isRoot;",
+      "correctCode": "const isRoot = user.value?.isRoot;",
+      "explanation": "返回值是 Ref<UserInfo | undefined>，初始化阶段可能为空。"
+    }
+  ],
+  "searchKeywords": [
+    "useUser",
+    "当前用户",
+    "权限",
+    "isRoot",
+    "curUserId",
+    "账号信息"
+  ]
+}

package/hooks/useValidForm.json

@@ -0,0 +1,43 @@
+{
+  "id": "useValidForm",
+  "name": "useValidForm",
+  "displayName": "表单校验管理",
+  "category": "form",
+  "description": "封装 Form 实例的校验、重置和滚动定位能力，适合页面表单和弹窗表单统一管理。",
+  "importStatement": "import { useValidForm } from '@ksyun-internal/versatile';",
+  "source": "@ksyun-internal/versatile",
+  "params": [
+    {
+      "name": "models",
+      "type": "Ref<T>",
+      "required": false,
+      "description": "表单模型对象，可在 reset 时恢复默认值"
+    }
+  ],
+  "returnType": "{ formRef: Ref<Form | undefined>; validate: Function; validateByScroll: Function; reset: Function; scrollIntoFirstInvalidFormItem: Function; }",
+  "examples": [
+    {
+      "id": "page_form",
+      "title": "页面表单校验",
+      "description": "在提交前统一校验并定位第一个错误项",
+      "code": "<script setup lang=\"ts\">\nimport { ref } from 'vue';\nimport { useValidForm } from '@ksyun-internal/versatile';\n\nconst models = ref({ name: '', region: '' });\nconst { formRef, validateByScroll } = useValidForm(models);\n</script>"
+    }
+  ],
+  "commonMistakes": [
+    {
+      "id": "reset_without_models",
+      "description": "希望 reset 恢复初始模型，但没有把 models 传给 hook",
+      "wrongCode": "const { reset } = useValidForm();",
+      "correctCode": "const { reset } = useValidForm(models);",
+      "explanation": "如果需要重置业务表单值，建议把模型 Ref 传入 useValidForm。"
+    }
+  ],
+  "searchKeywords": [
+    "useValidForm",
+    "表单校验",
+    "Form",
+    "validateByScroll",
+    "reset",
+    "滚动定位"
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "king-design-analyzer",
-    "version": "2.1.7",
+    "version": "2.2.0",
     "description": "AST-based code analyzer for King Design Vue components with on-demand modular imports",
     "main": "./dist/index.js",
     "module": "./dist/index.mjs",
@@ -40,6 +40,11 @@
             "types": "./dist/metadata/index.d.ts",
             "import": "./dist/metadata/index.mjs",
             "require": "./dist/metadata/index.js"
+        },
+        "./shared": {
+            "types": "./dist/shared/index.d.ts",
+            "import": "./dist/shared/index.mjs",
+            "require": "./dist/shared/index.js"
         }
     },
     "files": [
@@ -53,10 +58,12 @@
         "build:tsc": "tsc",
         "dev": "tsup --watch",
         "clean": "rm -rf dist",
-        "validate": "npx tsx src/tools/validateDataset.ts",
-        "validate:report": "npx tsx src/tools/validateDataset.ts -o report.json",
-        "validate:unified": "npx tsx src/tools/testUnifiedValidator.ts",
-        "transform:md": "npx ts-node scripts/transform_metadata.ts",
+        "validate": "ts-node -P tsconfig.scripts.json src/tools/validateDataset.ts",
+        "validate:report": "ts-node -P tsconfig.scripts.json src/tools/validateDataset.ts -o report.json",
+        "validate:unified": "ts-node -P tsconfig.scripts.json src/tools/testUnifiedValidator.ts",
+        "audit:versatile": "node scripts/audit_versatile.js",
+        "audit:hooks": "node scripts/audit_hooks.js",
+        "transform:md": "ts-node -P tsconfig.scripts.json scripts/transform_metadata.ts",
         "test": "vitest run",
         "test:watch": "vitest",
         "prepublishOnly": "npm run build",
@@ -76,7 +83,6 @@
     "author": "",
     "license": "MIT",
     "dependencies": {
-        "king-design-analyzer": "^2.1.4",
         "sucrase": "^3.35.1"
     },
     "peerDependencies": {