feat: hide deprecated commands (#1050)

salesforcecli · Jan 3, 2024 · ed172ae · ed172ae
1 parent 6ceea73
commit ed172ae
Show file tree

Hide file tree

Showing 12 changed files with 24 additions and 29 deletions.
diff --git a/src/commands/force/mdapi/deploy.ts b/src/commands/force/mdapi/deploy.ts
@@ -5,7 +5,6 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-
 import { Duration, env } from '@salesforce/kit';
 import { Lifecycle, Messages, Org } from '@salesforce/core';
 import { AsyncResult, DeployVersionData, MetadataApiDeploy } from '@salesforce/source-deploy-retrieve';
@@ -32,7 +31,7 @@ import { DeployProgressStatusFormatter } from '../../../formatters/deployProgres
 import { MdDeployAsyncResultFormatter } from '../../../formatters/mdapi/mdDeployAsyncResultFormatter.js';
 import { ResultFormatterOptions } from '../../../formatters/resultFormatter.js';
 
-Messages.importMessagesDirectoryFromMetaUrl(import.meta.url)
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-source', 'md.deploy');
 const deployMessages = Messages.loadMessages('@salesforce/plugin-source', 'deployCommand');
 
@@ -46,6 +45,7 @@ export class Deploy extends DeployCommand {
     to: replacement,
     message: messages.getMessage('deprecation', [replacement]),
   };
+  public static readonly hidden = true;
   public static readonly summary = messages.getMessage('summary');
   public static readonly examples = messages.getMessages('examples');
   public static readonly flags = {

diff --git a/src/commands/force/mdapi/deploy/cancel.ts b/src/commands/force/mdapi/deploy/cancel.ts
@@ -5,7 +5,6 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-
 import { Connection, Messages, SfError } from '@salesforce/core';
 import { Duration } from '@salesforce/kit';
 import { RequestStatus } from '@salesforce/source-deploy-retrieve';
@@ -23,7 +22,7 @@ import {
   DeployCancelResultFormatter,
 } from '../../../../formatters/deployCancelResultFormatter.js';
 
-Messages.importMessagesDirectoryFromMetaUrl(import.meta.url)
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-source', 'md.cancel');
 
 const replacement = 'project deploy cancel';
@@ -33,6 +32,7 @@ export class Cancel extends DeployCommand {
   public static readonly summary = messages.getMessage('summary');
   public static readonly examples = messages.getMessages('examples');
   public static readonly state = 'deprecated';
+  public static readonly hidden = true;
   public static readonly deprecationOptions = {
     to: replacement,
     message: messages.getMessage('deprecation', [replacement]),

diff --git a/src/commands/force/mdapi/deploy/report.ts b/src/commands/force/mdapi/deploy/report.ts
@@ -5,7 +5,6 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-
 import { Messages, Org } from '@salesforce/core';
 import { Duration, env } from '@salesforce/kit';
 import { RequestStatus } from '@salesforce/source-deploy-retrieve';
@@ -24,7 +23,7 @@ import { ProgressFormatter } from '../../../../formatters/progressFormatter.js';
 import { DeployProgressBarFormatter } from '../../../../formatters/deployProgressBarFormatter.js';
 import { DeployProgressStatusFormatter } from '../../../../formatters/deployProgressStatusFormatter.js';
 
-Messages.importMessagesDirectoryFromMetaUrl(import.meta.url)
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-source', 'md.deployreport');
 
 const replacement = 'project deploy report';
@@ -34,6 +33,7 @@ export class Report extends DeployCommand {
   public static readonly description = messages.getMessage('description');
   public static readonly examples = messages.getMessages('examples');
   public static readonly state = 'deprecated';
+  public static readonly hidden = true;
   public static readonly deprecationOptions = {
     to: replacement,
     message: messages.getMessage('deprecation', ['project deploy start', replacement]),

diff --git a/src/commands/force/mdapi/retrieve.ts b/src/commands/force/mdapi/retrieve.ts
@@ -5,7 +5,6 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-
 import { Lifecycle, Messages, Org, SfError, SfProject } from '@salesforce/core';
 import { Duration } from '@salesforce/kit';
 import {
@@ -32,7 +31,7 @@ import {
   RetrieveResultFormatter,
 } from '../../../formatters/mdapi/retrieveResultFormatter.js';
 
-Messages.importMessagesDirectoryFromMetaUrl(import.meta.url)
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-source', 'md.retrieve');
 const spinnerMessages = Messages.loadMessages('@salesforce/plugin-source', 'spinner');
 const retrieveMessages = Messages.loadMessages('@salesforce/plugin-source', 'retrieve');
@@ -45,6 +44,7 @@ export class Retrieve extends SourceCommand {
     to: replacement,
     message: messages.getMessage('deprecation', [replacement]),
   };
+  public static readonly hidden = true;
   public static readonly summary = messages.getMessage('retrieve.summary');
   public static readonly description = messages.getMessage('retrieve.description');
   public static readonly examples = messages.getMessages('retrieve.examples');

diff --git a/src/commands/force/mdapi/retrieve/report.ts b/src/commands/force/mdapi/retrieve/report.ts
@@ -5,7 +5,6 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-
 import { Messages, Org, SfError } from '@salesforce/core';
 import { Duration } from '@salesforce/kit';
 import { MetadataApiRetrieve, MetadataApiRetrieveStatus, RetrieveResult } from '@salesforce/source-deploy-retrieve';
@@ -25,7 +24,7 @@ import {
   RetrieveResultFormatter,
 } from '../../../../formatters/mdapi/retrieveResultFormatter.js';
 
-Messages.importMessagesDirectoryFromMetaUrl(import.meta.url)
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-source', 'md.retrieve');
 const spinnerMessages = Messages.loadMessages('@salesforce/plugin-source', 'spinner');
 export type ReportCommandResult = RetrieveCommandResult | RetrieveCommandAsyncResult;
@@ -34,6 +33,7 @@ export class Report extends SourceCommand {
   public static readonly description = messages.getMessage('report.description');
   public static readonly examples = messages.getMessages('report.examples');
   public static readonly state = 'deprecated';
+  public static readonly hidden = true;
   public static readonly flags = {
     'api-version': orgApiVersionFlagWithDeprecations,
     loglevel,

diff --git a/src/commands/force/source/deploy.ts b/src/commands/force/source/deploy.ts
@@ -5,8 +5,6 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-
-
 import { Lifecycle, Messages, Org } from '@salesforce/core';
 import { Duration, env } from '@salesforce/kit';
 import { SourceTracking } from '@salesforce/source-tracking';
@@ -37,7 +35,7 @@ import { DeployProgressStatusFormatter } from '../../../formatters/deployProgres
 import { filterConflictsByComponentSet, trackingSetup, updateTracking } from '../../../trackingFunctions.js';
 import { ResultFormatterOptions } from '../../../formatters/resultFormatter.js';
 
-Messages.importMessagesDirectoryFromMetaUrl(import.meta.url)
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 
 const messages = Messages.loadMessages('@salesforce/plugin-source', 'deploy');
 const deployMessages = Messages.loadMessages('@salesforce/plugin-source', 'deployCommand');
@@ -53,6 +51,7 @@ export class Deploy extends DeployCommand {
   public static readonly description = messages.getMessage('description');
   public static readonly examples = messages.getMessages('examples');
   public static readonly state = 'deprecated';
+  public static readonly hidden = true;
   public static readonly deprecationOptions = {
     to: replacement,
     message: messages.getMessage('deprecation', [replacement]),

diff --git a/src/commands/force/source/deploy/cancel.ts b/src/commands/force/source/deploy/cancel.ts
@@ -5,7 +5,6 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-
 import { Messages, SfError } from '@salesforce/core';
 import { Duration } from '@salesforce/kit';
 import { RequestStatus } from '@salesforce/source-deploy-retrieve';
@@ -23,7 +22,7 @@ import {
   DeployCancelResultFormatter,
 } from '../../../../formatters/deployCancelResultFormatter.js';
 
-Messages.importMessagesDirectoryFromMetaUrl(import.meta.url)
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-source', 'cancel');
 
 const replacement = 'project deploy cancel';
@@ -32,6 +31,7 @@ export class Cancel extends DeployCommand {
   public static readonly description = messages.getMessage('description');
   public static readonly examples = messages.getMessages('examples');
   public static readonly state = 'deprecated';
+  public static readonly hidden = true;
   public static readonly deprecationOptions = {
     to: replacement,
     message: messages.getMessage('deprecation', [replacement]),

diff --git a/src/commands/force/source/deploy/report.ts b/src/commands/force/source/deploy/report.ts
@@ -5,8 +5,6 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-
-
 import { Messages, SfProject } from '@salesforce/core';
 
 import { Duration, env } from '@salesforce/kit';
@@ -30,7 +28,7 @@ import { DeployProgressBarFormatter } from '../../../../formatters/deployProgres
 import { DeployProgressStatusFormatter } from '../../../../formatters/deployProgressStatusFormatter.js';
 import { ResultFormatterOptions } from '../../../../formatters/resultFormatter.js';
 
-Messages.importMessagesDirectoryFromMetaUrl(import.meta.url)
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-source', 'report');
 
 const replacement = 'project deploy report';
@@ -40,6 +38,7 @@ export class Report extends DeployCommand {
   public static readonly summary = messages.getMessage('summary');
   public static readonly examples = messages.getMessages('examples');
   public static readonly state = 'deprecated';
+  public static readonly hidden = true;
   public static readonly deprecationOptions = {
     to: replacement,
     message: messages.getMessage('deprecation', ['project deploy start', replacement]),

diff --git a/src/commands/force/source/pull.ts b/src/commands/force/source/pull.ts
@@ -5,8 +5,6 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-
-
 import { Duration } from '@salesforce/kit';
 import { Lifecycle, Messages } from '@salesforce/core';
 import { FileResponse, RequestStatus, RetrieveVersionData, RetrieveResult } from '@salesforce/source-deploy-retrieve';
@@ -23,14 +21,15 @@ import { SourceCommand } from '../../../sourceCommand.js';
 import { PullResponse, PullResultFormatter } from '../../../formatters/source/pullFormatter.js';
 import { trackingSetup, updateTracking } from '../../../trackingFunctions.js';
 
-Messages.importMessagesDirectoryFromMetaUrl(import.meta.url)
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-source', 'pull');
 const retrieveMessages = Messages.loadMessages('@salesforce/plugin-source', 'retrieve');
 
 const replacement = 'project retrieve start';
 
 export default class Pull extends SourceCommand {
   public static readonly state = 'deprecated';
+  public static readonly hidden = true;
   public static readonly deprecationOptions = {
     to: replacement,
     message: messages.getMessage('deprecation', [replacement]),

diff --git a/src/commands/force/source/push.ts b/src/commands/force/source/push.ts
@@ -5,8 +5,6 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-
-
 import { Duration, env } from '@salesforce/kit';
 import { Lifecycle, Messages } from '@salesforce/core';
 import { ComponentStatus, DeployResult, DeployVersionData, RequestStatus } from '@salesforce/source-deploy-retrieve';
@@ -27,14 +25,15 @@ import { DeployProgressBarFormatter } from '../../../formatters/deployProgressBa
 import { DeployProgressStatusFormatter } from '../../../formatters/deployProgressStatusFormatter.js';
 import { trackingSetup, updateTracking } from '../../../trackingFunctions.js';
 
-Messages.importMessagesDirectoryFromMetaUrl(import.meta.url)
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-source', 'push');
 const deployMessages = Messages.loadMessages('@salesforce/plugin-source', 'deployCommand');
 
 const replacement = 'project deploy start';
 
 export default class Push extends DeployCommand {
   public static readonly state = 'deprecated';
+  public static readonly hidden = true;
   public static readonly deprecationOptions = {
     to: replacement,
     message: messages.getMessage('deprecation', [replacement]),

diff --git a/src/commands/force/source/retrieve.ts b/src/commands/force/source/retrieve.ts
@@ -8,7 +8,6 @@
 import { dirname, join, resolve } from 'node:path';
 import fs from 'node:fs';
 
-
 import { Lifecycle, Messages, SfError, SfProject } from '@salesforce/core';
 import { Duration } from '@salesforce/kit';
 import {
@@ -39,7 +38,7 @@ import {
 import { filterConflictsByComponentSet, trackingSetup, updateTracking } from '../../../trackingFunctions.js';
 import { promisesQueue } from '../../../promiseQueue.js';
 
-Messages.importMessagesDirectoryFromMetaUrl(import.meta.url)
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-source', 'retrieve');
 const spinnerMessages = Messages.loadMessages('@salesforce/plugin-source', 'spinner');
 const retrieveMessages = Messages.loadMessages('@salesforce/plugin-source', 'retrieve');
@@ -52,6 +51,7 @@ export class Retrieve extends SourceCommand {
   public static readonly examples = messages.getMessages('examples');
   public static readonly requiresProject = true;
   public static readonly state = 'deprecated';
+  public static readonly hidden = true;
   public static readonly deprecationOptions = {
     to: replacement,
     message: messages.getMessage('deprecation', [replacement]),

diff --git a/src/commands/force/source/status.ts b/src/commands/force/source/status.ts
@@ -5,8 +5,6 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-
-
 import { Messages } from '@salesforce/core';
 import { ChangeResult, StatusOutputRow } from '@salesforce/source-tracking';
 import { Interfaces } from '@oclif/core';
@@ -26,7 +24,7 @@ import {
 } from '../../../formatters/source/statusFormatter.js';
 import { trackingSetup } from '../../../trackingFunctions.js';
 
-Messages.importMessagesDirectoryFromMetaUrl(import.meta.url)
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-source', 'status');
 
 export type StatusCommandResult = StatusResult[];
@@ -36,6 +34,7 @@ export default class Status extends SfCommand<StatusCommandResult> {
   public static readonly summary = messages.getMessage('summary');
   public static readonly examples = messages.getMessages('examples');
   public static readonly state = 'deprecated';
+  public static readonly hidden = true;
   public static readonly deprecationOptions = {
     to: replacement,
     message: messages.getMessage('deprecation', [replacement]),