@kingsword/lint-config 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Kingsword
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,54 @@
+# @kingsword/lint-config
+
+可复用的 `oxlint` 配置与 `@kingsword/*` 规则插件。
+
+> 要求：`oxlint >= 1.43.0`
+
+## 安装
+
+```bash
+npm i -D oxlint @kingsword/lint-config
+```
+
+## 推荐用法（CLI 生成）
+
+```bash
+# 生成 oxlint.config.ts（默认 lib + none + recommended）
+npx xlint init lib
+
+# 更严格示例
+npx xlint init fullstack --test vitest --level strict
+```
+
+生成后执行：
+
+```bash
+npx oxlint .
+```
+
+## 手写配置
+
+```ts
+import { defineConfig } from "oxlint";
+import { oxlint } from "@kingsword/lint-config/config";
+
+export default defineConfig(
+  oxlint({
+    profile: "lib",
+    test: "none",
+    level: "recommended",
+  }),
+);
+```
+
+## 参数说明
+
+- `profile`: `base | lib | react | backend | fullstack`
+- `test`: `none | vitest`
+- `level`: `recommended | strict`
+
+`oxlint()` 无参数时，默认使用最严格推荐档（`fullstack-vitest-strict`）。
+
+## 规则文档
+
+- `docs/rules.zh-CN.md`

package/configs/oxlint/backend.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["./recommended.json"]
+}

package/configs/oxlint/base.json

@@ -0,0 +1,42 @@
+{
+  "env": {
+    "es2022": true,
+    "node": true
+  },
+  "ignorePatterns": ["build/**", "dist/**", "coverage/**", "node_modules/**"],
+  "rules": {
+    "no-console": "error",
+    "no-void": ["error", { "allowAsStatement": true }],
+    "prefer-const": "error",
+    "typescript/no-empty-object-type": "error",
+    "typescript/no-explicit-any": "error",
+    "typescript/no-floating-promises": "error",
+    "typescript/no-require-imports": "error",
+    "oxc/no-barrel-file": "error"
+  },
+  "overrides": [
+    {
+      "files": [
+        "**/*.test.js",
+        "**/*.test.jsx",
+        "**/*.test.ts",
+        "**/*.test.tsx",
+        "**/*.spec.js",
+        "**/*.spec.jsx",
+        "**/*.spec.ts",
+        "**/*.spec.tsx",
+        "**/test-utils/**"
+      ],
+      "rules": {
+        "no-console": "off",
+        "typescript/no-explicit-any": "off"
+      }
+    },
+    {
+      "files": ["**/index.ts", "**/index.tsx"],
+      "rules": {
+        "oxc/no-barrel-file": "off"
+      }
+    }
+  ]
+}

package/configs/oxlint/frontend.json

@@ -0,0 +1,34 @@
+{
+  "extends": ["./recommended.json", "./restricted-syntax-frontend.json"],
+  "env": {
+    "browser": true
+  },
+  "rules": {
+    "@kingsword/filename-match-export": [
+      "error",
+      { "ignoredFiles": ["utils.ts", "constants.ts", "types.ts"] }
+    ],
+    "@kingsword/no-dynamic-styled-components": "error",
+    "@kingsword/no-plain-html-text-elements": "error",
+    "@kingsword/no-use-effect-in-hooks": "error",
+
+    "no-restricted-globals": [
+      "error",
+      { "name": "fetch", "message": "fetch() is banned. Use an API client/wrapper instead." }
+    ]
+  },
+  "overrides": [
+    {
+      "files": ["**/*.stories.ts", "**/*.stories.tsx"],
+      "rules": {
+        "@kingsword/no-plain-html-text-elements": "off"
+      }
+    },
+    {
+      "files": ["**/*.test.ts", "**/*.test.tsx", "**/*.spec.ts", "**/*.spec.tsx"],
+      "rules": {
+        "@kingsword/no-plain-html-text-elements": "off"
+      }
+    }
+  ]
+}

package/configs/oxlint/fullstack.json

@@ -0,0 +1,8 @@
+{
+  "extends": ["./frontend.json"],
+  "env": {
+    "es2022": true,
+    "node": true,
+    "browser": true
+  }
+}

package/configs/oxlint/recommended.json

