feat(eslint-plugin)!: switch prefer-standalone fix to suggestion, reference guide

JamesHenry · JamesHenry · commit 4583034f9cdc · 2025-06-06T19:17:58.000+04:00
diff --git a/packages/eslint-plugin/src/rules/prefer-standalone.ts b/packages/eslint-plugin/src/rules/prefer-standalone.ts
@@ -4,21 +4,25 @@ import { createESLintRule } from '../utils/create-eslint-rule';
 
 export type Options = [];
 type DecoratorTypes = 'component' | 'directive' | 'pipe';
-export type MessageIds = 'preferStandalone';
+export type MessageIds = 'preferStandalone' | 'removeStandaloneFalse';
 export const RULE_NAME = 'prefer-standalone';
 
+const RECOMMENDED_GUIDE_URL =
+  'https://angular.dev/reference/migrations/standalone';
+
 export default createESLintRule<Options, MessageIds>({
   name: RULE_NAME,
   meta: {
     type: 'suggestion',
     docs: {
-      description: `Ensures Components, Directives and Pipes do not opt out of standalone`,
+      description: `Ensures Components, Directives and Pipes do not opt out of standalone.`,
       recommended: 'recommended',
     },
-    fixable: 'code',
+    hasSuggestions: true,
     schema: [],
     messages: {
-      preferStandalone: `Components, Directives and Pipes should not opt out of standalone`,
+      preferStandalone: `Components, Directives and Pipes should not opt out of standalone. Following this guide is highly recommended: ${RECOMMENDED_GUIDE_URL}`,
+      removeStandaloneFalse: `Quickly remove 'standalone: false'. NOTE - Following this guide is highly recommended: ${RECOMMENDED_GUIDE_URL}`,
     },
   },
   defaultOptions: [],
@@ -45,19 +49,24 @@ export default createESLintRule<Options, MessageIds>({
           node: standalone.parent,
           messageId: 'preferStandalone',
           data: { type },
-          fix: (fixer) => {
-            // Remove the standalone property altogether if it was set to false
-            const tokenAfter = context.sourceCode.getTokenAfter(
-              standalone.parent,
-            );
-            // Remove the trailing comma, if present
-            const removeStart = standalone.parent.range[0];
-            let removeEnd = standalone.parent.range[1];
-            if (tokenAfter && tokenAfter.value === ',') {
-              removeEnd = tokenAfter.range[1];
-            }
-            return fixer.removeRange([removeStart, removeEnd]);
-          },
+          suggest: [
+            {
+              messageId: 'removeStandaloneFalse',
+              fix: (fixer) => {
+                // Remove the standalone property altogether if it was set to false
+                const tokenAfter = context.sourceCode.getTokenAfter(
+                  standalone.parent,
+                );
+                // Remove the trailing comma, if present
+                const removeStart = standalone.parent.range[0];
+                let removeEnd = standalone.parent.range[1];
+                if (tokenAfter && tokenAfter.value === ',') {
+                  removeEnd = tokenAfter.range[1];
+                }
+                return fixer.removeRange([removeStart, removeEnd]);
+              },
+            },
+          ],
         });
       };
 
diff --git a/packages/eslint-plugin/tests/rules/prefer-standalone/cases.ts b/packages/eslint-plugin/tests/rules/prefer-standalone/cases.ts
@@ -141,11 +141,16 @@ export const invalid: readonly InvalidTestCase<MessageIds, Options>[] = [
       `,
     messageId,
     data: { type: 'component' },
-    annotatedOutput: `
+    suggestions: [
+      {
+        messageId: 'removeStandaloneFalse',
+        output: `
         @Component({  })
                      
         class Test {}
       `,
+      },
+    ],
   }),
   convertAnnotatedSourceToFailureCase({
     description:
@@ -160,14 +165,19 @@ export const invalid: readonly InvalidTestCase<MessageIds, Options>[] = [
 `,
     messageId,
     data: { type: 'component' },
-    annotatedOutput: `
+    suggestions: [
+      {
+        messageId: 'removeStandaloneFalse',
+        output: `
         @Component({
           
           
           template: '<div></div>'
         })
         class Test {}
 `,
+      },
+    ],
   }),
   convertAnnotatedSourceToFailureCase({
     description:
@@ -179,11 +189,16 @@ export const invalid: readonly InvalidTestCase<MessageIds, Options>[] = [
       `,
     messageId,
     data: { type: 'directive' },
-    annotatedOutput: `
+    suggestions: [
+      {
+        messageId: 'removeStandaloneFalse',
+        output: `
         @Directive({  })
                      
         class Test {}
       `,
+      },
+    ],
   }),
   convertAnnotatedSourceToFailureCase({
     description:
@@ -198,14 +213,19 @@ export const invalid: readonly InvalidTestCase<MessageIds, Options>[] = [
 `,
     messageId,
     data: { type: 'directive' },
-    annotatedOutput: `
+    suggestions: [
+      {
+        messageId: 'removeStandaloneFalse',
+        output: `
       @Directive({
         
         
         selector: 'x-selector'
       })
       class Test {}
 `,
+      },
+    ],
   }),
   convertAnnotatedSourceToFailureCase({
     description:
@@ -217,11 +237,16 @@ export const invalid: readonly InvalidTestCase<MessageIds, Options>[] = [
       `,
     messageId,
     data: { type: 'pipe' },
-    annotatedOutput: `
+    suggestions: [
+      {
+        messageId: 'removeStandaloneFalse',
+        output: `
         @Pipe({  })
                 
         class Test {}
       `,
+      },
+    ],
   }),
   convertAnnotatedSourceToFailureCase({
     description:
@@ -236,13 +261,18 @@ export const invalid: readonly InvalidTestCase<MessageIds, Options>[] = [
 `,
     messageId,
     data: { type: 'pipe' },
-    annotatedOutput: `
+    suggestions: [
+      {
+        messageId: 'removeStandaloneFalse',
+        output: `
         @Pipe({
           
           
           name: 'pipe-name'
         })
         class Test {}
 `,
+      },
+    ],
   }),
 ];
