eslint-plugin-ocavue 0.1.0 → 0.2.0

package/README.md

@@ -21,6 +21,7 @@ export default [
     plugins: { ocavue },
     rules: {
       'ocavue/no-implicit-arrow-linebreak': 'error',
+      'ocavue/prefer-while-true': 'error',
     },
   },
 ]
@@ -49,6 +50,24 @@ const items = Array.from({ length: count }, (_, index) => {
 
 When a comment sits between `=>` and the body, the rule reports without autofixing so the fix never drops a comment.
 
+### `prefer-while-true`
+
+Enforce `while (true)` instead of `for (;;)` for infinite loops. Rules such as [`no-constant-condition`](https://eslint.org/docs/latest/rules/no-constant-condition) (with `checkLoops: "all"`) and [`@typescript-eslint/no-unnecessary-condition`](https://typescript-eslint.io/rules/no-unnecessary-condition) report `while (true)` but not `for (;;)`, so people often rewrite the loop as `for (;;)` to silence them. That only hides the infinite loop from the linter: the code still loops forever. This rule removes that workaround. `while (true)` also reads more clearly than `for (;;)`.
+
+```js
+// Incorrect
+for (;;) {
+  step()
+}
+
+// Correct (what the fixer produces)
+while (true) {
+  step()
+}
+```
+
+When a comment sits inside the loop head, the rule reports without autofixing so the fix never drops a comment.
+
 ## Sponsors
 
 <p align="center">

package/dist/index.d.ts

@@ -6,6 +6,7 @@ declare const plugin: {
   };
   rules: {
     'no-implicit-arrow-linebreak': import("eslint").Rule.RuleModule;
+    'prefer-while-true': import("eslint").Rule.RuleModule;
   };
 };
 //#endregion

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"mappings":";cAMM"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"mappings":";cAOM"}

package/dist/index.js

@@ -3,41 +3,76 @@
 const plugin = {
 	meta: {
 		name: "eslint-plugin-ocavue",
-		version: "0.1.0"
+		version: "0.2.0"
 	},
-	rules: { "no-implicit-arrow-linebreak": {
-		meta: {
-			type: "layout",
-			fixable: "code",
-			docs: {
-				description: "disallow a linebreak between `=>` and an implicit arrow function body, fixing it to a block body with `return`",
-				url: "https://github.com/ocavue/eslint-plugin-ocavue#no-implicit-arrow-linebreak"
+	rules: {
+		"no-implicit-arrow-linebreak": {
+			meta: {
+				type: "layout",
+				fixable: "code",
+				docs: {
+					description: "disallow a linebreak between `=>` and an implicit arrow function body, fixing it to a block body with `return`",
+					url: "https://github.com/ocavue/eslint-plugin-ocavue#no-implicit-arrow-linebreak"
+				},
+				messages: { linebreak: "Implicit arrow body must not start on a new line. Use a block body with `return` instead." },
+				schema: []
 			},
-			messages: { linebreak: "Implicit arrow body must not start on a new line. Use a block body with `return` instead." },
-			schema: []
+			create(context) {
+				const sourceCode = context.sourceCode;
+				return { ArrowFunctionExpression(node) {
+					if (node.body.type === "BlockStatement") return;
+					const arrowToken = sourceCode.getTokenBefore(node.body, { filter: (token) => token.type === "Punctuator" && token.value === "=>" });
+					if (!arrowToken) return;
+					const firstBodyToken = sourceCode.getTokenAfter(arrowToken);
+					const lastToken = sourceCode.getLastToken(node);
+					if (!firstBodyToken || !lastToken) return;
+					if (arrowToken.loc.end.line === firstBodyToken.loc.start.line) return;
+					const canFix = !sourceCode.commentsExistBetween(arrowToken, firstBodyToken);
+					context.report({
+						node: node.body,
+						messageId: "linebreak",
+						fix: canFix ? (fixer) => {
+							const bodyText = sourceCode.text.slice(firstBodyToken.range[0], lastToken.range[1]);
+							return fixer.replaceTextRange([arrowToken.range[1], lastToken.range[1]], ` { return ${bodyText} }`);
+						} : void 0
+					});
+				} };
+			}
 		},
-		create(context) {
-			const sourceCode = context.sourceCode;
-			return { ArrowFunctionExpression(node) {
-				if (node.body.type === "BlockStatement") return;
-				const arrowToken = sourceCode.getTokenBefore(node.body, { filter: (token) => token.type === "Punctuator" && token.value === "=>" });
-				if (!arrowToken) return;
-				const firstBodyToken = sourceCode.getTokenAfter(arrowToken);
-				const lastToken = sourceCode.getLastToken(node);
-				if (!firstBodyToken || !lastToken) return;
-				if (arrowToken.loc.end.line === firstBodyToken.loc.start.line) return;
-				const canFix = !sourceCode.commentsExistBetween(arrowToken, firstBodyToken);
-				context.report({
-					node: node.body,
-					messageId: "linebreak",
-					fix: canFix ? (fixer) => {
-						const bodyText = sourceCode.text.slice(firstBodyToken.range[0], lastToken.range[1]);
-						return fixer.replaceTextRange([arrowToken.range[1], lastToken.range[1]], ` { return ${bodyText} }`);
-					} : void 0
-				});
-			} };
+		"prefer-while-true": {
+			meta: {
+				type: "suggestion",
+				fixable: "code",
+				docs: {
+					description: "enforce `while (true)` instead of `for (;;)` for infinite loops",
+					url: "https://github.com/ocavue/eslint-plugin-ocavue#prefer-while-true"
+				},
+				messages: { preferWhileTrue: "Use `while (true)` instead of `for (;;)`." },
+				schema: []
+			},
+			create(context) {
+				const sourceCode = context.sourceCode;
+				return { ForStatement(node) {
+					if (node.init || node.test || node.update) return;
+					const forToken = sourceCode.getFirstToken(node);
+					const closingParen = sourceCode.getTokenBefore(node.body);
+					if (!forToken || !closingParen) return;
+					const canFix = !sourceCode.commentsExistBetween(forToken, closingParen);
+					context.report({
+						node,
+						loc: {
+							start: forToken.loc.start,
+							end: closingParen.loc.end
+						},
+						messageId: "preferWhileTrue",
+						fix: canFix ? (fixer) => {
+							return fixer.replaceTextRange([forToken.range[0], closingParen.range[1]], "while (true)");
+						} : void 0
+					});
+				} };
+			}
 		}
-	} }
+	}
 };
 //#endregion
 export { plugin as default };

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["noImplicitArrowLinebreak"],"sources":["../package.json","../src/rules/no-implicit-arrow-linebreak.ts","../src/index.ts"],"sourcesContent":["","import type { Rule } from 'eslint'\n\nconst rule: Rule.RuleModule = {\n  meta: {\n    type: 'layout',\n    fixable: 'code',\n    docs: {\n      description:\n        'disallow a linebreak between `=>` and an implicit arrow function body, fixing it to a block body with `return`',\n      url: 'https://github.com/ocavue/eslint-plugin-ocavue#no-implicit-arrow-linebreak',\n    },\n    messages: {\n      linebreak:\n        'Implicit arrow body must not start on a new line. Use a block body with `return` instead.',\n    },\n    schema: [],\n  },\n  create(context) {\n    const sourceCode = context.sourceCode\n    return {\n      ArrowFunctionExpression(node) {\n        if (node.body.type === 'BlockStatement') {\n          return\n        }\n\n        const arrowToken = sourceCode.getTokenBefore(node.body, {\n          filter: (token) => token.type === 'Punctuator' && token.value === '=>',\n        })\n        if (!arrowToken) {\n          return\n        }\n        const firstBodyToken = sourceCode.getTokenAfter(arrowToken)\n        // The last token of the arrow function. When the body is wrapped in\n        // parentheses, this is the closing `)`, so the fix keeps the parens.\n        const lastToken = sourceCode.getLastToken(node)\n        if (!firstBodyToken || !lastToken) {\n          return\n        }\n        if (arrowToken.loc.end.line === firstBodyToken.loc.start.line) {\n          return\n        }\n\n        // The fix rewrites the region between `=>` and the body, so bail out\n        // of fixing (but still report) if that region contains comments.\n        const canFix = !sourceCode.commentsExistBetween(arrowToken, firstBodyToken)\n\n        context.report({\n          node: node.body,\n          messageId: 'linebreak',\n          fix: canFix\n            ? (fixer) => {\n                const bodyText = sourceCode.text.slice(firstBodyToken.range[0], lastToken.range[1])\n                return fixer.replaceTextRange(\n                  [arrowToken.range[1], lastToken.range[1]],\n                  ` { return ${bodyText} }`,\n                )\n              }\n            : undefined,\n        })\n      },\n    }\n  },\n}\n\nexport default rule\n","import type { ESLint } from 'eslint'\n\nimport { version } from '../package.json'\n\nimport noImplicitArrowLinebreak from './rules/no-implicit-arrow-linebreak'\n\nconst plugin = {\n  meta: {\n    name: 'eslint-plugin-ocavue',\n    version,\n  },\n  rules: {\n    'no-implicit-arrow-linebreak': noImplicitArrowLinebreak,\n  },\n} satisfies ESLint.Plugin\n\nexport default plugin\n"],"mappings":";;AEMA,MAAM,SAAS;CACb,MAAM;EACJ,MAAM;EACN;CACF;CACA,OAAO,EACL,+BAA+BA;EDTjC,MAAM;GACJ,MAAM;GACN,SAAS;GACT,MAAM;IACJ,aACE;IACF,KAAK;GACP;GACA,UAAU,EACR,WACE,4FACJ;GACA,QAAQ,CAAC;EACX;EACA,OAAO,SAAS;GACd,MAAM,aAAa,QAAQ;GAC3B,OAAO,EACL,wBAAwB,MAAM;IAC5B,IAAI,KAAK,KAAK,SAAS,kBACrB;IAGF,MAAM,aAAa,WAAW,eAAe,KAAK,MAAM,EACtD,SAAS,UAAU,MAAM,SAAS,gBAAgB,MAAM,UAAU,KACpE,CAAC;IACD,IAAI,CAAC,YACH;IAEF,MAAM,iBAAiB,WAAW,cAAc,UAAU;IAG1D,MAAM,YAAY,WAAW,aAAa,IAAI;IAC9C,IAAI,CAAC,kBAAkB,CAAC,WACtB;IAEF,IAAI,WAAW,IAAI,IAAI,SAAS,eAAe,IAAI,MAAM,MACvD;IAKF,MAAM,SAAS,CAAC,WAAW,qBAAqB,YAAY,cAAc;IAE1E,QAAQ,OAAO;KACb,MAAM,KAAK;KACX,WAAW;KACX,KAAK,UACA,UAAU;MACT,MAAM,WAAW,WAAW,KAAK,MAAM,eAAe,MAAM,IAAI,UAAU,MAAM,EAAE;MAClF,OAAO,MAAM,iBACX,CAAC,WAAW,MAAM,IAAI,UAAU,MAAM,EAAE,GACxC,aAAa,SAAS,GACxB;KACF,IACA,KAAA;IACN,CAAC;GACH,EACF;EACF;CCjDiCA,EACjC;AACF"}
+{"version":3,"file":"index.js","names":["rule","noImplicitArrowLinebreak","preferWhileTrue"],"sources":["../package.json","../src/rules/no-implicit-arrow-linebreak.ts","../src/rules/prefer-while-true.ts","../src/index.ts"],"sourcesContent":["","import type { Rule } from 'eslint'\n\nconst rule: Rule.RuleModule = {\n  meta: {\n    type: 'layout',\n    fixable: 'code',\n    docs: {\n      description:\n        'disallow a linebreak between `=>` and an implicit arrow function body, fixing it to a block body with `return`',\n      url: 'https://github.com/ocavue/eslint-plugin-ocavue#no-implicit-arrow-linebreak',\n    },\n    messages: {\n      linebreak:\n        'Implicit arrow body must not start on a new line. Use a block body with `return` instead.',\n    },\n    schema: [],\n  },\n  create(context) {\n    const sourceCode = context.sourceCode\n    return {\n      ArrowFunctionExpression(node) {\n        if (node.body.type === 'BlockStatement') {\n          return\n        }\n\n        const arrowToken = sourceCode.getTokenBefore(node.body, {\n          filter: (token) => token.type === 'Punctuator' && token.value === '=>',\n        })\n        if (!arrowToken) {\n          return\n        }\n        const firstBodyToken = sourceCode.getTokenAfter(arrowToken)\n        // The last token of the arrow function. When the body is wrapped in\n        // parentheses, this is the closing `)`, so the fix keeps the parens.\n        const lastToken = sourceCode.getLastToken(node)\n        if (!firstBodyToken || !lastToken) {\n          return\n        }\n        if (arrowToken.loc.end.line === firstBodyToken.loc.start.line) {\n          return\n        }\n\n        // The fix rewrites the region between `=>` and the body, so bail out\n        // of fixing (but still report) if that region contains comments.\n        const canFix = !sourceCode.commentsExistBetween(arrowToken, firstBodyToken)\n\n        context.report({\n          node: node.body,\n          messageId: 'linebreak',\n          fix: canFix\n            ? (fixer) => {\n                const bodyText = sourceCode.text.slice(firstBodyToken.range[0], lastToken.range[1])\n                return fixer.replaceTextRange(\n                  [arrowToken.range[1], lastToken.range[1]],\n                  ` { return ${bodyText} }`,\n                )\n              }\n            : undefined,\n        })\n      },\n    }\n  },\n}\n\nexport default rule\n","import type { Rule } from 'eslint'\n\nconst rule: Rule.RuleModule = {\n  meta: {\n    type: 'suggestion',\n    fixable: 'code',\n    docs: {\n      description: 'enforce `while (true)` instead of `for (;;)` for infinite loops',\n      url: 'https://github.com/ocavue/eslint-plugin-ocavue#prefer-while-true',\n    },\n    messages: {\n      preferWhileTrue: 'Use `while (true)` instead of `for (;;)`.',\n    },\n    schema: [],\n  },\n  create(context) {\n    const sourceCode = context.sourceCode\n    return {\n      ForStatement(node) {\n        if (node.init || node.test || node.update) {\n          return\n        }\n\n        const forToken = sourceCode.getFirstToken(node)\n        const closingParen = sourceCode.getTokenBefore(node.body)\n        if (!forToken || !closingParen) {\n          return\n        }\n\n        // Bail out of fixing (but still report) if the loop head contains\n        // comments, so the fix never drops a comment.\n        const canFix = !sourceCode.commentsExistBetween(forToken, closingParen)\n\n        context.report({\n          node,\n          loc: { start: forToken.loc.start, end: closingParen.loc.end },\n          messageId: 'preferWhileTrue',\n          fix: canFix\n            ? (fixer) => {\n                return fixer.replaceTextRange(\n                  [forToken.range[0], closingParen.range[1]],\n                  'while (true)',\n                )\n              }\n            : undefined,\n        })\n      },\n    }\n  },\n}\n\nexport default rule\n","import type { ESLint } from 'eslint'\n\nimport { version } from '../package.json'\n\nimport noImplicitArrowLinebreak from './rules/no-implicit-arrow-linebreak'\nimport preferWhileTrue from './rules/prefer-while-true'\n\nconst plugin = {\n  meta: {\n    name: 'eslint-plugin-ocavue',\n    version,\n  },\n  rules: {\n    'no-implicit-arrow-linebreak': noImplicitArrowLinebreak,\n    'prefer-while-true': preferWhileTrue,\n  },\n} satisfies ESLint.Plugin\n\nexport default plugin\n"],"mappings":";;AGOA,MAAM,SAAS;CACb,MAAM;EACJ,MAAM;EACN;CACF;CACA,OAAO;EACL,+BAA+BC;GFVjC,MAAM;IACJ,MAAM;IACN,SAAS;IACT,MAAM;KACJ,aACE;KACF,KAAK;IACP;IACA,UAAU,EACR,WACE,4FACJ;IACA,QAAQ,CAAC;GACX;GACA,OAAO,SAAS;IACd,MAAM,aAAa,QAAQ;IAC3B,OAAO,EACL,wBAAwB,MAAM;KAC5B,IAAI,KAAK,KAAK,SAAS,kBACrB;KAGF,MAAM,aAAa,WAAW,eAAe,KAAK,MAAM,EACtD,SAAS,UAAU,MAAM,SAAS,gBAAgB,MAAM,UAAU,KACpE,CAAC;KACD,IAAI,CAAC,YACH;KAEF,MAAM,iBAAiB,WAAW,cAAc,UAAU;KAG1D,MAAM,YAAY,WAAW,aAAa,IAAI;KAC9C,IAAI,CAAC,kBAAkB,CAAC,WACtB;KAEF,IAAI,WAAW,IAAI,IAAI,SAAS,eAAe,IAAI,MAAM,MACvD;KAKF,MAAM,SAAS,CAAC,WAAW,qBAAqB,YAAY,cAAc;KAE1E,QAAQ,OAAO;MACb,MAAM,KAAK;MACX,WAAW;MACX,KAAK,UACA,UAAU;OACT,MAAM,WAAW,WAAW,KAAK,MAAM,eAAe,MAAM,IAAI,UAAU,MAAM,EAAE;OAClF,OAAO,MAAM,iBACX,CAAC,WAAW,MAAM,IAAI,UAAU,MAAM,EAAE,GACxC,aAAa,SAAS,GACxB;MACF,IACA,KAAA;KACN,CAAC;IACH,EACF;GACF;EEhDiCA;EAC/B,qBAAqBC;GDXvB,MAAM;IACJ,MAAM;IACN,SAAS;IACT,MAAM;KACJ,aAAa;KACb,KAAK;IACP;IACA,UAAU,EACR,iBAAiB,4CACnB;IACA,QAAQ,CAAC;GACX;GACA,OAAO,SAAS;IACd,MAAM,aAAa,QAAQ;IAC3B,OAAO,EACL,aAAa,MAAM;KACjB,IAAI,KAAK,QAAQ,KAAK,QAAQ,KAAK,QACjC;KAGF,MAAM,WAAW,WAAW,cAAc,IAAI;KAC9C,MAAM,eAAe,WAAW,eAAe,KAAK,IAAI;KACxD,IAAI,CAAC,YAAY,CAAC,cAChB;KAKF,MAAM,SAAS,CAAC,WAAW,qBAAqB,UAAU,YAAY;KAEtE,QAAQ,OAAO;MACb;MACA,KAAK;OAAE,OAAO,SAAS,IAAI;OAAO,KAAK,aAAa,IAAI;MAAI;MAC5D,WAAW;MACX,KAAK,UACA,UAAU;OACT,OAAO,MAAM,iBACX,CAAC,SAAS,MAAM,IAAI,aAAa,MAAM,EAAE,GACzC,cACF;MACF,IACA,KAAA;KACN,CAAC;IACH,EACF;GACF;EClCuBA;CACvB;AACF"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-ocavue",
   "type": "module",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Custom ESLint rules from ocavue",
   "author": "ocavue <ocavue@gmail.com>",
   "license": "MIT",
@@ -35,15 +35,15 @@
     "eslint": "^10.0.0"
   },
   "devDependencies": {
-    "@ocavue/eslint-config": "^4.13.5",
+    "@ocavue/eslint-config": "^4.22.0",
     "@ocavue/tsconfig": "^0.7.1",
     "@types/node": "^24.0.0",
-    "eslint": "^10.9.1",
-    "knip": "^6.33.0",
-    "oxfmt": "^0.65.0",
-    "tsdown": "^0.22.14",
+    "eslint": "^10.14.0",
+    "knip": "^6.41.0",
+    "oxfmt": "^0.73.0",
+    "tsdown": "^0.23.1",
     "typescript": "^6.0.3",
-    "vitest": "^4.1.11"
+    "vitest": "^5.0.5"
   },
   "scripts": {
     "build": "tsdown",

package/src/index.ts

@@ -3,6 +3,7 @@ import type { ESLint } from 'eslint'
 import { version } from '../package.json'
 
 import noImplicitArrowLinebreak from './rules/no-implicit-arrow-linebreak'
+import preferWhileTrue from './rules/prefer-while-true'
 
 const plugin = {
   meta: {
@@ -11,6 +12,7 @@ const plugin = {
   },
   rules: {
     'no-implicit-arrow-linebreak': noImplicitArrowLinebreak,
+    'prefer-while-true': preferWhileTrue,
   },
 } satisfies ESLint.Plugin
 

package/src/rules/prefer-while-true.test.ts

@@ -0,0 +1,43 @@
+import { RuleTester } from 'eslint'
+import { test } from 'vitest'
+
+import rule from './prefer-while-true'
+
+test('prefer-while-true', () => {
+  const tester = new RuleTester({
+    languageOptions: { ecmaVersion: 'latest', sourceType: 'module' },
+  })
+
+  tester.run('prefer-while-true', rule, {
+    valid: [
+      'while (true) {}',
+      'for (let i = 0; i < 10; i++) {}',
+      'for (; i < 10; ) {}',
+      'for (let i = 0; ; i++) {}',
+      'for (const x of xs) {}',
+    ],
+    invalid: [
+      {
+        code: 'for (;;) {\n  fn()\n}',
+        output: 'while (true) {\n  fn()\n}',
+        errors: [{ messageId: 'preferWhileTrue' }],
+      },
+      {
+        code: 'for ( ; ; ) fn()',
+        output: 'while (true) fn()',
+        errors: [{ messageId: 'preferWhileTrue' }],
+      },
+      {
+        code: 'outer: for (;;) {\n  for (;;) break outer\n}',
+        output: 'outer: while (true) {\n  while (true) break outer\n}',
+        errors: [{ messageId: 'preferWhileTrue' }, { messageId: 'preferWhileTrue' }],
+      },
+      {
+        // No autofix when a comment sits inside the loop head.
+        code: 'for (; /* forever */ ;) {}',
+        output: null,
+        errors: [{ messageId: 'preferWhileTrue' }],
+      },
+    ],
+  })
+})

package/src/rules/prefer-while-true.ts

@@ -0,0 +1,52 @@
+import type { Rule } from 'eslint'
+
+const rule: Rule.RuleModule = {
+  meta: {
+    type: 'suggestion',
+    fixable: 'code',
+    docs: {
+      description: 'enforce `while (true)` instead of `for (;;)` for infinite loops',
+      url: 'https://github.com/ocavue/eslint-plugin-ocavue#prefer-while-true',
+    },
+    messages: {
+      preferWhileTrue: 'Use `while (true)` instead of `for (;;)`.',
+    },
+    schema: [],
+  },
+  create(context) {
+    const sourceCode = context.sourceCode
+    return {
+      ForStatement(node) {
+        if (node.init || node.test || node.update) {
+          return
+        }
+
+        const forToken = sourceCode.getFirstToken(node)
+        const closingParen = sourceCode.getTokenBefore(node.body)
+        if (!forToken || !closingParen) {
+          return
+        }
+
+        // Bail out of fixing (but still report) if the loop head contains
+        // comments, so the fix never drops a comment.
+        const canFix = !sourceCode.commentsExistBetween(forToken, closingParen)
+
+        context.report({
+          node,
+          loc: { start: forToken.loc.start, end: closingParen.loc.end },
+          messageId: 'preferWhileTrue',
+          fix: canFix
+            ? (fixer) => {
+                return fixer.replaceTextRange(
+                  [forToken.range[0], closingParen.range[1]],
+                  'while (true)',
+                )
+              }
+            : undefined,
+        })
+      },
+    }
+  },
+}
+
+export default rule