fix: replace hardcoded 'sf' with config.bin for sfdx use

WillieRuemmele · WillieRuemmele · commit 69a907510a01 · 2023-03-27T09:03:16.000-06:00
diff --git a/messages/delete.source.md b/messages/delete.source.md
@@ -4,7 +4,7 @@ Delete source from your project and from a non-source-tracked org.
 
 # description
 
-Use this command to delete components from orgs that don’t have source tracking. To remove deleted items from orgs that have source tracking enabled, "sf project deploy start".
+Use this command to delete components from orgs that don’t have source tracking. To remove deleted items from orgs that have source tracking enabled, "<%= config.bin %> project deploy start".
 
 When you run this command, both the local source file and the metadata component in the org are deleted.
 
diff --git a/messages/deploy.async.md b/messages/deploy.async.md
@@ -8,12 +8,12 @@ Deploy has been queued for cancellation.
 
 # info.AsyncDeployCancel
 
-Run "sf project deploy cancel --job-id %s" to cancel the deploy.
+Run "%s project deploy cancel --job-id %s" to cancel the deploy.
 
 # info.AsyncDeployStatus
 
-Run "sf project deploy report --job-id %s" to get the latest status.
+Run "%s project deploy report --job-id %s" to get the latest status.
 
 # info.AsyncDeployResume
 
-Run "sf project deploy resume --job-id %s" to resume watching the deploy.
+Run "%s project deploy resume --job-id %s" to resume watching the deploy.
diff --git a/messages/deploy.md b/messages/deploy.md
@@ -12,7 +12,7 @@ For example, if your local project contains a source directory with metadata fil
 
 The command stores your responses in the "deploy-options.json" file in your local project directory and uses them as defaults when you rerun the command. Specify --interactive to force the command to reprompt.
 
-Use this command for quick and simple deploys. For more complicated deployments, use the environment-specific commands, such as "sf project deploy start", that provide additional flags.
+Use this command for quick and simple deploys. For more complicated deployments, use the environment-specific commands, such as "<%= config.bin %> project deploy start", that provide additional flags.
 
 # examples
 
diff --git a/messages/deploy.metadata.cancel.md b/messages/deploy.metadata.cancel.md
@@ -47,15 +47,15 @@ Number of minutes to wait for the command to complete and display results.
 
 # flags.wait.description
 
-If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the cancellation, run "sf project deploy resume". To check the status of the cancellation, run "<%= config.bin %> project deploy report".
+If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the cancellation, run "<%= config.bin %> project deploy resume". To check the status of the cancellation, run "<%= config.bin %> project deploy report".
 
 # flags.async.summary
 
 Run the command asynchronously.
 
 # flags.async.description
 
-The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the cancellation, run "sf project deploy resume". To check the status of the cancellation, run "<%= config.bin %> project deploy report".
+The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the cancellation, run "<%= config.bin %> project deploy resume". To check the status of the cancellation, run "<%= config.bin %> project deploy report".
 
 # error.CannotCancelDeploy
 
diff --git a/messages/deploy.metadata.md b/messages/deploy.metadata.md
@@ -110,7 +110,7 @@ Number of minutes to wait for command to complete and display results.
 
 # flags.wait.description
 
-If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume the deployment, run "sf project deploy resume". To check the status of the deployment, run "sf project deploy report".
+If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume the deployment, run "<%= config.bin %> project deploy resume". To check the status of the deployment, run "<%= config.bin %> project deploy report".
 
 # flags.manifest.summary
 
@@ -178,7 +178,7 @@ Run the command asynchronously.
 
 # flags.async.description
 
-The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run "sf project deploy resume". To check the status of the deployment, run "sf project deploy report".
+The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run "<%= config.bin %> project deploy resume". To check the status of the deployment, run "<%= config.bin %> project deploy report".
 
 # flags.metadata-dir.summary
 
@@ -203,7 +203,7 @@ You must specify tests using the --tests flag if the --test-level flag is set to
 
 # error.ClientTimeout
 
-The command has timed out, although the deployment is still running. Use "sf project deploy resume" to resume watching the deployment.
+The command has timed out, although the deployment is still running. Use "%s project deploy resume" to resume watching the deployment.
 
 # error.Conflicts
 
@@ -213,15 +213,15 @@ There are changes in the org that conflict with the local changes you're trying
 
 - To overwrite the remote changes, rerun this command with the --ignore-conflicts flag.
 
-- To overwrite the local changes, run the "sf project retrieve start" command with the --ignore-conflicts flag.
+- To overwrite the local changes, run the "%s project retrieve start" command with the --ignore-conflicts flag.
 
 # error.nothingToDeploy
 
 No local changes to deploy.
 
 # error.nothingToDeploy.Actions
 
-- To see conflicts and ignored files, run "sf project deploy preview" with any of the manifest, directory, or metadata flags.
+- To see conflicts and ignored files, run "%s project deploy preview" with any of the manifest, directory, or metadata flags.
 
 # flags.junit
 
diff --git a/messages/deploy.metadata.preview.md b/messages/deploy.metadata.preview.md
@@ -94,4 +94,4 @@ There are changes in the org that conflict with the local changes you're trying
 
 - To overwrite the remote changes, rerun this command with the --ignore-conflicts flag.
 
