eslint-plugin-unicorn 65.0.1 → 67.0.0

package/rules/prefer-at.js

@@ -12,11 +12,14 @@ import {
 	needsSemicolon,
 	shouldAddParenthesesToMemberExpressionObject,
 	isLeftHandSide,
+	isString,
+	unwrapTypeScriptExpression as unwrapExpression,
 } from './utils/index.js';
 import {
 	getNegativeIndexLengthNode,
 	removeLengthNode,
 } from './shared/negative-index.js';
+import {getSubstringSingleCharacterIndex} from './shared/substring.js';
 import {removeMemberExpressionProperty, removeMethodCall} from './fix/index.js';
 import {
 	isLiteral,
@@ -30,6 +33,7 @@ const MESSAGE_ID_NEGATIVE_INDEX = 'negative-index';
 const MESSAGE_ID_INDEX = 'index';
 const MESSAGE_ID_STRING_CHAR_AT_NEGATIVE = 'string-char-at-negative';
 const MESSAGE_ID_STRING_CHAR_AT = 'string-char-at';
+const MESSAGE_ID_STRING_SUBSTRING = 'string-substring';
 const MESSAGE_ID_SLICE = 'slice';
 const MESSAGE_ID_GET_LAST_FUNCTION = 'get-last-function';
 const SUGGESTION_ID = 'use-at';
@@ -38,6 +42,7 @@ const messages = {
 	[MESSAGE_ID_INDEX]: 'Prefer `.at(…)` over index access.',
 	[MESSAGE_ID_STRING_CHAR_AT_NEGATIVE]: 'Prefer `String#at(…)` over `String#charAt(….length - index)`.',
 	[MESSAGE_ID_STRING_CHAR_AT]: 'Prefer `String#at(…)` over `String#charAt(…)`.',
+	[MESSAGE_ID_STRING_SUBSTRING]: 'Prefer `String#at(…)` over `String#substring(…)` when getting one character.',
 	[MESSAGE_ID_SLICE]: 'Prefer `.at(…)` over the first element from `.slice(…)`.',
 	[MESSAGE_ID_GET_LAST_FUNCTION]: 'Prefer `.at(-1)` over `{{description}}(…)` to get the last element.',
 	[SUGGESTION_ID]: 'Use `.at(…)`.',
@@ -45,21 +50,6 @@ const messages = {
 
 const isArguments = node => node.type === 'Identifier' && node.name === 'arguments';
 
-function unwrapExpression(node) {
-	if (
-		[
-			'TSAsExpression',
-			'TSTypeAssertion',
-			'TSNonNullExpression',
-			'TSSatisfiesExpression',
-		].includes(node.type)
-	) {
-		return unwrapExpression(node.expression);
-	}
-
-	return node;
-}
-
 const isUnsupportedAtReceiverExpression = node => {
 	node = unwrapExpression(node);
 
@@ -109,7 +99,7 @@ const isLiteralNegativeInteger = node =>
 	&& node.prefix
 	&& node.operator === '-'
 	&& node.argument.type === 'Literal'
-	&& Number.isInteger(node.argument.value)
+	&& Number.isSafeInteger(node.argument.value)
 	&& node.argument.value > 0;
 const isZeroIndexAccess = node =>
 	isMemberExpression(node.parent, {
@@ -131,7 +121,21 @@ const isArrayPopOrShiftCall = (node, method) =>
 const isArrayPopCall = node => isArrayPopOrShiftCall(node, 'pop');
 const isArrayShiftCall = node => isArrayPopOrShiftCall(node, 'shift');
 
-function checkSliceCall(node) {
+function getFirstElementGetMethod(node) {
+	if (isZeroIndexAccess(node)) {
+		return isLeftHandSide(node.parent) ? undefined : 'zero-index';
+	}
+
+	if (isArrayShiftCall(node)) {
+		return 'shift';
+	}
+
+	if (isArrayPopCall(node)) {
+		return 'pop';
+	}
+}
+
+function getSliceCallResult(node) {
 	const sliceArgumentsLength = node.arguments.length;
 	const [startIndexNode, endIndexNode] = node.arguments;
 
@@ -139,19 +143,7 @@ function checkSliceCall(node) {
 		return;
 	}
 
-	let firstElementGetMethod = '';
-	if (isZeroIndexAccess(node)) {
-		if (isLeftHandSide(node.parent)) {
-			return;
-		}
-
-		firstElementGetMethod = 'zero-index';
-	} else if (isArrayShiftCall(node)) {
-		firstElementGetMethod = 'shift';
-	} else if (isArrayPopCall(node)) {
-		firstElementGetMethod = 'pop';
-	}
-
+	const firstElementGetMethod = getFirstElementGetMethod(node);
 	if (!firstElementGetMethod) {
 		return;
 	}
@@ -192,6 +184,27 @@ const lodashLastFunctions = [
 	'underscore.last',
 ];
 
+// TODO: Remove this once DOM collections like NodeList and HTMLCollection reliably support `.at()` in browsers.
+const domCollectionProperties = [
+	'childNodes',
+	'children',
+];
+
+const domCollectionMethods = [
+	'getElementsByClassName',
+	'getElementsByName',
+	'getElementsByTagName',
+	'getElementsByTagNameNS',
+	'querySelectorAll',
+];
+
+const isDomCollectionReceiver = node => {
+	node = unwrapExpression(node);
+
+	return isMemberExpression(node, {properties: domCollectionProperties})
+		|| isMethodCall(node, {methods: domCollectionMethods});
+};
+
 /** @param {import('eslint').Rule.RuleContext} context */
 function create(context) {
 	const {
@@ -210,17 +223,21 @@ function create(context) {
 			return;
 		}
 
+		if (isDomCollectionReceiver(node.object)) {
+			return;
+		}
+
 		const indexNode = node.property;
 		const lengthNode = getNegativeIndexLengthNode(indexNode, node.object);
 
 		if (!lengthNode) {
-			if (!checkAllIndexAccess) {
+			// Only if we are sure it's a positive integer
+			const staticValue = getStaticValue(indexNode, sourceCode.getScope(indexNode));
+			if (!staticValue || !Number.isSafeInteger(staticValue.value) || staticValue.value < 0) {
 				return;
 			}
 
-			// Only if we are sure it's a positive integer
-			const staticValue = getStaticValue(indexNode, sourceCode.getScope(indexNode));
-			if (!staticValue || !Number.isInteger(staticValue.value) || staticValue.value < 0) {
+			if (!checkAllIndexAccess && !isString(node.object, context)) {
 				return;
 			}
 
@@ -304,6 +321,44 @@ function create(context) {
 		};
 	});
 
+	// `string.substring(index, index + 1)`
+	context.on('CallExpression', node => {
+		const indexNode = getSubstringSingleCharacterIndex(node);
+		if (!indexNode) {
+			return;
+		}
+
+		const problem = {
+			node,
+			messageId: MESSAGE_ID_STRING_SUBSTRING,
+		};
+
+		const [firstArgument, secondArgument] = node.arguments;
+		const replacementRange = [
+			getParenthesizedRange(firstArgument, context)[0],
+			getParenthesizedRange(secondArgument, context)[1],
+		];
+		const hasCommentsInsideReplacementRange = sourceCode.getAllComments().some(comment => {
+			const commentRange = sourceCode.getRange(comment);
+			return commentRange[0] >= replacementRange[0] && commentRange[1] <= replacementRange[1];
+		});
+		if (hasCommentsInsideReplacementRange) {
+			return problem;
+		}
+
+		return {
+			...problem,
+			suggest: [{
+				messageId: SUGGESTION_ID,
+				* fix(fixer) {
+					yield fixer.replaceText(node.callee.property, 'at');
+
+					yield fixer.replaceTextRange(replacementRange, getParenthesizedText(indexNode, context));
+				},
+			}],
+		};
+	});
+
 	// `.slice()`
 	context.on('CallExpression', sliceCall => {
 		if (!isMethodCall(sliceCall, {
@@ -315,7 +370,7 @@ function create(context) {
 			return;
 		}
 
-		const result = checkSliceCall(sliceCall);
+		const result = getSliceCallResult(sliceCall);
 		if (!result) {
 			return;
 		}
@@ -386,7 +441,7 @@ function create(context) {
 					fixed = `(${fixed})`;
 				}
 
-				fixed = `${fixed}.at(-1)`;
+				fixed += '.at(-1)';
 
 				const tokenBefore = sourceCode.getTokenBefore(node);
 				if (needsSemicolon(tokenBefore, context, fixed)) {
@@ -431,6 +486,9 @@ const config = {
 		schema,
 		defaultOptions: [{getLastElementFunctions: [], checkAllIndexAccess: false}],
 		messages,
+		languages: [
+			'js/js',
+		],
 	},
 };
 

package/rules/prefer-await.js

@@ -0,0 +1,69 @@
+import {getPropertyName} from '@eslint-community/eslint-utils';
+import {isPromiseType} from './utils/index.js';
+
+const MESSAGE_ID = 'prefer-await';
+const messages = {
+	[MESSAGE_ID]: 'Prefer `await` over promise chaining with `.{{method}}()`.',
+};
+
+const promiseMethods = new Set(['then', 'catch', 'finally']);
+
+function isPromiseObject(node, context) {
+	const {parserServices} = context.sourceCode;
+	if (!parserServices?.program) {
+		return;
+	}
+
+	try {
+		return isPromiseType(
+			parserServices.getTypeAtLocation(node),
+			parserServices.program.getTypeChecker(),
+		);
+	} catch {
+		// TypeScript can throw while resolving incomplete projects; keep this rule best-effort.
+	}
+}
+
+/** @param {import('eslint').Rule.RuleContext} context */
+const create = context => {
+	context.on('CallExpression', callExpression => {
+		const {callee} = callExpression;
+		if (callee.type !== 'MemberExpression') {
+			return;
+		}
+
+		const method = getPropertyName(callee, context.sourceCode.getScope(callExpression));
+		if (!promiseMethods.has(method)) {
+			return;
+		}
+
+		const promiseObject = isPromiseObject(callee.object, context);
+		if (promiseObject === false) {
+			return;
+		}
+
+		return {
+			node: callee.property,
+			messageId: MESSAGE_ID,
+			data: {method},
+		};
+	});
+};
+
+/** @type {import('eslint').Rule.RuleModule} */
+const config = {
+	create,
+	meta: {
+		type: 'suggestion',
+		docs: {
+			description: 'Prefer `await` over promise chaining.',
+			recommended: 'unopinionated',
+		},
+		messages,
+		languages: [
+			'js/js',
+		],
+	},
+};
+
+export default config;

package/rules/prefer-bigint-literals.js

@@ -74,6 +74,7 @@ function getReplacement(valueNode) {
 
 	const {value, raw} = valueNode;
 
+	// Intentionally `Number.isInteger`, not `Number.isSafeInteger`: large integers beyond the safe range are exactly what bigint literals are for.
 	if (!Number.isInteger(value)) {
 		return;
 	}
@@ -171,6 +172,9 @@ const config = {
 		fixable: 'code',
 		hasSuggestions: true,
 		messages,
+		languages: [
+			'js/js',
+		],
 	},
 };
 

package/rules/prefer-blob-reading-methods.js

@@ -41,6 +41,9 @@ const config = {
 			recommended: 'unopinionated',
 		},
 		messages,
+		languages: [
+			'js/js',
+		],
 	},
 };
 

package/rules/prefer-class-fields.js

@@ -148,6 +148,9 @@ const config = {
 		fixable: 'code',
 		hasSuggestions: true,
 		messages,
+		languages: [
+			'js/js',
+		],
 	},
 };
 

package/rules/prefer-classlist-toggle.js

@@ -155,7 +155,7 @@ const create = context => {
 
 		// `element.classList.add('className');`
 		// `element.classList.remove('className');`
-		if (!clauses.every(node => isClassListMethodCall(node, ['add', 'remove']))) {
+		if (clauses.some(node => !isClassListMethodCall(node, ['add', 'remove']))) {
 			return;
 		}
 
@@ -181,7 +181,7 @@ const create = context => {
 			let text = `${elementText}${isOptional ? '?' : ''}.classList.toggle(${classNameText}${conditionText ? `, ${conditionText}` : ''})`;
 
 			if (!isExpression) {
-				text = `${text};`;
+				text += ';';
 			}
 
 			if (needsSemicolon(sourceCode.getTokenBefore(node), context, text)) {
@@ -249,6 +249,9 @@ const config = {
 		fixable: 'code',
 		hasSuggestions: true,
 		messages,
+		languages: [
+			'js/js',
+		],
 	},
 };
 

package/rules/prefer-code-point.js

@@ -51,6 +51,9 @@ const config = {
 		},
 		hasSuggestions: true,
 		messages,
+		languages: [
+			'js/js',
+		],
 	},
 };
 

package/rules/prefer-date-now.js

@@ -130,6 +130,9 @@ const config = {
 		},
 		fixable: 'code',
 		messages,
+		languages: [
+			'js/js',
+		],
 	},
 };
 

package/rules/prefer-default-parameters.js

@@ -96,7 +96,6 @@ const fixDefaultExpression = (fixer, sourceCode, node) => {
 	const nodeText = sourceCode.getText(node);
 	const lineText = sourceCode.lines[line - 1];
 	const isOnlyNodeOnLine = lineText.trim() === nodeText;
-	const endsWithWhitespace = lineText[column] === ' ';
 
 	if (isOnlyNodeOnLine) {
 		return fixer.removeRange([
@@ -105,6 +104,7 @@ const fixDefaultExpression = (fixer, sourceCode, node) => {
 		]);
 	}
 
+	const endsWithWhitespace = lineText[column] === ' ';
 	if (endsWithWhitespace) {
 		const [start, end] = sourceCode.getRange(node);
 		return fixer.removeRange([start, end + 1]);
@@ -118,7 +118,7 @@ const create = context => {
 	const {sourceCode} = context;
 	const functionStack = [];
 
-	const checkExpression = (node, left, right, assignment) => {
+	const getDefaultParameterProblem = (node, left, right, assignment) => {
 		const currentFunction = functionStack.at(-1);
 
 		if (!currentFunction || !isDefaultExpression(left, right)) {
@@ -186,13 +186,13 @@ const create = context => {
 
 	context.on('AssignmentExpression', node => {
 		if (node.parent.type === 'ExpressionStatement' && node.parent.expression === node) {
-			return checkExpression(node.parent, node.left, node.right, true);
+			return getDefaultParameterProblem(node.parent, node.left, node.right, true);
 		}
 	});
 
 	context.on('VariableDeclarator', node => {
 		if (node.parent.type === 'VariableDeclaration' && node.parent.declarations[0] === node) {
-			return checkExpression(node.parent, node.id, node.init, false);
+			return getDefaultParameterProblem(node.parent, node.id, node.init, false);
 		}
 	});
 };
@@ -211,6 +211,9 @@ const config = {
 			[MESSAGE_ID]: 'Prefer default parameters over reassignment.',
 			[MESSAGE_ID_SUGGEST]: 'Replace reassignment with default parameter.',
 		},
+		languages: [
+			'js/js',
+		],
 	},
 };