@whoj/eslint-config 7.5.2 → 9.2.0

package/README.md

@@ -167,6 +167,72 @@ Add the following settings to your `.vscode/settings.json`:
 
 </details>
 
+<details>
+<summary>🔲 Zed support</summary>
+
+<br>
+
+Add the following settings to your `.zed/settings.json`:
+
+```jsonc
+{
+  // Use ESLint's --fix:
+  "code_actions_on_format": {
+    "source.fixAll.eslint": true
+  },
+  "formatter": [],
+  // Enable eslint for all supported languages
+  // Defaults only include https://github.com/search?q=repo%3Azed-industries%2Fzed%20eslint_languages&type=code
+  "languages": {
+    "HTML": {
+      "language_servers": ["...", "eslint"]
+    },
+    "Markdown": {
+      "language_servers": ["...", "eslint"]
+    },
+    "Markdown-Inline": {
+      "language_servers": ["...", "eslint"]
+    },
+    "JSON": {
+      "language_servers": ["...", "eslint"]
+    },
+    "JSONC": {
+      "language_servers": ["...", "eslint"]
+    },
+    "YAML": {
+      "language_servers": ["...", "eslint"]
+    },
+    "CSS": {
+      "language_servers": ["...", "eslint"]
+    }
+    // Add other languages as needed
+  },
+  "lsp": {
+    "eslint": {
+      "settings": {
+        "workingDirectories": ["./"],
+
+        // Silent the stylistic rules in your IDE, but still auto fix them
+        "rulesCustomizations": [
+          { "rule": "style/*", "severity": "off", "fixable": true },
+          { "rule": "format/*", "severity": "off", "fixable": true },
+          { "rule": "*-indent", "severity": "off", "fixable": true },
+          { "rule": "*-spacing", "severity": "off", "fixable": true },
+          { "rule": "*-spaces", "severity": "off", "fixable": true },
+          { "rule": "*-order", "severity": "off", "fixable": true },
+          { "rule": "*-dangle", "severity": "off", "fixable": true },
+          { "rule": "*-newline", "severity": "off", "fixable": true },
+          { "rule": "*quotes", "severity": "off", "fixable": true },
+          { "rule": "*semi", "severity": "off", "fixable": true }
+        ]
+      }
+    }
+  }
+}
+```
+
+</details>
+
 <details>
 <summary>🟩 Neovim Support</summary>
 
@@ -294,9 +360,9 @@ export default whoj.clone().overrides({
     },
   },
 }).disableRulesFix([
-  'unused-imports/no-unused-imports',
-  'test/no-only-tests',
   'prefer-const',
+  'test/no-only-tests',
+  'unused-imports/no-unused-imports',
 ], {
   builtinRules: () => import(['eslint', 'use-at-your-own-risk'].join('/')).then(r => r.builtinRules),
 });
