@longzai-intelligence-oxlint/schema-type-separation-plugin 0.1.0

package/README.md

@@ -0,0 +1,17 @@
+# @longzai-intelligence-oxlint/schema-type-separation-plugin
+
+## 意图
+
+在静态检查阶段强制 Zod Schema 与 TypeScript Type 文件职责分离，避免在同一文件内混合两类定义造成维护负担。
+
+## 定位
+
+Oxlint 生态的 Schema/Type 职责分离插件，通过 `eslintCompatPlugin` 包装以同时兼容 Oxlint 与 ESLint 运行时。
+
+## 职能
+
+提供 `no-type-in-schema` 规则禁止在 Schema 文件内定义纯类型、`no-schema-in-types` 规则禁止在类型文件内定义 Zod Schema；同时导出 `isSchemaFile`、`isTypesFile` 与 Zod Schema 方法常量供外部复用。
+
+## 实现情况
+
+两条规则及配套判断工具均已实现并按规则目录组织，规则、工具与插件对象一并导出；当前规则集合聚焦 Schema/Type 分离维度，处于稳定可用形态。

package/dist/configs/recommended.d.ts

@@ -0,0 +1,11 @@
+import { OxlintRules } from "@longzai-intelligence-oxlint/core";
+//#region src/configs/recommended.config.d.ts
+/**
+ * 推荐规则配置对象
+ *
+ * 包含 schema-type-separation 插件的推荐规则设置，
+ * 两条规则默认关闭，推荐将 type 定义合并在 schema 文件中
+ */
+declare const recommended: OxlintRules;
+//#endregion
+export { recommended };

package/dist/configs/recommended.js

@@ -0,0 +1 @@
+const e={"@longzai-intelligence-oxlint/schema-type-separation-plugin/no-type-in-schema":`off`,"@longzai-intelligence-oxlint/schema-type-separation-plugin/no-schema-in-types":`off`};export{e as recommended};

package/dist/index.d.ts

@@ -0,0 +1,48 @@
+//#region src/rules/no-schema-in-types/index.d.ts
+/**
+ * Zod Schema 运行时方法名列表
+ *
+ * 覆盖所有可能创建 Zod Schema 的方法调用
+ */
+declare const ZOD_SCHEMA_METHODS: Set<string>;
+/**
+ * 判断文件是否为 types 文件
+ *
+ * @param filename - 文件名
+ * @returns 是否为 types 文件
+ */
+declare function isTypesFile(filename: string): boolean;
+/**
+ * no-schema-in-types 规则定义
+ *
+ * 在 *.types.ts 文件中禁止 Zod Schema 运行时定义，允许 z.infer 类型推导。
+ * 使用 createOnce 替代 create 以获得 Oxlint 最佳性能。
+ */
+declare const noSchemaInTypesRule: import("@oxlint/plugins").Rule;
+//#endregion
+//#region src/rules/no-type-in-schema/index.d.ts
+/**
+ * 判断文件是否为 schema 文件
+ *
+ * @param filename - 文件名
+ * @returns 是否为 schema 文件
+ */
+declare function isSchemaFile(filename: string): boolean;
+/**
+ * no-type-in-schema 规则定义
+ *
+ * 在 *.schema.ts 文件中禁止任何 type 声明，零容忍。
+ * 使用 createOnce 替代 create 以获得 Oxlint 最佳性能。
+ */
+declare const noTypeInSchemaRule: import("@oxlint/plugins").Rule;
+//#endregion
+//#region src/index.d.ts
+/**
+ * schema-type-separation 插件
+ *
+ * 提供 Schema/Type 职责分离相关的 Oxlint 规则，
+ * 通过 eslintCompatPlugin 包装以同时支持 Oxlint 和 ESLint 运行时
+ */
+declare const schemaTypeSeparationPlugin: import("@oxlint/plugins").Plugin;
+//#endregion
+export { ZOD_SCHEMA_METHODS, schemaTypeSeparationPlugin as default, schemaTypeSeparationPlugin, isSchemaFile, isTypesFile, noSchemaInTypesRule, noTypeInSchemaRule };

package/dist/index.js

