Add internal rule to remove unnecessary yield * (#2795)

Author: fisker

rules/no-immediate-mutation.js

@@ -244,7 +244,7 @@ const arrayMutationSettings = {
 				: appendListTextToArrayExpressionOrObjectExpression(context, fixer, arrayExpression, text)
 		);
 
-		yield * removeExpressionStatementAfterAssign(
+		yield removeExpressionStatementAfterAssign(
 			nextExpressionStatement,
 			context,
 			fixer,
@@ -365,7 +365,7 @@ const objectWithAssignmentExpressionSettings = {
 			`${shouldInsertComma ? ',' : ''} ${text}`,
 		);
 
-		yield * removeExpressionStatementAfterAssign(
+		yield removeExpressionStatementAfterAssign(
 			nextExpressionStatement,
 			context,
 			fixer,
@@ -473,7 +473,7 @@ const objectWithObjectAssignSettings = {
 			return;
 		}
 
-		yield * removeExpressionStatementAfterAssign(
+		yield removeExpressionStatementAfterAssign(
 			nextExpressionStatement,
 			context,
 			fixer,

rules/no-instanceof-builtins.js

@@ -61,14 +61,14 @@ const replaceWithFunctionCall = (node, context, functionName) => function * (fix
 	const tokenStore = getTokenStore(context, node);
 	const instanceofToken = tokenStore.getTokenAfter(left, isInstanceofToken);
 
-	yield * fixSpaceAroundKeyword(fixer, node, context);
+	yield fixSpaceAroundKeyword(fixer, node, context);
 
 	const range = getParenthesizedRange(left, {sourceCode: tokenStore});
 	yield fixer.insertTextBeforeRange(range, functionName + '(');
 	yield fixer.insertTextAfterRange(range, ')');
 
-	yield * replaceNodeOrTokenAndSpacesBefore(instanceofToken, '', fixer, context, tokenStore);
-	yield * replaceNodeOrTokenAndSpacesBefore(right, '', fixer, context, tokenStore);
+	yield replaceNodeOrTokenAndSpacesBefore(instanceofToken, '', fixer, context, tokenStore);
+	yield replaceNodeOrTokenAndSpacesBefore(right, '', fixer, context, tokenStore);
 };
 
 const replaceWithTypeOfExpression = (node, context) => function * (fixer) {
@@ -83,7 +83,7 @@ const replaceWithTypeOfExpression = (node, context) => function * (fixer) {
 	// Get safe quote
 	const safeQuote = vueExpressionContainer ? (sourceCode.getText(vueExpressionContainer)[0] === '"' ? '\'' : '"') : '\'';
 
-	yield * fixSpaceAroundKeyword(fixer, node, context);
+	yield fixSpaceAroundKeyword(fixer, node, context);
 
 	const leftRange = getParenthesizedRange(left, {sourceCode: tokenStore});
 	yield fixer.insertTextBeforeRange(leftRange, 'typeof ');

scripts/internal-rules/index.js

@@ -5,6 +5,7 @@ import preferNegativeBooleanAttribute from './prefer-negative-boolean-attribute.
 import preferFixerRemoveRange from './prefer-fixer-remove-range.js';
 import noRestrictedPropertyAccess from './no-restricted-property-access.js';
 import noSourceCodeParameter from './no-source-code-parameter.js';
+import noFixYieldStar from './no-fix-yield-star.js';
 
 const pluginName = 'internal';
 const PROJECT_ROOT = new URL('../../', import.meta.url);
@@ -31,6 +32,7 @@ const rules = [
 	{id: 'prefer-fixer-remove-range', directories: RULES_DIRECTORIES, rule: preferFixerRemoveRange},
 	{id: 'no-restricted-property-access', directories: RULES_DIRECTORIES, rule: noRestrictedPropertyAccess},
 	{id: 'no-source-code-parameter', directories: UTILITIES_DIRECTORIES, rule: noSourceCodeParameter},
+	{id: 'no-fix-yield-star', directories: RULES_DIRECTORIES, rule: noFixYieldStar},
 ];
 
 const createFilePredicate = directories => {

scripts/internal-rules/no-fix-yield-star.js

@@ -0,0 +1,44 @@
+import path from 'node:path';
+import {fileURLToPath} from 'node:url';
+
+const messageId = path.basename(fileURLToPath(import.meta.url), '.js');
+
+const config = {
+	create(context) {
+		const {sourceCode} = context;
+
+		return {
+			YieldExpression(yieldExpression) {
+				if (!yieldExpression.delegate) {
+					return;
+				}
+
+				const scope = sourceCode.getScope(yieldExpression).variableScope;
+				const functionNode = scope.block;
+				if (!functionNode.params.some(node => node.type === 'Identifier' && node.name === 'fixer')) {
+					return;
+				}
+
+				const starToken = sourceCode.getFirstToken(yieldExpression, {skip: 1});
+				const [start, end] = sourceCode.getRange(starToken);
+
+				context.report({
+					node: starToken,
+					messageId,
+					fix: fixer => fixer.removeRange([
+						start,
+						end + (sourceCode.text[start - 1] === ' ' && sourceCode.text[end + 1] === ' ' ? 1 : 0),
+					]),
+				});
+			},
+		};
+	},
+	meta: {
+		fixable: 'code',
+		messages: {
+			[messageId]: 'Unnecessary to delegate fixes',
+		},
+	},
+};
+
+export default config;