@weapp-vite/oxlint 0.0.0-stage → 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 ice breaker
+
+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

@@ -1,3 +1,43 @@
-# Temporary Holding Version
+# @weapp-vite/oxlint
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+为原生、Wevu 与 React 小程序提供 Oxlint 脚本规则预设及组合语言检查 CLI。规则复用 `@weapp-vite/eslint` 的运行时 API 与 Wevu 兼容清单；不会给小程序源码启用浏览器或 Node.js 环境。
+
+```ts
+import { miniProgramRecommended } from '@weapp-vite/oxlint'
+import { defineConfig } from 'vite-plus'
+
+export default defineConfig({
+  lint: miniProgramRecommended,
+})
+```
+
+Wevu 项目使用 `wevuRecommended`，React 项目使用 `reactRecommended`。Vite Plus 模板使用 Vite+ 1.2.0，其内置 Oxlint 为 1.88.0。预设通过 `@weapp-vite/oxlint/plugin` 注册自己的 JS 插件，无须额外安装另一份 Oxlint。
+
+| 规则 | 级别 | 适用预设 |
+| --- | --- | --- |
+| `weapp-vite/no-unsupported-runtime-api` | error | 原生、React、Wevu |
+| `weapp-vite/no-implicit-runtime-polyfill` | warn | 原生、React、Wevu |
+| `weapp-vite/no-unsupported-api` | error | Wevu |
+| `weapp-vite/no-risky-api` | warn | Wevu |
+| `react/rules-of-hooks` | error | React |
+| `react/exhaustive-deps` | warn | React |
+
+运行时规则只检查 `src` 下的 JS、TS、JSX、TSX 和 Vue 脚本；忽略测试、脚本、Web-only 文件、`node.*`、受管支持文件及生成产物。局部变量、显式兼容实现导入、`typeof` 能力探针与类型引用不会被当成隐式宿主 API。
+
+`no-debugger` 与 `eqeqeq` 默认报错，Oxlint correctness 类规则默认警告。React 预设额外启用内置 React 插件，检查 Hooks 调用顺序和依赖数组，仍保留小程序宿主的 API 边界。配置与构建脚本使用独立的 Node.js 环境。
+
+Wevu 预设启用 Oxlint 内置 Vue 规则。Oxlint 不提供 `vue-eslint-parser` 的完整模板访问接口，需要 parser services 的 Vue 模板检查继续使用 ESLint 的 `wevu/no-unsupported-template-feature`。WXSS、ACSS、TTSS、QSS、JXSS、TYSS、CSS、SCSS 和 Vue `<style>` 的语义检查继续使用 Stylelint，关闭与 Oxfmt 重复的格式规则。
+
+```sh
+pnpm exec weapp-vite-lint
+pnpm exec weapp-vite-lint --fix
+pnpm exec weapp-vite-lint --native-only
+```
+
+组合 CLI 执行标准 `vp lint`，并使用 `@weapp-vite/language-service` 检查 WXML、AXML、TTML、SWAN、JXML、QML、KSML、XHSML、TYML，以及独立/内联 WXS、SJS、KS、filter 和对应编译源文件。`--fix` 只自动修复 Oxlint 负责的内容，原生语言错误需修改源码；`--native-only` 单独运行平台语言诊断。`--deny-warnings` 将语言警告一并计为失败。
+
+平台配置放在 `vite.config.ts` 的 `weapp.language` 中，支持按文件 glob 覆盖；SJS 等共享后缀存在歧义或引用冲突时需明确平台。原生模块按平台的模块系统和内建 API 校验，不能把 AppService 的 JS/TS 规则套在所有脚本模块上。配置、诊断偏移和作用域模型与 VSCode 共用。
+
+普通 `vp lint` / `oxlint` 仍可直接使用这些预设，但不会替代组合 CLI 的原生语言检查。此工具不新增完整模板类型检查器；静态检查、VSCode 与构建通过不代表真实小程序 IDE runtime 已验收。
+
+可直接展开预设再添加 `rules` 或 `overrides`；添加 override 时保留预设的 `overrides` 数组，避免取消运行时代码范围约束。

package/dist/cli.d.mts

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

package/dist/cli.mjs

