@oliver139/eslint-config 4.1.0 → 4.2.1

package/README.md

@@ -20,11 +20,6 @@
 - Respects `.gitignore` by default
 - Requires ESLint v9.5.0+
 
-> [!NOTE]
-> Since v1.0.0, this config is rewritten to the new [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new), check the [release note](https://github.com/antfu/eslint-config/releases/tag/v1.0.0) for more details.
->
-> Since v3.0.0, ESLint v9.5.0+ is now required.
-
 > [!WARNING]
 > I am super appreciative and even a bit flattered that so many of you are fond of using this config. For that reason, I tried to make it as flexible and customizable as possible to fit more use cases.
 >
@@ -808,8 +803,11 @@ Auto-fixing for the following rules are disabled when ESLint is running in a cod
 - [`prefer-const`](https://eslint.org/docs/rules/prefer-const)
 - [`test/no-only-tests`](https://github.com/levibuzolic/eslint-plugin-no-only-tests)
 - [`unused-imports/no-unused-imports`](https://www.npmjs.com/package/eslint-plugin-unused-imports)
+- [`pnpm/json-enforce-catalog`](https://github.com/antfu/pnpm-workspace-utils/tree/main/packages/eslint-plugin-pnpm#rules)
+- [`pnpm/json-prefer-workspace-settings`](https://github.com/antfu/pnpm-workspace-utils/tree/main/packages/eslint-plugin-pnpm#rules)
+- [`pnpm/json-valid-catalog`](https://github.com/antfu/pnpm-workspace-utils/tree/main/packages/eslint-plugin-pnpm#rules)
 
-Since v3.16.0, they are no longer disabled, but made non-fixable using [this helper](https://github.com/antfu/eslint-flat-config-utils#composerdisablerulesfix).
+> Since v3.16.0, they are no longer disabled, but made non-fixable using [this helper](https://github.com/antfu/eslint-flat-config-utils#composerdisablerulesfix).
 
 This is to prevent unused imports from getting removed by the editor during refactoring to get a better developer experience. Those rules will be applied when you run ESLint in the terminal or [Lint Staged](#lint-staged). If you don't want this behavior, you can disable them:
 
@@ -891,6 +889,10 @@ If you enjoy this code style, and would like to mention it in your project, here
 
 Well, you can still use Prettier to format files that are not supported well by ESLint yet, such as `.css`, `.html`, etc. See [formatters](#formatters) for more details.
 
+### oxlint?
+
+We do have a plan to integrate [oxlint](https://github.com/oxc-project/oxc) in someway to speed up the linting process. However there are still some blocks we are waiting for. Track the progress [in this issue: **Oxlint Integration Plan**](https://github.com/antfu/eslint-config/issues/767).
+
 ### dprint?
 
 [dprint](https://dprint.dev/) is also a great formatter that with more abilities to customize. However, it's in the same model as Prettier which reads the AST and reprints the code from scratch. This means it's similar to Prettier, which ignores the original line breaks and might also cause the inconsistent diff. So in general, we prefer to use ESLint to format and lint JavaScript/TypeScript code.

package/bin/index.mjs

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import '../dist/cli.mjs'

package/dist/{cli.js → cli.mjs}

@@ -1,15 +1,15 @@
 import process from "node:process";
+import fsPromises from "node:fs/promises";
+import fs from "node:fs";
+import path from "node:path";
 import * as p from "@clack/prompts";
 import c, { green } from "ansis";
 import { cac } from "cac";
-import fs from "node:fs";
-import path from "node:path";
-import fsp from "node:fs/promises";
 import parse from "parse-gitignore";
 import { execSync } from "node:child_process";
 
 //#region package.json
-var version = "4.1.0";
+var version = "4.2.1";
 
 //#endregion
 //#region src/cli/constants.ts
@@ -143,13 +143,13 @@ async function updateEslintFiles(result) {
 	const cwd = process.cwd();
 	const pathESLintIgnore = path.join(cwd, ".eslintignore");
 	const pathPackageJSON = path.join(cwd, "package.json");
-	const pkgContent = await fsp.readFile(pathPackageJSON, "utf-8");
+	const pkgContent = await fsPromises.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.existsSync(pathESLintIgnore)) {
 		p.log.step(c.cyan`Migrating existing .eslintignore`);
-		const globs = parse(await fsp.readFile(pathESLintIgnore, "utf-8")).globs();
+		const globs = parse(await fsPromises.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}`));
 	}
@@ -159,7 +159,7 @@ 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 fsp.writeFile(pathFlatConfig, eslintConfigContent);
+	await fsPromises.writeFile(pathFlatConfig, eslintConfigContent);
 	p.log.success(c.green`Created ${configFileName}`);
 	const files = fs.readdirSync(cwd);
 	const legacyConfig = [];
@@ -172,20 +172,20 @@ async function updateEslintFiles(result) {
 //#endregion
 //#region src/cli/constants-generated.ts
 const versionsMap = {
-	"@eslint-react/eslint-plugin": "^2.2.4",
-	"@next/eslint-plugin-next": "^16.0.1",
-	"@unocss/eslint-plugin": "^66.5.4",
+	"@eslint-react/eslint-plugin": "^2.3.13",
+	"@next/eslint-plugin-next": "^16.1.0",
+	"@unocss/eslint-plugin": "^66.5.10",
 	"astro-eslint-parser": "^1.2.2",
-	"eslint": "^9.38.0",
-	"eslint-plugin-astro": "^1.4.0",
-	"eslint-plugin-format": "^1.0.2",
+	"eslint": "^9.39.2",
+	"eslint-plugin-astro": "^1.5.0",
+	"eslint-plugin-format": "^1.1.0",
 	"eslint-plugin-react-hooks": "^7.0.1",
-	"eslint-plugin-react-refresh": "^0.4.24",
+	"eslint-plugin-react-refresh": "^0.4.26",
 	"eslint-plugin-solid": "^0.14.5",
-	"eslint-plugin-svelte": "^3.13.0",
+	"eslint-plugin-svelte": "^3.13.1",
 	"prettier-plugin-astro": "^0.14.1",
 	"prettier-plugin-slidev": "^1.0.5",
-	"svelte-eslint-parser": "^1.4.0"
+	"svelte-eslint-parser": "^1.4.1"
 };
 
 //#endregion
@@ -194,7 +194,7 @@ async function updatePackageJson(result) {
 	const cwd = process.cwd();
 	const pathPackageJSON = path.join(cwd, "package.json");
 	p.log.step(c.cyan`Bumping @oliver139/eslint-config to v${version}`);
-	const pkgContent = await fsp.readFile(pathPackageJSON, "utf-8");
+	const pkgContent = await fsPromises.readFile(pathPackageJSON, "utf-8");
 	const pkg = JSON.parse(pkgContent);
 	pkg.devDependencies ??= {};
 	pkg.devDependencies["@oliver139/eslint-config"] = `^${version}`;
@@ -225,7 +225,7 @@ async function updatePackageJson(result) {
 		});
 	}
 	if (addedPackages.length) p.note(c.dim(addedPackages.join(", ")), "Added packages");
-	await fsp.writeFile(pathPackageJSON, JSON.stringify(pkg, null, 2));
+	await fsPromises.writeFile(pathPackageJSON, JSON.stringify(pkg, null, 2));
 	p.log.success(c.green`Changes wrote to package.json`);
 }
 
@@ -236,16 +236,16 @@ async function updateVscodeSettings(result) {
 	if (!result.updateVscodeSettings) return;
 	const dotVscodePath = path.join(cwd, ".vscode");
 	const settingsPath = path.join(dotVscodePath, "settings.json");
-	if (!fs.existsSync(dotVscodePath)) await fsp.mkdir(dotVscodePath, { recursive: true });
+	if (!fs.existsSync(dotVscodePath)) await fsPromises.mkdir(dotVscodePath, { recursive: true });
 	if (!fs.existsSync(settingsPath)) {
-		await fsp.writeFile(settingsPath, `{${vscodeSettingsString}}\n`, "utf-8");
+		await fsPromises.writeFile(settingsPath, `{${vscodeSettingsString}}\n`, "utf-8");
 		p.log.success(green`Created .vscode/settings.json`);
 	} else {
-		let settingsContent = await fsp.readFile(settingsPath, "utf8");
+		let settingsContent = await fsPromises.readFile(settingsPath, "utf8");
 		settingsContent = settingsContent.trim().replace(/\s*\}$/, "");
 		settingsContent += settingsContent.endsWith(",") || settingsContent.endsWith("{") ? "" : ",";
 		settingsContent += `${vscodeSettingsString}}\n`;
-		await fsp.writeFile(settingsPath, settingsContent, "utf-8");
+		await fsPromises.writeFile(settingsPath, settingsContent, "utf-8");
 		p.log.success(green`Updated .vscode/settings.json`);
 	}
 }