@salesforce/cli 2.28.4 → 2.28.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -24,7 +24,7 @@ $ npm install -g @salesforce/cli
24
24
  $ sf COMMAND
25
25
  running command...
26
26
  $ sf (--version|-v)
27
- @salesforce/cli/2.28.4 linux-x64 node-v20.11.0
27
+ @salesforce/cli/2.28.6 linux-x64 node-v20.11.0
28
28
  $ sf --help [COMMAND]
29
29
  USAGE
30
30
  $ sf COMMAND
@@ -3064,7 +3064,7 @@ EXAMPLES
3064
3064
  $ sf org list auth
3065
3065
  ```
3066
3066
 
3067
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.9/src/commands/org/list/auth.ts)_
3067
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.11/src/commands/org/list/auth.ts)_
3068
3068
 
3069
3069
  ## `sf org list limits`
3070
3070
 
@@ -3357,7 +3357,7 @@ FLAG DESCRIPTIONS
3357
3357
  To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
3358
3358
  ```
3359
3359
 
3360
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.9/src/commands/org/login/access-token.ts)_
3360
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.11/src/commands/org/login/access-token.ts)_
3361
3361
 
3362
3362
  ## `sf org login device`
3363
3363
 
@@ -3416,7 +3416,7 @@ FLAG DESCRIPTIONS
3416
3416
  To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
3417
3417
  ```
3418
3418
 
3419
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.9/src/commands/org/login/device.ts)_
3419
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.11/src/commands/org/login/device.ts)_
3420
3420
 
3421
3421
  ## `sf org login jwt`
3422
3422
 
@@ -3505,7 +3505,7 @@ FLAG DESCRIPTIONS
3505
3505
  To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
3506
3506
  ```
3507
3507
 
3508
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.9/src/commands/org/login/jwt.ts)_
3508
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.11/src/commands/org/login/jwt.ts)_
3509
3509
 
3510
3510
  ## `sf org login sfdx-url`
3511
3511
 
@@ -3520,8 +3520,7 @@ FLAGS
3520
3520
  -d, --set-default-dev-hub Set the authenticated org as the default Dev Hub.
3521
3521
  -f, --sfdx-url-file=<value> Path to a file that contains the Salesforce DX authorization URL.
3522
3522
  -s, --set-default Set the authenticated org as the default that all org-related commands run against.
3523
- -u, --sfdx-url-stdin=<value> Specify '-' as this flag's value to pipe the Salesforce DX authorization URL through
3524
- standard input (stdin).
3523
+ -u, --sfdx-url-stdin=<value> Pipe the Salesforce DX authorization URL through standard input (stdin).
3525
3524
 
3526
3525
  GLOBAL FLAGS
3527
3526
  --json Format output as json.
@@ -3551,8 +3550,7 @@ DESCRIPTION
3551
3550
  You can also create a JSON file that has a top-level property named sfdxAuthUrl whose value is the authorization URL.
3552
3551
  Finally, you can create a normal text file that includes just the URL and nothing else.
3553
3552
 
3554
- Alternatively, you can pipe the SFDX authorization URL through standard input by using the --sfdx-url-stdin flag and
3555
- providing the '-' character as the value.
3553
+ Alternatively, you can pipe the SFDX authorization URL through standard input by specifying the --sfdx-url-stdin flag.
3556
3554
 
3557
3555
  ALIASES
3558
3556
  $ sf force auth sfdxurl store
@@ -3567,12 +3565,12 @@ EXAMPLES
3567
3565
 
3568
3566
  $ sf org login sfdx-url --sfdx-url-file files/authFile.json --set-default --alias MyDefaultOrg
3569
3567
 
3570
- Pipe the SFDX authorization URL from stdin by specifying the '-' value.
3568
+ Pipe the SFDX authorization URL from stdin:
3571
3569
 
3572
- $ echo url | sf org login sfdx-url --sfdx-url-stdin -
3570
+ $ echo url | sf org login sfdx-url --sfdx-url-stdin
3573
3571
  ```
3574
3572
 
3575
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.9/src/commands/org/login/sfdx-url.ts)_
3573
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.11/src/commands/org/login/sfdx-url.ts)_
3576
3574
 
3577
3575
  ## `sf org login web`
3578
3576
 
@@ -3657,7 +3655,7 @@ FLAG DESCRIPTIONS
3657
3655
  To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
3658
3656
  ```
