@salesforce/cli 2.87.5 → 2.87.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
@@ -25,7 +25,7 @@ $ npm install -g @salesforce/cli
25
25
  $ sf COMMAND
26
26
  running command...
27
27
  $ sf (--version|-v)
28
- @salesforce/cli/2.87.5 linux-x64 node-v22.14.0
28
+ @salesforce/cli/2.87.6 linux-x64 node-v22.14.0
29
29
  $ sf --help [COMMAND]
30
30
  USAGE
31
31
  $ sf COMMAND
@@ -76,7 +76,6 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
76
76
  - [`sf data import resume`](#sf-data-import-resume)
77
77
  - [`sf data import tree`](#sf-data-import-tree)
78
78
  - [`sf data query`](#sf-data-query)
79
- - [`sf data query resume`](#sf-data-query-resume)
80
79
  - [`sf data resume`](#sf-data-resume)
81
80
  - [`sf data search`](#sf-data-search)
82
81
  - [`sf data update bulk`](#sf-data-update-bulk)
@@ -1337,7 +1336,7 @@ EXAMPLES
1337
1336
  $ sf data bulk results --job-id 7507i000fake341G --target-org my-scratch
1338
1337
  ```
1339
1338
 
1340
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.28/src/commands/data/bulk/results.ts)_
1339
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.29/src/commands/data/bulk/results.ts)_
1341
1340
 
1342
1341
  ## `sf data create file`
1343
1342
 
@@ -1386,7 +1385,7 @@ EXAMPLES
1386
1385
  $ sf data create file --file path/to/astro.png --parent-id a03fakeLoJWPIA3
1387
1386
  ```
1388
1387
 
1389
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.28/src/commands/data/create/file.ts)_
1388
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.29/src/commands/data/create/file.ts)_
1390
1389
 
1391
1390
  ## `sf data create record`
1392
1391
 
@@ -1442,7 +1441,7 @@ EXAMPLES
1442
1441
  TracedEntityId=01p17000000R6bLAAS"
1443
1442
  ```
1444
1443
 
1445
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.28/src/commands/data/create/record.ts)_
1444
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.29/src/commands/data/create/record.ts)_
1446
1445
 
1447
1446
  ## `sf data delete bulk`
1448
1447
 
@@ -1502,7 +1501,7 @@ FLAG DESCRIPTIONS
1502
1501
  and can be enabled only by a system administrator.
1503
1502
  ```
1504
1503
 
1505
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.28/src/commands/data/delete/bulk.ts)_
1504
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.29/src/commands/data/delete/bulk.ts)_
1506
1505
 
1507
1506
  ## `sf data delete record`
1508
1507
 
@@ -1563,7 +1562,7 @@ EXAMPLES
1563
1562
  $ sf data delete record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
1564
1563
  ```
1565
1564
 
1566
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.28/src/commands/data/delete/record.ts)_
1565
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.29/src/commands/data/delete/record.ts)_
1567
1566
 
1568
1567
  ## `sf data delete resume`
1569
1568
 
@@ -1602,7 +1601,7 @@ EXAMPLES
1602
1601
  $ sf data delete resume --use-most-recent --target-org my-scratch
1603
1602
  ```
1604
1603
 
1605
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.28/src/commands/data/delete/resume.ts)_
1604
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.29/src/commands/data/delete/resume.ts)_
1606
1605
 
1607
1606
  ## `sf data export bulk`
1608
1607
 
@@ -1676,7 +1675,7 @@ EXAMPLES
1676
1675
  --result-format json --async
1677
1676
  ```
1678
1677
 
1679
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.28/src/commands/data/export/bulk.ts)_
1678
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.29/src/commands/data/export/bulk.ts)_
1680
1679
 
1681
1680
  ## `sf data export resume`
1682
1681
 
@@ -1712,7 +1711,7 @@ EXAMPLES
1712
1711
  $ sf data export resume --use-most-recent --target-org my-scratch
1713
1712
  ```
1714
1713
 
1715
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.28/src/commands/data/export/resume.ts)_
1714
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.29/src/commands/data/export/resume.ts)_
1716
1715
 
1717
1716
  ## `sf data export tree`
1718
1717
 
@@ -1772,7 +1771,7 @@ EXAMPLES
1772
1771
  my-scratch
1773
1772
  ```
1774
1773
 
1775
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.28/src/commands/data/export/tree.ts)_
1774
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.29/src/commands/data/export/tree.ts)_
1776
1775
 
1777
1776
  ## `sf data get record`
1778
1777
 
@@ -1836,7 +1835,7 @@ EXAMPLES
1836
1835
  $ sf data get record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
1837
1836
  ```
1838
1837
 
1839
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.28/src/commands/data/get/record.ts)_
1838
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.29/src/commands/data/get/record.ts)_
1840
1839
 
1841
1840
  ## `sf data import bulk`
1842
1841
 
@@ -1894,7 +1893,7 @@ EXAMPLES
1894
1893
  $ sf data import bulk --file accounts.csv --sobject Account --async
1895
1894
  ```
1896
1895
 
1897
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.28/src/commands/data/import/bulk.ts)_
1896
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.29/src/commands/data/import/bulk.ts)_
1898
1897
 
1899
1898
  ## `sf data import resume`
1900
1899
 
@@ -1930,7 +1929,7 @@ EXAMPLES
1930
1929
  $ sf data import resume --use-most-recent --target-org my-scratch
1931
1930
  ```
1932
1931
 
1933
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.28/src/commands/data/import/resume.ts)_
1932
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.29/src/commands/data/import/resume.ts)_
1934
1933
 
1935
1934
  ## `sf data import tree`
1936
1935
 
@@ -1994,7 +1993,7 @@ FLAG DESCRIPTIONS
1994
1993
  - files(array) - Files: An array of files paths to load
1995
1994
  ```
1996
1995
 
1997
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.28/src/commands/data/import/tree.ts)_
1996
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.29/src/commands/data/import/tree.ts)_
1998
1997
 
1999
1998
  ## `sf data query`
2000
1999
 
@@ -2003,10 +2002,9 @@ Execute a SOQL query.
2003
2002
  ```
2004
2003
  USAGE
2005
2004
  $ sf data query -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-q <value>] [-f <value>]
2006
- [-t | -b] [-w <value> ] [--async ] [--all-rows] [-r human|csv|json] [--output-file <value>]
2005
+ [-t] [--all-rows] [-r human|csv|json] [--output-file <value>]
2007
2006
 
2008
2007
  FLAGS
2009
- -b, --bulk Use Bulk API 2.0 to run the query.
2010
2008
  -f, --file=<value> File that contains the SOQL query.
2011
2009
  -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
2012
2010
  configuration variable is already set.
@@ -2014,10 +2012,8 @@ FLAGS
2014
2012
  -r, --result-format=<option> [default: human] Format to display the results; the --json flag overrides this flag.
2015
2013
  <options: human|csv|json>
2016
2014
  -t, --use-tooling-api Use Tooling API so you can run queries on Tooling API objects.
2017
- -w, --wait=<value> Time to wait for the command to finish, in minutes.
2018
2015
  --all-rows Include deleted records. By default, deleted records are not returned.
2019
2016
  --api-version=<value> Override the api version used for api requests made by this command
2020
- --async Use Bulk API 2.0, but don't wait for the job to complete.
2021
2017
  --output-file=<value> File where records are written; only CSV and JSON output formats are supported.
2022
2018
 
2023
2019
  GLOBAL FLAGS
@@ -2029,14 +2025,8 @@ DESCRIPTION
2029
2025
 
2030
2026
  Specify the SOQL query at the command line with the --query flag or read the query from a file with the --file flag.
2031
2027
 
2032
- If your query returns more than 10,000 records, specify the --bulk flag. The command then runs the query using Bulk
2033
- API 2.0, which has higher limits than the default API used by the command.
2034
-
2035
- When using --bulk, the command waits 3 minutes by default for the query to complete. Use the --wait parameter to
2036
- specify a different number of minutes to wait, or set --wait to 0 to immediately return control to the terminal. If
2037
- you set --wait to 0, or you use the --async flag, or the command simply times out, the command displays an ID. Pass
2038
- this ID to the the "data query resume" command using the --bulk-query-id flag to get the results; pass the ID to the
2039
- "data resume" command to get the job status.
2028
+ If your query returns more than 10,000 records, prefer to use the `sf data export bulk` command instead. It runs the
2029
+ query using Bulk API 2.0, which has higher limits than the default API used by the command.
2040
2030
 
2041
2031
  ALIASES
2042
2032
  $ sf force data soql query
@@ -2054,50 +2044,9 @@ EXAMPLES
2054
2044
  Use Tooling API to run a query on the ApexTrigger Tooling API object:
2055
2045
 
2056
2046
  $ sf data query --query "SELECT Name FROM ApexTrigger" --use-tooling-api
