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.