fix: add back -h support (#104)

smithgp · web-flow · commit bf753e23dad3 · 2022-04-13T10:25:58.000-06:00
* fix: add back -h support

To bring in plugin-help, I also reved @salesforce/core and @salesforce/command.
That then needed some minor updates for changes to the types.

* chore: switch from deprecated core.fs
diff --git a/package.json b/package.json
@@ -6,8 +6,9 @@
   "bugs": "https://github.com/forcedotcom/analyticsdx-vscode/issues",
   "dependencies": {
     "@oclif/config": "^1",
-    "@salesforce/command": "^3.1.3",
-    "@salesforce/core": "^2.25.1",
+    "@oclif/plugin-help": "^3.3.1",
+    "@salesforce/command": "^4.2.2",
+    "@salesforce/core": "^2.36.0",
     "moment": "^2.24.0",
     "tslib": "^2"
   },
diff --git a/src/commands/analytics/app/create.ts b/src/commands/analytics/app/create.ts
@@ -5,9 +5,10 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
+import { promises as fs } from 'fs';
 import { EOL } from 'os';
 import { flags, SfdxCommand } from '@salesforce/command';
-import { fs, Messages, Org, SfdxError, StatusResult, StreamingClient } from '@salesforce/core';
+import { Messages, Org, SfdxError, StatusResult, StreamingClient } from '@salesforce/core';
 import { Duration } from '@salesforce/kit';
 import { JsonMap } from '@salesforce/ts-types';
 import chalk from 'chalk';
diff --git a/src/commands/analytics/query.ts b/src/commands/analytics/query.ts
@@ -5,9 +5,10 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
+import { promises as fs } from 'fs';
 import * as path from 'path';
 import { flags, SfdxCommand } from '@salesforce/command';
-import { fs, Messages, Org, SfdxError } from '@salesforce/core';
+import { Messages, Org, SfdxError } from '@salesforce/core';
 import QuerySvc, {
   DRYRUN_FLAG,
   LIMIT_FLAG,
diff --git a/test/commands/app/create.test.ts b/test/commands/app/create.test.ts
@@ -5,7 +5,8 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core } from '@salesforce/command';
+import { promises as fs } from 'fs';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 import { AnyJson, ensureJsonMap, ensureString } from '@salesforce/ts-types';
 import { StreamingClient } from '@salesforce/core';
@@ -188,7 +189,7 @@ describe('analytics:app:create', () => {
       }
       return Promise.reject();
     })
