fix: parking orbit plugin-org

Author: cristiand391

bin/dev

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core');
+
+const path = require('path');
+const project = path.join(__dirname, '..', 'tsconfig.json');
+
+// In dev mode -> use ts-node and dev plugins
+process.env.NODE_ENV = 'development';
+
+require('ts-node').register({ project });
+
+// In dev mode, always show stack traces
+oclif.settings.debug = true;
+
+// Start the CLI
+oclif.run().then(oclif.flush).catch(oclif.Errors.handle);

bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\dev" %*

bin/run

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
 
-require('@oclif/command').run()
-.catch(require('@oclif/errors/handle'))
+const oclif = require('@oclif/core');
+
+oclif.run().then(require('@oclif/core/flush')).catch(require('@oclif/core/handle'));

bin/run.cmd

@@ -1,3 +1,3 @@
 @echo off
 
-node "%~dp0\run" %*
+node "%~dp0\run" %*

package.json

@@ -1,23 +1,24 @@
 {
   "name": "@salesforce/plugin-org",
-  "description": "A template repository for sfdx plugins",
-  "version": "1.13.0",
+  "description": "Commands to interact with Salesforce orgs",
+  "version": "2.0.0",
   "author": "Salesforce",
+  "main": "lib/index.js",
   "bugs": "https://github.com/forcedotcom/cli/issues",
   "dependencies": {
-    "@oclif/config": "^1.18.1",
-    "@salesforce/command": "^4.2.2",
-    "@salesforce/core": "^2.36.3",
+    "@oclif/core": "^1.7.0",
+    "@salesforce/command": "^5.1.0",
+    "@salesforce/core": "^3.18.2",
     "@salesforce/kit": "^1.5.17",
     "open": "8.4.0",
     "tslib": "^2"
   },
   "devDependencies": {
     "@oclif/dev-cli": "^1",
-    "@oclif/plugin-command-snapshot": "^2.2.2",
+    "@oclif/plugin-command-snapshot": "^3.1.3",
     "@salesforce/cli-plugins-testkit": "^1.5.3",
-    "@salesforce/dev-config": "^3.0.0",
-    "@salesforce/dev-scripts": "^2.0.0",
+    "@salesforce/dev-config": "^3.0.1",
+    "@salesforce/dev-scripts": "^2.0.2",
     "@salesforce/plugin-command-reference": "^1.3.0",
     "@salesforce/prettier-config": "^0.0.2",
     "@salesforce/ts-sinon": "1.3.21",
@@ -37,10 +38,10 @@
     "eslint-plugin-jsdoc": "^35.1.2",
     "eslint-plugin-prettier": "^3.1.3",
     "husky": "^7.0.4",
-    "lint-staged": "^11.0.0",
     "mocha": "^9.1.3",
     "moment": "^2.29.1",
     "nyc": "^15.1.0",
+    "oclif": "^3.0.1",
     "prettier": "^2.4.1",
     "pretty-quick": "^3.1.0",
     "shelljs": "^0.8.5",
@@ -49,9 +50,6 @@
     "ts-node": "^10.0.0",
     "typescript": "^4.4.4"
   },
-  "resolutions": {
-    "@salesforce/core": "^2.37.1"
-  },
   "config": {
     "commitizen": {
       "path": "cz-conventional-changelog"
@@ -110,11 +108,11 @@
     "prepare": "sf-install",
     "pretest": "sf-compile-test",
     "test": "sf-test",
-    "test:command-reference": "./bin/run commandreference:generate --erroronwarnings",
-    "test:deprecation-policy": "./bin/run snapshot:compare",
+    "test:command-reference": "./bin/dev commandreference:generate --erroronwarnings",
+    "test:deprecation-policy": "./bin/dev snapshot:compare",
     "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 600000 --parallel",
     "test:nuts:sandbox": "nyc mocha \"**/*.sandboxNut.ts\" --slow 450000 --timeout 7200000",
-    "version": "oclif-dev readme"
+    "version": "oclif readme"
   },
   "publishConfig": {
     "access": "public"

src/commands/force/org/beta/create.ts

@@ -11,7 +11,7 @@ import { flags, FlagsConfig, SfdxCommand } from '@salesforce/command';
 import { Duration } from '@salesforce/kit';
 import {
   AuthFields,
-  Aliases,
+  GlobalInfo,
   Config,
   Lifecycle,
   Messages,
@@ -22,7 +22,8 @@ import {
   SandboxProcessObject,
   SandboxRequest,
   SandboxUserAuthResponse,
-  SfdxError,
+  SfError,
+  SfdxPropertyKeys,
   StatusEvent,
   ScratchOrgRequest,
   ScratchOrgInfo,
@@ -114,10 +115,10 @@ export class Create extends SfdxCommand {
 
   private validateSandboxFlags(): void {
     if (!this.flags.targetusername) {
-      throw SfdxError.create('@salesforce/plugin-org', 'create', 'requiresUsername');
+      throw new SfError(messages.getMessage('requiresUsername'));
     }
     if (this.flags.retry !== 0) {
-      throw SfdxError.create('@salesforce/plugin-org', 'create', 'retryIsNotValidForSandboxes');
+      throw new SfError(messages.getMessage('retryIsNotValidForSandboxes'));
     }
 
     if (this.flags.clientid) {
@@ -169,7 +170,7 @@ export class Create extends SfdxCommand {
       this.ux.warn(`No SandboxName defined, generating new SandboxName: ${sandboxReq.SandboxName}`);
     }
     if (!sandboxReq.LicenseType) {
-      throw SfdxError.create('@salesforce/plugin-org', 'create', 'missingLicenseType');
+      throw new SfError(messages.getMessage('missingLicenseType'));
     }
     return sandboxReq;
   }
@@ -201,21 +202,19 @@ export class Create extends SfdxCommand {
       this.ux.log(sandboxReadyForUse);
       this.ux.styledHeader('Sandbox Org Creation Status');
       this.ux.table(data, {
-        columns: [
-          { key: 'key', label: 'Name' },
-          { key: 'value', label: 'Value' },
-        ],
+        key: { header: 'Name' },
+        value: { header: 'Value' },
       });
       if (results.sandboxRes?.authUserName) {
         if (this.flags.setalias) {
-          const alias = await Aliases.create(Aliases.getDefaultOptions());
-          alias.set(this.flags.setalias, results.sandboxRes.authUserName);
-          const result = await alias.write();
+          const globalInfo = await GlobalInfo.getInstance();
+          globalInfo.aliases.set(this.flags.setalias, results.sandboxRes.authUserName);
+          const result = await globalInfo.write();
           this.logger.debug('Set Alias: %s result: %s', this.flags.setalias, result);
         }
         if (this.flags.setdefaultusername) {
           const globalConfig: Config = this.configAggregator.getGlobalConfig();
-          globalConfig.set(Config.DEFAULT_USERNAME, results.sandboxRes.authUserName);
+          globalConfig.set(SfdxPropertyKeys.DEFAULT_USERNAME, results.sandboxRes.authUserName);
           const result = await globalConfig.write();
           this.logger.debug('Set defaultUsername: %s result: %s', this.flags.setdefaultusername, result);
         }
@@ -231,18 +230,18 @@ export class Create extends SfdxCommand {
       return prodOrg.createSandbox(sandboxReq, { wait });
     } catch (e) {
       // guaranteed to be SfdxError from core;
-      const err = e as SfdxError;
+      const err = e as SfError;
       if (err?.message.includes('The org cannot be found')) {
         // there was most likely an issue with DNS when auth'ing to the new sandbox, but it was created.
         if (this.flags.setalias && this.sandboxAuth) {
-          const alias = await Aliases.create(Aliases.getDefaultOptions());
-          alias.set(this.flags.setalias, this.sandboxAuth.authUserName);
-          const result = await alias.write();
+          const globalInfo = await GlobalInfo.getInstance();
+          globalInfo.aliases.set(this.flags.setalias, this.sandboxAuth.authUserName);
+          const result = await globalInfo.write();
           this.logger.debug('Set Alias: %s result: %s', this.flags.setalias, result);
         }
         if (this.flags.setdefaultusername && this.sandboxAuth) {
           const globalConfig: Config = this.configAggregator.getGlobalConfig();
-          globalConfig.set(Config.DEFAULT_USERNAME, this.sandboxAuth.authUserName);
+          globalConfig.set(SfdxPropertyKeys.DEFAULT_USERNAME, this.sandboxAuth.authUserName);
           const result = await globalConfig.write();
           this.logger.debug('Set defaultUsername: %s result: %s', this.flags.setdefaultusername, result);
         }
@@ -262,9 +261,9 @@ export class Create extends SfdxCommand {
   }
 
   private async setAliasAndDefaultUsername(username: string): Promise<void> {
-    const aliases = await Aliases.create(Aliases.getDefaultOptions());
+    const globalInfo = await GlobalInfo.getInstance();
     if (this.flags.setalias) {
-      await aliases.updateValue(this.flags.setalias, username);
+      globalInfo.aliases.update(this.flags.setalias, username);
       this.logger.debug('Set Alias: %s result: %s', this.flags.setalias);
     }
     if (this.flags.setdefaultusername) {
@@ -274,20 +273,20 @@ export class Create extends SfdxCommand {
       } catch {
         config = await Config.create({ isGlobal: true });
       }
-      const value = aliases.getKeysByValue(username)[0] || username;
-      const result = config.set(Config.DEFAULT_USERNAME, value);
+      const value = globalInfo.aliases.get(username) || username;
+      const result = config.set(SfdxPropertyKeys.DEFAULT_USERNAME, value);
       await config.write();
       this.logger.debug('Set defaultUsername: %s result: %s', this.flags.setdefaultusername, result);
     }
   }
   private async createScratchOrg(): Promise<ScratchOrgProcessObject> {
     this.logger.debug('OK, will do scratch org creation');
     if (!this.hubOrg) {
-      throw SfdxError.create('@salesforce/plugin-org', 'create', 'RequiresDevhubUsernameError');
+      throw new SfError(messages.getMessage('RequiresDevhubUsernameError'));
     }
     // Ensure we have an org config input source.
     if (!this.flags.definitionfile && Object.keys(this.varargs).length === 0) {
-      throw new SfdxError(messages.getMessage('noConfig'));
+      throw new SfError(messages.getMessage('noConfig'));
     }
 
     this.logger.debug('validation complete');

src/commands/force/org/clone.ts

@@ -9,13 +9,13 @@ import { EOL } from 'os';
 import * as fs from 'fs';
 import { flags, FlagsConfig, SfdxCommand } from '@salesforce/command';
 import {
-  SfdxError,
-  SfdxErrorConfig,
+  SfError,
   Config,
   Lifecycle,
   Messages,
   OrgTypes,
-  Aliases,
+  SfdxPropertyKeys,
+  GlobalInfo,
   SandboxEvents,
   SandboxRequest,
   StatusEvent,
@@ -82,21 +82,20 @@ export class OrgCloneCommand extends SfdxCommand {
         this.ux.log(sandboxReadyForUse);
         this.ux.styledHeader('Sandbox Org Cloning Status');
         this.ux.table(data, {
-          columns: [
-            { key: 'key', label: 'Name' },
-            { key: 'value', label: 'Value' },
-          ],
+          key: { header: 'Name' },
+          value: { header: 'Value' },
         });
 
         if (results?.sandboxRes?.authUserName) {
           if (this.flags.setalias) {
-            const alias = await Aliases.create({});
-            const result = alias.set(this.flags.setalias, results.sandboxRes.authUserName);
+            const globalInfo = await GlobalInfo.create();
+            globalInfo.aliases.set(this.flags.setalias, results.sandboxRes.authUserName);
+            const result = globalInfo.aliases.getAll();
             this.logger.debug('Set Alias: %s result: %s', this.flags.setalias, result);
           }
           if (this.flags.setdefaultusername) {
             const globalConfig: Config = this.configAggregator.getGlobalConfig();
-            globalConfig.set(Config.DEFAULT_USERNAME, results.sandboxRes.authUserName);
+            globalConfig.set(SfdxPropertyKeys.DEFAULT_USERNAME, results.sandboxRes.authUserName);
             const result = await globalConfig.write();
             this.logger.debug('Set defaultUsername: %s result: %s', this.flags.setdefaultusername, result);
           }
@@ -109,10 +108,9 @@ export class OrgCloneCommand extends SfdxCommand {
       const wait = this.flags.wait as Duration;
       return this.org.cloneSandbox(sandboxReq, srcSandboxName, { wait });
     } else {
-      throw SfdxError.create(
-        new SfdxErrorConfig('@salesforce/plugin-org', 'clone', 'commandOrganizationTypeNotSupport', [
-          OrgTypes.Sandbox,
-        ]).addAction('commandOrganizationTypeNotSupportAction', [OrgTypes.Sandbox])
+      throw new SfError(
+        messages.getMessage('commandOrganizationTypeNotSupport', [OrgTypes.Sandbox]),
+        messages.getMessage('commandOrganizationTypeNotSupportAction', [OrgTypes.Sandbox])
       );
     }
   }
@@ -145,10 +143,9 @@ export class OrgCloneCommand extends SfdxCommand {
       delete sandboxReq[OrgCloneCommand.SANDBOXDEF_SRC_SANDBOXNAME];
     } else {
       // error - we need SourceSandboxName to know which sandbox to clone from
-      throw SfdxError.create(
-        new SfdxErrorConfig('@salesforce/plugin-org', 'clone', 'missingSourceSandboxName', [
-          OrgCloneCommand.SANDBOXDEF_SRC_SANDBOXNAME,
-        ]).addAction('missingSourceSandboxNameAction', [OrgCloneCommand.SANDBOXDEF_SRC_SANDBOXNAME])
+      throw new SfError(
+        messages.getMessage('missingSourceSandboxName', [OrgCloneCommand.SANDBOXDEF_SRC_SANDBOXNAME]),
+        messages.getMessage('missingSourceSandboxNameAction', [OrgCloneCommand.SANDBOXDEF_SRC_SANDBOXNAME])
       );
     }
     return { sandboxReq, srcSandboxName };

src/commands/force/org/display.ts

@@ -7,7 +7,7 @@
 
 import * as os from 'os';
 import { flags, FlagsConfig, SfdxCommand } from '@salesforce/command';
-import { AuthInfo, Messages, sfdc, SfdxError } from '@salesforce/core';
+import { AuthInfo, Messages, sfdc, SfError } from '@salesforce/core';
 import { camelCaseToTitleCase } from '@salesforce/kit';
 
 import { OrgDisplayReturn, ScratchOrgFields } from '../../../shared/orgTypes';
@@ -71,12 +71,6 @@ export class OrgDisplayCommand extends SfdxCommand {
 
   private print(result: OrgDisplayReturn): void {
     this.ux.log('');
-    const columns = {
-      columns: [
-        { key: 'key', label: 'KEY' },
-        { key: 'value', label: 'VALUE' },
-      ],
-    };
     const tableRows = Object.keys(result)
       .filter((key) => result[key] !== undefined && result[key] !== null) // some values won't exist
       .sort() // this command always alphabetizes the table rows
@@ -86,7 +80,10 @@ export class OrgDisplayCommand extends SfdxCommand {
       }));
 
     this.ux.styledHeader('Org Description');
-    this.ux.table(tableRows, columns);
+    this.ux.table(tableRows, {
+      key: { header: 'KEY' },
+      value: { header: 'VALUE' },
+    });
   }
 
   private async getScratchOrgInformation(orgId: string): Promise<ScratchOrgFields> {
@@ -106,7 +103,7 @@ export class OrgDisplayCommand extends SfdxCommand {
         createdDate: result.CreatedDate,
       };
     }
-    throw new SfdxError(
+    throw new SfError(
       messages.getMessage('noScratchOrgInfoError', [sfdc.trimTo15(orgId), hubOrg.getUsername()]),
       'NoScratchInfo',
       [messages.getMessage('noScratchOrgInfoAction')]