3659
3657
 
3660
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.9/src/commands/org/login/web.ts)_
3658
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.11/src/commands/org/login/web.ts)_
3661
3659
 
3662
3660
  ## `sf org logout`
3663
3661
 
@@ -3717,7 +3715,7 @@ FLAG DESCRIPTIONS
3717
3715
  All orgs includes Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.
3718
3716
  ```
3719
3717
 
3720
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.9/src/commands/org/logout.ts)_
3718
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.3.11/src/commands/org/logout.ts)_
3721
3719
 
3722
3720
  ## `sf org open`
3723
3721
 
@@ -3962,7 +3960,7 @@ FLAG DESCRIPTIONS
3962
3960
  subscribers.
3963
3961
  ```
3964
3962
 
3965
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.5/src/commands/package1/version/create.ts)_
3963
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.6/src/commands/package1/version/create.ts)_
3966
3964
 
3967
3965
  ## `sf package1 version create get`
3968
3966
 
@@ -3994,7 +3992,7 @@ EXAMPLES
3994
3992
  $ sf package1 version create get --request-id 0HD... --target-org myorg@example.com
3995
3993
  ```
3996
3994
 
3997
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.5/src/commands/package1/version/create/get.ts)_
3995
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.6/src/commands/package1/version/create/get.ts)_
3998
3996
 
3999
3997
  ## `sf package1 version display`
4000
3998
 
@@ -4027,7 +4025,7 @@ EXAMPLES
4027
4025
  $ sf package1 version display --package-version-id 04t... --target-org myorg@example.com
4028
4026
  ```
4029
4027
 
4030
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.5/src/commands/package1/version/display.ts)_
4028
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.6/src/commands/package1/version/display.ts)_
4031
4029
 
4032
4030
  ## `sf package1 version list`
4033
4031
 
@@ -4064,7 +4062,7 @@ FLAG DESCRIPTIONS
4064
4062
  If not specified, shows all versions for all packages (managed and unmanaged) in the org.
4065
4063
  ```
4066
4064
 
4067
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.5/src/commands/package1/version/list.ts)_
4065
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.6/src/commands/package1/version/list.ts)_
4068
4066
 
4069
4067
  ## `sf package create`
4070
4068
 
@@ -4142,7 +4140,7 @@ FLAG DESCRIPTIONS
4142
4140
  Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
4143
4141
  ```
4144
4142
 
4145
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.5/src/commands/package/create.ts)_
4143
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.6/src/commands/package/create.ts)_
4146
4144
 
4147
4145
  ## `sf package delete`
4148
4146
 
@@ -4183,7 +4181,7 @@ EXAMPLES
4183
4181
  $ sf package delete --package 0Ho... --target-dev-hub devhub@example.com
4184
4182
  ```
4185
4183
 
4186
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.5/src/commands/package/delete.ts)_
4184
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.6/src/commands/package/delete.ts)_
4187
4185
 
4188
4186
  ## `sf package install`
4189
4187
 
@@ -4281,7 +4279,7 @@ FLAG DESCRIPTIONS
4281
4279
  specify DeprecateOnly or Delete only for unlocked package upgrades.
4282
4280
  ```
4283
4281
 
4284
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.5/src/commands/package/install.ts)_
4282
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.6/src/commands/package/install.ts)_
4285
4283
 
4286
4284
  ## `sf package install report`
4287
4285
 
@@ -4313,7 +4311,7 @@ EXAMPLES
4313
4311
  $ sf package install report --request-id 0Hf... --target-org me@example.com
4314
4312
  ```
4315
4313
 
4316
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.5/src/commands/package/install/report.ts)_
4314
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.6/src/commands/package/install/report.ts)_
4317
4315
 
4318
4316
  ## `sf package installed list`
4319
4317
 
@@ -4344,7 +4342,7 @@ EXAMPLES
4344
4342
  $ sf package installed list --target-org me@example.com
4345
4343
  ```
4346
4344
 
