king-design-analyzer 2.1.9 → 2.2.1

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.9",
+    "version": "2.2.1",
     "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,12 +58,14 @@
         "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",
-        "test": "vitest run",
-        "test:watch": "vitest",
+        "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": "node --require ./scripts/vitest-webcrypto.cjs ./node_modules/vitest/vitest.mjs run",
+        "test:watch": "node --require ./scripts/vitest-webcrypto.cjs ./node_modules/vitest/vitest.mjs",
         "prepublishOnly": "npm run build",
         "release:patch": "npm version patch && npm publish",
         "release:minor": "npm version minor && npm publish",
@@ -76,7 +83,6 @@
     "author": "",
     "license": "MIT",
     "dependencies": {
-        "king-design-analyzer": "^2.1.4",
         "sucrase": "^3.35.1"
     },
     "peerDependencies": {

package/dist/chunk-D3Y6FGWA.js

@@ -1,153 +0,0 @@
-'use strict';
-
-var chunkHPAUCD5I_js = require('./chunk-HPAUCD5I.js');
-
-// src/runtime/index.ts
-var scopeIdCounter = 0;
-var MOCK_VUE_CONTEXT = {
-  // Reactivity
-  ref: (v) => ({ value: v }),
-  reactive: (v) => v,
-  computed: (fn) => ({ value: typeof fn === "function" ? fn() : fn }),
-  readonly: (v) => v,
-  shallowRef: (v) => ({ value: v }),
-  shallowReactive: (v) => v,
-  toRef: () => ({ value: void 0 }),
-  toRefs: (obj) => Object.fromEntries(
-    Object.keys(obj || {}).map((k) => [k, { value: obj[k] }])
-  ),
-  toRaw: (v) => v,
-  markRaw: (v) => v,
-  isRef: () => false,
-  isReactive: () => false,
-  isReadonly: () => false,
-  isProxy: () => false,
-  triggerRef: () => {
-  },
-  customRef: (factory) => factory(() => {
-  }, () => {
-  }),
-  // Lifecycle
-  onMounted: () => {
-  },
-  onUnmounted: () => {
-  },
-  onBeforeMount: () => {
-  },
-  onBeforeUnmount: () => {
-  },
-  onUpdated: () => {
-  },
-  onBeforeUpdate: () => {
-  },
-  onActivated: () => {
-  },
-  onDeactivated: () => {
-  },
-  onErrorCaptured: () => {
-  },
-  // Watchers
-  watch: () => () => {
-  },
-  watchEffect: () => () => {
-  },
-  watchPostEffect: () => () => {
-  },
-  watchSyncEffect: () => () => {
-  },
-  // Composition API
-  defineProps: () => ({}),
-  defineEmits: () => () => {
-  },
-  defineExpose: () => {
-  },
-  defineOptions: () => {
-  },
-  defineSlots: () => ({}),
-  defineModel: () => ({ value: void 0 }),
-  withDefaults: (_props, defaults) => defaults,
-  useSlots: () => ({}),
-  useAttrs: () => ({}),
-  // Dependency Injection
-  inject: () => void 0,
-  provide: () => {
-  },
-  // Utilities
-  nextTick: () => Promise.resolve(),
-  getCurrentInstance: () => null,
-  h: () => ({}),
-  createVNode: () => ({}),
-  resolveComponent: () => ({}),
-  // =========================================================================
-  // @ksyun-internal/versatile Hooks
-  // =========================================================================
-  useToState: (_props, _key, _emit, defaultValue) => ({ value: defaultValue ?? void 0 }),
-  useIdEntity: () => ({ value: void 0 }),
-  // =========================================================================
-  // Module Mocking
-  // =========================================================================
-  __mockModule: (modulePath) => {
-    const createMockProxy = (path) => {
-      return new Proxy(() => {
-      }, {
-        get: (target, prop) => {
-          if (prop === Symbol.toPrimitive) return () => 0;
-          if (prop === "then") return void 0;
-          return createMockProxy();
-        },
-        apply: (target, thisArg, args) => {
-          return createMockProxy();
-        }
-      });
-    };
-    return createMockProxy();
-  }
-};
-function validateRuntimePrecheck(code) {
-  const scopeId = `runtime-${Date.now()}-${++scopeIdCounter}`;
-  const { script, bindings, strippedImports, error } = chunkHPAUCD5I_js.compileSFC(code, scopeId);
-  if (error) {
-    return {
-      name: "\u8FD0\u884C\u65F6\u9884\u68C0\u67E5",
-      passed: false,
-      errors: [error]
-    };
-  }
-  try {
-    const funcBody = `
-            "use strict";
-            ${script}
-            return { ${bindings.join(", ")} };
-        `;
-    const keys = Object.keys(MOCK_VUE_CONTEXT);
-    const values = Object.values(MOCK_VUE_CONTEXT);
-    const runner = new Function(...keys, funcBody);
-    const result = runner(...values);
-    const missingBindings = bindings.filter((binding) => !(binding in result));
-    if (missingBindings.length > 0) {
-      return {
-        name: "\u8FD0\u884C\u65F6\u9884\u68C0\u67E5",
-        passed: false,
-        errors: missingBindings.map((b) => `\u53D8\u91CF ${b} \u672A\u6B63\u786E\u5BFC\u51FA`)
-      };
-    }
-    return {
-      name: "\u8FD0\u884C\u65F6\u9884\u68C0\u67E5",
-      passed: true,
-      errors: []
-    };
-  } catch (e) {
-    const errorMessage = e.message || String(e);
-    const errorLocation = e.stack?.split("\n")[1]?.trim() || "";
-    return {
-      name: "\u8FD0\u884C\u65F6\u9884\u68C0\u67E5",
-      passed: false,
-      errors: [
-        `JavaScript \u6267\u884C\u9519\u8BEF: ${errorMessage}`,
-        ...errorLocation ? [`\u4F4D\u7F6E: ${errorLocation}`] : []
-      ]
-    };
-  }
-}
-
-exports.validateRuntimePrecheck = validateRuntimePrecheck;

package/dist/chunk-HPAUCD5I.js

@@ -1,156 +0,0 @@
-'use strict';
-
-var sucrase = require('sucrase');
-var ts = require('typescript');
-
-function _interopNamespace(e) {
-  if (e && e.__esModule) return e;
-  var n = Object.create(null);
-  if (e) {
-    Object.keys(e).forEach(function (k) {
-      if (k !== 'default') {
-        var d = Object.getOwnPropertyDescriptor(e, k);
-        Object.defineProperty(n, k, d.get ? d : {
-          enumerable: true,
-          get: function () { return e[k]; }
-        });
-      }
-    });
-  }
-  n.default = e;
-  return Object.freeze(n);
-}
-
-var ts__namespace = /*#__PURE__*/_interopNamespace(ts);
-
-// src/tools/sfcCompiler.ts
-var ALLOWED_IMPORT_SOURCES = [
-  "vue",
-  "@vue/",
-  "@king-design/vue",
-  "@ksyun-internal/versatile"
-];
-function scopeStyles(css, scopeClass) {
-  return css.replace(/([^\r\n,{}]+)(,(?=[^}]*{)|\s*{)/g, (match, selector, suffix) => {
-    if (selector.trim().startsWith("@")) return match;
-    const scopedSelector = selector.split(",").map((s) => {
-      s = s.trim();
-      if (s === "body" || s === "html") return `.${scopeClass}`;
-      return `.${scopeClass} ${s}`;
-    }).join(", ");
-    return `${scopedSelector}${suffix}`;
-  });
-}
-function transformLocalImportToMock(importClause, source) {
-  const namespaceMatch = importClause.match(/^\*\s+as\s+(\w+)$/);
-  if (namespaceMatch) {
-    return `const ${namespaceMatch[1]} = __mockModule('${source}');`;
-  }
-  const namedMatch = importClause.match(/^\{([^}]+)\}$/);
-  if (namedMatch) {
-    return `const { ${namedMatch[1]} } = __mockModule('${source}');`;
-  }
-  const defaultMatch = importClause.match(/^(\w+)/);
-  if (defaultMatch) {
-    const defaultName = defaultMatch[1];
-    const mixedMatch = importClause.match(/^(\w+)\s*,\s*\{([^}]+)\}$/);
-    if (mixedMatch) {
-      const namedImports = mixedMatch[2];
-      return `const _mock_${defaultName} = __mockModule('${source}'); const ${defaultName} = _mock_${defaultName}.default || _mock_${defaultName}; const { ${namedImports} } = _mock_${defaultName};`;
-    }
-    return `const ${defaultName} = __mockModule('${source}').default || __mockModule('${source}');`;
-  }
-  return "";
-}
-function compileSFC(code, scopeId, options) {
-  const whitelist = options?.allowedImports ?? ALLOWED_IMPORT_SOURCES;
-  const strippedImports = [];
-  try {
-    const templateMatch = code.match(/<template>([\s\S]*)<\/template>/);
-    const scriptMatch = code.match(/<script[\s\S]*?>([\s\S]*)<\/script>/);
-    const styleMatch = code.match(/<style[\s\S]*?>([\s\S]*)<\/style>/);
-    const template = templateMatch && templateMatch[1] || "";
-    const script = scriptMatch && scriptMatch[1] || "";
-    const styleRaw = styleMatch && styleMatch[1] || "";
-    const style = styleRaw ? scopeStyles(styleRaw, scopeId) : "";
-    if (!template && !script) {
-      return { template: "", script: "", style: "", bindings: [] };
-    }
-    let cleanScript = script;
-    cleanScript = cleanScript.replace(/import\s+type\s+[\s\S]*?from\s+['"].*?['"];?/g, "");
-    cleanScript = cleanScript.replace(
-      /import\s+([^;]+?)\s+from\s+['"]([^'"]+)['"];?/g,
-      (match, importClause, source) => {
-        const isWhitelisted = whitelist.some(
-          (w) => source === w || source.startsWith(w + "/")
-        );
-        if (isWhitelisted) {
-          strippedImports.push({ source, reason: "whitelisted" });
-          return "";
-        }
-        if (source.startsWith(".")) {
-          strippedImports.push({ source, reason: "relative" });
-          return transformLocalImportToMock(importClause.trim(), source);
-        }
-        strippedImports.push({ source, reason: "unknown" });
-        return "";
-      }
-    );
-    const result = sucrase.transform(cleanScript, {
-      transforms: ["typescript"],
-      disableESTransforms: true
-    });
-    if (result && typeof result.code === "string") {
-      cleanScript = result.code;
-    }
-    const varNames = /* @__PURE__ */ new Set();
-    try {
-      let extractNames2 = function(name) {
-        if (ts__namespace.isIdentifier(name)) {
-          varNames.add(name.text);
-        } else if (ts__namespace.isObjectBindingPattern(name) || ts__namespace.isArrayBindingPattern(name)) {
-          name.elements.forEach((element) => {
-            if (ts__namespace.isBindingElement(element)) {
-              extractNames2(element.name);
-            }
-          });
-        }
-      }, visit2 = function(node) {
-        if (ts__namespace.isVariableStatement(node)) {
-          node.declarationList.declarations.forEach((decl) => extractNames2(decl.name));
-        } else if (ts__namespace.isFunctionDeclaration(node) && node.name) {
-          varNames.add(node.name.text);
-        } else if (ts__namespace.isClassDeclaration(node) && node.name) {
-          varNames.add(node.name.text);
-        }
-      };
-      var extractNames = extractNames2, visit = visit2;
-      const sourceFile = ts__namespace.createSourceFile(
-        "temp.ts",
-        cleanScript,
-        ts__namespace.ScriptTarget.Latest,
-        true
-      );
-      sourceFile.statements.forEach(visit2);
-    } catch (e) {
-    }
-    return {
-      template,
-      script: cleanScript,
-      style,
-      bindings: [...varNames],
-      strippedImports: strippedImports.length > 0 ? strippedImports : void 0
-    };
-  } catch (e) {
-    return {
-      template: "",
-      script: "",
-      style: "",
-      bindings: [],
-      error: e.message
-    };
-  }
-}
-
-exports.compileSFC = compileSFC;
-exports.scopeStyles = scopeStyles;

package/dist/chunk-L4DS3EXI.mjs

@@ -1,133 +0,0 @@
-import { transform } from 'sucrase';
-import * as ts from 'typescript';
-
-// src/tools/sfcCompiler.ts
-var ALLOWED_IMPORT_SOURCES = [
-  "vue",
-  "@vue/",
-  "@king-design/vue",
-  "@ksyun-internal/versatile"
-];
-function scopeStyles(css, scopeClass) {
-  return css.replace(/([^\r\n,{}]+)(,(?=[^}]*{)|\s*{)/g, (match, selector, suffix) => {
-    if (selector.trim().startsWith("@")) return match;
-    const scopedSelector = selector.split(",").map((s) => {
-      s = s.trim();
-      if (s === "body" || s === "html") return `.${scopeClass}`;
-      return `.${scopeClass} ${s}`;
-    }).join(", ");
-    return `${scopedSelector}${suffix}`;
-  });
-}
-function transformLocalImportToMock(importClause, source) {
-  const namespaceMatch = importClause.match(/^\*\s+as\s+(\w+)$/);
-  if (namespaceMatch) {
-    return `const ${namespaceMatch[1]} = __mockModule('${source}');`;
-  }
-  const namedMatch = importClause.match(/^\{([^}]+)\}$/);
-  if (namedMatch) {
-    return `const { ${namedMatch[1]} } = __mockModule('${source}');`;
-  }
-  const defaultMatch = importClause.match(/^(\w+)/);
-  if (defaultMatch) {
-    const defaultName = defaultMatch[1];
-    const mixedMatch = importClause.match(/^(\w+)\s*,\s*\{([^}]+)\}$/);
-    if (mixedMatch) {
-      const namedImports = mixedMatch[2];
-      return `const _mock_${defaultName} = __mockModule('${source}'); const ${defaultName} = _mock_${defaultName}.default || _mock_${defaultName}; const { ${namedImports} } = _mock_${defaultName};`;
-    }
-    return `const ${defaultName} = __mockModule('${source}').default || __mockModule('${source}');`;
-  }
-  return "";
-}
-function compileSFC(code, scopeId, options) {
-  const whitelist = options?.allowedImports ?? ALLOWED_IMPORT_SOURCES;
-  const strippedImports = [];
-  try {
-    const templateMatch = code.match(/<template>([\s\S]*)<\/template>/);
-    const scriptMatch = code.match(/<script[\s\S]*?>([\s\S]*)<\/script>/);
-    const styleMatch = code.match(/<style[\s\S]*?>([\s\S]*)<\/style>/);
-    const template = templateMatch && templateMatch[1] || "";
-    const script = scriptMatch && scriptMatch[1] || "";
-    const styleRaw = styleMatch && styleMatch[1] || "";
-    const style = styleRaw ? scopeStyles(styleRaw, scopeId) : "";
-    if (!template && !script) {
-      return { template: "", script: "", style: "", bindings: [] };
-    }
-    let cleanScript = script;
-    cleanScript = cleanScript.replace(/import\s+type\s+[\s\S]*?from\s+['"].*?['"];?/g, "");
-    cleanScript = cleanScript.replace(
-      /import\s+([^;]+?)\s+from\s+['"]([^'"]+)['"];?/g,
-      (match, importClause, source) => {
-        const isWhitelisted = whitelist.some(
-          (w) => source === w || source.startsWith(w + "/")
-        );
-        if (isWhitelisted) {
-          strippedImports.push({ source, reason: "whitelisted" });
-          return "";
-        }
-        if (source.startsWith(".")) {
-          strippedImports.push({ source, reason: "relative" });
-          return transformLocalImportToMock(importClause.trim(), source);
-        }
-        strippedImports.push({ source, reason: "unknown" });
-        return "";
-      }
-    );
-    const result = transform(cleanScript, {
-      transforms: ["typescript"],
-      disableESTransforms: true
-    });
-    if (result && typeof result.code === "string") {
-      cleanScript = result.code;
-    }
-    const varNames = /* @__PURE__ */ new Set();
-    try {
-      let extractNames2 = function(name) {
-        if (ts.isIdentifier(name)) {
-          varNames.add(name.text);
-        } else if (ts.isObjectBindingPattern(name) || ts.isArrayBindingPattern(name)) {
-          name.elements.forEach((element) => {
-            if (ts.isBindingElement(element)) {
-              extractNames2(element.name);
-            }
-          });
-        }
-      }, visit2 = function(node) {
-        if (ts.isVariableStatement(node)) {
-          node.declarationList.declarations.forEach((decl) => extractNames2(decl.name));
-        } else if (ts.isFunctionDeclaration(node) && node.name) {
-          varNames.add(node.name.text);
-        } else if (ts.isClassDeclaration(node) && node.name) {
-          varNames.add(node.name.text);
-        }
-      };
-      var extractNames = extractNames2, visit = visit2;
-      const sourceFile = ts.createSourceFile(
-        "temp.ts",
-        cleanScript,
-        ts.ScriptTarget.Latest,
-        true
-      );
-      sourceFile.statements.forEach(visit2);
-    } catch (e) {
-    }
-    return {
-      template,
-      script: cleanScript,
-      style,
-      bindings: [...varNames],
-      strippedImports: strippedImports.length > 0 ? strippedImports : void 0
-    };
-  } catch (e) {
-    return {
-      template: "",
-      script: "",
-      style: "",
-      bindings: [],
-      error: e.message
-    };
-  }
-}
-
-export { compileSFC, scopeStyles };