feat: add aliases to readonly props

salesforcecli · Mar 19, 2023 · 3fd5eaf · 3fd5eaf
1 parent 6d0bea0
commit 3fd5eaf
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 1 deletion.
diff --git a/src/rules/read-only-properties.ts b/src/rules/read-only-properties.ts
@@ -7,7 +7,7 @@
 import { AST_NODE_TYPES, ESLintUtils } from '@typescript-eslint/utils';
 import { extendsSfCommand, isInCommandDirectory } from '../shared/commands';
 
-const props = ['summary', 'description', 'examples', 'flags', 'requiresProject', 'hidden'];
+const props = ['summary', 'description', 'examples', 'flags', 'requiresProject', 'hidden', 'aliases'];
 
 export const readOnlyProperties = ESLintUtils.RuleCreator.withoutDocs({
   meta: {

diff --git a/test/rules/read-only-properties.test.ts b/test/rules/read-only-properties.test.ts
@@ -94,6 +94,58 @@ export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
   public static readonly description = 'bar'
   public static readonly summary = 'baz'
 }
+`,
+    },
+    {
+      name: 'aliases only modifies top-level, not flags (public)',
+      filename: path.normalize('src/commands/foo.ts'),
+      errors: [
+        {
+          messageId: 'public',
+          data: { prop: 'aliases' },
+        },
+      ],
+      output: `
+export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
+  public static readonly aliases = 'bar'
+  public static readonly flags = {
+    foo: flags.string({char: 'f', description: 'foo', aliases: ['g']}),
+  }
+}
+`,
+      code: `
+export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
+  protected static readonly aliases = 'bar'
+  public static readonly flags = {
+    foo: flags.string({char: 'f', description: 'foo', aliases: ['g']}),
+  }
+}
+`,
+    },
+    {
+      name: 'aliases only modifies top-level, not flags (readonly)',
+      filename: path.normalize('src/commands/foo.ts'),
+      errors: [
+        {
+          messageId: 'readonly',
+          data: { prop: 'aliases' },
+        },
+      ],
+      code: `
+export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
+  protected static aliases = 'bar'
+  public static readonly flags = {
+    foo: flags.string({char: 'f', description: 'foo', aliases: ['g']}),
+  }
+}
+`,
+      output: `
+export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
+  protected static readonly aliases = 'bar'
+  public static readonly flags = {
+    foo: flags.string({char: 'f', description: 'foo', aliases: ['g']}),
+  }
+}
 `,
     },
   ],