feat: add no default and depends on flag configuration rule

src/index.ts

@@ -46,6 +46,7 @@ import { noClassesInCommandReturnType } from './rules/no-classes-in-command-retu
 import { noExecCmdDoubleQuotes } from './rules/no-execCmd-double-quotes';
 import { noMessagesLoad } from './rules/no-messages-load';
 import { esmMessageImport } from './rules/esm-message-import';
+import { noDefaultDependsOnFlags } from "./rules/no-default-depends-on-flags";
 
 const library = {
   plugins: ['sf-plugin'],
@@ -84,6 +85,7 @@ const recommended = {
     'sf-plugin/no-args-parse-without-strict-false': 'error',
     'sf-plugin/no-hyphens-aliases': 'error',
     'sf-plugin/no-classes-in-command-return-type': 'error',
+    'sf-plugin/no-default-and-depends-on-flags': 'error',
   },
 };
 
@@ -107,13 +109,15 @@ export = {
         'sf-plugin/no-time-flags': 'error',
         'sf-plugin/no-id-flags': 'error',
         'sf-plugin/no-username-properties': 'error',
+        'sf-plugin/no-default-and-depends-on-flags': 'error',
         'sf-plugin/encourage-alias-deprecation': 'warn',
       },
     },
   },
   rules: {
     'esm-message-import': esmMessageImport,
     'no-h-short-char': dashH,
+    'no-default-and-depends-on-flags': noDefaultDependsOnFlags,
     'no-duplicate-short-characters': noDuplicateShortCharacters,
     'run-matches-class-type': runMatchesClassType,
     'flag-case': flagCasing,

src/rules/no-default-depends-on-flags.ts

@@ -0,0 +1,57 @@
+/*
+ * 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 { AST_NODE_TYPES } from '@typescript-eslint/utils';
+import { RuleCreator } from '@typescript-eslint/utils/eslint-utils';
+import { ancestorsContainsSfCommand, isInCommandDirectory } from '../shared/commands';
+import { flagPropertyIsNamed, isFlag } from '../shared/flags';
+
+export const noDefaultDependsOnFlags = RuleCreator.withoutDocs({
+  meta: {
+    docs: {
+      description: 'Do not allow creation of a flag with default value and dependsOn',
+      recommended: 'recommended',
+    },
+    messages: {
+      message: 'Cannot create a flag with a default value and dependsOn',
+    },
+    type: 'problem',
+    schema: [],
+  },
+  defaultOptions: [],
+  create(context) {
+    return isInCommandDirectory(context)
+      ? {
+        Property(node): void {
+          // is a flag
+          if (
+            isFlag(node) &&
+            ancestorsContainsSfCommand(context.getAncestors()) &&
+            node.value?.type === AST_NODE_TYPES.CallExpression &&
+            node.value.arguments?.[0]?.type === AST_NODE_TYPES.ObjectExpression
+          ) {
+            const dependsOn = node.value.arguments[0].properties.find(
+              (property) =>
+                property.type === AST_NODE_TYPES.Property &&
+                flagPropertyIsNamed(property, 'dependsOn')
+            );
+            const defaultValue = node.value.arguments[0].properties.find(
+              (property) =>
+                property.type === AST_NODE_TYPES.Property &&
+                flagPropertyIsNamed(property, 'default')
+            );
+            if (dependsOn && defaultValue) {
+              context.report({
+                node: dependsOn,
+                messageId: 'message',
+              });
+            }
+          }
+        },
+      }
+      : {};
+  },
+});

test/rules/no-default-depends-on-flags.test.ts

@@ -0,0 +1,52 @@
+/*
+ * 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 path from 'path';
+import { RuleTester } from '@typescript-eslint/rule-tester';
+
+import { noDefaultDependsOnFlags } from "../../src/rules/no-default-depends-on-flags";
+
+const ruleTester = new RuleTester({
+  parser: '@typescript-eslint/parser',
+});
+
+ruleTester.run('noDefaultDependsOnFlags', noDefaultDependsOnFlags, {
+  valid: [
+    {
+      name: 'does not use default and dependsOn',
+      filename: path.normalize('src/commands/foo.ts'),
+      code: `
+export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
+  public static flags = {
+    alias: Flags.string({
+      summary: 'foo',
+      char: 'a'
+    })
+  }
+}
+
+`,
+    },
+  ],
+  invalid: [
+    {
+      name: 'uses dependsOn and default',
+      filename: path.normalize('src/commands/foo.ts'),
+      errors: [{ messageId: 'message' }],
+      code: `
+export default class EnvCreateScratch extends SfCommand<Foo> {
+  public static flags = {
+    json: Flags.boolean({
+      char: 'h',
+      default: true,
+      dependsOn: ['myOtherFlag']
+    })
+  }
+}
+`,
+    },
+  ],
+});