feat(eslint-plugin): [sort-ngmodule-metadata-arrays] add fixer (#493)

angular-eslint · May 22, 2021 · 32fae47 · 32fae47
1 parent 70b01bd
commit 32fae47
Show file tree

Hide file tree

Showing 2 changed files with 90 additions and 7 deletions.
diff --git a/packages/eslint-plugin/src/rules/sort-ngmodule-metadata-arrays.ts b/packages/eslint-plugin/src/rules/sort-ngmodule-metadata-arrays.ts
@@ -32,6 +32,7 @@ export default createESLintRule<Options, MessageIds>({
       category: 'Best Practices',
       recommended: false,
     },
+    fixable: 'code',
     schema: [],
     messages: {
       sortNgmoduleMetadataArrays:
@@ -51,18 +52,26 @@ export default createESLintRule<Options, MessageIds>({
           ) {
             return;
           }
-          const unorderedNode = initializer.elements
+          const unorderedNodes = initializer.elements
             .filter(isIdentifier)
-            .find(({ name }, index, list) => {
-              const nextElementName = list[index + 1]?.name;
-              return (
-                nextElementName && name.localeCompare(nextElementName) === 1
-              );
+            .map((current, index, list) => {
+              return [current, list[index + 1]];
+            })
+            .find(([current, next]) => {
+              return next && current.name.localeCompare(next.name) === 1;
             });
-          if (!unorderedNode) return;
+          if (!unorderedNodes) return;
+
+          const [unorderedNode, nextNode] = unorderedNodes;
           context.report({
             messageId: 'sortNgmoduleMetadataArrays',
             node: unorderedNode,
+            fix: (fixer) => {
+              return [
+                fixer.replaceText(unorderedNode, nextNode.name),
+                fixer.replaceText(nextNode, unorderedNode.name),
+              ];
+            },
           });
         });
       },

diff --git a/packages/eslint-plugin/tests/rules/sort-ngmodule-metadata-arrays.test.ts b/packages/eslint-plugin/tests/rules/sort-ngmodule-metadata-arrays.test.ts
@@ -67,6 +67,18 @@ ruleTester.run(RULE_NAME, rule, {
       class Test {}
       `,
       messageId,
+      annotatedOutput: `
+      @NgModule({
+        imports: [
+          aModule,
+          bModule,
+          cModule,
+          ~~~~~~~
+          DModule,
+        ]
+      })
+      class Test {}
+      `,
     }),
     convertAnnotatedSourceToFailureCase({
       description: 'it should fail if declarations array is not sorted ASC',
@@ -83,6 +95,18 @@ ruleTester.run(RULE_NAME, rule, {
       class Test {}
       `,
       messageId,
+      annotatedOutput: `
+      @NgModule({
+        declarations: [
+          AComponent,
+          bDirective,
+          ~~~~~
+          cPipe,
+          DComponent,
+        ],
+      })
+      class Test {}
+      `,
     }),
     convertAnnotatedSourceToFailureCase({
       description: 'it should fail if exports array is not sorted ASC',
@@ -99,6 +123,18 @@ ruleTester.run(RULE_NAME, rule, {
       class Test {}
       `,
       messageId,
+      annotatedOutput: `
+      @NgModule({
+        exports: [
+          AComponent,
+          bDirective,
+          ~~~~~
+          cPipe,
+          DComponent,
+        ],
+      })
+      class Test {}
+      `,
     }),
     convertAnnotatedSourceToFailureCase({
       description: 'it should fail if bootstrap array is not sorted ASC',
@@ -114,6 +150,17 @@ ruleTester.run(RULE_NAME, rule, {
       class Test {}
       `,
       messageId,
+      annotatedOutput: `
+      @NgModule({
+        bootstrap: [
+          AppModule2,
+          AppModule1,
+          ~~~~~~~~~~
+          AppModule3,
+        ]
+      })
+      class Test {}
+      `,
     }),
     convertAnnotatedSourceToFailureCase({
       description: 'it should fail if schemas array is not sorted ASC',
@@ -129,6 +176,17 @@ ruleTester.run(RULE_NAME, rule, {
       class Test {}
       `,
       messageId,
+      annotatedOutput: `
+      @NgModule({
+        schemas: [
+          A_SCHEMA,
+          B_SCHEMA,
+          ~~~~~~~~
+          C_SCHEMA,
+        ]
+      })
+      class Test {}
+      `,
     }),
     convertAnnotatedSourceToFailureCase({
       description:
@@ -150,6 +208,22 @@ ruleTester.run(RULE_NAME, rule, {
       class Test {}
       `,
       messageId,
+      annotatedOutput: `
+      @NgModule({
+        imports: [
+          AProvider,
+          {
+            provide: 'myprovider',
+            useClass: MyProvider,
+          },
+          bProvider,
+          ~~~~~~~~~
+          cProvider,
+          DProvider,
+        ]
+      })
+      class Test {}
+      `,
     }),
   ],
 });