@@ -0,0 +1,65 @@
+#!/usr/bin/env node
+import process from "node:process";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import { analyzeProject, loadProjectConfig, printDiagnostic } from "@weapp-vite/language-service/project";
+import { execa } from "execa";
+// src/project.ts
+/** 原生语言分析与标准 Oxlint 分别处理所属文件，避免未知后缀被静默跳过。 */
+async function runLint(args, cwd = process.cwd()) {
+	const inputs = [];
+	const flags = [];
+	let nativeOnly = false;
+	let configFile;
+	for (let index = 0; index < args.length; index++) {
+		const argument = args[index];
+		if (argument === "--native-only") nativeOnly = true;
+		else if (argument === "--fix" || argument === "--deny-warnings") flags.push(argument);
+		else if (argument === "-c" || argument === "--config") {
+			configFile = args[++index];
+			if (!configFile || configFile.startsWith("-")) throw new Error("--config 需要配置文件路径");
+			flags.push(argument, configFile);
+		} else if (argument === "-h" || argument === "--help") {
+			process.stdout.write("weapp-vite-lint [--fix] [--deny-warnings] [--native-only] [-c config] [paths...]\n");
+			return;
+		} else if (argument.startsWith("-")) throw new Error(`未知参数：${argument}`);
+		else inputs.push(argument);
+	}
+	const project = await loadProjectConfig(cwd, {
+		configFile,
+		configKind: "lint"
+	});
+	const paths = inputs.length ? inputs : ["."];
+	const scopedInputs = paths.map((input) => {
+		const negative = input.startsWith("!");
+		const relative = path.relative(project.root, path.resolve(cwd, negative ? input.slice(1) : input)).split(path.sep).join("/");
+		return `${negative ? "!" : ""}${relative || "."}`;
+	});
+	const documents = await analyzeProject(project.root, scopedInputs, project.language, project.lint?.ignorePatterns);
+	let failed = false;
+	for (const document of documents) for (const diagnostic of document.analysis.diagnostics) {
+		process.stderr.write(`${printDiagnostic(document.fileName, document.source, diagnostic)}\n`);
+		failed ||= diagnostic.severity === "error" || diagnostic.severity === "warning" && flags.includes("--deny-warnings");
+	}
+	if (!nativeOnly) {
+		const vp = fileURLToPath(new URL("../bin/vp", import.meta.resolve("vite-plus")));
+		const result = await execa(process.execPath, [
+			vp,
+			"lint",
+			...flags,
+			...paths
+		], {
+			cwd,
+			stdio: "inherit",
+			reject: false
+		});
+		failed ||= result.exitCode !== 0;
+	}
+	if (failed) process.exitCode = 1;
+}
+// src/cli.ts
+runLint(process.argv.slice(2)).catch((error) => {
+	process.stderr.write(`${error instanceof Error ? error.message : String(error)}\n`);
+	process.exitCode = 1;
+});
+export {};

package/dist/index.d.mts

