fix(commands): fix all commands to display sfp in examples

flxbl-io · Sep 16, 2023 · 461d9ac · 461d9ac
1 parent d222854
commit 461d9ac
Show file tree

Hide file tree

Showing 16 changed files with 22 additions and 29 deletions.
diff --git a/packages/sfpowerscripts-cli/src/commands/changelog/generate.ts b/packages/sfpowerscripts-cli/src/commands/changelog/generate.ts
@@ -13,7 +13,7 @@ export default class GenerateChangelog extends SfpowerscriptsCommand {
     public static description = messages.getMessage('commandDescription');
 
     public static examples = [
-        `$ sfpowerscripts changelog:generate -n <releaseName> -d path/to/artifact/directory -w <regexp> -r <repoURL> -b <branchName>`,
+        `$ sfp changelog:generate -n <releaseName> -d path/to/artifact/directory -w <regexp> -r <repoURL> -b <branchName>`,
     ];
 
     protected static requiresUsername = false;

diff --git a/packages/sfpowerscripts-cli/src/commands/metrics/report.ts b/packages/sfpowerscripts-cli/src/commands/metrics/report.ts
@@ -18,7 +18,7 @@ export default class Report extends SfpowerscriptsCommand {
   protected static requiresDevhubUsername = false;
   protected static requiresProject = false;
 
-  public static examples = ['$ sfpowerscripts metrics:report -m <metric> -t <type> -v <value>'];
+  public static examples = ['$ sfp metrics:report -m <metric> -t <type> -v <value>'];
 
   public static flags = {
     metric: Flags.string({

diff --git a/packages/sfpowerscripts-cli/src/commands/orchestrator/deploy.ts b/packages/sfpowerscripts-cli/src/commands/orchestrator/deploy.ts
@@ -25,7 +25,7 @@ const messages = Messages.loadMessages('@dxatscale/sfpowerscripts', 'deploy');
 export default class Deploy extends SfpowerscriptsCommand {
     public static description = messages.getMessage('commandDescription');
 
-    public static examples = [`$ sfpowerscripts orchestrator:deploy -u <username>`];
+    public static examples = [`$ sfp orchestrator:deploy -u <username>`];
 
     protected static requiresUsername = false;
     protected static requiresDevhubUsername = false;

diff --git a/packages/sfpowerscripts-cli/src/commands/orchestrator/prepare.ts b/packages/sfpowerscripts-cli/src/commands/orchestrator/prepare.ts
@@ -53,7 +53,7 @@ export default class Prepare extends SfpowerscriptsCommand {
 
     public static description = messages.getMessage('commandDescription');
 
-    public static examples = [`$ sfpowerscripts orchestrator:prepare -f config/mypoolconfig.json  -v <devhub>`];
+    public static examples = [`$ sfp orchestrator:prepare -f config/mypoolconfig.json  -v <devhub>`];
 
     public async execute(): Promise<any> {
         let executionStartTime = Date.now();

diff --git a/packages/sfpowerscripts-cli/src/commands/orchestrator/promote.ts b/packages/sfpowerscripts-cli/src/commands/orchestrator/promote.ts
@@ -17,7 +17,7 @@ const messages = Messages.loadMessages('@dxatscale/sfpowerscripts', 'promote');
 export default class Promote extends SfpowerscriptsCommand {
     public static description = messages.getMessage('commandDescription');
 
-    public static examples = [`$ sfpowerscripts orchestrator:promote -d path/to/artifacts -v <org>`];
+    public static examples = [`$ sfp orchestrator:promote -d path/to/artifacts -v <org>`];
 
     protected static requiresDevhubUsername = true;
 

diff --git a/packages/sfpowerscripts-cli/src/commands/orchestrator/publish.ts b/packages/sfpowerscripts-cli/src/commands/orchestrator/publish.ts
@@ -33,10 +33,10 @@ export default class Promote extends SfpowerscriptsCommand {
     public static description = messages.getMessage('commandDescription');
 
     public static examples = [
-        `$ sfpowerscripts orchestrator:publish -f path/to/script`,
-        `$ sfpowerscripts orchestrator:publish --npm`,
-        `$ sfpowerscripts orchestrator:publish -f path/to/script -p -v HubOrg`,
-        `$ sfpowerscripts orchestrator:publish -f path/to/script --gittag --pushgittag`,
+        `$ sfp orchestrator:publish -f path/to/script`,
+        `$ sfp orchestrator:publish --npm`,
+        `$ sfp orchestrator:publish -f path/to/script -p -v HubOrg`,
+        `$ sfp orchestrator:publish -f path/to/script --gittag --pushgittag`,
     ];
 
     protected static requiresUsername = false;

diff --git a/packages/sfpowerscripts-cli/src/commands/orchestrator/release.ts b/packages/sfpowerscripts-cli/src/commands/orchestrator/release.ts
@@ -25,7 +25,7 @@ export default class Release extends SfpowerscriptsCommand {
     public static description = messages.getMessage('commandDescription');
 
     public static examples = [
-        `sfpowerscripts orchestrator:release -p path/to/releasedefinition.yml -u myorg --npm --scope myscope --generatechangelog`,
+        `sfp orchestrator:release -p path/to/releasedefinition.yml -u myorg --npm --scope myscope --generatechangelog`,
     ];
 
     protected static requiresUsername = false;

diff --git a/packages/sfpowerscripts-cli/src/commands/orchestrator/validateAgainstOrg.ts b/packages/sfpowerscripts-cli/src/commands/orchestrator/validateAgainstOrg.ts
@@ -16,7 +16,7 @@ const messages = Messages.loadMessages('@dxatscale/sfpowerscripts', 'validateAga
 export default class ValidateAgainstOrg extends SfpowerscriptsCommand {
     public static description = messages.getMessage('commandDescription');
 
-    public static examples = [`$ sfpowerscripts orchestrator:validateAgainstOrg -u <targetorg>`];
+    public static examples = [`$ sfp orchestrator:validateAgainstOrg -u <targetorg>`];
 
     public static flags = {
         targetorg: requiredUserNameFlag,

diff --git a/packages/sfpowerscripts-cli/src/commands/package/source/create.ts b/packages/sfpowerscripts-cli/src/commands/package/source/create.ts
@@ -13,15 +13,8 @@ export default class CreateSourcePackage extends PackageCreateCommand {
     public static description = messages.getMessage('commandDescription');
 
     public static examples = [
-        `$ sfpowerscripts package:source:create -n mypackage -v <version>`,
-        `$ sfpowerscripts package:source:create -n <mypackage> -v <version> --diffcheck --gittag`,
-        `Output variable:`,
-        `sfpowerscripts_artifact_metadata_directory`,
-        `<refname>_sfpowerscripts_artifact_metadata_directory`,
-        `sfpowerscripts_artifact_directory`,
-        `<refname>_sfpowerscripts_artifact_directory`,
-        `sfpowerscripts_package_version_number`,
-        `<refname>_sfpowerscripts_package_version_number`,
+        `$ sfp package:source:create -n mypackage -v <version>`,
+        `$ sfp package:source:create -n <mypackage> -v <version> --diffcheck --gittag`
     ];
 
     protected static requiresUsername = false;

diff --git a/packages/sfpowerscripts-cli/src/commands/package/source/install.ts b/packages/sfpowerscripts-cli/src/commands/package/source/install.ts
@@ -19,7 +19,7 @@ const messages = Messages.loadMessages('@dxatscale/sfpowerscripts', 'install_sou
 export default class InstallSourcePackage extends InstallPackageCommand {
     public static description = messages.getMessage('commandDescription');
 
-    public static examples = [`$ sfpowerscripts package:source:install -n mypackage -u <org>`];
+    public static examples = [`$ sfp package:source:install -n mypackage -u <org>`];
 
     public static flags = {
         package: Flags.string({

diff --git a/packages/sfpowerscripts-cli/src/commands/package/unlocked/install.ts b/packages/sfpowerscripts-cli/src/commands/package/unlocked/install.ts
@@ -18,7 +18,7 @@ const messages = Messages.loadMessages('@dxatscale/sfpowerscripts', 'install_unl
 export default class InstallUnlockedPackage extends InstallPackageCommand {
     public static description = messages.getMessage('commandDescription');
 
-    public static examples = [`$ sfpowerscripts package:unlocked:install -n packagename -u sandboxalias -i`];
+    public static examples = [`$ sfp package:unlocked:install -n packagename -u sandboxalias -i`];
 
     public static flags = {
         package: Flags.string({

diff --git a/packages/sfpowerscripts-cli/src/commands/pool/metrics/publish.ts b/packages/sfpowerscripts-cli/src/commands/pool/metrics/publish.ts
@@ -21,7 +21,7 @@ export default class Publish extends SfpowerscriptsCommand {
     protected static requiresDevhubUsername = true;
     protected static requiresProject = false;
 
-    public static examples = ['$ sfpowerscripts pool:metrics:publish -v <myDevHub>'];
+    public static examples = ['$ sfp pool:metrics:publish -v <myDevHub>'];
 
     public static flags = {
        targetdevhubusername,

diff --git a/packages/sfpowerscripts-cli/src/commands/pool/org/delete.ts b/packages/sfpowerscripts-cli/src/commands/pool/org/delete.ts
@@ -17,7 +17,7 @@ export default class Delete extends SfpowerscriptsCommand {
 
     protected static requiresDevhubUsername = true;
 
-    public static examples = [`$ sfpowerscripts pool:org:delete -u test-xasdasd@example.com -v devhub`];
+    public static examples = [`$ sfp pool:org:delete -u test-xasdasd@example.com -v devhub`];
 
     public static flags = {
         'apiversion': orgApiVersionFlagSfdxStyle,

diff --git a/packages/sfpowerscripts-cli/src/commands/profile/reconcile.ts b/packages/sfpowerscripts-cli/src/commands/profile/reconcile.ts
@@ -23,9 +23,9 @@ export default class Reconcile extends SfpowerscriptsCommand {
     public static description = messages.getMessage('commandDescription');
 
     public static examples = [
-        `$ sfpowerscripts profile:reconcile  --folder force-app -d destfolder -s`,
-        `$ sfpowerscripts profile:reconcile  --folder force-app,module2,module3 -u sandbox -d destfolder`,
-        `$ sfpowerscripts profile:reconcile  -u myscratchorg -d destfolder`,
+        `$ sfp profile:reconcile  --folder force-app -d destfolder -s`,
+        `$ sfp profile:reconcile  --folder force-app,module2,module3 -u sandbox -d destfolder`,
+        `$ sfp profile:reconcile  -u myscratchorg -d destfolder`,
     ];
 
 

diff --git a/packages/sfpowerscripts-cli/src/commands/releasedefinition/generate.ts b/packages/sfpowerscripts-cli/src/commands/releasedefinition/generate.ts
@@ -12,7 +12,7 @@ export default class Generate extends SfpowerscriptsCommand {
     public static description = messages.getMessage('commandDescription');
 
     public static examples = [
-        `$ sfpowerscripts releasedefinition:generate -n <releaseName>`,
+        `$ sfp releasedefinition:generate -n <releaseName>`,
     ];
 
     protected static requiresProject = true;

diff --git a/packages/sfpowerscripts-cli/src/commands/repo/patch.ts b/packages/sfpowerscripts-cli/src/commands/repo/patch.ts
@@ -26,7 +26,7 @@ const messages = Messages.loadMessages('@dxatscale/sfpowerscripts', 'patch');
 export default class Patch extends SfpowerscriptsCommand {
     public static description = messages.getMessage('commandDescription');
 
-    public static examples = [`$ sfpowerscripts repo:patch -n <releaseName>`];
+    public static examples = [`$ sfp repo:patch -n <releaseName>`];
 
     protected static requiresProject = true;
     protected static requiresDevhubUsername = false;