-- To overwrite the local changes, run the "sf project retrieve start" command with the --ignore-conflicts flag.
+- To overwrite the local changes, run the "%s project retrieve start" command with the --ignore-conflicts flag.
diff --git a/messages/retrieve.metadata.md b/messages/retrieve.metadata.md
@@ -157,7 +157,7 @@ There are changes in your local files that conflict with the org changes you're
 
 - To overwrite the local changes, rerun this command with the --ignore-conflicts flag.
 
-- To overwrite the remote changes, run the "sf project deploy start" command with the --ignore-conflicts flag.
+- To overwrite the remote changes, run the "%s project deploy start" command with the --ignore-conflicts flag.
 
 # info.WroteZipFile
 
diff --git a/src/commands/project/deploy/cancel.ts b/src/commands/project/deploy/cancel.ts
@@ -77,7 +77,7 @@ export default class DeployMetadataCancel extends SfCommand<DeployResultJson> {
 
     if (flags.async) {
       const asyncResult = await cancelDeployAsync({ 'target-org': deployOpts['target-org'] }, jobId);
-      const formatter = new AsyncDeployCancelResultFormatter(asyncResult.id);
+      const formatter = new AsyncDeployCancelResultFormatter(asyncResult.id, this.config.bin);
       if (!this.jsonEnabled()) formatter.display();
       return formatter.getJson();
     } else {
diff --git a/src/commands/project/deploy/quick.ts b/src/commands/project/deploy/quick.ts
@@ -97,7 +97,7 @@ export default class DeployMetadataQuick extends SfCommand<DeployResultJson> {
     this.log(`Deploy ID: ${bold(jobId)}`);
 
     if (flags.async) {
-      const asyncFormatter = new AsyncDeployResultFormatter(jobId);
+      const asyncFormatter = new AsyncDeployResultFormatter(jobId, 'sf');
       if (!this.jsonEnabled()) asyncFormatter.display();
       return asyncFormatter.getJson();
     }
diff --git a/src/commands/project/deploy/resume.ts b/src/commands/project/deploy/resume.ts
@@ -92,6 +92,7 @@ export default class DeployMetadataResume extends SfCommand<DeployResultJson> {
     const { deploy, componentSet } = await executeDeploy(
       // there will always be conflicts on a resume if anything deployed--the changes on the server are not synced to local
       { ...deployOpts, wait, 'dry-run': false, 'ignore-conflicts': true },
+      this.config.bin,
       this.project,
       jobId
     );
diff --git a/src/commands/project/deploy/start.ts b/src/commands/project/deploy/start.ts
@@ -185,6 +185,7 @@ export default class DeployMetadata extends SfCommand<DeployResultJson> {
         'target-org': flags['target-org'].getUsername(),
         api,
       },
+      this.config.bin,
       this.project
     );
 
@@ -196,7 +197,7 @@ export default class DeployMetadata extends SfCommand<DeployResultJson> {
       if (flags['coverage-formatters']) {
         this.warn(messages.getMessage('asyncCoverageJunitWarning'));
       }
-      const asyncFormatter = new AsyncDeployResultFormatter(deploy.id);
+      const asyncFormatter = new AsyncDeployResultFormatter(deploy.id, this.config.bin);
       if (!this.jsonEnabled()) asyncFormatter.display();
       return asyncFormatter.getJson();
     }
@@ -225,12 +226,12 @@ export default class DeployMetadata extends SfCommand<DeployResultJson> {
         return super.catch({
           ...error,
           message: messages.getMessage('error.Conflicts'),
-          actions: messages.getMessages('error.Conflicts.Actions'),
+          actions: messages.getMessages('error.Conflicts.Actions', [this.config.bin]),
         });
       }
     }
     if (error.message.includes('client has timed out')) {
-      const err = messages.createError('error.ClientTimeout');
+      const err = messages.createError('error.ClientTimeout', [this.config.bin]);
       return super.catch({ ...error, name: err.name, message: err.message, code: err.code });
     }
     return super.catch(error);
diff --git a/src/commands/project/deploy/validate.ts b/src/commands/project/deploy/validate.ts
@@ -131,6 +131,7 @@ export default class DeployMetadataValidate extends SfCommand<DeployResultJson>
         'target-org': flags['target-org'].getUsername(),
         api,
       },
+      this.config.bin,
       this.project
     );
 
@@ -139,7 +140,7 @@ export default class DeployMetadataValidate extends SfCommand<DeployResultJson>
     new DeployProgress(deploy, this.jsonEnabled()).start();
 
     if (flags.async) {
-      const asyncFormatter = new AsyncDeployResultFormatter(deploy.id);
+      const asyncFormatter = new AsyncDeployResultFormatter(deploy.id, this.config.bin);
       if (!this.jsonEnabled()) asyncFormatter.display();
       return asyncFormatter.getJson();
     }
