Merge pull request #5 from salesforcecli/sm/pr-feedback-as-pr

Sm/pr feedback as pr

Author: iowillhoit

.github/dependabot.yml

@@ -1,21 +1,21 @@
 version: 2
 updates:
-  - package-ecosystem: "npm"
-    directory: "/"
+  - package-ecosystem: 'npm'
+    directory: '/'
     schedule:
-      interval: "weekly"
-      day: "saturday"
-    versioning-strategy: "increase"
+      interval: 'weekly'
+      day: 'saturday'
+    versioning-strategy: 'increase'
     labels:
-      - "dependencies"
+      - 'dependencies'
     open-pull-requests-limit: 5
     pull-request-branch-name:
-      separator: "-"
+      separator: '-'
     commit-message:
       # cause a release for non-dev-deps
       prefix: fix(deps)
       # no release for dev-deps
       prefix-development: chore(dev-deps)
     ignore:
-      - dependency-name: "*"
-        update-types: ["version-update:semver-major"]
+      - dependency-name: '*'
+        update-types: ['version-update:semver-major']

package.json

@@ -15,26 +15,25 @@
     "@oclif/test": "^2.1.1",
     "@salesforce/cli-plugins-testkit": "^2.3.10",
     "@salesforce/dev-config": "^3.1.0",
-    "@salesforce/dev-scripts": "^2.0.4",
+    "@salesforce/dev-scripts": "^3.0.0",
     "@salesforce/kit": "^1.5.45",
     "@salesforce/plugin-command-reference": "^2.2.8",
     "@salesforce/prettier-config": "^0.0.2",
     "@salesforce/ts-sinon": "^1.3.21",
     "@salesforce/ts-types": "^1.5.20",
     "@types/fs-extra": "^9.0.13",
     "@types/shelljs": "^0.8.11",
-    "@typescript-eslint/eslint-plugin": "^4.33.0",
-    "@typescript-eslint/parser": "^4.33.0",
+    "@typescript-eslint/eslint-plugin": "^5.33.0",
+    "@typescript-eslint/parser": "^5.33.0",
     "chai": "^4.3.6",
-    "eslint": "^7.32.0",
+    "eslint": "^8.21.0",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-config-salesforce": "^0.1.6",
+    "eslint-config-salesforce": "^1.1.0",
     "eslint-config-salesforce-license": "^0.1.6",
-    "eslint-config-salesforce-typescript": "^0.2.8",
+    "eslint-config-salesforce-typescript": "^1.1.1",
     "eslint-plugin-header": "^3.1.1",
-    "eslint-plugin-import": "2.26.0",
-    "eslint-plugin-jsdoc": "^35.5.1",
-    "eslint-plugin-prettier": "^3.4.1",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-jsdoc": "^39.3.6",
     "eslint-plugin-sf-plugin": "^0.3.0",
     "fs-extra": "^10.1.0",
     "husky": "^7.0.4",
@@ -122,4 +121,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}

src/commands/config/set.ts