@@ -0,0 +1,160 @@
+/** 原生小程序的脚本检查预设，不启用浏览器或 DOM 环境。 */
+export declare const miniProgramRecommended: {
+  categories: {
+    correctness: "warn";
+  };
+  env: {
+    builtin: true;
+    browser: false;
+    node: false;
+  };
+  jsPlugins: {
+    name: string;
+    specifier: string;
+  }[];
+  ignorePatterns: string[];
+  rules: {
+    'no-debugger': "error";
+    eqeqeq: "error";
+  };
+  overrides: ({
+    files: string[];
+    excludeFiles: string[];
+    globals: {
+      App: "readonly";
+      Page: "readonly";
+      Component: "readonly";
+      Behavior: "readonly";
+      getApp: "readonly";
+      getCurrentPages: "readonly";
+      wx: "readonly";
+      require: "readonly";
+    };
+    rules: {
+      'weapp-vite/no-unsupported-api': "error";
+      'weapp-vite/no-risky-api': "warn";
+      'weapp-vite/no-unsupported-runtime-api': "error";
+      'weapp-vite/no-implicit-runtime-polyfill': "warn";
+    } | {
+      'weapp-vite/no-unsupported-runtime-api': "error";
+      'weapp-vite/no-implicit-runtime-polyfill': "warn";
+    };
+    env?: undefined;
+  } | {
+    files: string[];
+    env: {
+      node: true;
+    };
+    excludeFiles?: undefined;
+    globals?: undefined;
+    rules?: undefined;
+  })[];
+};
+/** 在小程序脚本检查基础上增加 Wevu 的上游 API 兼容诊断。 */
+export declare const wevuRecommended: {
+  plugins: ("unicorn" | "typescript" | "oxc" | "vue")[];
+  categories: {
+    correctness: "warn";
+  };
+  env: {
+    builtin: true;
+    browser: false;
+    node: false;
+  };
+  jsPlugins: {
+    name: string;
+    specifier: string;
+  }[];
+  ignorePatterns: string[];
+  rules: {
+    'no-debugger': "error";
+    eqeqeq: "error";
+  };
+  overrides: ({
+    files: string[];
+    excludeFiles: string[];
+    globals: {
+      App: "readonly";
+      Page: "readonly";
+      Component: "readonly";
+      Behavior: "readonly";
+      getApp: "readonly";
+      getCurrentPages: "readonly";
+      wx: "readonly";
+      require: "readonly";
+    };
+    rules: {
+      'weapp-vite/no-unsupported-api': "error";
+      'weapp-vite/no-risky-api': "warn";
+      'weapp-vite/no-unsupported-runtime-api': "error";
+      'weapp-vite/no-implicit-runtime-polyfill': "warn";
+    } | {
+      'weapp-vite/no-unsupported-runtime-api': "error";
+      'weapp-vite/no-implicit-runtime-polyfill': "warn";
+    };
+    env?: undefined;
+  } | {
+    files: string[];
+    env: {
+      node: true;
+    };
+    excludeFiles?: undefined;
+    globals?: undefined;
+    rules?: undefined;
+  })[];
+};
+/** React 小程序增加 Hooks 约束，仍沿用小程序宿主环境。 */
+export declare const reactRecommended: {
+  plugins: ("react" | "unicorn" | "typescript" | "oxc")[];
+  rules: {
+    'react/rules-of-hooks': "error";
+    'react/exhaustive-deps': "warn";
+    'no-debugger': "error";
+    eqeqeq: "error";
+  };
+  categories: {
+    correctness: "warn";
+  };
+  env: {
+    builtin: true;
+    browser: false;
+    node: false;
+  };
+  jsPlugins: {
+    name: string;
+    specifier: string;
+  }[];
+  ignorePatterns: string[];
+  overrides: ({
+    files: string[];
+    excludeFiles: string[];
+    globals: {
+      App: "readonly";
+      Page: "readonly";
+      Component: "readonly";
+      Behavior: "readonly";
+      getApp: "readonly";
+      getCurrentPages: "readonly";
+      wx: "readonly";
+      require: "readonly";
+    };
+    rules: {
+      'weapp-vite/no-unsupported-api': "error";
+      'weapp-vite/no-risky-api': "warn";
+      'weapp-vite/no-unsupported-runtime-api': "error";
+      'weapp-vite/no-implicit-runtime-polyfill': "warn";
+    } | {
+      'weapp-vite/no-unsupported-runtime-api': "error";
+      'weapp-vite/no-implicit-runtime-polyfill': "warn";
+    };
+    env?: undefined;
+  } | {
+    files: string[];
+    env: {
+      node: true;
+    };
+    excludeFiles?: undefined;
+    globals?: undefined;
+    rules?: undefined;
+  })[];
+};

package/dist/index.mjs

@@ -0,0 +1,93 @@
+import { MINI_PROGRAM_RUNTIME_DEFAULT_FILES, MINI_PROGRAM_RUNTIME_DEFAULT_IGNORES } from "@weapp-vite/eslint";
+// src/index.ts
+const runtimeRules = {
+	"weapp-vite/no-unsupported-runtime-api": "error",
+	"weapp-vite/no-implicit-runtime-polyfill": "warn"
+};
+const compatibilityRules = {
+	"weapp-vite/no-unsupported-api": "error",
+	"weapp-vite/no-risky-api": "warn"
+};
+function createPreset(wevu) {
+	return {
+		categories: { correctness: "warn" },
+		env: {
+			builtin: true,
+			browser: false,
+			node: false
+		},
+		jsPlugins: [{
+			name: "weapp-vite",
+			specifier: "@weapp-vite/oxlint/plugin"
+		}],
+		ignorePatterns: [
+			"**/node_modules/**",
+			"**/dist/**",
+			"**/dist-*/**",
+			"**/.weapp-vite/**",
+			"**/miniprogram_npm/**",
+			"**/generated/**"
+		],
+		rules: {
+			"no-debugger": "error",
+			"eqeqeq": "error"
+		},
+		overrides: [{
+			files: [...MINI_PROGRAM_RUNTIME_DEFAULT_FILES],
+			excludeFiles: [
+				...MINI_PROGRAM_RUNTIME_DEFAULT_IGNORES,
+				"**/*.{wxs,sjs,ks}.{js,ts}",
+				"**/*.filter.{js,ts}"
+			],
+			globals: {
+				App: "readonly",
+				Page: "readonly",
+				Component: "readonly",
+				Behavior: "readonly",
+				getApp: "readonly",
+				getCurrentPages: "readonly",
+				wx: "readonly",
+				require: "readonly"
+			},
+			rules: wevu ? {
+				...runtimeRules,
+				...compatibilityRules
+			} : { ...runtimeRules }
+		}, {
+			files: [
+				"*.config.*",
+				"scripts/**",
+				"**/*.{test,spec}.{js,mjs,cjs,jsx,ts,mts,cts,tsx}"
+			],
+			env: { node: true }
+		}]
+	};
+}
+/** 原生小程序的脚本检查预设，不启用浏览器或 DOM 环境。 */
+const miniProgramRecommended = createPreset(false);
+/** 在小程序脚本检查基础上增加 Wevu 的上游 API 兼容诊断。 */
+const wevuRecommended = {
+	...createPreset(true),
+	plugins: [
+		"typescript",
+		"unicorn",
+		"oxc",
+		"vue"
+	]
+};
+/** React 小程序增加 Hooks 约束，仍沿用小程序宿主环境。 */
+const reactRecommended = {
+	...createPreset(false),
+	plugins: [
+		"typescript",
+		"unicorn",
+		"oxc",
+		"react"
+	],
+	rules: {
+		...miniProgramRecommended.rules,
+		"react/rules-of-hooks": "error",
+		"react/exhaustive-deps": "warn"
+	}
+};
+export { miniProgramRecommended, reactRecommended, wevuRecommended };

