sindresorhus/eslint-plugin-unicorn

Rule proposal: Enforce compare function style for `Array#sort()`

Open

#1,473 建立於 2021年8月8日

在 GitHub 查看
 (2 留言) (3 反應) (0 負責人)JavaScript (5,022 star) (468 fork)user submission
help wantednew rule

描述

I've seen many people just write the compare function too complicated, yes sometimes maybe it's more readable, but sometimes it's just too long.

Fail

array.sort((a, b) => {
	if (a > b) {
		return 1;
	}

	if (a < b) {
		return -1;
	}

	return 0;
});

array.sort((a, b) => a > b ? 1 : -1);

array.sort((a, b) => {
	if (a.foo > b.foo) {
		return 1;
	}

	if (a.foo < b.foo) {
		return -1;
	}

	if (a.bar > b.bar) {
		return 1;
	}

	if (a.bar < b.bar) {
		return -1;
	}

	return 0;
});

array.sort(() => Math.random() > 0. 5 ? 1 : -1);

Pass

array.sort((a, b) => a - b);

array.sort((a, b) => a.localeCompare(b));

array.sort((a, b) => a.foo - b.foo || a.bar - b.bar);

array.sort(() => Math.random() - 0.5);

This rule should not fixable unless we are sure they are numbers.

貢獻者指南

技術棧
javascriptnodejs
領域
toolingdeveloper experience
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
JavaScriptESLint rule creation
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
Review existing rules in the repository (e.g., src/rules/) to understand the pattern for creating a new ESLint rule. The rule should inspect the callback passed to Array.prototype.sort() and detect if it uses a verbose if else pattern instead of a concise subtraction or localeCompare. Use AST node types like ArrowFunctionExpression or FunctionExpression and examine the function body for return statements with conditionals. Refer to ESLint's documentation on custom rules and the plugin's existing test structure.