feat: only apply in /commands folder

salesforcecli · Jun 12, 2022 · 1c04f52 · 1c04f52
1 parent 8461761
commit 1c04f52
Show file tree

Hide file tree

Showing 12 changed files with 311 additions and 16 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -5,17 +5,23 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import { noDuplicateShortCharacters } from './rules/noDuplicateShortCharacters';
+import { flagSummary } from './rules/flagSummary';
 import { flagCasing } from './rules/flagCasing';
 import { extractMessage } from './rules/extractMessage';
 import { flagCrossReferences } from './rules/flagCrossReferences';
+import { commandSummary } from './rules/commandSummary';
+import { commandExamples } from './rules/commandExamples';
 
 export = {
   configs: {
     recommended: {
       plugins: ['sf-plugin'],
       rules: {
+        'sf-plugin/command-summary': 'error',
+        'sf-plugin/command-example': 'warn',
         'sf-plugin/no-duplicate-short-characters': 'error',
         'sf-plugin/flag-case': 'error',
+        'sf-plugin/flag-summary': 'error',
         'sf-plugin/no-hardcoded-messages': 'warn',
         'sf-plugin/flag-cross-references': 'error',
       },
@@ -24,7 +30,10 @@ export = {
   rules: {
     'no-duplicate-short-characters': noDuplicateShortCharacters,
     'flag-case': flagCasing,
+    'flag-summary': flagSummary,
     'no-hardcoded-messages': extractMessage,
     'flag-cross-references': flagCrossReferences,
+    'command-summary': commandSummary,
+    'command-example': commandExamples,
   },
 };
diff --git a/src/rules/extractMessage.ts b/src/rules/extractMessage.ts
@@ -6,6 +6,7 @@
  */
 import { ESLintUtils, AST_NODE_TYPES } from '@typescript-eslint/utils';
 import { isFlag } from '../shared/flags';
+import { ancestorsContainsSfCommand, isInCommandDirectory } from '../shared/commands';
 
 export const extractMessage = ESLintUtils.RuleCreator.withoutDocs({
   meta: {
@@ -24,11 +25,15 @@ export const extractMessage = ESLintUtils.RuleCreator.withoutDocs({
   create(context) {
     return {
       Property(node): void {
+        if (!isInCommandDirectory(context)) {
+          return;
+        }
+        const ancestors = context.getAncestors();
         if (
-          node.type === AST_NODE_TYPES.Property &&
           node.key.type === AST_NODE_TYPES.Identifier &&
           (node.key.name === 'summary' || node.key.name === 'description') &&
-          context.getAncestors().some((a) => isFlag(a))
+          ancestors.some((a) => isFlag(a)) &&
+          ancestorsContainsSfCommand(ancestors)
         ) {
           if (node.value.type === 'Literal') {
             context.report({

diff --git a/src/rules/flagCasing.ts b/src/rules/flagCasing.ts
@@ -5,6 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import { ESLintUtils } from '@typescript-eslint/utils';
+import { ancestorsContainsSfCommand, isInCommandDirectory } from '../shared/commands';
 import { getFlagName, isFlag } from '../shared/flags';
 
 export const flagCasing = ESLintUtils.RuleCreator.withoutDocs({
@@ -23,7 +24,7 @@ export const flagCasing = ESLintUtils.RuleCreator.withoutDocs({
   create(context) {
     return {
       Property(node): void {
-        if (isFlag(node)) {
+        if (isInCommandDirectory(context) && isFlag(node) && ancestorsContainsSfCommand(context.getAncestors())) {
           const flagName = getFlagName(node);
           if (flagName.toLowerCase() !== flagName) {
             context.report({

diff --git a/src/rules/flagCrossReferences.ts b/src/rules/flagCrossReferences.ts
@@ -5,6 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import { ESLintUtils } from '@typescript-eslint/utils';
+import { ancestorsContainsSfCommand, isInCommandDirectory } from '../shared/commands';
 import { isFlag, isFlagsStaticProperty } from '../shared/flags';
 
 // properties that reference other flags by name
@@ -26,14 +27,19 @@ export const flagCrossReferences = ESLintUtils.RuleCreator.withoutDocs({
   create(context) {
     return {
       Property(node): void {
+        if (!isInCommandDirectory(context)) {
+          return;
+        }
+        const ancestors = context.getAncestors();
         if (
           node.key.type === 'Identifier' &&
           node.value.type === 'ArrayExpression' &&
           node.value.elements.every((e) => e.type === 'Literal' && e.raw) &&
           propertyNames.includes(node.key.name) &&
-          context.getAncestors().some((a) => isFlag(a))
+          ancestorsContainsSfCommand(ancestors) &&
+          ancestors.some((a) => isFlag(a))
         ) {
-          const flagsNode = context.getAncestors().find((a) => isFlagsStaticProperty(a));
+          const flagsNode = ancestors.find((a) => isFlagsStaticProperty(a));
 
           const arrayValues = node.value.elements
             .map((e) => (e.type === 'Literal' ? e.value : undefined))

diff --git a/src/rules/flagSummary.ts b/src/rules/flagSummary.ts
@@ -0,0 +1,44 @@
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { ESLintUtils } from '@typescript-eslint/utils';
+import { ancestorsContainsSfCommand, isInCommandDirectory } from '../shared/commands';
+import { flagPropertyIsNamed, isFlag } from '../shared/flags';
+
+export const flagSummary = ESLintUtils.RuleCreator.withoutDocs({
+  meta: {
+    docs: {
+      description: 'Enforce that flags have a summary property',
+      recommended: 'error',
+    },
+    messages: {
+      message: 'Flags should have a summary property',
+    },
+    type: 'problem',
+    schema: [],
+  },
+  defaultOptions: [],
+  create(context) {
+    return {
+      Property(node): void {
+        if (isInCommandDirectory(context) && isFlag(node) && ancestorsContainsSfCommand(context.getAncestors())) {
+          if (
+            node.value?.type === 'CallExpression' &&
+            node.value.arguments?.[0]?.type === 'ObjectExpression' &&
+            !node.value.arguments[0].properties.some(
+              (property) => property.type === 'Property' && flagPropertyIsNamed(property, 'summary')
+            )
+          ) {
+            context.report({
+              node,
+              messageId: 'message',
+            });
+          }
+        }
+      },
+    };
+  },
+});
diff --git a/src/shared/commands.ts b/src/shared/commands.ts
@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import { sep } from 'path';
+import { AST_NODE_TYPES, TSESTree } from '@typescript-eslint/utils';
+import { RuleContext } from '@typescript-eslint/utils/dist/ts-eslint';
+
+export const isClassDeclaration = (node: TSESTree.Node): node is TSESTree.ClassDeclaration =>
+  node.type === AST_NODE_TYPES.ClassDeclaration;
+
+export const ancestorsContainsSfCommand = (ancestors: TSESTree.Node[]): boolean =>
+  ancestors.some((a) => isClassDeclaration(a) && extendsSfCommand(a));
+
+export const extendsSfCommand = (node: TSESTree.ClassDeclaration): boolean =>
+  node.superClass?.type === AST_NODE_TYPES.Identifier && node.superClass.name === 'SfCommand';
+
+export const getClassPropertyIdentifierName = (node: TSESTree.ClassElement): string =>
+  node.type === 'PropertyDefinition' && node.key.type === AST_NODE_TYPES.Identifier ? node.key.name : undefined;
+
+// we don't care what the types are, really any context will do
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export const isInCommandDirectory = (context: RuleContext<any, any>): boolean => {
+  return context.getPhysicalFilename().includes(`${sep}commands${sep}`); // not an sfCommand
+};
diff --git a/src/shared/flags.ts b/src/shared/flags.ts
@@ -20,17 +20,32 @@ export const getFlagName = (node: TSESTree.Node): string => {
   }
 };
 
+/** Current node is 'foo' : Flags.x({}) */
 export const isFlag = (node: TSESTree.Node): boolean =>
   node.type === AST_NODE_TYPES.Property &&
   node.value?.type === 'CallExpression' &&
   node.value?.callee?.type === 'MemberExpression' &&
   node.value?.callee?.object?.type === 'Identifier' &&
   node.value?.callee?.object?.name === 'Flags';
 
+/** Current node is public static flags = */
 export const isFlagsStaticProperty = (node: TSESTree.Node): boolean =>
   node.type === AST_NODE_TYPES.PropertyDefinition &&
   node.static &&
   node.value?.type === AST_NODE_TYPES.ObjectExpression &&
   node.key.type === AST_NODE_TYPES.Identifier &&
   node.key.name === 'flags' &&
   node.accessibility === 'public';
+
+export const flagPropertyIsNamed = (node: TSESTree.Property, name: string): node is TSESTree.Property =>
+  resolveFlagName(node) === name;
+
+/** pass in a flag Property and it gives back the key name/value depending on type */
+export const resolveFlagName = (flag: TSESTree.PropertyComputedName | TSESTree.PropertyNonComputedName): string => {
+  if (flag.key.type === AST_NODE_TYPES.Identifier) {
+    return flag.key.name;
+  }
+  if (flag.key.type === AST_NODE_TYPES.Literal && typeof flag.key.value === 'string') {
+    return flag.key.value;
+  }
+};
diff --git a/test/rules/duplicateChars.test.ts b/test/rules/duplicateChars.test.ts
@@ -14,7 +14,9 @@ const ruleTester = new ESLintUtils.RuleTester({
 ruleTester.run('no duplicate short characters', noDuplicateShortCharacters, {
   valid: [
     // example with different chars
-    `
+    {
+      filename: 'src/commands/foo.ts',
+      code: `
 export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
   public static flags = {
     alias: Flags.string({
@@ -27,11 +29,32 @@ export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
 }
 
 `,
+    },
     // example with some chars not present
-    `
+    {
+      filename: 'src/commands/foo.ts',
+      code: `
+export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
+  public static flags = {
+    alias: Flags.string({
+    }),
+    'some-literal': Flags.string({
+      char: 'b'
+    }),
+  }
+}
+
+`,
+    },
+
+    // bad but not in commands directory
+    {
+      filename: 'src/foo.ts',
+      code: `
 export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
   public static flags = {
     alias: Flags.string({
+      char: 'b'
     }),
     'some-literal': Flags.string({
       char: 'b'
@@ -40,6 +63,7 @@ export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
 }
 
 `,
+    },
   ],
   invalid: [
     {
@@ -49,6 +73,7 @@ export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
           data: { flag2: 'alias', flag1: 'some-literal', char: "'a'" },
         },
       ],
+      filename: 'src/commands/foo.ts',
       code: `
 export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
   public static flags = {

diff --git a/test/rules/extractMessage.test.ts b/test/rules/extractMessage.test.ts
@@ -14,7 +14,9 @@ const ruleTester = new ESLintUtils.RuleTester({
 ruleTester.run('no duplicate short characters', extractMessage, {
   valid: [
     // no messages is fine
-    `
+    {
+      filename: 'src/commands/foo.ts',
+      code: `
 export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
   public static flags = {
     alias: Flags.string({
@@ -23,8 +25,11 @@ export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
   }
 }
 `,
+    },
     // summary only
-    `
+    {
+      filename: 'src/commands/foo.ts',
+      code: `
 export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
   public static flags = {
     alias: Flags.string({
@@ -33,7 +38,10 @@ export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
   }
 }
 `,
-    `
+    },
+    {
+      filename: 'src/commands/foo.ts',
+      code: `
 export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
   public static flags = {
     alias: Flags.string({
@@ -43,7 +51,10 @@ export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
   }
 }
 `,
-    `
+    },
+    {
+      filename: 'src/commands/foo.ts',
+      code: `
 export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
   public static flags = {
     alias: Flags.string({
@@ -52,9 +63,26 @@ export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
   }
 }
 `,
+    },
+    // all sorts of violations but not in the commands directory
+    {
+      filename: 'src/foo.ts',
+      code: `
+export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
+  public static flags = {
+    alias: Flags.string({
+      description: 'foo',
+      summary: 'foo'
+    }),
+  }
+}
+`,
+    },
   ],
   invalid: [
     {
+      filename: 'src/commands/foo.ts',
+
       errors: [
         {
           messageId: 'message',
@@ -76,6 +104,8 @@ export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
           messageId: 'message',
         },
       ],
+      filename: 'src/commands/foo.ts',
+
       code: `
 export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
   public static flags = {
@@ -95,6 +125,8 @@ export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
           messageId: 'message',
         },
       ],
+      filename: 'src/commands/foo.ts',
+
       code: `
 export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
   public static flags = {