package/dist/plugin.d.mts

@@ -0,0 +1,13 @@
+/** 复用 ESLint 的脚本规则及能力清单；Vue 模板规则仍由 vue-eslint-parser 执行。 */
+declare const plugin: {
+  meta: {
+    name: string;
+  };
+  rules: {
+    'no-unsupported-api': import("eslint").Rule.RuleModule;
+    'no-risky-api': import("eslint").Rule.RuleModule;
+    'no-unsupported-runtime-api': import("eslint").Rule.RuleModule;
+    'no-implicit-runtime-polyfill': import("eslint").Rule.RuleModule;
+  };
+};
+export { plugin as default };

package/dist/plugin.mjs

@@ -0,0 +1,12 @@
+import { miniProgramRuntimePlugin, wevuCompatibilityPlugin } from "@weapp-vite/eslint";
+// src/plugin.ts
+/** 复用 ESLint 的脚本规则及能力清单；Vue 模板规则仍由 vue-eslint-parser 执行。 */
+const plugin = {
+	meta: { name: "weapp-vite" },
+	rules: {
+		...miniProgramRuntimePlugin.rules,
+		"no-unsupported-api": wevuCompatibilityPlugin.rules["no-unsupported-api"],
+		"no-risky-api": wevuCompatibilityPlugin.rules["no-risky-api"]
+	}
+};
+export { plugin as default };

package/package.json

@@ -1,6 +1,87 @@
 {
   "name": "@weapp-vite/oxlint",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "type": "module",
+  "version": "0.0.0",
+  "description": "Oxlint presets and mini-program compatibility rules for weapp-vite",
+  "license": "MIT",
+  "homepage": "https://vite.weapp.dev/packages/oxlint",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/weapp-vite/weapp-vite.git",
+    "directory": "packages/oxlint"
+  },
+  "bugs": {
+    "url": "https://github.com/weapp-vite/weapp-vite/issues"
+  },
+  "keywords": [
+    "weapp-vite",
+    "miniprogram",
+    "oxlint",
+    "lint"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    },
+    "./plugin": {
+      "types": "./dist/plugin.d.mts",
+      "import": "./dist/plugin.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "bin": {
+    "weapp-vite-lint": "./dist/cli.mjs"
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": "^22.23.4 || ^24.22.1 || >=26.12.1"
+  },
+  "peerDependencies": {
+    "vite-plus": ">=1.2.0 <2"
+  },
+  "peerDependenciesMeta": {
+    "vite-plus": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@types/eslint": "^9.6.1",
+    "@weapp-vite/eslint": "0.3.0",
+    "@weapp-vite/language-service": "0.0.0",
+    "execa": "^10.2.1"
+  },
+  "devDependencies": {
+    "eslint": "^10.14.0",
+    "typescript": "^6.0.3",
+    "vite-plus": "1.2.0",
+    "vitest": "^5.0.5"
+  },
+  "tsd": {
+    "compilerOptions": {
+      "module": "NodeNext",
+      "moduleResolution": "NodeNext",
+      "strict": true,
+      "skipLibCheck": false
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "test": "vitest run --config ./vitest.config.ts",
+    "test:types": "pnpm build && pnpm run test:types:check",
+    "test:types:check": "tsd --files \"test-d/**/*.test-d.ts\"",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  }
 }