@@ -0,0 +1,45 @@
+{
+  "extends": ["./base.json", "./restricted-syntax-base.json"],
+  "jsPlugins": [{ "name": "@kingsword", "specifier": "../../dist/index.cjs" }],
+  "rules": {
+    "@kingsword/no-exported-string-union-types": "error",
+    "@kingsword/structured-logging": "error",
+    "@kingsword/enum-file-organization": "error",
+    "@kingsword/types-file-organization": "error",
+    "@kingsword/constants-file-organization": "error",
+    "@kingsword/errors-file-organization": "error",
+    "@kingsword/no-exported-function-expressions": "error",
+    "@kingsword/test-utils-organization": "error",
+    "@kingsword/test-file-location": "error",
+    "@kingsword/no-log-exception-with-throw": "error"
+  },
+  "overrides": [
+    {
+      "files": ["**/schema.ts"],
+      "rules": {
+        "@kingsword/types-file-organization": "off",
+        "@kingsword/constants-file-organization": "off"
+      }
+    },
+    {
+      "files": [
+        "**/route.ts",
+        "**/api.ts",
+        "**/slice.ts",
+        "**/selectors.ts",
+        "**/*.test.js",
+        "**/*.test.jsx",
+        "**/*.test.ts",
+        "**/*.test.tsx",
+        "**/*.spec.js",
+        "**/*.spec.jsx",
+        "**/*.spec.ts",
+        "**/*.spec.tsx",
+        "**/test-utils/**"
+      ],
+      "rules": {
+        "@kingsword/constants-file-organization": "off"
+      }
+    }
+  ]
+}

package/configs/oxlint/restricted-syntax-base.json

@@ -0,0 +1,35 @@
+{
+  "rules": {
+    "@kingsword/no-restricted-syntax": [
+      "error",
+      {
+        "selector": "ForInStatement",
+        "message": "Avoid for..in. Use Object.{keys,values,entries} and iterate over the resulting array."
+      },
+      {
+        "selector": "LabeledStatement",
+        "message": "Labels are a form of GOTO; using them makes code confusing and hard to maintain."
+      },
+      {
+        "selector": "WithStatement",
+        "message": "`with` is disallowed in strict mode because it makes code impossible to predict and optimize."
+      },
+      {
+        "selector": "ExportAllDeclaration",
+        "message": "Avoid `export *` because it can cause unexpected exposure and ESM transpilation edge cases."
+      },
+      {
+        "selector": "CatchClause CallExpression[callee.name=\"logError\"]",
+        "message": "Do not use logError() inside catch; use logException() instead."
+      },
+      {
+        "selector": "CatchClause CallExpression[callee.property.name=\"logError\"]",
+        "message": "Do not use .logError() inside catch; use logException() instead."
+      },
+      {
+        "selector": "ThrowStatement > NewExpression[callee.name=\"Error\"]",
+        "message": "Prefer a domain error type (e.g. MetaError) instead of throwing a raw Error."
+      }
+    ]
+  }
+}

package/configs/oxlint/restricted-syntax-frontend.json

