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

Métriques du dépôt

Stars

5 022 étoiles (5 022 étoiles)

Métriques de merge PR

Merge moyen 1j 16h (Merge moyen 1j 16h)399 PRs mergées en 30 j (399 PRs mergées en 30 j)

Description

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);

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);

Guide contributeur

Direction de recherche

Examinez les règles existantes dans le dépôt (par exemple, src/rules/) pour comprendre le modèle de création d'une nouvelle règle ESLint. La règle doit inspecter la fonction de rappel passée à Array.prototype.sort() et détecter si elle utilise un motif if else verbeux au lieu d'une soustraction concise ou de localeCompare. Utilisez des types de nœuds AST comme ArrowFunctionExpression ou FunctionExpression et examinez le corps de la fonction pour les instructions return avec des conditionnelles. Référez vous à la documentation d'ESLint sur les règles personnalisées et à la structure de test existante du plugin.

Stack technique

javascript

Domaine

tooling

Type d'issue

Fonctionnalité

DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.

2

Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.

Une demi journée

Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.

Active

ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.

Claire

Prérequis

JavaScriptESLint

Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.

60