@antfu/eslint-config 9.4.1 → 9.5.1

package/README.md

@@ -336,36 +336,38 @@ And that's it! Or you can configure each integration individually, for example:
 import antfu from '@antfu/eslint-config'
 
 export default antfu({
-  // Type of the project. 'lib' for libraries, the default is 'app'
+  /** Type of the project. 'lib' for libraries, the default is 'app' */
   type: 'lib',
 
-  // `.eslintignore` is no longer supported in Flat config, use `ignores` instead
-  // The `ignores` option in the option (first argument) is specifically treated to always be global ignores
-  // And will **extend** the config's default ignores, not override them
-  // You can also pass a function to modify the default ignores
+  /**
+   * `.eslintignore` is no longer supported in Flat config, use `ignores` instead
+   * The `ignores` option in the option (first argument) is specifically treated to always be global ignores
+   * And will **extend** the config's default ignores, not override them
+   * You can also pass a function to modify the default ignores
+   */
   ignores: [
     '**/fixtures',
     // ...globs
   ],
 
-  // Parse the `.gitignore` file to get the ignores, on by default
+  /** Parse the `.gitignore` file to get the ignores, on by default */
   gitignore: true,
 
   // Enable stylistic formatting rules
   // stylistic: true,
 
-  // Or customize the stylistic rules
+  /** Or customize the stylistic rules */
   stylistic: {
     indent: 2, // 4, or 'tab'
     quotes: 'single', // or 'double'
     braceStyle: 'stroustrup', // '1tbs', or 'allman'
   },
 
-  // TypeScript and Vue are autodetected, you can also explicitly enable them:
+  /** TypeScript and Vue are autodetected, you can also explicitly enable them: */
   typescript: true,
   vue: true,
 
-  // Disable jsonc and yaml support
+  /** Disable jsonc and yaml support */
   jsonc: false,
   yaml: false,
 })
@@ -514,14 +516,14 @@ export default antfu(
     typescript: true
   },
   {
-    // Remember to specify the file glob here, otherwise it might cause the vue plugin to handle non-vue files
+    /** Remember to specify the file glob here, otherwise it might cause the vue plugin to handle non-vue files */
     files: ['**/*.vue'],
     rules: {
       'vue/operator-linebreak': ['error', 'before'],
     },
   },
   {
-    // Without `files`, they are general rules for all files (Markdown excluded — see note below)
+    /** Without `files`, they are general rules for all files (Markdown excluded, see note below) */
     rules: {
       'style/semi': ['error', 'never'],
     },
@@ -548,7 +550,7 @@ export default antfu({
     overrides: {
       'ts/consistent-type-definitions': ['error', 'interface'],
     },
-    // type aware rules overrides should write here
+    /** type aware rules overrides should write here */
     overridesTypeAware: {
       'ts/no-unsafe-assignment': ['warn'],
     }
@@ -814,6 +816,52 @@ Running `npx eslint` should prompt you to install the required dependencies, oth
 npm i -D @angular-eslint/eslint-plugin @angular-eslint/eslint-plugin-template @angular-eslint/template-parser
 ```
 
+#### Anti-Slop
+
+> [!WARNING]
+> Experimental: the enabled rule set is maintained in-house and may change in any release without following semver.
+
+To guard against low-value code patterns commonly introduced by AI agents, you can explicitly turn on the anti-slop rules:
+
+```js
+// eslint.config.js
+import antfu from '@antfu/eslint-config'
+
+export default antfu({
+  antislop: true,
+})
+```
+
+This enables [`eslint-plugin-slop`](https://github.com/antfu/eslint-plugin-slop) and a curated, in-house maintained subset of [`eslint-plugin-sonarjs`](https://github.com/SonarSource/SonarJS) rules focusing on redundant and duplicated code. It also disallows explicit `any` when TypeScript is enabled (inspired by [this writeup on keeping AI-authored code clean](https://zenn.dev/singularity/articles/clean-code-ci-for-ai-era)).
+
+You can toggle each plugin and pass options to `eslint-plugin-slop`:
+
+```js
+// eslint.config.js
+import antfu from '@antfu/eslint-config'
+
+export default antfu({
+  antislop: {
+    sonarjs: false,
+    /**
+     * an object enables `eslint-plugin-slop` and is forwarded to it
+     * via `settings.slop`, for example to only inspect recently changed code
+     */
+    slop: {
+      inspection: { mode: 'recent-changes', tracebackCommits: 5 },
+    },
+  },
+})
+```
+
+Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
+
+```bash
+npm i -D eslint-plugin-slop eslint-plugin-sonarjs
+```
+
+Since linters only see one file at a time, we recommend pairing this option with [`jscpd`](https://github.com/kucherenko/jscpd) to detect copy-paste duplication across files, and [`knip`](https://knip.dev) to find unused files, dependencies, and exports.
+
 ### Optional Rules
 
 This config also provides some optional plugins/rules for extended usage.

package/dist/cli.mjs

@@ -8,7 +8,7 @@ import { cac } from "cac";
 import parse from "parse-gitignore";
 import { execSync } from "node:child_process";
 //#region package.json
-var version = "9.4.1";
+var version = "9.5.1";
 //#endregion
 //#region src/cli/constants.ts
 const vscodeSettingsString = `
@@ -188,21 +188,22 @@ async function updatePackageJson(result) {
 	const pkgContent = await fsPromises.readFile(pathPackageJSON, "utf-8");
 	const pkg = JSON.parse(pkgContent);
 	pkg.devDependencies ??= {};
-	pkg.devDependencies["@antfu/eslint-config"] = `^${version}`;
-	pkg.devDependencies.eslint ??= versionsMap.eslint;
+	const devDependencies = pkg.devDependencies;
+	devDependencies["@antfu/eslint-config"] = `^${version}`;
+	devDependencies.eslint ??= versionsMap.eslint;
 	const addedPackages = [];
 	if (result.extra.length) result.extra.forEach((item) => {
 		switch (item) {
 			case "formatter":
 				[...dependenciesMap.formatter, ...result.frameworks.includes("astro") ? dependenciesMap.formatterAstro : []].forEach((f) => {
 					if (!f) return;
-					pkg.devDependencies[f] = versionsMap[f];
+					devDependencies[f] = versionsMap[f];
 					addedPackages.push(f);
 				});
 				break;
 			case "unocss":
 				dependenciesMap.unocss.forEach((f) => {
-					pkg.devDependencies[f] = versionsMap[f];
+					devDependencies[f] = versionsMap[f];
 					addedPackages.push(f);
 				});
 				break;
@@ -211,7 +212,7 @@ async function updatePackageJson(result) {
 	for (const framework of result.frameworks) {
 		const deps = dependenciesMap[framework];
 		if (deps) deps.forEach((f) => {
-			pkg.devDependencies[f] = versionsMap[f];
+			devDependencies[f] = versionsMap[f];
 			addedPackages.push(f);
 		});
 	}
@@ -259,7 +260,7 @@ async function run(options = {}) {
 	if (!argSkipPrompt) {
 		result = await p.group({
 			uncommittedConfirmed: () => {
-				if (argSkipPrompt || isGitClean()) return Promise.resolve(true);
+				if (isGitClean()) return Promise.resolve(true);
 				return p.confirm({
 					initialValue: false,
 					message: "There are uncommitted changes in the current repository, are you sure to continue?"