@@ -0,0 +1,123 @@
+{
+  "rules": {
+    "@kingsword/no-restricted-syntax": [
+      "error",
+      {
+        "selector": "ForInStatement",
+        "message": "Avoid for..in. Use Object.{keys,values,entries} and iterate over the resulting array."
+      },
+      {
+        "selector": "LabeledStatement",
+        "message": "Labels are a form of GOTO; using them makes code confusing and hard to maintain."
+      },
+      {
+        "selector": "WithStatement",
+        "message": "`with` is disallowed in strict mode because it makes code impossible to predict and optimize."
+      },
+      {
+        "selector": "ExportAllDeclaration",
+        "message": "Avoid `export *` because it can cause unexpected exposure and ESM transpilation edge cases."
+      },
+      {
+        "selector": "CatchClause CallExpression[callee.name=\"logError\"]",
+        "message": "Do not use logError() inside catch; use logException() instead."
+      },
+      {
+        "selector": "CatchClause CallExpression[callee.property.name=\"logError\"]",
+        "message": "Do not use .logError() inside catch; use logException() instead."
+      },
+      {
+        "selector": "ThrowStatement > NewExpression[callee.name=\"Error\"]",
+        "message": "Prefer a domain error type (e.g. MetaError) instead of throwing a raw Error."
+      },
+      {
+        "selector": "CallExpression[callee.name=\"useEffect\"]",
+        "message": "useEffect is banned. Prefer alternative patterns or dedicated hooks."
+      },
+      {
+        "selector": "CallExpression[callee.object.name=\"React\"][callee.property.name=\"useEffect\"]",
+        "message": "React.useEffect is banned. Prefer alternative patterns or dedicated hooks."
+      },
+      {
+        "selector": "CallExpression[callee.name=\"useLayoutEffect\"]",
+        "message": "useLayoutEffect is banned. Prefer alternative patterns or dedicated hooks."
+      },
+      {
+        "selector": "CallExpression[callee.object.name=\"React\"][callee.property.name=\"useLayoutEffect\"]",
+        "message": "React.useLayoutEffect is banned. Prefer alternative patterns or dedicated hooks."
+      },
+      {
+        "selector": "CallExpression[callee.name=\"useMemo\"]",
+        "message": "useMemo is banned. Prefer compiler / simpler code first."
+      },
+      {
+        "selector": "CallExpression[callee.object.name=\"React\"][callee.property.name=\"useMemo\"]",
+        "message": "React.useMemo is banned. Prefer compiler / simpler code first."
+      },
+      {
+        "selector": "CallExpression[callee.name=\"useCallback\"]",
+        "message": "useCallback is banned. Prefer compiler / simpler code first."
+      },
+      {
+        "selector": "CallExpression[callee.object.name=\"React\"][callee.property.name=\"useCallback\"]",
+        "message": "React.useCallback is banned. Prefer compiler / simpler code first."
+      },
+      {
+        "selector": "CallExpression[callee.property.name=\"then\"]",
+        "message": "Promise.then() is banned. Use async/await with try/catch instead."
+      },
+      {
+        "selector": "CallExpression[callee.property.name=\"catch\"]",
+        "message": "Promise.catch() is banned. Use async/await with try/catch instead."
+      },
+      {
+        "selector": "TSTypeReference[typeName.type=\"TSQualifiedName\"][typeName.left.name=\"React\"][typeName.right.name=\"ChangeEvent\"]",
+        "message": "React.ChangeEvent is banned. Import ChangeEvent directly from react."
+      },
+      {
+        "selector": "TSTypeReference[typeName.type=\"TSQualifiedName\"][typeName.left.name=\"React\"][typeName.right.name=\"MouseEvent\"]",
+        "message": "React.MouseEvent is banned. Import MouseEvent directly from react."
+      },
+      {
+        "selector": "TSTypeReference[typeName.type=\"TSQualifiedName\"][typeName.left.name=\"React\"][typeName.right.name=\"KeyboardEvent\"]",
+        "message": "React.KeyboardEvent is banned. Import KeyboardEvent directly from react."
+      },
+      {
+        "selector": "TSTypeReference[typeName.type=\"TSQualifiedName\"][typeName.left.name=\"React\"][typeName.right.name=\"FormEvent\"]",
+        "message": "React.FormEvent is banned. Import FormEvent directly from react."
+      },
+      {
+        "selector": "TSTypeReference[typeName.type=\"TSQualifiedName\"][typeName.left.name=\"React\"][typeName.right.name=\"FocusEvent\"]",
+        "message": "React.FocusEvent is banned. Import FocusEvent directly from react."
+      },
+      {
+        "selector": "TSTypeReference[typeName.type=\"TSQualifiedName\"][typeName.left.name=\"React\"][typeName.right.name=/.*Event$/]",
+        "message": "React.*Event types are banned. Import event types directly from react."
+      },
+      {
+        "selector": "AssignmentExpression[left.object.name=\"window\"][left.property.name=\"location\"]",
+        "message": "Direct window.location manipulation is banned. Prefer router navigation instead."
+      },
+      {
+        "selector": "MemberExpression[object.object.name=\"window\"][object.property.name=\"location\"][property.name=\"href\"]",
+        "message": "window.location.href is banned. Prefer router navigation instead."
+      },
+      {
+        "selector": "MemberExpression[object.object.name=\"window\"][object.property.name=\"location\"][property.name=\"assign\"]",
+        "message": "window.location.assign() is banned. Prefer router navigation instead."
+      },
+      {
+        "selector": "MemberExpression[object.object.name=\"window\"][object.property.name=\"location\"][property.name=\"replace\"]",
+        "message": "window.location.replace() is banned. Prefer router navigation instead."
+      },
+      {
+        "selector": "JSXOpeningElement[name.name=/./]:has(JSXAttribute[name.name=\"as\"][value.value=\"a\"]):not(:has(JSXAttribute[name.name=\"target\"][value.value=\"_blank\"]))",
+        "message": "as=\"a\" without target=\"_blank\" is banned. Prefer a safe Link component or add target for external links."
+      },
+      {
+        "selector": "JSXOpeningElement[name.name=\"a\"]:not(:has(JSXAttribute[name.name=\"target\"][value.value=\"_blank\"]))",
+        "message": "<a> without target=\"_blank\" is banned. Prefer a safe Link component or add target for external links."
+      }
+    ]
+  }
+}