2057
-
2058
- Use Bulk API 2.0 to run a query that returns many rows, and return control to the terminal immediately:
2059
-
2060
- $ sf data query --query "SELECT Id FROM Contact" --bulk --wait 0
2061
2047
  ```
2062
2048
 
2063
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.28/src/commands/data/query.ts)_
2064
-
2065
- ## `sf data query resume`
2066
-
2067
- View the status of a bulk query.
2068
-
2069
- ```
2070
- USAGE
2071
- $ sf data query resume [--json] [--flags-dir <value>] [-o <value>] [--api-version <value>] [-r human|csv|json] [-i
2072
- <value>] [--use-most-recent]
2073
-
2074
- FLAGS
2075
- -i, --bulk-query-id=<value> Job ID of the bulk query.
2076
- -o, --target-org=<value> Username or alias of the target org.
2077
- -r, --result-format=<option> [default: human] Format to display the results; the --json flag overrides this flag.
2078
- <options: human|csv|json>
2079
- --api-version=<value> Override the api version used for api requests made by this command
2080
- --use-most-recent Use the most recent bulk query ID from cache.
2081
-
2082
- GLOBAL FLAGS
2083
- --flags-dir=<value> Import flag values from a directory.
2084
- --json Format output as json.
2085
-
2086
- DESCRIPTION
2087
- View the status of a bulk query.
2088
-
2089
- Run this command using the job ID returned from the "sf data query --bulk" command.
2090
-
2091
- ALIASES
2092
- $ sf force data soql bulk report
2093
-
2094
- EXAMPLES
2095
- View the status of a bulk query with the specified ID:
2096
-
2097
- $ sf data query resume --bulk-query-id 7500x000005BdFzXXX
2098
- ```
2099
-
2100
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.28/src/commands/data/query/resume.ts)_
2049
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.29/src/commands/data/query.ts)_
2101
2050
 
2102
2051
  ## `sf data resume`
2103
2052
 
@@ -2134,7 +2083,7 @@ EXAMPLES
2134
2083
  $ sf data resume --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA
2135
2084
  ```
2136
2085
 
2137
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.28/src/commands/data/resume.ts)_
2086
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.29/src/commands/data/resume.ts)_
2138
2087
 
2139
2088
  ## `sf data search`
2140
2089
 
@@ -2184,7 +2133,7 @@ EXAMPLES
2184
2133
  $ sf data search --file query.txt --target-org my-scratch --result-format csv
2185
2134
  ```
2186
2135
 
2187
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.28/src/commands/data/search.ts)_
2136
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.29/src/commands/data/search.ts)_
2188
2137
 
2189
2138
  ## `sf data update bulk`
2190
2139
 
@@ -2245,7 +2194,7 @@ EXAMPLES
2245
2194
  $ sf data update bulk --file accounts.csv --sobject Account --async
2246
2195
  ```
2247
2196
 
2248
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.28/src/commands/data/update/bulk.ts)_
2197
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.29/src/commands/data/update/bulk.ts)_
2249
2198
 
2250
2199
  ## `sf data update record`
2251
2200
 
@@ -2307,7 +2256,7 @@ EXAMPLES
2307
2256
  "ExpirationDate=2017-12-01T00:58:04.000+0000"
2308
2257
  ```
2309
2258
 
2310
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.28/src/commands/data/update/record.ts)_
2259
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.29/src/commands/data/update/record.ts)_
2311
2260
 
2312
2261
  ## `sf data update resume`
2313
2262
 
@@ -2343,7 +2292,7 @@ EXAMPLES
2343
2292
  $ sf data update resume --use-most-recent --target-org my-scratch
2344
2293
  ```
2345
2294
 
2346
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.28/src/commands/data/update/resume.ts)_
2295
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.29/src/commands/data/update/resume.ts)_
2347
2296
 
2348
2297
  ## `sf data upsert bulk`
2349
2298
 
@@ -2400,7 +2349,7 @@ EXAMPLES
2400
2349
  my-scratch
2401
2350
  ```
2402
2351
 
2403
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.28/src/commands/data/upsert/bulk.ts)_
2352
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.29/src/commands/data/upsert/bulk.ts)_
2404
2353
 
2405
2354
  ## `sf data upsert resume`
2406
2355
 
@@ -2439,7 +2388,7 @@ EXAMPLES
2439
2388
  $ sf data upsert resume --use-most-recent --target-org my-scratch
2440
2389
  ```
2441
2390
 
2442
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.28/src/commands/data/upsert/resume.ts)_
2391
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.29/src/commands/data/upsert/resume.ts)_
2443
2392
 
2444
2393
  ## `sf doctor`
2445
2394
 
@@ -2534,7 +2483,7 @@ EXAMPLES
2534
2483
  $ sf force data bulk delete --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
2535
2484
  ```
2536
2485
 
2537
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.28/src/commands/force/data/bulk/delete.ts)_
2486
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.29/src/commands/force/data/bulk/delete.ts)_
2538
2487
 
2539
2488
  ## `sf force data bulk status`
2540
2489
 
@@ -2571,7 +2520,7 @@ EXAMPLES
2571
2520
  $ sf force data bulk status --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA --target-org my-scratch
2572
2521
  ```
2573
2522
 
2574
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.28/src/commands/force/data/bulk/status.ts)_
2523
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.29/src/commands/force/data/bulk/status.ts)_
2575
2524
 
2576
2525
  ## `sf force data bulk upsert`
2577
2526
 
@@ -2629,7 +2578,7 @@ EXAMPLES
2629
2578
  --target-org my-scratch
2630
2579
  ```
2631
2580
 
2632
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.28/src/commands/force/data/bulk/upsert.ts)_
2581
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.29/src/commands/force/data/bulk/upsert.ts)_
2633
2582
 
2634
2583
  ## `sf help [COMMAND]`
2635
2584
 
@@ -6423,7 +6372,7 @@ FLAG DESCRIPTIONS
6423
6372
  If you specify this flag, don’t specify --metadata or --source-dir.
6424
6373
  ```
6425
6374
 
6426
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.4/src/commands/project/convert/mdapi.ts)_
6375
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.5/src/commands/project/convert/mdapi.ts)_
6427
6376
 
6428
6377
  ## `sf project convert source`
6429
6378
 
@@ -6496,7 +6445,7 @@ FLAG DESCRIPTIONS
6496
6445
  Override the api version used for api requests made by this command
6497
6446
  ```
6498
6447
 
6499
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.4/src/commands/project/convert/source.ts)_
6448
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.5/src/commands/project/convert/source.ts)_
6500
6449
 
6501
6450
  ## `sf project convert source-behavior`
6502
6451
 
@@ -6555,7 +6504,7 @@ EXAMPLES
6555
6504
  $ sf project convert source-behavior --behavior decomposePermissionSetBeta --dry-run --preserve-temp-dir
6556
6505
  ```
6557
6506
 
6558
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.4/src/commands/project/convert/source-behavior.ts)_
6507
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.5/src/commands/project/convert/source-behavior.ts)_
6559
6508
 
6560
6509
  ## `sf project delete source`
6561
6510
 
@@ -6695,7 +6644,7 @@ FLAG DESCRIPTIONS
6695
6644
  - Separate the test names with spaces: --tests Test1 Test2 "Test With Space"
6696
6645
  ```
6697
6646
 
6698
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.4/src/commands/project/delete/source.ts)_
6647
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.5/src/commands/project/delete/source.ts)_
6699
6648
 
6700
6649
  ## `sf project delete tracking`
6701
6650
 
@@ -6732,7 +6681,7 @@ EXAMPLES
6732
6681
  $ sf project delete tracking --target-org my-scratch
6733
6682
  ```
6734
6683
 
6735
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.4/src/commands/project/delete/tracking.ts)_
6684
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.5/src/commands/project/delete/tracking.ts)_
6736
6685
 
6737
6686
  ## `sf project deploy cancel`
6738
6687
 
@@ -6804,7 +6753,7 @@ FLAG DESCRIPTIONS
6804
6753
  project deploy report".
6805
6754
  ```
6806
6755
 
6807
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.4/src/commands/project/deploy/cancel.ts)_
6756
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.5/src/commands/project/deploy/cancel.ts)_
6808
6757
 
6809
6758
  ## `sf project deploy preview`
6810
6759
 
@@ -6887,7 +6836,7 @@ FLAG DESCRIPTIONS
6887
6836
  All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
6888
6837
  ```
6889
6838
 
6890
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.4/src/commands/project/deploy/preview.ts)_
6839
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.5/src/commands/project/deploy/preview.ts)_
6891
6840
 
6892
6841
  ## `sf project deploy quick`
6893
6842
 
@@ -6980,7 +6929,7 @@ ERROR CODES
6980
6929
  Canceling (69) The deploy is being canceled.