@@ -30,16 +30,18 @@ export class Set extends ConfigCommand<ConfigResponses> {
 
   public async run(): Promise<ConfigResponses> {
     const { flags } = await this.parse(Set);
-    const config: Config = await this.loadConfig(flags.global);
-    let value = '';
+    const config: Config = await loadConfig(flags.global);
     const configs = await this.parseConfigKeysAndValues();
     for (const name of Object.keys(configs)) {
+      // We need to allow `undefined` here so that we can support unsetting with set=''
+      // See the "use set to unset a config key" NUT
+      const value = configs[name];
       try {
-        value = configs[name];
         // core's builtin config validation requires synchronous functions but there's
         // currently no way to validate an org synchronously. Therefore, we have to manually
         // validate the org here and manually set the error message if it fails
-        if (this.isOrgKey(name) && value) await this.validateOrg(value);
+        // eslint-disable-next-line no-await-in-loop
+        if (isOrgKey(name) && value) await validateOrg(value);
         config.set(name, value);
         this.responses.push({ name, value, success: true });
       } catch (err) {
@@ -92,31 +94,29 @@ export class Set extends ConfigCommand<ConfigResponses> {
 
     return configs;
   }
+}
 
-  protected async loadConfig(global: boolean): Promise<Config> {
-    try {
-      const config = await Config.create(Config.getDefaultOptions(global));
-      await config.read();
-      return config;
-    } catch (error) {
-      if (error instanceof SfdxError) {
-        error.actions = error.actions || [];
-        error.actions.push('Run with --global to set for your entire workspace.');
-      }
-      throw error;
+const loadConfig = async (global: boolean): Promise<Config> => {
+  try {
+    const config = await Config.create(Config.getDefaultOptions(global));
+    await config.read();
+    return config;
+  } catch (error) {
+    if (error instanceof SfdxError) {
+      error.actions = error.actions || [];
+      error.actions.push('Run with --global to set for your entire workspace.');
     }
+    throw error;
   }
+};
 
-  private isOrgKey(name: string): boolean {
-    const orgKeys = [OrgConfigProperties.TARGET_DEV_HUB, OrgConfigProperties.TARGET_ORG] as string[];
-    return orgKeys.includes(name);
-  }
+const isOrgKey = (name: string): boolean =>
+  [OrgConfigProperties.TARGET_DEV_HUB as string, OrgConfigProperties.TARGET_ORG as string].includes(name);
 
-  private async validateOrg(value: string): Promise<void> {
-    try {
-      await Org.create({ aliasOrUsername: value });
-    } catch {
-      throw new Error(`Invalid config value: org "${value}" is not authenticated.`);
-    }
+const validateOrg = async (value: string): Promise<void> => {
+  try {
+    await Org.create({ aliasOrUsername: value });
+  } catch {
+    throw new Error(`Invalid config value: org "${value}" is not authenticated.`);
   }
-}
+};

test/commands/config/get.test.ts

@@ -40,7 +40,7 @@ describe('config:get', () => {
   }
 
   test
-    .do(async () => await prepareStubs(true))
+    .do(async () => prepareStubs(true))
     .stdout()
     .command(['config:get', OrgConfigProperties.TARGET_DEV_HUB, OrgConfigProperties.TARGET_ORG, '--json'])
     .it('should return values for globally configured properties', (ctx) => {
@@ -52,7 +52,7 @@ describe('config:get', () => {
     });
 
   test
-    .do(async () => await prepareStubs(false))
+    .do(async () => prepareStubs(false))
     .stdout()
     .command(['config:get', OrgConfigProperties.TARGET_DEV_HUB, OrgConfigProperties.TARGET_ORG, '--json'])
     .it('should return values for locally configured properties', (ctx) => {
@@ -64,7 +64,7 @@ describe('config:get', () => {
     });
 
   test
-    .do(async () => await prepareStubs())
+    .do(async () => prepareStubs())
     .stdout()
     .command(['config:get', OrgConfigProperties.ORG_API_VERSION, '--json'])
     .it('should gracefully handle unconfigured properties', (ctx) => {
@@ -78,7 +78,7 @@ describe('config:get', () => {
     });
 
   test
-    .do(async () => await prepareStubs())
+    .do(async () => prepareStubs())
     .stdout()
     .command(['config:get', '--json'])
     .it('should throw an error when no keys are provided', (ctx) => {
@@ -87,7 +87,7 @@ describe('config:get', () => {
     });
 
   test
-    .do(async () => await prepareStubs())
+    .do(async () => prepareStubs())
     .stdout()
     .command(['config:get', SfConfigProperties.DISABLE_TELEMETRY, '--json'])
     .it('should gracefully handle failed attempts to ConfigAggregator.getInfo', (ctx) => {

test/commands/config/set.test.ts

@@ -31,7 +31,7 @@ describe('config:set', () => {
   }
 
   test
-    .do(async () => await prepareStubs())
+    .do(async () => prepareStubs())
     .stdout()
     .command(['config:set', `${OrgConfigProperties.ORG_API_VERSION}=49.0`, '--global', '--json'])
     .it('should return values for all configured properties', (ctx) => {

test/commands/config/unset.test.ts

@@ -37,7 +37,7 @@ describe('config:unset', () => {
   }
 
   test
-    .do(async () => await prepareStubs())
+    .do(async () => prepareStubs())
     .stdout()
     .command(['config:unset', `${OrgConfigProperties.ORG_API_VERSION}`, '--global', '--json'])
     .it('should unset values for a single property', (ctx) => {
@@ -47,7 +47,7 @@ describe('config:unset', () => {
     });
 
   test
-    .do(async () => await prepareStubs())
+    .do(async () => prepareStubs())
     .stdout()
     .command([
       'config:unset',
@@ -66,7 +66,7 @@ describe('config:unset', () => {
     });
 
   test
-    .do(async () => await prepareStubs())
+    .do(async () => prepareStubs())
     .stdout()
     .command(['config:unset', '--json'])
     .it('should throw an error if no properties are provided', (ctx) => {
@@ -75,7 +75,7 @@ describe('config:unset', () => {
     });
 
   test
-    .do(async () => await prepareStubs(true))
+    .do(async () => prepareStubs(true))
     .stdout()
     .command(['config:unset', `${OrgConfigProperties.ORG_API_VERSION}`, '--global', '--json'])
     .it('should handle errors with --json flag', (ctx) => {
@@ -95,7 +95,7 @@ describe('config:unset', () => {
     });
 
   test
-    .do(async () => await prepareStubs(true))
+    .do(async () => prepareStubs(true))
     .stdout()
     .command(['config:unset', `${OrgConfigProperties.ORG_API_VERSION}`, '--global'])
     .it('should handle errors with no --json flag', (ctx) => {