@@ -0,0 +1 @@
+import{defineRule as e,eslintCompatPlugin as t}from"@oxlint/plugins";const n=new Set(`object.enum.string.number.boolean.array.record.tuple.union.intersection.literal.nativeEnum.any.unknown.void.never.date.bigint.map.set.nan.null.undefined.symbol.coerce.lazy.promise.function.branded.catch.default.describe.nullable.optional.transform.pipe.refine.superRefine.preprocess`.split(`.`));function r(e){return e.endsWith(`.types.ts`)}const i=e({meta:{type:`problem`,docs:{description:`禁止在 *.types.ts 文件中包含 Zod Schema 运行时定义，允许 z.infer 类型推导`}},createOnce(e){return{before(){let t=e.filename;if(!r(t))return!1},CallExpression(t){if(t.callee.type!==`MemberExpression`||t.callee.object.type!==`Identifier`||t.callee.object.name!==`z`||t.callee.property.type!==`Identifier`)return;let r=t.callee.property.name;n.has(r)&&e.report({node:t,message:`*.types.ts 文件不允许包含 Zod Schema 定义。"z.${r}()" 是运行时验证逻辑，应放在 *.schema.ts 文件中。`})},ImportDeclaration(t){if(t.source.value===`zod`&&!(`importKind`in t&&t.importKind===`type`))for(let n of t.specifiers){if(n.type===`ImportNamespaceSpecifier`){e.report({node:t,message:`*.types.ts 文件不允许从 zod 进行值导入。如需引用 Zod 类型，请使用 import type 语法。`});return}if(!(`importKind`in n&&n.importKind===`type`)){e.report({node:t,message:`*.types.ts 文件不允许从 zod 进行值导入。如需引用 Zod 类型，请使用 import type 语法。`});return}}}}}});function a(e){return e.endsWith(`.schema.ts`)}function o(e){if(`id`in e&&e.id!==null&&typeof e.id==`object`&&`name`in e.id&&typeof e.id.name==`string`)return e.id.name}const s=e({meta:{type:`problem`,docs:{description:`禁止在 *.schema.ts 文件中包含任何 type 定义，强制拆分到 *.types.ts 文件`}},createOnce(e){return{before(){let t=e.filename;if(!a(t))return!1},TSTypeAliasDeclaration(t){let n=o(t);e.report({node:t,message:`*.schema.ts 文件不允许包含 type 定义。类型 "${n??`未知类型`}" 应拆分到对应的 *.types.ts 文件中。`})}}}}),c=t({meta:{name:`@longzai-intelligence-oxlint/schema-type-separation-plugin`},rules:{"no-type-in-schema":s,"no-schema-in-types":i}});export{n as ZOD_SCHEMA_METHODS,c as default,c as schemaTypeSeparationPlugin,a as isSchemaFile,r as isTypesFile,i as noSchemaInTypesRule,s as noTypeInSchemaRule};

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@longzai-intelligence-oxlint/schema-type-separation-plugin",
+  "version": "0.1.0",
+  "license": "UNLICENSED",
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./configs/recommended": {
+      "types": "./dist/configs/recommended.d.ts",
+      "import": "./dist/configs/recommended.js"
+    }
+  },
+  "scripts": {
+    "build": "lzi-builder",
+    "build:prod": "NODE_ENV=production lzi-builder",
+    "prepublishOnly": "bun run build:prod",
+    "dev": "lzi-builder --watch",
+    "clean": "rimraf dist",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "lint": "oxlint && oxfmt --check",
+    "lint:fix": "oxlint --fix && oxfmt",
+    "typecheck": "bun run typecheck:app && bun run typecheck:node && bun run typecheck:test",
+    "typecheck:app": "tsgo --noEmit -p tsconfig/app.json",
+    "typecheck:node": "tsgo --noEmit -p tsconfig/node.json",
+    "typecheck:test": "tsgo --noEmit -p tsconfig/test.json"
+  },
+  "dependencies": {
+    "@longzai-intelligence-oxlint/core": "0.1.0",
+    "@oxlint/plugins": "^1.74.0"
+  },
+  "devDependencies": {
+    "@vitest/coverage-v8": "^4.1.10",
+    "typescript": "^6.0.3"
+  },
+  "peerDependencies": {
+    "oxlint": ">=1.0.0"
+  }
+}