@@ -346,6 +412,7 @@ export default whoj({
 
   // Or customize the stylistic rules
   stylistic: {
+    braceStyle: 'stroustrup', // '1tbs', or 'allman'
     indent: 2, // 4, or 'tab'
     quotes: 'single', // or 'double'
   },
@@ -510,7 +577,7 @@ export default whoj(
     },
   },
   {
-    // Without `files`, they are general rules for all files
+    // Without `files`, they are general rules for all files (Markdown excluded — see note below)
     rules: {
       'style/semi': ['error', 'never'],
     },
@@ -518,6 +585,9 @@ export default whoj(
 );
 ```
 
+> [!NOTE]
+> Rule overrides without an explicit `files` constraint are automatically excluded from Markdown files, via [`composer.setDefaultIgnores`](https://github.com/antfu/eslint-flat-config-utils#composersetdefaultignores). This prevents JS-only rules (e.g. `no-irregular-whitespace`, `perfectionist/sort-imports`) from crashing on `@eslint/markdown`'s `SourceCode`, which doesn't expose JS-specific methods like `getAllComments()`. If you want a rule to apply to Markdown, scope it explicitly with `files: ['**/*.md']`.
+
 We also provided the `overrides` options in each integration to make it easier:
 
 ```js
@@ -529,6 +599,10 @@ export default whoj({
     overrides: {
       'ts/consistent-type-definitions': ['error', 'interface'],
     },
+    // type aware rules overrides should write here
+    overridesTypeAware: {
+      'ts/no-unsafe-assignment': ['warn'],
+    }
   },
   vue: {
     overrides: {
@@ -679,7 +753,7 @@ export default whoj({
 Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
 
 ```bash
-npm i -D @eslint-react/eslint-plugin eslint-plugin-react-hooks eslint-plugin-react-refresh
+npm i -D @eslint-react/eslint-plugin eslint-plugin-react-refresh
 ```
 
 #### Next.js
@@ -849,6 +923,21 @@ export default whoj({
 });
 ```
 
+### Prettier
+
+If you're using prettier outside eslint, you can disable the config via etc:
+
+```js
+import antfu from '@antfu/eslint-config';
+import prettierConflicts from 'eslint-config-prettier';
+
+export default antfu({
+  rules: {
+    'some-rule': 'off'
+  }
+}, prettierConflicts);
+```
+
 ### Editor Specific Disables
 
 Auto-fixing for the following rules are disabled when ESLint is running in a code editor:

package/dist/cli.mjs

@@ -1,15 +1,14 @@
-import process from "node:process";
-import fs from "node:fs/promises";
-import fs$1 from "node:fs";
-import path from "node:path";
 import c, { green } from "ansis";
 import { cac } from "cac";
+import process from "node:process";
 import * as p from "@clack/prompts";
+import fs from "node:fs";
+import path from "node:path";
 import { execSync } from "node:child_process";
+import fsp from "node:fs/promises";
 import parse from "parse-gitignore";
 import { deepMerge } from "@whoj/utils-core";
 import { XMLBuilder, XMLParser } from "fast-xml-parser";
-
 //#region src/cli/utils.ts
 function isGitClean() {
 	try {
@@ -54,20 +53,21 @@ export default whoj.clone().overrides({
 })
 `.trimStart();
 }
-
 //#endregion
 //#region src/cli/stages/update-eslint-files.ts
+const ESLINT_OR_PRETTIER = /eslint|prettier/;
+const ESLINT_CONFIG = /eslint\.config\./;
 async function updateEslintFiles(result) {
 	const cwd = process.cwd();
 	const pathESLintIgnore = path.join(cwd, ".eslintignore");
 	const pathPackageJSON = path.join(cwd, "package.json");
-	const pkgContent = await fs.readFile(pathPackageJSON, "utf-8");
+	const pkgContent = await fsp.readFile(pathPackageJSON, "utf-8");
 	const configFileName = JSON.parse(pkgContent).type === "module" ? "eslint.config.js" : "eslint.config.mjs";
 	const pathFlatConfig = path.join(cwd, configFileName);
 	const eslintIgnores = [];
-	if (fs$1.existsSync(pathESLintIgnore)) {
+	if (fs.existsSync(pathESLintIgnore)) {
 		p.log.step(c.cyan`Migrating existing .eslintignore`);
-		const globs = parse(await fs.readFile(pathESLintIgnore, "utf-8")).globs();
+		const globs = parse(await fsp.readFile(pathESLintIgnore, "utf-8")).globs();
 		for (const glob of globs) if (glob.type === "ignore") eslintIgnores.push(...glob.patterns);
 		else if (glob.type === "unignore") eslintIgnores.push(...glob.patterns.map((pattern) => `!${pattern}`));
 	}
@@ -77,17 +77,16 @@ async function updateEslintFiles(result) {
 	if (result.extra.includes("unocss")) configLines.push("unocss: true,");
 	for (const framework of result.frameworks) configLines.push(`${framework}: true,`);
 	const eslintConfigContent = getEslintConfigContent(configLines.map((i) => `  ${i}`).join("\n"), []);
-	await fs.writeFile(pathFlatConfig, eslintConfigContent);
+	await fsp.writeFile(pathFlatConfig, eslintConfigContent);
 	p.log.success(c.green`Created ${configFileName}`);
-	const files = fs$1.readdirSync(cwd);
+	const files = fs.readdirSync(cwd);
 	const legacyConfig = [];
 	files.forEach((file) => {
-		if (/eslint|prettier/.test(file) && !/eslint\.config\./.test(file)) legacyConfig.push(file);
+		if (ESLINT_OR_PRETTIER.test(file) && !ESLINT_CONFIG.test(file)) legacyConfig.push(file);
 	});
 	if (legacyConfig.length) p.note(c.dim(legacyConfig.join(", ")), "You can now remove those files manually");
 	return configFileName;
 }
-
 //#endregion
 //#region src/cli/constants.ts
 const vscodeSettingsString = `
@@ -150,31 +149,31 @@ const frameworkOptions = [
 		value: "react",
 		label: c.cyan("React")
 	},
-	{
-		value: "svelte",
-		label: c.red("Svelte")
-	},
-	{
-		value: "astro",
-		label: c.magenta("Astro")
-	},
 	{
 		value: "solid",
 		label: c.cyan("Solid")
 	},
+	{
+		value: "svelte",
+		label: c.red("Svelte")
+	},
 	{
 		value: "slidev",
 		label: c.blue("Slidev")
+	},
+	{
+		value: "astro",
+		label: c.magenta("Astro")
 	}
 ];
 const frameworks = frameworkOptions.map(({ value }) => value);
 const extraOptions = [{
+	value: "unocss",
+	label: c.cyan("UnoCSS")
+}, {
 	value: "formatter",
 	label: c.red("Formatter"),
 	hint: "Use external formatters (Prettier and/or dprint) to format files that ESLint cannot handle yet (.css, .html, etc)"
-}, {
-	value: "unocss",
-	label: c.cyan("UnoCSS")
 }];
 const extra = extraOptions.map(({ value }) => value);
 const dependenciesMap = {
@@ -187,11 +186,7 @@ const dependenciesMap = {
 	formatterAstro: ["prettier-plugin-astro"],
 	astro: ["eslint-plugin-astro", "astro-eslint-parser"],
 	svelte: ["eslint-plugin-svelte", "svelte-eslint-parser"],
-	react: [
-		"@eslint-react/eslint-plugin",
-		"eslint-plugin-react-hooks",
-		"eslint-plugin-react-refresh"
-	]
+	react: ["@eslint-react/eslint-plugin", "eslint-plugin-react-refresh"]
 };
 const jetbrainsSettingsObj = {
 	"?xml": {
@@ -214,37 +209,33 @@ const jetbrainsSettingsObj = {
 		}
 	}
 };
-
 //#endregion
 //#region package.json
-var version = "7.5.2";
-
+var version = "9.2.0";
 //#endregion
 //#region src/cli/constants-generated.ts
 const versionsMap = {
-	"@eslint-react/eslint-plugin": "^2.12.4",
-	"@next/eslint-plugin-next": "^16.1.6",
-	"@unocss/eslint-plugin": "^66.6.0",
-	"astro-eslint-parser": "^1.2.2",
-	"eslint": "^9.39.2||^10.0.0",
-	"eslint-plugin-astro": "^1.5.0",
-	"eslint-plugin-format": "^1.4.0",
-	"eslint-plugin-react-hooks": "^7.0.1",
-	"eslint-plugin-react-refresh": "^0.5.0",
+	"@eslint-react/eslint-plugin": "^5.14.7",
+	"@next/eslint-plugin-next": "^16.2.10",
+	"@unocss/eslint-plugin": "^66.7.5",
+	"astro-eslint-parser": "^2.1 || ^3.0",
+	"eslint": "^9.0.0 || ^10.7.0",
+	"eslint-plugin-astro": "^2.1 || ^3.0",
+	"eslint-plugin-format": "^2.0.1",
+	"eslint-plugin-react-refresh": "^0.5.3",
 	"eslint-plugin-solid": "^0.14.5",
-	"eslint-plugin-svelte": "^3.15.0",
+	"eslint-plugin-svelte": "^3.20.0",
 	"prettier-plugin-astro": "^0.14.1",
 	"prettier-plugin-slidev": "^1.0.5",
-	"svelte-eslint-parser": "^1.4.1"
+	"svelte-eslint-parser": "^1.8.0"
 };
-
 //#endregion
 //#region src/cli/stages/update-package-json.ts
 async function updatePackageJson(result) {
 	const cwd = process.cwd();
 	const pathPackageJSON = path.join(cwd, "package.json");
 	p.log.step(c.cyan`Bumping @whoj/eslint-config to v${version}`);
-	const pkgContent = await fs.readFile(pathPackageJSON, "utf-8");
+	const pkgContent = await fsp.readFile(pathPackageJSON, "utf-8");
 	const pkg = JSON.parse(pkgContent);
 	pkg.devDependencies ??= {};
 	pkg.devDependencies["@whoj/eslint-config"] = `^${version}`;
@@ -275,10 +266,9 @@ async function updatePackageJson(result) {
 		});
 	}
 	if (addedPackages.length) p.note(c.dim(addedPackages.join(", ")), "Added packages");
-	await fs.writeFile(pathPackageJSON, JSON.stringify(pkg, null, 2));
+	await fsp.writeFile(pathPackageJSON, JSON.stringify(pkg, null, 2));
 	p.log.success(c.green`Changes wrote to package.json`);
 }
-
 //#endregion
 //#region src/cli/stages/update-jetbrains-idea.ts
 async function updateJetbrainsIdea(result, configFileName) {
@@ -296,12 +286,12 @@ async function updateJetbrainsIdea(result, configFileName) {
 	const cwd = process.cwd();
 	const ideaDir = path.join(cwd, ".idea");
 	const jsLintersDir = path.join(ideaDir, "jsLinters");
-	if (!fs$1.existsSync(ideaDir)) fs$1.mkdirSync(ideaDir, { recursive: true });
-	if (!fs$1.existsSync(jsLintersDir)) fs$1.mkdirSync(jsLintersDir, { recursive: true });
+	if (!fs.existsSync(ideaDir)) fs.mkdirSync(ideaDir, { recursive: true });
+	if (!fs.existsSync(jsLintersDir)) fs.mkdirSync(jsLintersDir, { recursive: true });
 	const eslintXmlPath = path.join(jsLintersDir, "eslint.xml");
 	let settings;
-	if (fs$1.existsSync(eslintXmlPath)) {
-		const content = fs$1.readFileSync(eslintXmlPath, "utf-8");
+	if (fs.existsSync(eslintXmlPath)) {
+		const content = fs.readFileSync(eslintXmlPath, "utf-8");
 		settings = deepMerge(xmlParser.parse(content), jetbrainsSettingsObj);
 		p.log.step(c.cyan`Updating existing JetBrains ESLint configuration`);
 	} else {
@@ -313,41 +303,40 @@ async function updateJetbrainsIdea(result, configFileName) {
 		path: `$PROJECT_DIR$/.idea/jsLinters/${configFileName}`
 	};
 	const xml = xmlBuilder.build(settings);
-	fs$1.writeFileSync(eslintXmlPath, xml, "utf-8");
+	fs.writeFileSync(eslintXmlPath, xml, "utf-8");
 	const jetbrainsConfigPath = path.join(jsLintersDir, configFileName);
 	const configContent = getJetbrainsEslintConfigContent(path.relative(jsLintersDir, path.join(cwd, configFileName)));
-	fs$1.writeFileSync(jetbrainsConfigPath, configContent, "utf-8");
+	fs.writeFileSync(jetbrainsConfigPath, configContent, "utf-8");
 	p.log.success(c.green`JetBrains ESLint configuration updated`);
 }
-
 //#endregion
 //#region src/cli/stages/update-vscode-settings.ts
+const LAST_LINE_PATTERN = /\s*\}$/;
 async function updateVscodeSettings(result) {
 	const cwd = process.cwd();
 	if (!result.updateVscodeSettings) return;
 	const dotVscodePath = path.join(cwd, ".vscode");
 	const settingsPath = path.join(dotVscodePath, "settings.json");
-	if (!fs$1.existsSync(dotVscodePath)) await fs.mkdir(dotVscodePath, { recursive: true });
-	if (!fs$1.existsSync(settingsPath)) {
-		await fs.writeFile(settingsPath, `{${vscodeSettingsString}}\n`, "utf-8");
+	if (!fs.existsSync(dotVscodePath)) await fsp.mkdir(dotVscodePath, { recursive: true });
+	if (!fs.existsSync(settingsPath)) {
+		await fsp.writeFile(settingsPath, `{${vscodeSettingsString}}\n`, "utf-8");
 		p.log.success(green`Created .vscode/settings.json`);
 	} else {
-		let settingsContent = await fs.readFile(settingsPath, "utf8");
-		settingsContent = settingsContent.trim().replace(/\s*\}$/, "");
+		let settingsContent = await fsp.readFile(settingsPath, "utf8");
+		settingsContent = settingsContent.trim().replace(LAST_LINE_PATTERN, "");
 		settingsContent += settingsContent.endsWith(",") || settingsContent.endsWith("{") ? "" : ",";
 		settingsContent += `${vscodeSettingsString}}\n`;
-		await fs.writeFile(settingsPath, settingsContent, "utf-8");
+		await fsp.writeFile(settingsPath, settingsContent, "utf-8");
 		p.log.success(green`Updated .vscode/settings.json`);
 	}
 }
-
 //#endregion
 //#region src/cli/run.ts
 async function run({ jetbrains, ...options } = {}) {
 	const argSkipPrompt = !!process.env.SKIP_PROMPT || options.yes;
 	const argTemplate = options.frameworks?.map((m) => m?.trim()).filter(Boolean);
 	const argExtra = options.extra?.map((m) => m?.trim()).filter(Boolean);
-	if (fs$1.existsSync(path.join(process.cwd(), "eslint.config.js"))) {
+	if (fs.existsSync(path.join(process.cwd(), "eslint.config.js"))) {
 		p.log.warn(c.yellow`eslint.config.js already exists, migration wizard exited.`);
 		return process.exit(1);
 	}
@@ -378,7 +367,7 @@ async function run({ jetbrains, ...options } = {}) {
 				});
 			},
 			extra: ({ results }) => {
-				const isArgExtraValid = argExtra?.length && !argExtra.filter((element) => !extra.includes(element)).length;
+				const isArgExtraValid = argExtra?.length && argExtra.every((element) => extra.includes(element));
 				if (!results.uncommittedConfirmed || isArgExtraValid) return;
 				const message = !isArgExtraValid && argExtra ? `"${argExtra}" isn't a valid extra util. Please choose from below: ` : "Select a extra utils:";
 				return p.multiselect({
@@ -414,7 +403,6 @@ async function run({ jetbrains, ...options } = {}) {
 	p.log.success(c.green`Setup completed`);
 	p.outro(`Now you can update the dependencies by run ${c.blue("pnpm install")} and run ${c.blue("eslint --fix")}\n`);
 }
-
 //#endregion
 //#region src/cli/index.ts
 function header() {
@@ -422,11 +410,7 @@ function header() {
 	p.intro(`${c.green`@whoj/eslint-config `}${c.dim`v${version}`}`);
 }
 const cli = cac("@whoj/eslint-config");
-cli.command("", "Run the initialization or migration").option("--yes, -y", "Skip prompts and use default values", { default: false }).option("--template, -t <template>", "Use the framework template for optimal customization: vue / react / svelte / astro", { type: [] }).option("--extra, -e <extra>", "Use the extra utils: formatter / perfectionist / unocss", { type: [] }).option("--jetbrains", "Configure eslint settings for better Jetbrains IDE. (WebStorm / PhpStorm) experience.", {
-	default: true,
-	type: "boolean",
-	alias: ["idea", "j"]
-}).action(async (args) => {
+cli.command("", "Run the initialization or migration").option("--yes, -y", "Skip prompts and use default values", { default: false }).option("--template, -t <template>", "Use the framework template for optimal customization: vue / react / svelte / astro", { type: [] }).option("--extra, -e <extra>", "Use the extra utils: formatter / perfectionist / unocss", { type: [] }).option("--jetbrains, --idea, -j", "Configure eslint settings for better Jetbrains IDE. (WebStorm / PhpStorm) experience.", { default: true }).action(async (args) => {
 	header();
 	try {
 		await run(args);
@@ -439,6 +423,5 @@ cli.command("", "Run the initialization or migration").option("--yes, -y", "Skip
 cli.help();
 cli.version(version);
 cli.parse();
-
 //#endregion
-export {  };
+export {};