package/configs/oxlint/vitest-kingsword.json

@@ -0,0 +1,10 @@
+{
+  "jsPlugins": [{ "name": "@kingsword", "specifier": "../../dist/index.cjs" }],
+  "rules": {
+    "@kingsword/vitest-no-focused-tests": "error",
+    "@kingsword/vitest-no-disabled-tests": "error",
+    "@kingsword/vitest-no-test-prefixes": "error",
+    "@kingsword/vitest-mock-require-actual": "error",
+    "@kingsword/vitest-mock-absolute-paths": "error"
+  }
+}

package/configs/oxlint/vitest-strict.json

@@ -0,0 +1,11 @@
+{
+  "extends": ["./vitest.json"],
+  "rules": {
+    "vitest/prefer-called-once": "error",
+    "vitest/prefer-called-times": "error",
+    "vitest/prefer-describe-function-title": "error",
+    "vitest/prefer-to-be-falsy": "error",
+    "vitest/prefer-to-be-object": "error",
+    "vitest/prefer-to-be-truthy": "error"
+  }
+}

package/configs/oxlint/vitest.json

@@ -0,0 +1,24 @@
+{
+  "plugins": ["unicorn", "typescript", "oxc", "vitest"],
+  "rules": {
+    "jest/expect-expect": "off",
+    "jest/no-conditional-expect": "off",
+    "jest/no-disabled-tests": "off",
+    "jest/no-export": "off",
+    "jest/no-focused-tests": "off",
+    "jest/no-standalone-expect": "off",
+    "jest/require-to-throw-message": "off",
+    "jest/valid-describe-callback": "off",
+    "jest/valid-expect": "off",
+    "jest/valid-title": "off",
+
+    "vitest/consistent-each-for": "error",
+    "vitest/hoisted-apis-on-top": "error",
+    "vitest/no-conditional-tests": "error",
+    "vitest/require-local-test-context-for-concurrent-snapshots": "error",
+    "vitest/warn-todo": "error",
+
+    "vitest/consistent-vitest-vi": "error",
+    "vitest/no-import-node-test": "error"
+  }
+}

package/dist/chunk-CbDLau6x.cjs

@@ -0,0 +1,34 @@
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") {
+		for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+			key = keys[i];
+			if (!__hasOwnProp.call(to, key) && key !== except) {
+				__defProp(to, key, {
+					get: ((k) => from[k]).bind(null, key),
+					enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+				});
+			}
+		}
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+
+Object.defineProperty(exports, '__toESM', {
+  enumerable: true,
+  get: function () {
+    return __toESM;
+  }
+});

package/dist/cli.cjs