-    .stub(core.fs, 'readFile', () =>
+    .stub(fs, 'readFile', () =>
       Promise.resolve(
         JSON.stringify({
           templateSourceId: testTemplateJson.id,
@@ -222,7 +223,7 @@ describe('analytics:app:create', () => {
       }
       return Promise.reject();
     })
-    .stub(core.fs, 'readFile', () =>
+    .stub(fs, 'readFile', () =>
       Promise.resolve(
         JSON.stringify({
           templateSourceId: testTemplateJson.id,
@@ -256,7 +257,7 @@ describe('analytics:app:create', () => {
       }
       return Promise.reject();
     })
-    .stub(core.fs, 'readFile', () =>
+    .stub(fs, 'readFile', () =>
       Promise.resolve(
         JSON.stringify({
           assetIcon: '16.png',
@@ -300,7 +301,7 @@ describe('analytics:app:create', () => {
           })
       };
     })
-    .stub(core.fs, 'readFile', () =>
+    .stub(fs, 'readFile', () =>
       Promise.resolve(
         JSON.stringify({
           templateSourceId: testTemplateJson.id,
@@ -346,7 +347,7 @@ describe('analytics:app:create', () => {
         }
       };
     })
-    .stub(core.fs, 'readFile', () =>
+    .stub(fs, 'readFile', () =>
       Promise.resolve(
         JSON.stringify({
           templateSourceId: testTemplateJson.id,
@@ -396,7 +397,7 @@ describe('analytics:app:create', () => {
           })
       };
     })
-    .stub(core.fs, 'readFile', () =>
+    .stub(fs, 'readFile', () =>
       Promise.resolve(
         JSON.stringify({
           templateSourceId: testTemplateJson.id,
@@ -446,7 +447,7 @@ describe('analytics:app:create', () => {
         }
       };
     })
-    .stub(core.fs, 'readFile', () =>
+    .stub(fs, 'readFile', () =>
       Promise.resolve(
         JSON.stringify({
           templateSourceId: testTemplateJson.id,
diff --git a/test/commands/app/decouple.test.ts b/test/commands/app/decouple.test.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 
 core.Messages.importMessagesDirectory(__dirname);
diff --git a/test/commands/app/delete.test.ts b/test/commands/app/delete.test.ts
@@ -4,7 +4,7 @@
  * 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 { core } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 import { ensureJsonMap } from '@salesforce/ts-types';
 
diff --git a/test/commands/app/display.test.ts b/test/commands/app/display.test.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 
 core.Messages.importMessagesDirectory(__dirname);
diff --git a/test/commands/app/list.test.ts b/test/commands/app/list.test.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 import { ensureJsonMap, ensureString } from '@salesforce/ts-types';
 
diff --git a/test/commands/app/update.test.ts b/test/commands/app/update.test.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 
 const messages = core.Messages.loadMessages('@salesforce/analytics', 'app');
diff --git a/test/commands/asset/publisher/create.test.ts b/test/commands/asset/publisher/create.test.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 
 core.Messages.importMessagesDirectory(__dirname);
diff --git a/test/commands/asset/publisher/deleteall.test.ts b/test/commands/asset/publisher/deleteall.test.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 import { ensureJsonMap } from '@salesforce/ts-types';
 
diff --git a/test/commands/asset/publisher/list.test.ts b/test/commands/asset/publisher/list.test.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 
 core.Messages.importMessagesDirectory(__dirname);
diff --git a/test/commands/autoinstall/app/create.test.ts b/test/commands/autoinstall/app/create.test.ts
@@ -5,7 +5,8 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core, UX } from '@salesforce/command';
+import { UX } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 import { SfdxError } from '@salesforce/core';
 import { JsonMap } from '@salesforce/ts-types';
diff --git a/test/commands/autoinstall/app/delete.test.ts b/test/commands/autoinstall/app/delete.test.ts
@@ -5,7 +5,8 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core, UX } from '@salesforce/command';
+import { UX } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 import { SfdxError } from '@salesforce/core';
 import { JsonMap } from '@salesforce/ts-types';
diff --git a/test/commands/autoinstall/app/update.test.ts b/test/commands/autoinstall/app/update.test.ts
@@ -5,7 +5,8 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core, UX } from '@salesforce/command';
+import { UX } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 import { SfdxError } from '@salesforce/core';
 import { JsonMap } from '@salesforce/ts-types';
diff --git a/test/commands/autoinstall/list.test.ts b/test/commands/autoinstall/list.test.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 core.Messages.importMessagesDirectory(__dirname);
 const messages = core.Messages.loadMessages('@salesforce/analytics', 'autoinstall');
diff --git a/test/commands/dashboard/history/list.test.ts b/test/commands/dashboard/history/list.test.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 
 core.Messages.importMessagesDirectory(__dirname);
diff --git a/test/commands/dashboard/history/revert.test.ts b/test/commands/dashboard/history/revert.test.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 
 core.Messages.importMessagesDirectory(__dirname);
diff --git a/test/commands/dashboard/list.test.ts b/test/commands/dashboard/list.test.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 
 core.Messages.importMessagesDirectory(__dirname);
diff --git a/test/commands/dashboard/update.test.ts b/test/commands/dashboard/update.test.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 
 core.Messages.importMessagesDirectory(__dirname);
diff --git a/test/commands/dataflow/history/list.test.ts b/test/commands/dataflow/history/list.test.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 
 core.Messages.importMessagesDirectory(__dirname);
diff --git a/test/commands/dataflow/history/revert.test.ts b/test/commands/dataflow/history/revert.test.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 
 core.Messages.importMessagesDirectory(__dirname);
diff --git a/test/commands/dataflow/list.test.ts b/test/commands/dataflow/list.test.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 
 core.Messages.importMessagesDirectory(__dirname);
diff --git a/test/commands/dataset/display.test.ts b/test/commands/dataset/display.test.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 
 core.Messages.importMessagesDirectory(__dirname);
diff --git a/test/commands/dataset/list.test.ts b/test/commands/dataset/list.test.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 
 core.Messages.importMessagesDirectory(__dirname);
diff --git a/test/commands/dataset/rows/fetch.test.ts b/test/commands/dataset/rows/fetch.test.ts
@@ -7,7 +7,7 @@
 // the test data is actual data from a server, which uses _ in field names
 /* eslint-disable camelcase */
 
-import { core } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 import { SfdxError } from '@salesforce/core';
 import { AnyJson, JsonMap, ensureJsonMap, ensureString } from '@salesforce/ts-types';
diff --git a/test/commands/enable.test.ts b/test/commands/enable.test.ts
@@ -5,7 +5,8 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core, UX } from '@salesforce/command';
+import { UX } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 import { SfdxError } from '@salesforce/core';
 import { JsonMap } from '@salesforce/ts-types';
diff --git a/test/commands/lens/history/list.test.ts b/test/commands/lens/history/list.test.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 
 core.Messages.importMessagesDirectory(__dirname);
diff --git a/test/commands/lens/history/revert.test.ts b/test/commands/lens/history/revert.test.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 
 core.Messages.importMessagesDirectory(__dirname);
diff --git a/test/commands/lens/list.test.ts b/test/commands/lens/list.test.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 
 core.Messages.importMessagesDirectory(__dirname);
diff --git a/test/commands/query.test.ts b/test/commands/query.test.ts
@@ -7,7 +7,8 @@
 // our test data is real data from a server, which uses _'s in the field names
 /* eslint-disable camelcase */
 
-import { core } from '@salesforce/command';
+import { promises as fs } from 'fs';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 import { SfdxError } from '@salesforce/core';
 import { AnyJson, JsonMap, ensureJsonMap, ensureString } from '@salesforce/ts-types';
@@ -315,7 +316,7 @@ describe('analytics:query', () => {
       }
       return Promise.reject(new SfdxError('Invalid connection request'));
     })
-    .stub(core.fs, 'readFile', () => Promise.resolve(sqlResponse.query))
+    .stub(fs, 'readFile', () => Promise.resolve(sqlResponse.query))
     .stdout()
     .stderr()
     .command(['analytics:query', '-f', 'query.sql'])
@@ -348,7 +349,7 @@ describe('analytics:query', () => {
       }
       return Promise.reject(new SfdxError('Invalid connection request'));
     })
-    .stub(core.fs, 'readFile', () => Promise.resolve('q = load "datasetname";'))
+    .stub(fs, 'readFile', () => Promise.resolve('q = load "datasetname";'))
     .stderr()
     .stdout()
     .command(['analytics:query', '-f', 'query.saql'])
diff --git a/test/commands/template/create.test.ts b/test/commands/template/create.test.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 import { AnyJson, ensureJsonMap, ensureString } from '@salesforce/ts-types';
 
diff --git a/test/commands/template/delete.test.ts b/test/commands/template/delete.test.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { core } from '@salesforce/command';
+import * as core from '@salesforce/core';
 import { expect, test } from '@salesforce/command/lib/test';
 import { ensureJsonMap, ensureString } from '@salesforce/ts-types';
 
diff --git a/test/commands/template/display.test.ts b/test/commands/template/display.test.ts
diff --git a/test/commands/template/list.test.ts b/test/commands/template/list.test.ts
diff --git a/test/commands/template/update.test.ts b/test/commands/template/update.test.ts
diff --git a/tsconfig.json b/tsconfig.json
diff --git a/yarn.lock b/yarn.lock
