chore: code review

Author: mdonnalley

package.json

@@ -9,7 +9,7 @@
     "@oclif/core": "^2.3.0",
     "@salesforce/core": "^3.33.4",
     "@salesforce/kit": "^1.9.0",
-    "@salesforce/sf-plugins-core": "^2.2.2",
+    "@salesforce/sf-plugins-core": "^2.2.3",
     "open": "8.4.1",
     "tslib": "^2"
   },

test/unit/org/display.test.ts

@@ -7,7 +7,7 @@
 import { expect, config as chaiConfig } from 'chai';
 import { MockTestOrgData, TestContext } from '@salesforce/core/lib/testSetup';
 import { Connection } from '@salesforce/core';
-import { stubSfCommandUx, stubUx } from '@salesforce/sf-plugins-core';
+import { stubSfCommandUx } from '@salesforce/sf-plugins-core';
 import { OrgDisplayCommand } from '../../../src/commands/org/display';
 import { OrgListUtil } from '../../../src/shared/orgListUtil';
 import { OrgDisplayReturn } from '../../../src/shared/orgTypes';
@@ -17,6 +17,10 @@ chaiConfig.truncateThreshold = 0;
 const refreshToken = '5Aep8616XE5JLxJp3EMunMMUzXg.Ye8T6EJDtnvz0aSok0TzLMkNbW7YRi99Yx85XLvz6zP44x_hVTl8pIW8S5_IW';
 
 describe('org:display', () => {
+  // Create new TestContext, which automatically creates and restores stubs
+  // pertaining to authorization, orgs, config files, etc...
+  // There is no need to call $$.restore() in afterEach() since that is
+  // done automatically by the TestContext.
   const $$ = new TestContext();
   let testOrg = new MockTestOrgData();
   let sfCommandUxStubs: ReturnType<typeof stubSfCommandUx>;
@@ -32,7 +36,9 @@ describe('org:display', () => {
   beforeEach(() => {
     testOrg = new MockTestOrgData();
     testOrg.orgId = '00Dxx0000000000';
-    stubUx($$.SANDBOX);
+    // Stub the ux methods on SfCommand so that you don't get any command output in your tests.
+    // You can also make assertions on the ux methods to ensure that they are called with the
+    // correct arguments.
     sfCommandUxStubs = stubSfCommandUx($$.SANDBOX);
   });
 

test/unit/org/list.test.ts

@@ -9,18 +9,22 @@ import * as chaiAsPromised from 'chai-as-promised';
 import { TestContext } from '@salesforce/core/lib/testSetup';
 import { AuthInfo, Connection, Org } from '@salesforce/core';
 import { stubMethod } from '@salesforce/ts-sinon';
-import { SfCommand, stubSfCommandUx, stubUx } from '@salesforce/sf-plugins-core';
+import { SfCommand, stubSfCommandUx } from '@salesforce/sf-plugins-core';
 import OrgListMock = require('../../shared/orgListMock');
 import { OrgListCommand } from '../../../src/commands/org/list';
 import { OrgListUtil } from '../../../src/shared/orgListUtil';
 
 ChaiUse(chaiAsPromised);
 
 describe('org:list', () => {
+  // Create new TestContext, which automatically creates and restores stubs
+  // pertaining to authorization, orgs, config files, etc...
+  // There is no need to call $$.restore() in afterEach() since that is
+  // done automatically by the TestContext.
   const $$ = new TestContext();
 
   beforeEach(async () => {
-    stubUx($$.SANDBOX);
+    // Stub the ux methods on SfCommand so that you don't get any command output in your tests.
     stubSfCommandUx($$.SANDBOX);
     stubMethod($$.SANDBOX, AuthInfo, 'listAllAuthorizations').resolves([
       'Jimi Hendrix',

yarn.lock

@@ -1141,10 +1141,10 @@
     chalk "^4"
     inquirer "^8.2.5"
 
-"@salesforce/sf-plugins-core@^2.2.2":
-  version "2.2.2"
-  resolved "https://registry.yarnpkg.com/@salesforce/sf-plugins-core/-/sf-plugins-core-2.2.2.tgz#ddecd6abc3a76a9bc201703f6f2971c8cf79b308"
-  integrity sha512-MQtfbpBJQbHpIxK1o5rpfPzPto4tWxBywJUvc1baTblafGyX7IZUt9Sl2Ld4XKgWga/7lxJNFfAnrbJLuIVe9Q==
+"@salesforce/sf-plugins-core@^2.2.3":
+  version "2.2.3"
+  resolved "https://registry.yarnpkg.com/@salesforce/sf-plugins-core/-/sf-plugins-core-2.2.3.tgz#f491156fbd83b18d01d943a43396a57009d10b42"
+  integrity sha512-B+ITa19o2ChAQXWNjmqxtXy7Bn0+dOcFwxqUhVR4YJ7wBzgvvGQ/pvG/WOah+v/uza91Jqfokq59D14fNAQfPw==
   dependencies:
     "@oclif/core" "^2.2.1"
     "@salesforce/core" "^3.33.1"