4347
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.5/src/commands/package/installed/list.ts)_
4345
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.6/src/commands/package/installed/list.ts)_
4348
4346
 
4349
4347
  ## `sf package list`
4350
4348
 
@@ -4381,7 +4379,7 @@ EXAMPLES
4381
4379
  $ sf package list --target-dev-hub devhub@example.com --verbose
4382
4380
  ```
4383
4381
 
4384
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.5/src/commands/package/list.ts)_
4382
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.6/src/commands/package/list.ts)_
4385
4383
 
4386
4384
  ## `sf package uninstall`
4387
4385
 
@@ -4428,7 +4426,7 @@ EXAMPLES
4428
4426
  $ sf package uninstall --package "Undesirable Package Alias"
4429
4427
  ```
4430
4428
 
4431
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.5/src/commands/package/uninstall.ts)_
4429
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.6/src/commands/package/uninstall.ts)_
4432
4430
 
4433
4431
  ## `sf package uninstall report`
4434
4432
 
@@ -4460,7 +4458,7 @@ EXAMPLES
4460
4458
  $ sf package uninstall report --request-id 06y... --target-org me@example.com
4461
4459
  ```
4462
4460
 
4463
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.5/src/commands/package/uninstall/report.ts)_
4461
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.6/src/commands/package/uninstall/report.ts)_
4464
4462
 
4465
4463
  ## `sf package update`
4466
4464
 
@@ -4514,7 +4512,7 @@ FLAG DESCRIPTIONS
4514
4512
  associated with your package.
4515
4513
  ```
4516
4514
 
4517
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.5/src/commands/package/update.ts)_
4515
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.6/src/commands/package/update.ts)_
4518
4516
 
4519
4517
  ## `sf package version create`
4520
4518
 
@@ -4669,7 +4667,7 @@ FLAG DESCRIPTIONS
4669
4667
  periods of no output from commands.
4670
4668
  ```
4671
4669
 
4672
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.5/src/commands/package/version/create.ts)_
4670
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.6/src/commands/package/version/create.ts)_
4673
4671
 
4674
4672
  ## `sf package version create list`
4675
4673
 
@@ -4729,7 +4727,7 @@ EXAMPLES
4729
4727
  $ sf package version create list --created-last-days 0 --status Success
4730
4728
  ```
4731
4729
 
4732
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.5/src/commands/package/version/create/list.ts)_
4730
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.6/src/commands/package/version/create/list.ts)_
4733
4731
 
4734
4732
  ## `sf package version create report`
4735
4733
 
@@ -4771,7 +4769,7 @@ EXAMPLES
4771
4769
  $ sf package version create report --package-create-request-id 08c... --target-dev-hub devhub@example.com
4772
4770
  ```
4773
4771
 
4774
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.5/src/commands/package/version/create/report.ts)_
4772
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.6/src/commands/package/version/create/report.ts)_
4775
4773
 
4776
4774
  ## `sf package version delete`
4777
4775
 
@@ -4809,7 +4807,7 @@ EXAMPLES
4809
4807
  $ sf package version delete --package 04t... --target-org devhub@example.com
4810
4808
  ```
4811
4809
 
4812
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.5/src/commands/package/version/delete.ts)_
4810
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.6/src/commands/package/version/delete.ts)_
4813
4811
 
4814
4812
  ## `sf package version displayancestry`
4815
4813
 
@@ -4867,7 +4865,7 @@ FLAG DESCRIPTIONS
4867
4865
  You can use the DOT code output in graph visualization software to create tree visualizations.
4868
4866
  ```
4869
4867
 
4870
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.5/src/commands/package/version/displayancestry.ts)_
4868
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.6/src/commands/package/version/displayancestry.ts)_
4871
4869
 
4872
4870
  ## `sf package version list`
4873
4871
 
@@ -4935,7 +4933,7 @@ EXAMPLES
4935
4933
  $ sf package version list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
4936
4934
  ```
4937
4935
 
4938
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.5/src/commands/package/version/list.ts)_
4936
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.6/src/commands/package/version/list.ts)_
4939
4937
 
4940
4938
  ## `sf package version promote`
4941
4939
 
@@ -4978,7 +4976,7 @@ EXAMPLES
4978
4976
  $ sf package version promote --package "Awesome Package Alias"
