Add no-array-sort rule

Author: fisker

docs/rules/no-array-reverse.md

@@ -39,3 +39,7 @@ Pass `allowExpressionStatement: false` to forbid `Array#reverse()` even if it's
 // eslint unicorn/no-array-reverse: ["error", {"allowExpressionStatement": true}]
 array.reverse();
 ```
+
+## Related rules
+
+- [unicorn/no-array-sort](./no-array-sort.md)

docs/rules/no-array-sort.md

@@ -0,0 +1,53 @@
+# Prefer `Array#toSorted()` over `Array#sort()`
+
+💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config).
+
+💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
+
+<!-- end auto-generated rule header -->
+<!-- Do not manually modify this header. Run: `npm run fix:eslint-docs` -->
+
+Prefer using [`Array#toSorted()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/toSorted) over [`Array#sort()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort).
+
+`Array#sort()` modifies the original array, while `Array#toSorted()` returns a new reversed array.
+
+## Examples
+
+```js
+// ❌
+const sorted = [...array].sort();
+
+// ✅
+const sorted = [...array].toSorted();
+```
+
+```js
+// ❌
+const sorted = [...array].sort((a, b) => a - b);
+
+// ✅
+const sorted = [...array].toSorted((a, b) => a - b);
+```
+
+## Options
+
+Type: `object`
+
+### allowExpressionStatement
+
+Type: `boolean`\
+Default: `true`
+
+This rule allows `array.sort()` to be used as an expression statement by default.\
+Pass `allowExpressionStatement: false` to forbid `Array#sort()` even if it's an expression statement.
+
+#### Fail
+
+```js
+// eslint unicorn/no-array-sort: ["error", {"allowExpressionStatement": true}]
+array.sort();
+```
+
+## Related rules
+
+- [unicorn/no-array-reverse](./no-array-reverse.md)

readme.md

@@ -81,6 +81,7 @@ export default [
 | [no-array-method-this-argument](docs/rules/no-array-method-this-argument.md)                     | Disallow using the `this` argument in array methods.                                                                                                                                                              | ✅  | 🔧 | 💡 |
 | [no-array-reduce](docs/rules/no-array-reduce.md)                                                 | Disallow `Array#reduce()` and `Array#reduceRight()`.                                                                                                                                                              | ✅  |    |    |
 | [no-array-reverse](docs/rules/no-array-reverse.md)                                               | Prefer `Array#toReversed()` over `Array#reverse()`.                                                                                                                                                               | ✅  |    | 💡 |
+| [no-array-sort](docs/rules/no-array-sort.md)                                                     | Prefer `Array#toSorted()` over `Array#sort()`.                                                                                                                                                                    | ✅  |    | 💡 |
 | [no-await-expression-member](docs/rules/no-await-expression-member.md)                           | Disallow member access from await expression.                                                                                                                                                                     | ✅  | 🔧 |    |
 | [no-await-in-promise-methods](docs/rules/no-await-in-promise-methods.md)                         | Disallow using `await` in `Promise` method parameters.                                                                                                                                                            | ✅  |    | 💡 |
 | [no-console-spaces](docs/rules/no-console-spaces.md)                                             | Do not use leading/trailing space between `console.log` parameters.                                                                                                                                               | ✅  | 🔧 |    |

rules/index.js

@@ -25,6 +25,7 @@ export {default as 'no-array-for-each'} from './no-array-for-each.js';
 export {default as 'no-array-method-this-argument'} from './no-array-method-this-argument.js';
 export {default as 'no-array-reduce'} from './no-array-reduce.js';
 export {default as 'no-array-reverse'} from './no-array-reverse.js';
+export {default as 'no-array-sort'} from './no-array-sort.js';
 export {default as 'no-await-expression-member'} from './no-await-expression-member.js';
 export {default as 'no-await-in-promise-methods'} from './no-await-in-promise-methods.js';
 export {default as 'no-console-spaces'} from './no-console-spaces.js';

rules/no-array-sort.js

@@ -0,0 +1,3 @@
+import noArrayMutateRule from './shared/no-array-mutate-rule.js';
+
+export default noArrayMutateRule('sort');

rules/shared/no-array-mutate-rule.js

@@ -1,18 +1,6 @@
 import {isMethodCall} from '../ast/index.js';
 import {getParenthesizedText} from '../utils/index.js';
 
-const schema = [
-	{
-		type: 'object',
-		additionalProperties: false,
-		properties: {
-			allowExpressionStatement: {
-				type: 'boolean',
-			},
-		},
-	},
-];
-
 const MESSAGE_ID_ERROR = 'error';
 const MESSAGE_ID_SUGGESTION_APPLY_REPLACEMENT = 'suggestion-apply-replacement';
 const MESSAGE_ID_SUGGESTION_SPREADING_ARRAY = 'suggestion-spreading-array';
@@ -30,8 +18,31 @@ const methods = new Map([
 			}),
 		},
 	],
+	[
+		'sort',
+		{
+			replacement: 'toSorted',
+			predicate: callExpression => isMethodCall(callExpression, {
+				method: 'sort',
+				maximumArguments: 1,
+				optionalCall: false,
+			}),
+		},
+	],
 ]);
 
+const schema = [
+	{
+		type: 'object',
+		additionalProperties: false,
+		properties: {
+			allowExpressionStatement: {
+				type: 'boolean',
+			},
+		},
+	},
+];
+
 function noArrayMutateRule(methodName) {
 	const {
 		replacement,

test/no-array-sort.js

@@ -0,0 +1,45 @@
+import {getTester} from './utils/test.js';
+
+const {test} = getTester(import.meta);
+
+const FORBID_EXPRESSION_OPTIONS = [{allowExpressionStatement: false}];
+
+test.snapshot({
+	valid: [
+		'sorted =[...array].toSorted()',
+		'sorted =array.toSorted()',
+		'sorted =[...array].sort',
+		'sorted =[...array].sort?.()',
+		'array.sort()',
+		'array.sort?.()',
+		'array?.sort()',
+		'if (true) array.sort()',
+		'sorted = array.sort(...[])',
+		'sorted = array.sort(...[compareFn])',
+		'sorted = array.sort(compareFn, extraArgument)',
+	],
+	invalid: [
+		'sorted = [...array].sort()',
+		'sorted = [...array]?.sort()',
+		'sorted = array.sort()',
+		'sorted = array?.sort()',
+		'sorted = [...array].sort(compareFn)',
+		'sorted = [...array]?.sort(compareFn)',
+		'sorted = array.sort(compareFn)',
+		'sorted = array?.sort(compareFn)',
+		{
+			code: 'array.sort()',
+			options: FORBID_EXPRESSION_OPTIONS,
+		},
+		{
+			code: 'array?.sort()',
+			options: FORBID_EXPRESSION_OPTIONS,
+		},
+		// Don't care about `allowExpression`
+		{
+			code: '[...array].sort()',
+			options: FORBID_EXPRESSION_OPTIONS,
+		},
+		'sorted = [...(0, array)].sort()',
+	],
+});