fix(sfp): fix examples to demonstrate using -o shorthand notation

flxbl-io · Mar 6, 2024 · 45c1f55 · 45c1f55
1 parent 534bd4d
commit 45c1f55
Show file tree

Hide file tree

Showing 9 changed files with 11 additions and 26 deletions.
diff --git a/packages/sfp-cli/src/commands/apextests/trigger.ts b/packages/sfp-cli/src/commands/apextests/trigger.ts
@@ -31,8 +31,8 @@ export default class TriggerApexTest extends SfpCommand {
     public static description = messages.getMessage('commandDescription');
 
     public static examples = [
-        `$ sfp apextests:trigger -u scratchorg -l RunLocalTests -s`,
-        `$ sfp apextests:trigger -u scratchorg -l RunAllTestsInPackage -n <mypackage> -c`,
+        `$ sfp apextests:trigger -o scratchorg -l RunLocalTests -s`,
+        `$ sfp apextests:trigger -o scratchorg -l RunAllTestsInPackage -n <mypackage> -c`,
     ];
 
     public static flags = {

diff --git a/packages/sfp-cli/src/commands/artifacts/promote.ts b/packages/sfp-cli/src/commands/artifacts/promote.ts
@@ -31,15 +31,6 @@ export default class Promote extends SfpCommand {
             description: messages.getMessage('artifactDirectoryFlagDescription'),
             default: 'artifacts',
         }),
-        outputdir: Flags.directory({
-            required: false,
-            char: 'o',
-            description: messages.getMessage('outputDirectoryFlagDescription'),
-            hidden: true,
-            deprecated: {
-                message: '--outputdir is deprecated, Artifacts are no longer modified after promote',
-            },
-        }),
        loglevel
     };
 

diff --git a/packages/sfp-cli/src/commands/artifacts/query.ts b/packages/sfp-cli/src/commands/artifacts/query.ts
@@ -12,7 +12,7 @@ const messages = Messages.loadMessages('@flxblio/sfp', 'artifacts_query');
 export default class Query extends SfpCommand {
     public static description = messages.getMessage('commandDescription');
 
-    public static examples = [`$ sfp artifacts:query -u <target_org>`];
+    public static examples = [`$ sfp artifacts:query -o <target_org>`];
     public static enableJsonFlag = true
     protected static requiresUsername = true;
     protected static requiresDevhubUsername = false;

diff --git a/packages/sfp-cli/src/commands/changelog/generate.ts b/packages/sfp-cli/src/commands/changelog/generate.ts
@@ -43,12 +43,6 @@ export default class GenerateChangelog extends SfpCommand {
             required: false,
             description: messages.getMessage('workItemUrlFlagDescription'),
         }),
-        repourl: Flags.string({
-            required: false,
-            char: 'r',
-            description: messages.getMessage('repoUrlFlagDescription'),
-            deprecated: {message:'--repourl has been deprecated'}
-        }),
         directory: Flags.string({
             required: false,
             description: messages.getMessage('directoryFlagDescription'),

diff --git a/packages/sfp-cli/src/commands/pool/org/delete.ts b/packages/sfp-cli/src/commands/pool/org/delete.ts
@@ -24,7 +24,7 @@ export default class Delete extends SfpCommand {
 
     protected static requiresDevhubUsername = true;
 
-    public static examples = [`$ sfp pool:org:delete -u [email protected] -v devhub`];
+    public static examples = [`$ sfp pool:org:delete -o [email protected] -v devhub`];
 
     public static flags = {
         apiversion: orgApiVersionFlagSfdxStyle,

diff --git a/packages/sfp-cli/src/commands/profile/merge.ts b/packages/sfp-cli/src/commands/profile/merge.ts
@@ -18,7 +18,7 @@ export default class Merge extends SfpCommand {
     public static description = messages.getMessage('commandDescription');
 
     public static examples = [
-        `$ sfp profile:merge -u sandbox`,
+        `$ sfp profile:merge -o sandbox`,
         `$ sfp profile:merge -f force-app -n "My Profile" -u sandbox`,
         `$ sfp  profile:merge -f "module1, module2, module3" -n "My Profile1, My profile2"  -u sandbox`,
     ];

diff --git a/packages/sfp-cli/src/commands/profile/reconcile.ts b/packages/sfp-cli/src/commands/profile/reconcile.ts
@@ -22,8 +22,8 @@ export default class Reconcile extends SfpCommand {
 
     public static examples = [
         `$ 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`,
+        `$ sfp profile:reconcile  --folder force-app,module2,module3 -o sandbox -d destfolder`,
+        `$ sfp profile:reconcile  -o myscratchorg -d destfolder`,
     ];
 
 

diff --git a/packages/sfp-cli/src/commands/profile/retrieve.ts b/packages/sfp-cli/src/commands/profile/retrieve.ts
@@ -18,9 +18,9 @@ export default class Retrieve extends SfpCommand {
     public static description = messages.getMessage('commandDescription');
 
     public static examples = [
-        `$ sfp profile:retrieve -u prod`,
-        `$ sfp profile:retrieve -f force-app -n "My Profile" -u prod`,
-        `$ sfp profile:retrieve -f "module1, module2, module3" -n "My Profile1, My profile2"  -u prod`,
+        `$ sfp profile:retrieve -o prod`,
+        `$ sfp profile:retrieve -f force-app -n "My Profile" -o prod`,
+        `$ sfp profile:retrieve -f "module1, module2, module3" -n "My Profile1, My profile2"  -o prod`,
     ];
 
 

diff --git a/packages/sfp-cli/src/commands/validate/org.ts b/packages/sfp-cli/src/commands/validate/org.ts
@@ -17,7 +17,7 @@ export default class ValidateAgainstOrg extends SfpCommand {
     static aliases = ['orchestrator:validateagainstorg', 'validateagainstorg']
     public static description = messages.getMessage('commandDescription');
 
-    public static examples = [`$ sfp validateAgainstOrg -u <targetorg>`];
+    public static examples = [`$ sfp validate org  -o <targetorg>`];
 
     public static flags = {
         targetorg: requiredUserNameFlag,