diff --git a/src/commands/project/retrieve/start.ts b/src/commands/project/retrieve/start.ts
@@ -250,7 +250,7 @@ export default class RetrieveMetadata extends SfCommand<RetrieveResultJson> {
         return super.catch({
           ...error,
           message: messages.getMessage('error.Conflicts'),
-          actions: messages.getMessages('error.Conflicts.Actions'),
+          actions: messages.getMessages('error.Conflicts.Actions', [this.config.bin]),
         });
       }
     }
diff --git a/src/formatters/asyncDeployCancelResultFormatter.ts b/src/formatters/asyncDeployCancelResultFormatter.ts
@@ -13,15 +13,15 @@ Messages.importMessagesDirectory(__dirname);
 export const deployAsyncMessages = Messages.loadMessages('@salesforce/plugin-deploy-retrieve', 'deploy.async');
 
 export class AsyncDeployCancelResultFormatter implements Formatter<AsyncDeployResultJson> {
-  public constructor(private id: string) {}
+  public constructor(private id: string, private bin: string) {}
 
   public getJson(): DeployResultJson {
     return { id: this.id, done: false, status: 'Queued', files: [] };
   }
 
   public display(): void {
     ux.log(deployAsyncMessages.getMessage('info.AsyncDeployCancelQueued'));
-    ux.log(deployAsyncMessages.getMessage('info.AsyncDeployResume', [this.id]));
-    ux.log(deployAsyncMessages.getMessage('info.AsyncDeployStatus', [this.id]));
+    ux.log(deployAsyncMessages.getMessage('info.AsyncDeployResume', [this.bin, this.id]));
+    ux.log(deployAsyncMessages.getMessage('info.AsyncDeployStatus', [this.bin, this.id]));
   }
 }
diff --git a/src/formatters/asyncDeployResultFormatter.ts b/src/formatters/asyncDeployResultFormatter.ts
@@ -12,7 +12,7 @@ Messages.importMessagesDirectory(__dirname);
 export const deployAsyncMessages = Messages.loadMessages('@salesforce/plugin-deploy-retrieve', 'deploy.async');
 
 export class AsyncDeployResultFormatter implements Formatter<AsyncDeployResultJson> {
-  public constructor(private id: string) {}
+  public constructor(private id: string, private bin: string) {}
 
   public getJson(): AsyncDeployResultJson {
     return { id: this.id, done: false, status: 'Queued', files: [] };
@@ -21,8 +21,8 @@ export class AsyncDeployResultFormatter implements Formatter<AsyncDeployResultJs
   public display(): void {
     ux.log(deployAsyncMessages.getMessage('info.AsyncDeployQueued'));
     ux.log();
-    ux.log(deployAsyncMessages.getMessage('info.AsyncDeployResume', [this.id]));
-    ux.log(deployAsyncMessages.getMessage('info.AsyncDeployStatus', [this.id]));
-    ux.log(deployAsyncMessages.getMessage('info.AsyncDeployCancel', [this.id]));
+    ux.log(deployAsyncMessages.getMessage('info.AsyncDeployResume', [this.bin, this.id]));
+    ux.log(deployAsyncMessages.getMessage('info.AsyncDeployStatus', [this.bin, this.id]));
+    ux.log(deployAsyncMessages.getMessage('info.AsyncDeployCancel', [this.bin, this.id]));
   }
 }
diff --git a/src/utils/deploy.ts b/src/utils/deploy.ts
@@ -106,6 +106,7 @@ export async function buildComponentSet(opts: Partial<DeployOptions>, stl?: Sour
 
 export async function executeDeploy(
   opts: Partial<DeployOptions>,
+  bin = 'sf',
   project?: SfProject,
   id?: string
 ): Promise<{ deploy: MetadataApiDeploy; componentSet?: ComponentSet }> {
@@ -152,7 +153,7 @@ export async function executeDeploy(
       throw new SfError(
         deployMessages.getMessage('error.nothingToDeploy'),
         'NothingToDeploy',
-        deployMessages.getMessages('error.nothingToDeploy.Actions')
+        deployMessages.getMessages('error.nothingToDeploy.Actions', [bin])
       );
     }
     deploy = id

Original file line number	Diff line number	Diff line change
`@@ -94,4 +94,4 @@ There are changes in the org that conflict with the local changes you're trying`
`94`	`94`
`95`	`95`	`- To overwrite the remote changes, rerun this command with the --ignore-conflicts flag.`
`96`	`96`
`97`		`-- To overwrite the local changes, run the "sf project retrieve start" command with the --ignore-conflicts flag.`
	`97`	`+- To overwrite the local changes, run the "%s project retrieve start" command with the --ignore-conflicts flag.`
Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,7 @@ export default class DeployMetadataQuick extends SfCommand<DeployResultJson> {`
`97`	`97`	this.log(`Deploy ID: ${bold(jobId)}`);
`98`	`98`
`99`	`99`	`if (flags.async) {`
`100`		`- const asyncFormatter = new AsyncDeployResultFormatter(jobId);`
	`100`	`+ const asyncFormatter = new AsyncDeployResultFormatter(jobId, 'sf');`
`101`	`101`	`if (!this.jsonEnabled()) asyncFormatter.display();`
`102`	`102`	`return asyncFormatter.getJson();`
`103`	`103`	`}`