@@ -0,0 +1,106 @@
+const require_chunk = require('./chunk-CbDLau6x.cjs');
+let tiny_bin = require("tiny-bin");
+tiny_bin = require_chunk.__toESM(tiny_bin);
+let node_fs = require("node:fs");
+let node_path = require("node:path");
+let node_url = require("node:url");
+
+//#region src/cli.ts
+const __dirname$1 = (0, node_path.dirname)((0, node_url.fileURLToPath)(require("url").pathToFileURL(__filename).href));
+const ALLOWED_PROFILES = [
+	"base",
+	"lib",
+	"react",
+	"backend",
+	"fullstack"
+];
+const ALLOWED_LEVELS = ["recommended", "strict"];
+const ALLOWED_TESTS = ["none", "vitest"];
+function getVersion() {
+	try {
+		const pkgPath = (0, node_path.join)(__dirname$1, "..", "package.json");
+		return JSON.parse((0, node_fs.readFileSync)(pkgPath, "utf-8")).version || "0.0.0";
+	} catch {
+		return "0.0.0";
+	}
+}
+function isAllowed(value, allowed) {
+	return allowed.includes(value);
+}
+function readPackageTypeNear(startDir) {
+	let current = (0, node_path.resolve)(startDir);
+	while (true) {
+		const packageJsonPath = (0, node_path.join)(current, "package.json");
+		if ((0, node_fs.existsSync)(packageJsonPath)) try {
+			return JSON.parse((0, node_fs.readFileSync)(packageJsonPath, "utf-8")).type === "module" ? "module" : "commonjs";
+		} catch {
+			return "commonjs";
+		}
+		const parent = (0, node_path.dirname)(current);
+		if (parent === current) return "commonjs";
+		current = parent;
+	}
+}
+function renderTsConfigCode(opts, moduleType) {
+	if (moduleType === "module") return [
+		"import { defineConfig } from \"oxlint\";",
+		"import { oxlint } from \"@kingsword/lint-config/config\";",
+		"",
+		`export default defineConfig(oxlint({ profile: "${opts.profile}", test: "${opts.test}", level: "${opts.level}" }));`,
+		""
+	].join("\n");
+	return [
+		"const { defineConfig } = require(\"oxlint\");",
+		"const { oxlint } = require(\"@kingsword/lint-config/config\");",
+		"",
+		`module.exports = defineConfig(oxlint({ profile: "${opts.profile}", test: "${opts.test}", level: "${opts.level}" }));`,
+		""
+	].join("\n");
+}
+const version = getVersion();
+(0, tiny_bin.default)("xlint", "Generate oxlint config presets for @kingsword/lint-config").package("@kingsword/lint-config", version).command("init", "Generate oxlint.config.ts").argument("[profile]", `Project profile (${ALLOWED_PROFILES.join(", ")})`).option("-f, --force", "Overwrite existing oxlint.config.ts").option("--profile <profile>", `Project profile (${ALLOWED_PROFILES.join(", ")})`).option("--test <test>", `Test mode (${ALLOWED_TESTS.join(", ")})`).option("--level <level>", `Strictness level (${ALLOWED_LEVELS.join(", ")})`).option("-o, --output <path>", "Output config file path (default: ./oxlint.config.ts)").option("--print", "Print the generated config to stdout (no write)").action((options, args) => {
+	const force = options.force === true;
+	const profileFromFlag = options.profile;
+	const profileFromPositional = args?.[0] || void 0;
+	const profileRaw = profileFromFlag || profileFromPositional || "lib";
+	const testRaw = options.test || "none";
+	const levelRaw = options.level || "recommended";
+	const print = options.print === true;
+	const outputRaw = options.output;
+	if (!isAllowed(profileRaw, ALLOWED_PROFILES)) {
+		console.error(`Unknown profile: ${profileRaw}`);
+		console.error(`Expected one of: ${ALLOWED_PROFILES.join(", ")}`);
+		process.exit(1);
+	}
+	if (!isAllowed(testRaw, ALLOWED_TESTS)) {
+		console.error(`Unknown test mode: ${testRaw}`);
+		console.error(`Expected one of: ${ALLOWED_TESTS.join(", ")}`);
+		process.exit(1);
+	}
+	if (!isAllowed(levelRaw, ALLOWED_LEVELS)) {
+		console.error(`Unknown level: ${levelRaw}`);
+		console.error(`Expected one of: ${ALLOWED_LEVELS.join(", ")}`);
+		process.exit(1);
+	}
+	const outAbs = outputRaw ? (0, node_path.resolve)(process.cwd(), outputRaw) : (0, node_path.resolve)(process.cwd(), "oxlint.config.ts");
+	const outDir = (0, node_path.dirname)(outAbs);
+	const moduleType = readPackageTypeNear(outDir);
+	const code = renderTsConfigCode({
+		profile: profileRaw,
+		test: testRaw,
+		level: levelRaw
+	}, moduleType);
+	if (print) {
+		process.stdout.write(code);
+		return;
+	}
+	if ((0, node_fs.existsSync)(outAbs) && !force) {
+		console.error(`Refusing to overwrite existing ${outAbs}. Use --force to overwrite.`);
+		process.exit(1);
+	}
+	(0, node_fs.mkdirSync)(outDir, { recursive: true });
+	(0, node_fs.writeFileSync)(outAbs, code);
+	console.log(`Wrote ${outAbs}`);
+}).run();
+
+//#endregion

package/dist/cli.d.cts

@@ -0,0 +1 @@
+export { };

package/dist/cli.d.mts

@@ -0,0 +1 @@
+export { };