4979
4977
  ```
4980
4978
 
4981
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.5/src/commands/package/version/promote.ts)_
4979
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.6/src/commands/package/version/promote.ts)_
4982
4980
 
4983
4981
  ## `sf package version report`
4984
4982
 
@@ -5017,7 +5015,7 @@ EXAMPLES
5017
5015
  $ sf package version report --package "Your Package Alias" --target-dev-hub devhub@example.com
5018
5016
  ```
5019
5017
 
5020
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.5/src/commands/package/version/report.ts)_
5018
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.6/src/commands/package/version/report.ts)_
5021
5019
 
5022
5020
  ## `sf package version update`
5023
5021
 
@@ -5069,7 +5067,7 @@ EXAMPLES
5069
5067
  $ sf package version update --package 04t... --version-description "New Package Version Description"
5070
5068
  ```
5071
5069
 
5072
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.5/src/commands/package/version/update.ts)_
5070
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.1.6/src/commands/package/version/update.ts)_
5073
5071
 
5074
5072
  ## `sf plugins`
5075
5073
 
@@ -7310,7 +7308,7 @@ EXAMPLES
7310
7308
  $ sf update --available
7311
7309
  ```
7312
7310
 
7313
- _See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/4.1.9/src/commands/update.ts)_
7311
+ _See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/4.1.10/src/commands/update.ts)_
7314
7312
 
7315
7313
  ## `sf version`
7316
7314
 
@@ -4,7 +4,8 @@
4
4
  * Licensed under the BSD 3-Clause license.
5
5
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
6
6
  */
7
- import { Help } from '@oclif/core';
7
+ import { Help, toConfiguredId } from '@oclif/core';
8
+ import stripAnsi from 'strip-ansi';
8
9
  import chalk from 'chalk';
9
10
  import { SfCommandHelp } from './sfCommandHelp.js';
10
11
  export default class SfHelp extends Help {
@@ -13,16 +14,10 @@ export default class SfHelp extends Help {
13
14
  this.CommandHelpClass = SfCommandHelp;
14
15
  this.showShortHelp = false;
15
16
  this.commands = [];
16
- this.subCommands = {};
17
17
  }
18
18
  async showHelp(argv) {
19
19
  this.showShortHelp = argv.includes('-h');
20
- this.commands = this.config.commandIDs.map((c) => `${this.config.bin} ${c.replace(/:/g, this.config.topicSeparator)}`);
21
- for (const cmd of this.commands) {
22
- this.subCommands[cmd] = this.commands
23
- .filter((c) => c.startsWith(cmd) && c !== cmd)
24
- .map((c) => `${c.replace(cmd, '')}`);
25
- }
20
+ this.commands = this.config.commandIDs.map((c) => `${this.config.bin} ${toConfiguredId(c, this.config)}`);
26
21
  return super.showHelp(argv);
27
22
  }
28
23
  getCommandHelpClass(command) {
@@ -33,10 +28,21 @@ export default class SfHelp extends Help {
33
28
  log(...args) {
34
29
  const formatted = args.map((arg) => {
35
30
  for (const cmd of this.commands) {
36
- const regex = this.subCommands[cmd].length > 0
37
- ? new RegExp(`(?<!\\$ )${cmd}(?!${this.subCommands[cmd].join('|')})`, 'g')
38
- : new RegExp(`(?<!\\$ )${cmd}`, 'g');
39
- arg = arg.replace(regex, chalk.dim(cmd));
31
+ /**
32
+ * This regex matches any command in the help output.
33
+ * It will continue to match until the next space, quote, or period.
34
+ *
35
+ * Examples that will match:
36
+ * - sf deploy project start
37
+ * - "sf deploy project start"
38
+ * - sf org create scratch|sandbox
39
+ * - "sf org create scratch|sandbox"
40
+ */
41
+ const regex = new RegExp(`${cmd}([^\\s".]+)?`, 'g');
42
+ const [match] = stripAnsi(arg.slice()).match(regex) ?? [];
43
+ if (match) {
44
+ arg = arg.replace(regex, chalk.dim(match));
45
+ }
40
46
  }
41
47
  return arg;
42
48
  });