6981
6930
  ```
6982
6931
 
6983
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.4/src/commands/project/deploy/quick.ts)_
6932
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.5/src/commands/project/deploy/quick.ts)_
6984
6933
 
6985
6934
  ## `sf project deploy report`
6986
6935
 
@@ -7072,7 +7021,7 @@ FLAG DESCRIPTIONS
7072
7021
  --coverage-formatters lcov --coverage-formatters clover
7073
7022
  ```
7074
7023
 
7075
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.4/src/commands/project/deploy/report.ts)_
7024
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.5/src/commands/project/deploy/report.ts)_
7076
7025
 
7077
7026
  ## `sf project deploy resume`
7078
7027
 
@@ -7169,7 +7118,7 @@ ERROR CODES
7169
7118
  Canceling (69) The deploy is being canceled.
7170
7119
  ```
7171
7120
 
7172
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.4/src/commands/project/deploy/resume.ts)_
7121
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.5/src/commands/project/deploy/resume.ts)_
7173
7122
 
7174
7123
  ## `sf project deploy start`
7175
7124
 
@@ -7422,7 +7371,7 @@ ERROR CODES
7422
7371
  Canceling (69) The deploy is being canceled.
7423
7372
  ```
7424
7373
 
7425
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.4/src/commands/project/deploy/start.ts)_
7374
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.5/src/commands/project/deploy/start.ts)_
7426
7375
 
7427
7376
  ## `sf project deploy validate`
7428
7377
 
@@ -7612,7 +7561,7 @@ ERROR CODES
7612
7561
  Canceling (69) The deploy is being canceled.
7613
7562
  ```
7614
7563
 
7615
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.4/src/commands/project/deploy/validate.ts)_
7564
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.5/src/commands/project/deploy/validate.ts)_
7616
7565
 
7617
7566
  ## `sf project generate`
7618
7567
 
@@ -7813,7 +7762,7 @@ EXAMPLES
7813
7762
  $ sf project generate manifest --from-org test@myorg.com --excluded-metadata StandardValueSet
7814
7763
  ```
7815
7764
 
7816
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.4/src/commands/project/generate/manifest.ts)_
7765
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.5/src/commands/project/generate/manifest.ts)_
7817
7766
 
7818
7767
  ## `sf project list ignored`
7819
7768
 
@@ -7855,7 +7804,7 @@ EXAMPLES
7855
7804
  $ sf project list ignored --source-dir package.xml
7856
7805
  ```
7857
7806
 
7858
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.4/src/commands/project/list/ignored.ts)_
7807
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.5/src/commands/project/list/ignored.ts)_
7859
7808
 
7860
7809
  ## `sf project reset tracking`
7861
7810
 
@@ -7904,7 +7853,7 @@ EXAMPLES
7904
7853
  $ sf project reset tracking --revision 30
7905
7854
  ```
7906
7855
 
7907
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.4/src/commands/project/reset/tracking.ts)_
7856
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.5/src/commands/project/reset/tracking.ts)_
7908
7857
 
7909
7858
  ## `sf project retrieve preview`
7910
7859
 
@@ -7958,7 +7907,7 @@ FLAG DESCRIPTIONS
7958
7907
  production orgs.
7959
7908
  ```
7960
7909
 
7961
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.4/src/commands/project/retrieve/preview.ts)_
7910
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.5/src/commands/project/retrieve/preview.ts)_
7962
7911
 
7963
7912
  ## `sf project retrieve start`
7964
7913
 
@@ -8054,6 +8003,10 @@ EXAMPLES
8054
8003
 
8055
8004
  $ sf project retrieve start --metadata 'CustomObject:SBQQ__*'
8056
8005
 
8006
+ Retrieve all list views for the Case standard object:
8007
+
8008
+ $ sf project retrieve start --metadata 'ListView:Case*'
8009
+
8057
8010
  Retrieve all custom objects and Apex classes found in all defined package directories (both examples are
8058
8011
  equivalent):
8059
8012
 
@@ -8135,7 +8088,7 @@ ENVIRONMENT VARIABLES
8135
8088
  SF_USE_PROGRESS_BAR Set to false to disable the progress bar when running the metadata deploy command.
8136
8089
  ```
8137
8090
 
8138
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.4/src/commands/project/retrieve/start.ts)_
8091
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.5/src/commands/project/retrieve/start.ts)_
8139
8092
 
8140
8093
  ## `sf schema generate field`
8141
8094
 
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@salesforce/cli",
3
- "version": "2.87.5",
3
+ "version": "2.87.6",
4
4
  "lockfileVersion": 3,
5
5
  "requires": true,
