Document reduceRight alternative for no-array-reduce (#2457)

sindresorhus · Sep 29, 2024 · 6a043c2 · 6a043c2
1 parent 1558cbe
commit 6a043c2
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 6 deletions.
diff --git a/docs/rules/no-array-reduce.md b/docs/rules/no-array-reduce.md
@@ -58,6 +58,14 @@ for (const element of array) {
 }
 ```
 
+```js
+let result = initialValue;
+
+for (const element of array.toReversed()) { // Equivalent to .reduceRight()
+	result += element;
+}
+```
+
 ## Options
 
 ### allowSimpleOperations

diff --git a/rules/no-array-reduce.js b/rules/no-array-reduce.js
@@ -2,9 +2,11 @@
 const {isMethodCall} = require('./ast/index.js');
 const {isNodeValueNotFunction, isArrayPrototypeProperty} = require('./utils/index.js');
 
-const MESSAGE_ID = 'no-reduce';
+const MESSAGE_ID_REDUCE = 'reduce';
+const MESSAGE_ID_REDUCE_RIGHT = 'reduceRight';
 const messages = {
-	[MESSAGE_ID]: '`Array#{{method}}()` is not allowed',
+	[MESSAGE_ID_REDUCE]: '`Array#reduce()` is not allowed. Prefer other types of loop for readability.',
+	[MESSAGE_ID_REDUCE_RIGHT]: '`Array#reduceRight()` is not allowed. Prefer other types of loop for readability. You may want to call `Array#toReversed()` before looping it.',
 };
 
 const cases = [
@@ -104,8 +106,7 @@ const create = context => {
 				const methodNode = getMethodNode(callExpression);
 				yield {
 					node: methodNode,
-					messageId: MESSAGE_ID,
-					data: {method: methodNode.name},
+					messageId: methodNode.name,
 				};
 			}
 		},

diff --git a/test/no-array-reduce.mjs b/test/no-array-reduce.mjs
@@ -4,8 +4,8 @@ import {getTester} from './utils/test.mjs';
 
 const {test} = getTester(import.meta);
 
-const errorsReduce = [{messageId: 'no-reduce', data: {method: 'reduce'}}];
-const errorsReduceRight = [{messageId: 'no-reduce', data: {method: 'reduceRight'}}];
+const errorsReduce = [{messageId: 'reduce'}];
+const errorsReduceRight = [{messageId: 'reduceRight'}];
 
 test({
 	valid: [