fix: handle flag that are 'literals' (surrounded by single quotes) in…

…stead of a basic identifier
salesforcecli · Jul 26, 2023 · ab5689b · ab5689b
1 parent d2c5c68
commit ab5689b
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 20 deletions.
diff --git a/src/rules/extract-message-flags.ts b/src/rules/extract-message-flags.ts
@@ -5,7 +5,8 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import { ESLintUtils, AST_NODE_TYPES } from '@typescript-eslint/utils';
-import { isFlag } from '../shared/flags';
+import { isNodeOfType } from '@typescript-eslint/utils/dist/ast-utils';
+import { isFlag, resolveFlagName } from '../shared/flags';
 import { ancestorsContainsSfCommand, isInCommandDirectory } from '../shared/commands';
 
 export const extractMessageFlags = ESLintUtils.RuleCreator.withoutDocs({
@@ -44,11 +45,8 @@ export const extractMessageFlags = ESLintUtils.RuleCreator.withoutDocs({
                   messageId: 'message',
                 });
               }
-              const flag = ancestors.find((a) => isFlag(a));
-              const flagName =
-                flag?.type === AST_NODE_TYPES.Property &&
-                flag.key.type === AST_NODE_TYPES.Identifier &&
-                flag?.key?.name;
+              const flag = ancestors.filter(isNodeOfType(AST_NODE_TYPES.Property)).find((a) => isFlag(a));
+              const flagName = flag ? resolveFlagName(flag) : undefined;
               if (
                 flagName &&
                 node.value.type === AST_NODE_TYPES.CallExpression &&

diff --git a/src/rules/flag-casing.ts b/src/rules/flag-casing.ts
@@ -6,7 +6,7 @@
  */
 import { ESLintUtils } from '@typescript-eslint/utils';
 import { ancestorsContainsSfCommand, isInCommandDirectory } from '../shared/commands';
-import { getFlagName, isFlag } from '../shared/flags';
+import { isFlag, resolveFlagName } from '../shared/flags';
 
 const toLowerKebabCase = (str: string): string =>
   str
@@ -33,8 +33,8 @@ export const flagCasing = ESLintUtils.RuleCreator.withoutDocs({
       ? {
           Property(node): void {
             if (isFlag(node) && ancestorsContainsSfCommand(context.getAncestors())) {
-              const flagName = getFlagName(node);
-              if (toLowerKebabCase(flagName) !== flagName) {
+              const flagName = resolveFlagName(node);
+              if (flagName && toLowerKebabCase(flagName) !== flagName) {
                 context.report({
                   node,
                   messageId: 'message',

diff --git a/src/shared/flags.ts b/src/shared/flags.ts
@@ -7,17 +7,6 @@
 
 import { AST_NODE_TYPES, TSESTree } from '@typescript-eslint/utils';
 
-export const getFlagName = (node: TSESTree.Property): string => {
-  switch (node.key.type) {
-    case 'Identifier':
-      return node.key.name;
-    case 'Literal':
-      return node.key.value as string;
-    default:
-      throw new Error(`Unknown flag type ${node.key.type}`);
-  }
-};
-
 /** Current node is 'foo' : Flags.x({}) */
 export const isFlag = (node: TSESTree.Node): boolean =>
   node.type === AST_NODE_TYPES.Property &&

diff --git a/test/rules/extract-message-flags.test.ts b/test/rules/extract-message-flags.test.ts
@@ -65,6 +65,19 @@ export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
     }),
   }
 }
+`,
+    },
+    {
+      name: 'flag with a hyphen',
+      filename: path.normalize('src/commands/foo.ts'),
+      code: `
+export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
+  public static flags = {
+    'hyphen-flag': Flags.string({
+      description: messages.getMessage('flags.hyphen-flag.description')
+    }),
+  }
+}
 `,
     },
     {
@@ -201,6 +214,34 @@ export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
     }),
   }
 }
+`,
+    },
+    {
+      name: 'description flag naming with a hyphen',
+      filename: path.normalize('src/commands/foo.ts'),
+      errors: [
+        {
+          messageId: 'descriptionFormat',
+          data: { name: 'hyphen-flag' },
+        },
+      ],
+      output: `
+export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
+  public static flags = {
+    'hyphen-flag': Flags.string({
+      description: messages.getMessage('flags.hyphen-flag.description')
+    }),
+  }
+}
+`,
+      code: `
+export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
+  public static flags = {
+    'hyphen-flag': Flags.string({
+      description: messages.getMessage('flags.hyphenFlag.desc')
+    }),
+  }
+}
 `,
     },
   ],