6
6
  "packages": {
7
7
  "": {
8
8
  "name": "@salesforce/cli",
9
- "version": "2.87.5",
9
+ "version": "2.87.6",
10
10
  "hasInstallScript": true,
11
11
  "license": "Apache-2.0",
12
12
  "dependencies": {
@@ -27,8 +27,8 @@
27
27
  "@salesforce/plugin-apex": "3.6.15",
28
28
  "@salesforce/plugin-api": "1.3.3",
29
29
  "@salesforce/plugin-auth": "3.6.115",
30
- "@salesforce/plugin-data": "4.0.28",
31
- "@salesforce/plugin-deploy-retrieve": "3.22.4",
30
+ "@salesforce/plugin-data": "4.0.29",
31
+ "@salesforce/plugin-deploy-retrieve": "3.22.5",
32
32
  "@salesforce/plugin-info": "3.4.56",
33
33
  "@salesforce/plugin-limits": "3.3.52",
34
34
  "@salesforce/plugin-marketplace": "1.3.8",
@@ -5064,9 +5064,9 @@
5064
5064
  }
5065
5065
  },
5066
5066
  "node_modules/@salesforce/plugin-data": {
5067
- "version": "4.0.28",
5068
- "resolved": "https://registry.npmjs.org/@salesforce/plugin-data/-/plugin-data-4.0.28.tgz",
5069
- "integrity": "sha512-gmLY9Mgp9TRMLerIChp+yzG1favp6MLpDna5dQFDRX5C7/ZA0JMpMTMqLh6En19VGSJHk4N3nB+Q8HedjR7CkA==",
5067
+ "version": "4.0.29",
5068
+ "resolved": "https://registry.npmjs.org/@salesforce/plugin-data/-/plugin-data-4.0.29.tgz",
5069
+ "integrity": "sha512-+Fls7l6u4QIZskwYJCxesa9r8q0prqL08o/loGe3j1/aYDk8Hlq0Y3ccoO+3Zcgutkx/tadbohJw75aEq+G24w==",
5070
5070
  "license": "Apache-2.0",
5071
5071
  "dependencies": {
5072
5072
  "@jsforce/jsforce-node": "^3.6.6",
@@ -5087,10 +5087,10 @@
5087
5087
  }
5088
5088
  },
5089
5089
  "node_modules/@salesforce/plugin-deploy-retrieve": {
5090
- "version": "3.22.4",
5091
- "resolved": "https://registry.npmjs.org/@salesforce/plugin-deploy-retrieve/-/plugin-deploy-retrieve-3.22.4.tgz",
5092
- "integrity": "sha512-gpbJfIAUQTfFL6rtxQuREaz/CrrqrIzR7oNhzMeOZFN6Dky03LnKuQDMTFCEGzTJpiSStJ7RGb36I0rtTv7WZA==",
5093
- "license": "BSD-3-Clause",
5090
+ "version": "3.22.5",
5091
+ "resolved": "https://registry.npmjs.org/@salesforce/plugin-deploy-retrieve/-/plugin-deploy-retrieve-3.22.5.tgz",
5092
+ "integrity": "sha512-dhq7kagY5R8+n2DXnQidLv9bJMW/T198WrcT5VDSgyzvVIesVYJX7xbN2r6ISxt6PU1V/7IwYEOendfdI93rvQ==",
5093
+ "license": "Apache-2.0",
5094
5094
  "dependencies": {
5095
5095
  "@inquirer/prompts": "^7.4.1",
5096
5096
  "@oclif/core": "^4.2.10",
package/oclif.lock CHANGED
@@ -2105,10 +2105,10 @@
2105
2105
  debug "^4.4.0"
2106
2106
  handlebars "^4.7.8"
2107
2107
 
2108
- "@salesforce/plugin-data@4.0.28":
2109
- version "4.0.28"
2110
- resolved "https://registry.npmjs.org/@salesforce/plugin-data/-/plugin-data-4.0.28.tgz"
2111
- integrity sha512-gmLY9Mgp9TRMLerIChp+yzG1favp6MLpDna5dQFDRX5C7/ZA0JMpMTMqLh6En19VGSJHk4N3nB+Q8HedjR7CkA==
2108
+ "@salesforce/plugin-data@4.0.29":
2109
+ version "4.0.29"
2110
+ resolved "https://registry.npmjs.org/@salesforce/plugin-data/-/plugin-data-4.0.29.tgz"
2111
+ integrity sha512-+Fls7l6u4QIZskwYJCxesa9r8q0prqL08o/loGe3j1/aYDk8Hlq0Y3ccoO+3Zcgutkx/tadbohJw75aEq+G24w==
2112
2112
  dependencies:
2113
2113
  "@jsforce/jsforce-node" "^3.6.6"
2114
2114
  "@oclif/multi-stage-output" "^0.8.12"
@@ -2123,10 +2123,10 @@
2123
2123
  form-data "^4.0.2"
2124
2124
  terminal-link "^3.0.0"
2125
2125
 
2126
- "@salesforce/plugin-deploy-retrieve@3.22.4":
2127
- version "3.22.4"
2128
- resolved "https://registry.npmjs.org/@salesforce/plugin-deploy-retrieve/-/plugin-deploy-retrieve-3.22.4.tgz"
2129
- integrity sha512-gpbJfIAUQTfFL6rtxQuREaz/CrrqrIzR7oNhzMeOZFN6Dky03LnKuQDMTFCEGzTJpiSStJ7RGb36I0rtTv7WZA==
2126
+ "@salesforce/plugin-deploy-retrieve@3.22.5":
2127
+ version "3.22.5"
2128
+ resolved "https://registry.npmjs.org/@salesforce/plugin-deploy-retrieve/-/plugin-deploy-retrieve-3.22.5.tgz"
2129
+ integrity sha512-dhq7kagY5R8+n2DXnQidLv9bJMW/T198WrcT5VDSgyzvVIesVYJX7xbN2r6ISxt6PU1V/7IwYEOendfdI93rvQ==
2130
2130
  dependencies:
2131
2131
  "@inquirer/prompts" "^7.4.1"
2132
2132
  "@oclif/core" "^4.2.10"
@@ -3,22 +3,32 @@
3
3
  "code-analyzer:config": {
4
4
  "aliases": [],
5
5
  "args": {},
6
- "description": "Code Analyzer gives you the ability to configure settings that modify Code Analyzer's behavior, to override the tags and severity levels of rules, and to configure the engine specific settings. Use this command to see the current state of this configuration. You can also save this state to a YAML-formatted file that you can modify for your needs.\n\nTo apply a custom configuration with Code Analyzer, either keep your custom configuration settings in a `code-analyzer.yml` file located in the current folder from which you are executing commands, or specify the location of your custom configuration file to the Code Analyzer commands with the --config-file flag.\n\nWe're continually improving Salesforce Code Analyzer. Tell us what you think! Give feedback at http://sfdc.co/CodeAnalyzerFeedback.",
6
+ "description": "Code Analyzer gives you the ability to configure settings that modify Code Analyzer's behavior, to override the tags and severity levels of rules, and to configure the engine specific settings. Use this command to see the current state of this configuration. You can also save this state to a YAML-formatted file that you can modify for your needs.\n\nTo apply a custom configuration with Code Analyzer, either keep your custom configuration settings in a `code-analyzer.yml` file located in the current folder from which you are executing commands, or specify the location of your custom configuration file to the Code Analyzer commands with the --config-file flag.\n\nWe're continually improving Salesforce Code Analyzer. Tell us what you think! Give feedback at https://sfdc.co/CodeAnalyzerFeedback.",
7
7
  "examples": [
8
8
  "Display the current state of the Code Analyzer configuration using the default behavior: display top level configuration, display the engine and rule override settings associated with all the rules; and automatically apply any existing custom configuration settings found in a `code-analyzer.yml` or `code-analyzer.yaml` file in the current folder:\n<%= config.bin %> <%= command.id %>",
9
9
  "This example is identical to the previous one, assuming that `./code-analyzer.yml` exists in your current folder.\n<%= config.bin %> <%= command.id %> --config-file ./code-analyzer.yml --rule-selector all",
10
10
  "Write the current state of configuration to the file `code-analyzer.yml`, including any configuration from an existing `code-analyzer.yml` file. The command preserves all values from the original config, but overwrites any comments:\n<%= config.bin %> <%= command.id %> --config-file ./code-analyzer.yml --output-file code-analyzer.yml",
11
11
  "Display the configuration state for just the recommended rules, instead of all the rules:\n<%= config.bin %> <%= command.id %> --rule-selector Recommended",
12
- "Display the configuration state associated with all the rules that are applicable to your workspace folder, `./src`:\n<%= config.bin %> <%= command.id %> --workspace ./src",
12
+ "Display the configuration state associated with all the rules that are applicable to the files targeted within the folder `./src`:\n<%= config.bin %> <%= command.id %> --target ./src",
13
13
  "Display any relevant configuration settings associated with the rule name 'no-undef' from the 'eslint' engine:\n<%= config.bin %> <%= command.id %> --rule-selector eslint:no-undef",
14
14
  "Load an existing configuration file called `existing-config.yml`, and then write the configuration to a new file called `new-config.yml`, the configuration state that is applicable to all rules that are relevant to the workspace located in the current folder:\n<%= config.bin %> <%= command.id %> --config-file ./existing-config.yml --workspace . --output-file ./subfolder-config.yml"
15
15
  ],
16
16
  "flags": {
17
17
  "workspace": {
18
18
  "char": "w",
19
- "description": "Use the --workspace flag to display only the configuration associated with the rules that apply to the files that make up your workspace. Typically, a workspace is a single project folder that contains all your files. But it can also consist of one or more folders, one or more files, and use glob patterns (wildcards). If you specify this flag multiple times, then your workspace is the sum of the files and folders.\n\nThis command uses the type of file in the workspace, such as JavaScript or Typescript, to determine the rules to include in the configuration state. For example, if your workspace contains only JavaScript files, the command doesn't include TypeScript rules. The command uses a file's extension to determine what kind of file it is, such as \".ts\" for TypeScript.\n\nSome engines may be configured to add additional rules based on what it finds in your workspace. For example, if you set the \"engines.eslint.auto_discover_eslint_config\" value of your `code-analyzer.yml` file to true, then supplying your workspace allows the \"eslint\" engine to examine your files in order to find ESLint configuration files that could potentially add in additional rules.",
19
+ "description": "Use the `--workspace` flag to display only the configuration associated with the rules that apply to the files that make up your workspace. Typically, a workspace is a single project folder that contains all your files. But it can also consist of one or more folders, one or more files, and use glob patterns (wildcards). If you specify this flag multiple times, then your workspace is the sum of the files and folders.\n\nThis command uses the types of files in the workspace, such as JavaScript or Typescript, to determine the applicable configuration state. For example, if your workspace contains only JavaScript files, then the command doesn't display configuration state associated with TypeScript rules. The command uses a file's extension to determine what kind of file it is, such as \".ts\" for TypeScript.\n\nSome engines can be configured to add additional rules based on what it finds in your workspace. For example, if you set the engines.eslint.auto_discover_eslint_config value of your `code-analyzer.yml` file to true, then supplying your workspace allows the \"eslint\" engine to examine your files in order to find ESLint configuration files that could potentially add in additional rules.\n\nIf you specify `--target` but not `--workspace`, then the current folder '.' is used as your workspace.",
20
20
  "name": "workspace",
21
- "summary": "Set of files you want to include in the code analysis.",
21
+ "summary": "Set of files that make up your workspace.",
22
+ "delimiter": ",",
23
+ "hasDynamicHelp": false,
24
+ "multiple": true,
25
+ "type": "option"
26
+ },
27
+ "target": {
28
+ "char": "t",
29
+ "description": "Use the `--target` flag to display the configuration state associated with the rules that apply to only a subset of targeted files within your workspace. You can specify a target as a file, a folder, or a glob pattern. If you specify this flag multiple times, then the full list of targeted files is the sum of the files and folders.\n\nThe command uses the type of the targeted files, such as JavaScript or Typescript, to determine which configuration state is applicable. For example, if you target only JavaScript files, then the command doesn't display the configuration state associated with TypeScript rules. The command uses a file's extension to determine what kind of file it is, such as \".ts\" for TypeScript.\n\nEach targeted file must live within the workspace specified by the `–-workspace` flag.\n\nIf you specify `--workspace` but not `--target`, then all the files within your workspace are targeted.",
30
+ "name": "target",
31
+ "summary": "Subset of files within your workspace that you want to target for analysis.",
22
32
  "delimiter": ",",
23
33
  "hasDynamicHelp": false,
24
34
  "multiple": true,
@@ -26,7 +36,7 @@
26
36
  },
27
37
  "rule-selector": {
28
38
  "char": "r",
29
- "description": "Use the --rule-selector flag to display only the configuration associated with the rules based on specific criteria. You can select by engine, such as the rules associated with the \"retire-js\" or \"eslint\" engine. Or select by the severity of the rules, such as high or moderate. You can also select rules using tag values or rule names.\n\nYou can combine different criteria using colons to further filter the list; the colon works as an intersection. For example, \"--rule-selector eslint:Security\" reduces the output to only contain the configuration state associated with the rules from the \"eslint\" engine that have the \"Security\" tag. To add multiple rule selectors together (a union), specify the --rule-selector flag multiple times, such as \"--rule-selector eslint:Recommended --rule-selector retire-js:3\".\n\nIf you don't specify this flag, then the command uses the \"all\" rule selector.\n\nRun `<%= config.bin %> <%= command.id %> --rule-selector Recommended` to display the configuration state associated with just the 'Recommended' rules, instead of all the rules.",
39
+ "description": "Use the `--rule-selector` flag to display only the configuration associated with the rules based on specific criteria. You can select by engine, such as the rules associated with the \"retire-js\" or \"eslint\" engine. Or select by the severity of the rules, such as high or moderate. You can also select rules using tag values or rule names.\n\nYou can combine different criteria using colons to further filter the list; the colon works as an intersection. For example, `--rule-selector eslint:Security` reduces the output to only contain the configuration state associated with the rules from the \"eslint\" engine that have the \"Security\" tag. To add multiple rule selectors together (a union), specify the `--rule-selector` flag multiple times, such as `--rule-selector eslint:Recommended --rule-selector retire-js:3`.\n\nIf you don't specify this flag, then the command uses the \"all\" rule selector.\n\nRun `<%= config.bin %> <%= command.id %> --rule-selector Recommended` to display the configuration state associated with just the 'Recommended' rules, instead of all the rules.",
30
40
  "name": "rule-selector",
31
41
  "summary": "Selection of rules, based on engine name, severity level, rule name, tag, or a combination of criteria separated by colons.",
32
42
  "default": [
@@ -48,7 +58,7 @@
48
58
  },
49
59
  "output-file": {
50
60
  "char": "f",
51
- "description": "Use this flag to write the final config to a file, in addition to the terminal.",
61
+ "description": "If you specify a file within folder, such as `--output-file ./config/code-analyzer.yml`, the folder must already exist, or you get an error. If the file already exists, a prompt asks if you want to overwrite it.\n\nIf you don't specify this flag, the command outputs the configuration state to the terminal.",
52
62
  "name": "output-file",
53
63
  "summary": "Output file to write the configuration state to. The file is written in YAML format.",
54
64
  "hasDynamicHelp": false,
@@ -62,7 +72,6 @@
62
72
  "pluginAlias": "@salesforce/plugin-code-analyzer",
63
73
  "pluginName": "@salesforce/plugin-code-analyzer",
64
74
  "pluginType": "jit",
65
- "state": "Beta",
66
75
  "strict": true,
67
76
  "summary": "Display the current state of configuration for Code Analyzer.",
68
77
  "enableJsonFlag": false,
@@ -83,27 +92,37 @@
83
92
  "code-analyzer:rules": {
84
93
  "aliases": [],
85
94
  "args": {},
86
- "description": "You can also view details about the rules, such as the engine it's associated with, tags, and description.\n\nUse this command to determine the exact set of rules to analyze your code. The `code-analyzer run` command has similar flags as this command, so once you've determined the flag values for this command that list the rules you want to run, you specify the same values to the `code-analyzer run` command.\n\nWe're continually improving Salesforce Code Analyzer. Tell us what you think! Give feedback at http://sfdc.co/CodeAnalyzerFeedback.",
95
+ "description": "You can also view details about the rules, such as the engine it's associated with, tags, and description.\n\nUse this command to determine the exact set of rules to analyze your code. The `code-analyzer run` command has similar flags as this command, so once you've determined the flag values for this command that list the rules you want to run, you specify the same values to the `code-analyzer run` command.\n\nWe're continually improving Salesforce Code Analyzer. Tell us what you think! Give feedback at https://sfdc.co/CodeAnalyzerFeedback.",
87
96
  "examples": [
88
- "List rules using the default behavior: include rules from all engines that have a \"Recommended\" tag; display the rules using concise table format; and automatically apply rule or engine overrides if a \"code-analyzer.yml\" or \"code-analyzer.yaml\" file exists in the current folder:\n<%= config.bin %> <%= command.id %>",
97
+ "List rules using the default behavior: include rules from all engines that have a \"Recommended\" tag; display the rules using concise table format; and automatically apply rule or engine overrides if a `code-analyzer.yml` or `code-analyzer.yaml` file exists in the current folder:\n<%= config.bin %> <%= command.id %>",
89
98
  "The previous example is equivalent to this example:\n<%= config.bin %> <%= command.id %> --rule-selector Recommended --view table --config-file ./code-analyzer.yml",
90
- "List the recommended rules for the \"eslint\" engine:\n<%= config.bin %> <%= command.id %> --rule-selector eslint:Recommended",
91
- "List all the rules for the \"eslint\" engine:\n<%= config.bin %> <%= command.id %> --rule-selector eslint",
92
- "The previous example is equivalent to this example:\n<%= config.bin %> <%= command.id %> --rule-selector eslint:all",
93
- "List the details about all rules for all engines; also write the rules in JSON format to a file called \"rules.json\" in the \"out\" folder, which must already exist:\n<%= config.bin %> <%= command.id %> --rule-selector all --output-file ./out/rules.json --view detail",
94
- "Get a more accurate list of the rules that apply specifically to your workspace (all the files in the current folder):\n<%= config.bin %> <%= command.id %> --rule-selector all --workspace .",
95
- "List the recommended rules associated with a workspace that includes all the files in the folder \"./other-source\" and only the Apex class files (extension .cls) under the folder \"./force-app\":\n<%= config.bin %> <%= command.id %> --rule-selector Recommended --workspace ./other-source --workspace ./force-app/**/*.cls",
99
+ "List the recommended rules for the \"eslint\" engine:\n<%= config.bin %> <%= command.id %> --rule-selector eslint:Recommended",
100
+ "List all the rules for the \"eslint\" engine:\n<%= config.bin %> <%= command.id %> --rule-selector eslint",
101
+ "The previous example is equivalent to this example:\n<%= config.bin %> <%= command.id %> --rule-selector eslint:all",
102
+ "List the details about all rules for all engines; also write the rules in JSON format to a file called \"rules.json\" in the \"out\" folder, which must already exist:\n<%= config.bin %> <%= command.id %> --rule-selector all --output-file ./out/rules.json --view detail",
103
+ "Get a more accurate list of the rules that apply specifically to your workspace (all the files in the current folder):\n<%= config.bin %> <%= command.id %> --rule-selector all --workspace .",
104
+ "List the recommended rules associated with a workspace that targets all the files in the folder \"./other-source\" and only the Apex class files (extension .cls) under the folder \"./force-app\":\n<%= config.bin %> <%= command.id %> --rule-selector Recommended --workspace . --target ./other-source --target ./force-app/**/*.cls",
96
105
  "List all the \"eslint\" engine rules that have a moderate severity (3) and the recommended \"retire-js\" engine rules with any severity:\n<%= config.bin %> <%= command.id %> --rule-selector eslint:3 --rule-selector retire-js:Recommended",
97
- "Similar to the previous example, but apply the rule overrides and engine settings from the configuration file called \"code-analyzer2.yml\" in the current folder. If, for example, you changed the severity of an \"eslint\" rule from moderate (3) to high (2) in the configuration file, then that rule won't be listed:\n<%= config.bin %> <%= command.id %> --rule-selector eslint:3 --rule-selector retire-js:Recommended --config-file ./code-analyzer2.yml",
106
+ "Similar to the previous example, but apply the rule overrides and engine settings from the configuration file called `code-analyzer2.yml` in the current folder. If, for example, you changed the severity of an \"eslint\" rule from moderate (3) to high (2) in the configuration file, then that rule isn't listed:\n<%= config.bin %> <%= command.id %> --rule-selector eslint:3 --rule-selector retire-js:Recommended --config-file ./code-analyzer2.yml",
98
107
  "List the details of the \"getter-return\" rule of the \"eslint\" engine and the rules named \"no-inner-declarations\" in any engine:\n<%= config.bin %> <%= command.id %> --rule-selector eslint:getter-return --rule-selector no-inner-declarations --view detail",
99
- "List the details of the recommended \"eslint\" engine rules that have the tag \"problem\" and high severity level (2) that apply to your workspace folder \"./force-app\":\n<%= config.bin %> <%= command.id %> --rule-selector eslint:Recommended:problem:2 --view detail --workspace ./force-app"
108
+ "List the details of the recommended \"eslint\" engine rules that have the tag \"problem\" and high severity level (2) that apply when targeting the files within the folder \"./force-app\":\n<%= config.bin %> <%= command.id %> --rule-selector eslint:Recommended:problem:2 --view detail --target ./force-app"
100
109
  ],
101
110
  "flags": {
102
111
  "workspace": {
103
112
  "char": "w",
104
- "description": "If you specify this flag, the command returns a more accurate list of the rules that apply to the files that make up your workspace. Typically, a workspace is a single project folder that contains all your files. But it can also consist of one or more folders, one or more files, and use glob patterns (wildcards). If you specify this flag multiple times, then your workspace is the sum of the files and folders. \n\nThis command uses the type of file in the workspace, such as JavaScript or Typescript, to determine the rules to list. For example, if your workspace contains only JavaScript files, the command doesn't list TypeScript rules. The command uses a file's extension to determine what kind of file it is, such as \".ts\" for TypeScript.\n\nSome engines may be configured to add additional rules based on what it finds in your workspace. For example, if you set the engines.eslint.auto_discover_eslint_config value of your code-analyzer.yml file to true, then supplying your workspace allows the \"eslint\" engine to examine your files in order to find ESLint configuration files that could potentially add in additional rules.",
113
+ "description": "Use the `--workspace` flag to return a more accurate list of the rules that apply to the files that make up your workspace. Typically, a workspace is a single project folder that contains all your files. But it can also consist of one or more folders, one or more files, and use glob patterns (wildcards). If you specify this flag multiple times, then your workspace is the sum of the files and folders. \n\nThe command uses the types of files in the workspace, such as JavaScript or Typescript, to determine which rules to list. For example, if your workspace contains only JavaScript files, the command doesn't list TypeScript rules. The command uses a file's extension to determine what kind of file it is, such as \".ts\" for TypeScript.\n\nSome engines may be configured to add additional rules based on what it finds in your workspace. For example, if you set the engines.eslint.auto_discover_eslint_config value of your `code-analyzer.yml` file to true, then supplying your workspace allows the \"eslint\" engine to examine your files in order to find ESLint configuration files that could potentially add in additional rules.\n\nIf you specify `--target` but not `--workspace`, then the current folder '.' is used as your workspace.",
105
114
  "name": "workspace",
106
- "summary": "Set of files you want to include in the code analysis.",
115
+ "summary": "Set of files that make up your workspace.",
116
+ "delimiter": ",",
117
+ "hasDynamicHelp": false,
118
+ "multiple": true,
119
+ "type": "option"
120
+ },
121
+ "target": {
122
+ "char": "t",
123
+ "description": "Use the `--target` flag to return a more accurate list of the rules that apply to only a subset of targeted files within your workspace. You can specify a target as a file, a folder, or a glob pattern. If you specify this flag multiple times, then the full list of targeted files is the sum of the files and folders.\n\nThe command uses the type of the targeted files, such as JavaScript or Typescript, to determine which rules to list. For example, if you target only JavaScript files, the command doesn't list TypeScript rules. The command uses a file's extension to determine what kind of file it is, such as \".ts\" for TypeScript.\n\nEach targeted file must live within the workspace specified by the –-workspace flag.\n\nIf you specify `--workspace` but not `--target`, then all the files within your workspace are targeted.",
124
+ "name": "target",
125
+ "summary": "Subset of files within your workspace that you want to target for analysis.",
107
126
  "delimiter": ",",
108
127
  "hasDynamicHelp": false,
109
128
  "multiple": true,
@@ -111,7 +130,7 @@
111
130
  },
112
131
  "rule-selector": {
113
132
  "char": "r",
114
- "description": "Use the --rule-selector flag to select the list of rules based on specific criteria. For example, you can select by engine, such as the rules associated with the \"retire-js\" or \"eslint\" engine. Or select by the severity of the rules, such as high or moderate. You can also select rules using tag values or rule names. Every rule has a name, which is unique within the scope of an engine. Most rules have tags, although it's not required. An example of a tag is \"Recommended\". \n\nYou can combine different criteria using colons to further filter the list; the colon works as an intersection. For example, \"--rule-selector eslint:Security\" lists rules associated only with the \"eslint\" engine that have the Security tag. The flag \"--rule-selector eslint:Security:3\" flag lists the \"eslint\" rules that have the Security tag and moderate severity (3). To add multiple rule selectors together (a union), specify the --rule-selector flag multiple times, such as \"--rule-selector eslint:Recommended --rule-selector retire-js:3\".\n\nRun `<%= config.bin %> <%= command.id %> --rule-selector all` to list see the possible values for engine name, rule name, tags, and severity levels that you can use with this flag.",
133
+ "description": "Use the `--rule-selector` flag to select the list of rules based on specific criteria. For example, you can select by engine, such as the rules associated with the \"retire-js\" or \"eslint\" engine. Or select by the severity of the rules, such as high or moderate. You can also select rules using tag values or rule names. Every rule has a name, which is unique within the scope of an engine. Most rules have tags, although it's not required. An example of a tag is \"Recommended\". \n\nYou can combine different criteria using colons to further filter the list; the colon works as an intersection. For example, `--rule-selector eslint:Security` lists rules associated only with the \"eslint\" engine that have the Security tag. The flag `--rule-selector eslint:Security:3` flag lists the \"eslint\" rules that have the Security tag and moderate severity (3). To add multiple rule selectors together (a union), specify the `--rule-selector` flag multiple times, such as `--rule-selector eslint:Recommended --rule-selector retire-js:3`.\n\nRun `<%= config.bin %> <%= command.id %> --rule-selector all` to list the possible values for engine name, rule name, tags, and severity levels that you can use with this flag.",
115
134
  "name": "rule-selector",
116
135
  "summary": "Selection of rules, based on engine name, severity level, rule name, tag, or a combination of criteria separated by colons.",
117
136
  "default": [
@@ -124,7 +143,7 @@
124
143
  },
125
144
  "config-file": {
126
145
  "char": "c",
127
- "description": "Code Analyzer has an internal default configuration for its rule and engine properties. If you want to override these defaults, you can create a Code Analyzer configuration file.\n\nWe recommend that you name your Code Analyzer configuration file \"code-analyzer.yml\" or \"code-analyzer.yaml\" and put it at the root of your workspace. You then don't need to use this flag when you run the `<%= command.id %>` command from the root of your workspace, because it automatically looks for either file in the current folder, and if found, applies its rule overrides and engine settings. If you want to name the file something else, or put it in an alternative folder, then you must specify this flag.\n\nTo help you get started, use the `code-analyzer config` command to create your first Code Analyzer configuration file. With it, you can change the severity of an existing rule, change a rule's tags, and so on. Then use this flag to specify the file so that the command takes your customizations into account.",
146
+ "description": "Code Analyzer has an internal default configuration for its rule and engine properties. If you want to override these defaults, you can create a Code Analyzer configuration file.\n\nWe recommend that you name your Code Analyzer configuration file `code-analyzer.yml` or `code-analyzer.yaml` and put it at the root of your workspace. You then don't need to use this flag when you run the `<%= command.id %>` command from the root of your workspace, because it automatically looks for either file in the current folder, and if found, applies its rule overrides and engine settings. If you want to name the file something else, or put it in an alternative folder, then you must specify this flag.\n\nTo help you get started, use the `code-analyzer config` command to create your first Code Analyzer configuration file. With it, you can change the severity of an existing rule, change a rule's tags, and so on. Then use this flag to specify the file so that the command takes your customizations into account.",
128
147
  "name": "config-file",
129
148
  "summary": "Path to the configuration file used to customize the engines and rules.",
130
149
  "hasDynamicHelp": false,
@@ -133,7 +152,7 @@
133
152
  },
134
153
  "output-file": {
135
154
  "char": "f",
136
- "description": "If you specify a folder, such as \"--output-file ./out/rules.json\", the folder must already exist or you get an error. If the file already exists, it's overwritten without prompting.\n\nIf you don't specify this flag, the command outputs the rules to only the terminal.",
155
+ "description": "If you specify a file within folder, such as `--output-file ./out/rules.json`, the folder must already exist, or you get an error. If the file already exists, it's overwritten without prompting.\n\nIf you don't specify this flag, the command outputs the rules to only the terminal.",
137
156
  "name": "output-file",
138
157
  "summary": "Name of the file where the selected rules are written. The file format depends on the extension you specify; currently, only .json is supported for JSON-formatted output.",
139
158
  "hasDynamicHelp": false,
@@ -142,7 +161,7 @@
142
161
  },
143
162
  "view": {
144
163
  "char": "v",
145
- "description": "The format `table` is concise and shows minimal output, the format `detail` shows all available information. \n\nIf you specify neither --view nor --output-file, then the default table view is shown. If you specify --output-file but not --view, only summary information is shown in the terminal.",
164
+ "description": "The format `table` is concise and shows minimal output, the format `detail` shows all available information. \n\nIf you specify neither `--view` nor `--output-file`, then the default table view is shown. If you specify `--output-file` but not `--view`, only summary information is shown in the terminal.",
146
165
  "name": "view",
147
166
  "summary": "Format to display the rules in the terminal.",
148
167
  "hasDynamicHelp": false,
@@ -160,7 +179,6 @@
160
179
  "pluginAlias": "@salesforce/plugin-code-analyzer",
161
180
  "pluginName": "@salesforce/plugin-code-analyzer",
162
181
  "pluginType": "jit",
163
- "state": "Beta",
164
182
  "strict": true,
165
183
  "summary": "List the rules that are available to analyze your code.",
166
184
  "enableJsonFlag": false,
@@ -181,15 +199,15 @@
181
199
  "code-analyzer:run": {
182
200
  "aliases": [],
183
201
  "args": {},
184
- "description": "You can scan your codebase with the recommended rules. Or use flags to filter the rules based on engines (such as \"retire-js\" or \"eslint\"), rule names, tags, and more. \n\nIf you want to preview the list of rules before you actually run them, use the `code-analyzer rules` command, which also has the \"--rules-selector\", \"--workspace\", and \"--config-file\" flags that together define the list of rules to be run.\n\nWe're continually improving Salesforce Code Analyzer. Tell us what you think! Give feedback at http://sfdc.co/CodeAnalyzerFeedback.",
202
+ "description": "You can scan your codebase with the recommended rules. Or use flags to filter the rules based on engines (such as \"retire-js\" or \"eslint\"), rule names, tags, and more. \n\nIf you want to preview the list of rules before you actually run them, use the `code-analyzer rules` command, which also has the `--config-file`, `--rule-selector`, `--target`, and `--workspace` flags that together define the list of rules to be run.\n\nWe're continually improving Salesforce Code Analyzer. Tell us what you think! Give feedback at https://sfdc.co/CodeAnalyzerFeedback.",
185
203
  "examples": [
186
- "Analyze code using the default behavior: analyze the files in the current folder (default workspace) using the Recommended rules; display the output in the terminal with the concise table view; and automatically apply rule or engine overrides if a \"code-analyzer.yml\" or \"code-analyzer.yaml\" file exists in the current folder:\n<%= config.bin %> <%= command.id %>",
187
- "The previous example is equivalent to this example:\n<%= config.bin %> <%= command.id %> --rule-selector Recommended --workspace . --view table --config-file ./code-analyzer.yml",
204
+ "Analyze code using the default behavior: analyze all the files in the current folder (default workspace) using the Recommended rules; display the output in the terminal with the concise table view; and automatically apply rule or engine overrides if a `code-analyzer.yml` or `code-analyzer.yaml` file exists in the current folder:\n<%= config.bin %> <%= command.id %>",
205
+ "The previous example is equivalent to this example:\n<%= config.bin %> <%= command.id %> --rule-selector Recommended --workspace . --target . --view table --config-file ./code-analyzer.yml",
188
206
  "Analyze the files using the recommended \"eslint\" rules and show details of the violations:\n<%= config.bin %> <%= command.id %> --rule-selector eslint:Recommended --view detail",
189
207
  "Analyze the files using all the \"eslint\" rules:\n<%= config.bin %> <%= command.id %> --rule-selector eslint",
190
- "The previous example is equivalent to this example:\n<%= config.bin %> <%= command.id %> --rule-selector eslint:all",
208
+ "The previous example is equivalent to this example:\n<%= config.bin %> <%= command.id %> --rule-selector eslint:all",
191
209
  "Analyze the files using all rules for all engines:\n<%= config.bin %> <%= command.id %> --rule-selector all",
192
- "Analyze files using the recommended \"retire-js\" rules analyze in a workspace that consists of all files in the folder \"./other-source\" and only the Apex class files (extension .cls) in the folder \"./force-app\":\n<%= config.bin %> <%= command.id %> --rule-selector retire-js:Recommended --workspace ./other-source --workspace ./force-app/**/*.cls",
210
+ "Analyze files using the recommended \"retire-js\" rules; target all the files in the folder \"./other-source\" and only the Apex class files (extension .cls) in the folder \"./force-app\":\n<%= config.bin %> <%= command.id %> --rule-selector retire-js:Recommended --target ./other-source --target ./force-app/**/*.cls",
193
211
  "Specify a custom configuration file and output the results to the \"results.csv\" file in CSV format; the commands fails if it finds a violation that exceeds the moderate severity level (3):\n<%= config.bin %> <%= command.id %> --config-file ./code-analyzer2.yml --output-file results.csv --severity-threshold 3",
194
212
  "Analyze the files using all the \"eslint\" engine rules that have a moderate severity (3) and the recommended \"retire-js\" engine rules with any severity:\n<%= config.bin %> <%= command.id %> --rule-selector eslint:3 --rule-selector retire-js:Recommended",
195
213
  "Analyze the files using only the \"getter-return\" rule of the \"eslint\" engine and any rule named \"no-inner-declarations\" from any engine:\n<%= config.bin %> <%= command.id %> --rule-selector eslint:getter-return --rule-selector no-inner-declarations"
@@ -197,9 +215,9 @@
197
215
  "flags": {
198
216
  "workspace": {
199
217
  "char": "w",
200
- "description": "Typically, a workspace is a single project folder that contains all your files. But it can also consist of one or more folders, one or more files, and use glob patterns (wildcards). If you specify this flag multiple times, then your workspace is the sum of the files and folders.",
218
+ "description": "Typically, a workspace is a single project folder that contains all your files. But it can also consist of one or more folders, one or more files, and use glob patterns (wildcards). If you specify this flag multiple times, then your workspace is the sum of the files and folders.\n\nSome engines often need your entire code base to perform an analysis, even if you want to target only a subset of the files within your workspace , such as with the `--target` flag. For example, the Salesforce Graph Engine might need to compile your entire project in order to properly build a graph so it can perform a data flow analysis on the paths that start in your targeted files.\n\nIf you don't specify the `--workspace` flag, then the current folder '.' is used as your workspace.",
201
219
  "name": "workspace",
202
- "summary": "Set of files you want to include in the code analysis.",
220
+ "summary": "Set of files that make up your workspace.",
203
221
  "default": [
204
222
  "."
205
223
  ],
@@ -208,12 +226,11 @@
208
226
  "multiple": true,
209
227
  "type": "option"
210
228
  },
211
- "path-start": {
212
- "char": "s",
213
- "description": "If you don't specify this flag, then any path-based analysis rules automatically discover and use all starting points found in your workspace. Use this flag to restrict the starting points to only those you want in your code analysis. \n\nThis flag only applies to path-based analysis rules, which are of type DataFlow and Flow. These types of rules are only available from some engines, like the Salesforce Graph Engine, \"sfge\" for example.\n\nIf you specify a file or a folder as your starting point, then the analysis uses only the methods that have public or global accessibility. \n\nTo specify individual methods as a starting point, use the syntax \"<file>#methodName\" to select a single method or \"<file>#methodName1;methodName2\" to select multiple methods. For example, \"SomeClass.cls#method1\" (single method) or \"SomeClass.cls#method1;method2\" (multiple methods).\n\nYou can use glob patterns (wildcards) only when specifying files and folders; you can't use glob patterns when specifying individual methods.",
214
- "hidden": true,
215
- "name": "path-start",
216
- "summary": "Starting points within your workspace to restrict any path-based analysis rules to.",
229
+ "target": {
230
+ "char": "t",
231
+ "description": "You can specify a target as a file, a folder, or a glob pattern.\n\nIf you specify this flag multiple times, then the full list of targeted files is the sum of the files and folders.\n\nEach targeted file must live within the workspace that you specified with the `–-workspace` flag.\n\nIf you don't specify the `--target` flag, then all the files within your workspace (specified by the `--workspace` flag) are targeted for analysis.",
232
+ "name": "target",
233
+ "summary": "Subset of files within your workspace to be targeted for analysis.",
217
234
  "delimiter": ",",
218
235
  "hasDynamicHelp": false,
219
236
  "multiple": true,
@@ -221,7 +238,7 @@
221
238
  },
222
239
  "rule-selector": {
223
240
  "char": "r",
224
- "description": "Use the --rule-selector flag to select the list of rules to run based on specific criteria. For example, you can select by engine, such as the rules associated with the \"retire-js\" or \"eslint\" engine. Or select by the severity of the rules, such as high or moderate. You can also select rules using tag values or rule names. Every rule has a name, which is unique within the scope of an engine. Most rules have tags, although it's not required. An example of a tag is \"Recommended\".\n\nYou can combine different criteria using colons to further filter the list; the colon works as an intersection. For example, \"--rule-selector eslint:Security\" runs rules associated only with the \"eslint\" engine that have the Security tag. The flag \"--rule-selector eslint:Security:3\" flag runs the \"eslint\" rules that have the Security tag and moderate severity (3). To add multiple rule selectors together (a union), specify the --rule-selector flag multiple times, such as \"--rule-selector eslint:Recommended --rule-selector retire-js:3\".\n\nRun `<%= config.bin %> code-analyzer rules --rule-selector all` to see the possible values for engine name, rule name, tags, and severity levels that you can use with this flag.",
241
+ "description": "Use the `--rule-selector` flag to select the list of rules to run based on specific criteria. For example, you can select by engine, such as the rules associated with the \"retire-js\" or \"eslint\" engine. Or select by the severity of the rules, such as high or moderate. You can also select rules using tag values or rule names. Every rule has a name, which is unique within the scope of an engine. Most rules have tags, although it's not required. An example of a tag is \"Recommended\".\n\nYou can combine different criteria using colons to further filter the list; the colon works as an intersection. For example, `--rule-selector eslint:Security` runs rules associated only with the \"eslint\" engine that have the Security tag. The flag `--rule-selector eslint:Security:3` flag runs the \"eslint\" rules that have the Security tag and moderate severity (3). To add multiple rule selectors together (a union), specify the `--rule-selector` flag multiple times, such as `--rule-selector eslint:Recommended --rule-selector retire-js:3`.\n\nRun `<%= config.bin %> code-analyzer rules --rule-selector all` to see the possible values for engine name, rule name, tags, and severity levels that you can use with this flag.",
225
242
  "name": "rule-selector",
226
243
  "summary": "Selection of rules, based on engine name, severity level, rule name, tag, or a combination of criteria separated by colons.",
227
244
  "default": [
@@ -233,7 +250,7 @@
233
250
  "type": "option"
234
251
  },
235
252
  "severity-threshold": {
236
- "char": "t",
253
+ "char": "s",
237
254
  "description": "You can specify either a number (2) or its equivalent string (\"High\").",
238
255
  "name": "severity-threshold",
239
256
  "summary": "Severity level of a found violation that must be met or exceeded to cause this command to fail with a non-zero exit code.",
@@ -243,7 +260,7 @@
243
260
  },
244
261
  "view": {
245
262
  "char": "v",
246
- "description": "The format `table` is concise and shows minimal output, the format `detail` shows all available information.\n\nIf you specify neither --view nor --output-file, then the default table view is shown. If you specify --output-file but not --view, only summary information is shown.",
263
+ "description": "The format `table` is concise and shows minimal output, the format `detail` shows all available information.\n\nIf you specify neither `--view` nor `--output-file`, then the default table view is shown. If you specify `--output-file` but not `--view`, only summary information is shown.",
247
264
  "name": "view",
248
265
  "summary": "Format to display the command results in the terminal.",
249
266
  "hasDynamicHelp": false,
@@ -256,7 +273,7 @@
256
273
  },
257
274
  "output-file": {
258
275
  "char": "f",
259
- "description": "If you don't specify this flag, the command outputs the results to only the terminal. Use this flag to print the results to a file; the format of the results depends on the extension you provide. For example, \"--output-file results.csv\" creates a comma-separated values file. You can specify one of these extensions:\n\n- .csv\n- .html or .htm\n- .json\n- .sarif or .sarif.json\n- .xml\n\nTo output the results to multiple files, specify this flag multiple times. For example: \"--output-file results.json --output-file report.html\" creates both a JSON results file and an HTML file.\n\nIf you specify a folder, such as \"--output-file ./out/results.json\", the folder must already exist or you get an error. If the file already exists, it's overwritten without prompting.",
276
+ "description": "If you don't specify this flag, the command outputs the results to only the terminal. Use this flag to print the results to a file; the format of the results depends on the extension you provide. For example, `--output-file results.csv` creates a comma-separated values file. You can specify one of these extensions:\n\n- .csv\n- .html or .htm\n- .json\n- .sarif or .sarif.json\n- .xml\n\nTo output the results to multiple files, specify this flag multiple times. For example: `--output-file results.json --output-file report.html` creates both a JSON results file and an HTML file.\n\nIf you specify a file within a folder, such as `--output-file ./out/results.json`, the folder must already exist, or you get an error. If the file already exists, it's overwritten without prompting.",
260
277
  "name": "output-file",
261
278
  "summary": "Name of the file where the analysis results are written. The file format depends on the extension you specify, such as .csv, .html, .xml, and so on.",
262
279
  "delimiter": ",",
@@ -266,7 +283,7 @@
266
283
  },
267
284
  "config-file": {
268
285
  "char": "c",
269
- "description": "Code Analyzer has an internal default configuration for its rule and engine properties. If you want to override these defaults, you can create a Code Analyzer configuration file.\n\nWe recommend that you name your Code Analyzer configuration file \"code-analyzer.yml\" or \"code-analyzer.yaml\" and put it at the root of your workspace. You then don't need to use this flag when you run the `<%= command.id %>` command from the root of your workspace, because it automatically looks for either file in the current folder, and if found, applies its rule overrides and engine settings. If you want to name the file something else, or put it in an alternative folder, then you must specify this flag.\n\nTo help you get started, use the `code-analyzer config` command to create your first Code Analyzer configuration file. With it, you can change the severity of an existing rule, change a rule's tags, and so on. Then use this flag to specify the file so that the command takes your customizations into account.",
286
+ "description": "Code Analyzer has an internal default configuration for its rule and engine properties. If you want to override these defaults, you can create a Code Analyzer configuration file.\n\nWe recommend that you name your Code Analyzer configuration file `code-analyzer.yml` or `code-analyzer.yaml` and put it at the root of your workspace. You then don't need to use this flag when you run the `<%= command.id %>` command from the root of your workspace, because it automatically looks for either file in the current folder, and if found, applies its rule overrides and engine settings. If you want to name the file something else, or put it in an alternative folder, then you must specify this flag.\n\nTo help you get started, use the `code-analyzer config` command to create your first Code Analyzer configuration file. With it, you can change the severity of an existing rule, change a rule's tags, and so on. Then use this flag to specify the file so that the command takes your customizations into account.",
270
287
  "name": "config-file",
271
288
  "summary": "Path to the configuration file used to customize the engines and rules.",
272
289
  "hasDynamicHelp": false,
@@ -280,7 +297,6 @@
280
297
  "pluginAlias": "@salesforce/plugin-code-analyzer",
281
298
  "pluginName": "@salesforce/plugin-code-analyzer",
282
299
  "pluginType": "jit",
283
- "state": "Beta",
284
300
  "strict": true,
285
301
  "summary": "Analyze your code with a selection of rules to ensure good coding practices.",
286
302
  "enableJsonFlag": false,
@@ -5918,5 +5934,5 @@
5918
5934
  ]
5919
5935
  }
5920
5936
  },
5921
- "version": "2.87.5"
5937
+ "version": "2.87.6"
5922
5938
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@salesforce/cli",
3
3
  "description": "The Salesforce CLI",
4
- "version": "2.87.5",
4
+ "version": "2.87.6",
5
5
  "author": "Salesforce",
6
6
  "bin": {
7
7
  "sf": "./bin/run.js",
@@ -75,7 +75,7 @@
75
75
  "@salesforce/plugin-user"
76
76
  ],
77
77
  "jitPlugins": {
78
- "@salesforce/plugin-code-analyzer": "5.0.0-beta.3",
78
+ "@salesforce/plugin-code-analyzer": "5.0.0",
79
79
  "@salesforce/plugin-community": "3.3.21",
80
80
  "@salesforce/plugin-custom-metadata": "3.3.51",
81
81
  "@salesforce/plugin-dev": "2.5.1",
@@ -83,7 +83,7 @@
83
83
  "@salesforce/plugin-flow": "1.0.2",
84
84
  "@salesforce/plugin-signups": "2.6.23",
85
85
  "@salesforce/sfdx-plugin-lwc-test": "1.2.1",
86
- "@salesforce/sfdx-scanner": "4.11.0",
86
+ "@salesforce/sfdx-scanner": "4.12.0",
87
87
  "@salesforce/plugin-agent": "1.20.12"
88
88
  },
89
89
  "devPlugins": [
@@ -161,8 +161,8 @@
161
161
  "@salesforce/plugin-apex": "3.6.15",
162
162
  "@salesforce/plugin-api": "1.3.3",
163
163
  "@salesforce/plugin-auth": "3.6.115",
164
- "@salesforce/plugin-data": "4.0.28",
165
- "@salesforce/plugin-deploy-retrieve": "3.22.4",
164
+ "@salesforce/plugin-data": "4.0.29",
165
+ "@salesforce/plugin-deploy-retrieve": "3.22.5",
166
166
  "@salesforce/plugin-info": "3.4.56",
167
167
  "@salesforce/plugin-limits": "3.3.52",
168
168
  "@salesforce/plugin-marketplace": "1.3.8",