@salesforce/cli 2.0.0-qa.7 → 2.0.1

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.
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "2.0.0-qa.7",
2
+ "version": "2.0.1",
3
3
  "commands": {
4
4
  "cmdt:generate:field": {
5
5
  "id": "cmdt:generate:field",
@@ -561,7 +561,7 @@
561
561
  "community:create": {
562
562
  "id": "community:create",
563
563
  "summary": "Create an Experience Cloud site using a template.",
564
- "description": "See 'Which Experience Cloud Template Should I Use?' (https://help.salesforce.com/s/articleView?id=sf.siteforce_commtemp_intro.htm&type=5) in Salesforce Help for more information about the different template\ntypes available for Experience Cloud.\n\nWhen creating a site with the Build Your Own (LWR) template, you must also specify the AuthenticationType value using the format templateParams.AuthenticationType=value, where value is AUTHENTICATED, UNAUTHENTICATED, or AUTHENTICATED_WITH_PUBLIC_ACCESS. Name and values are case-sensitive. See 'ExperienceBundle' in the Metadata API Developer Guide for more information. (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_experiencebundle.htm)\n\nWhen you execute this command, it creates the site in preview status, which means that it isn't yet live. After you finish building your site, you can make it live.\n\nIf you have an Experience Builder site, publish the site using the \"community publish\" command to make it live.\n\nIf you have a Salesforce Tabs + Visualforce site, activate the site to make it live by updating the status field of the Network type in the Metadata API. Alternatively, in Experience Workspaces, go to Administration | Settings, and click Activate.\n\nFor Experience Builder sites, activating the site just sends out a welcome email to site members.",
564
+ "description": "Run the \"community list template\" command to see the templates available in your org. See 'Which Experience Cloud Template Should I Use?' in Salesforce Help for more information about the different template types available. (https://help.salesforce.com/s/articleView?id=sf.siteforce_commtemp_intro.htm&type=5)\n\nWhen you create a site with the Build Your Own (LWR) template, you must also specify the AuthenticationType value using the format templateParams.AuthenticationType=value, where value is AUTHENTICATED or AUTHENTICATED_WITH_PUBLIC_ACCESS_ENABLED. Name and values are case-sensitive. See 'DigitalExperienceBundle' in the Metadata API Developer Guide for more information. (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_digitalexperiencebundle.htm)\n\nThe site creation process is an async job that generates a jobId. To check the site creation status, query the BackgroundOperation object and enter the jobId as the Id. See ‘BackgroundOperation’ in the Object Reference for the Salesforce Platform for more information. (https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_backgroundoperation.htm)\n\nIf the job doesn’t complete within 10 minutes, it times out. You receive an error message and must restart the site creation process. Completed jobs expire after 24 hours and are removed from the database.\n\nWhen you run this command, it creates the site in preview status, which means that the site isn't yet live. After you finish building your site, you can make it live.\n\nIf you have an Experience Builder site, publish the site using the \"community publish\" command to make it live.\n\nIf you have a Salesforce Tabs + Visualforce site, to activate the site and make it live, update the status field of the Network type in Metadata API. (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_network.htm) Alternatively, in Experience Workspaces, go to Administration | Settings, and click Activate.\n\nFor Experience Builder sites, activating the site sends a welcome email to site members.",
565
565
  "strict": false,
566
566
  "pluginName": "@salesforce/plugin-community",
567
567
  "pluginAlias": "@salesforce/plugin-community",
@@ -663,19 +663,12 @@
663
663
  }
664
664
  },
665
665
  "args": {},
666
- "validationPatterns": [
667
- "name",
668
- "urlPathPrefix",
669
- "templateName",
670
- "description",
671
- "templateParams(\\.\\w+)+"
672
- ],
673
666
  "hasDynamicHelp": true
674
667
  },
675
668
  "community:publish": {
676
669
  "id": "community:publish",
677
670
  "summary": "Publish an Experience Builder site to make it live.",
678
- "description": "Each time you publish it, you update the live site with the most recent updates. When you publish an Experience Builder site for the first time, you make the site's URL live and enable login access for site members.\n\nAdditionally, to send a welcome email to all site members, you must activate the site. (Activation is also required to successfully set up SEO for Experience Builder sites.) To activate a site, update the status field of the Network type in the Metadata API. Alternatively, in Experience Workspaces, go to Administration | Settings, and click Activate.\n\nSubsequently, each time you publish the site, you update the live site with all changes made to the site since it was last published.\n\nAn email notification informs you when your changes are live.",
671
+ "description": "Each time you publish a site, you update the live site with the most recent updates. When you publish an Experience Builder site for the first time, you make the site's URL live and enable login access for site members.\n\nIn addition to publishing, you must activate a site to send a welcome email to all site members. Activation is also required to set up SEO for Experience Builder sites. To activate a site, update the status field of the Network type in Metadata API. (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_network.htm)Alternatively, in Experience Workspaces, go to Administration | Settings, and click Activate.\n\nAn email notification informs you when your changes are live on the published site. The site publish process is an async job that generates a jobId. To check the site publish status manually, query the BackgroundOperation object and enter the jobId as the Id. See ‘BackgroundOperation’ in the Object Reference for the Salesforce Platform for more information. (https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_backgroundoperation.htm)\n\nIf the job doesn’t complete within 15 minutes, it times out. You receive an error message and must restart the site publish process. Completed jobs expire after 24 hours and are removed from the database.",
679
672
  "strict": true,
680
673
  "pluginName": "@salesforce/plugin-community",
681
674
  "pluginAlias": "@salesforce/plugin-community",
@@ -848,14 +841,14 @@
848
841
  "dev:audit:messages": {
849
842
  "id": "dev:audit:messages",
850
843
  "summary": "Audit messages in a plugin's messages directory to locate unused messages and missing messages that have references in source code.",
851
- "description": "Audit messages in a plugin's messages directory to locate unused messages and missing messages that have references in source code.",
852
844
  "strict": true,
853
845
  "pluginName": "@salesforce/plugin-dev",
854
846
  "pluginAlias": "@salesforce/plugin-dev",
855
847
  "pluginType": "jit",
856
848
  "aliases": [],
857
849
  "examples": [
858
- "sf dev audit messages\nsf dev audit messages --json\nsf dev audit messages --messages-dir ./messages --source-dir ./src"
850
+ "Audit messages using default directories:\n<%= config.bin %> <%= command.id %>",
851
+ "Audit messages in the \"messages\" directory in the current working directory; the plugin's source directory is in \"src\":\n<%= config.bin %> <%= command.id %> --messages-dir ./messages --source-dir ./src"
859
852
  ],
860
853
  "flags": {
861
854
  "json": {
@@ -869,8 +862,7 @@
869
862
  "name": "project-dir",
870
863
  "type": "option",
871
864
  "char": "p",
872
- "summary": "Location project where messages are to be audited.",
873
- "description": "The project directory.",
865
+ "summary": "Location of the project where messages are to be audited.",
874
866
  "multiple": false,
875
867
  "default": ".",
876
868
  "aliases": [
@@ -881,8 +873,8 @@
881
873
  "name": "messages-dir",
882
874
  "type": "option",
883
875
  "char": "m",
884
- "summary": "Location of the message bundle directory.",
885
- "description": "The directory that holds the message bundle files. The default is the messages directory in the current working directory.",
876
+ "summary": "Directory that contains the plugin's message files.",
877
+ "description": "The default is the \"messages\" directory in the current working directory.",
886
878
  "multiple": false,
887
879
  "default": "messages",
888
880
  "aliases": [
@@ -893,8 +885,8 @@
893
885
  "name": "source-dir",
894
886
  "type": "option",
895
887
  "char": "s",
896
- "summary": "Location of the plugin's source code.",
897
- "description": "The directory that holds the plugin's source code. The default is the src directory in the current working directory.",
888
+ "summary": "Directory that contains the plugin's source code.",
889
+ "description": "The default is the \"src\" directory in the current working directory.",
898
890
  "multiple": false,
899
891
  "default": "src",
900
892
  "aliases": [
@@ -906,15 +898,15 @@
906
898
  },
907
899
  "dev:configure:repo": {
908
900
  "id": "dev:configure:repo",
909
- "summary": "Configure github repo for Actions pipeline.",
910
- "description": "Sets up labels and exempts the CLI bot for branch protection and PR rules",
901
+ "summary": "Configure a GitHub repo for the GitHub Actions pipeline.",
902
+ "description": "Sets up labels and exempts the CLI bot for branch protection and PR rules.",
911
903
  "strict": true,
912
904
  "pluginName": "@salesforce/plugin-dev",
913
905
  "pluginAlias": "@salesforce/plugin-dev",
914
906
  "pluginType": "jit",
915
907
  "aliases": [],
916
908
  "examples": [
917
- "<%= config.bin %> <%= command.id %> -r salesforcecli/testPackageRelease"
909
+ "Configure the repo \"testPackageRelease\", with owner \"salesforcecli\", for GitHub Actions.\n<%= config.bin %> <%= command.id %> --repository salesforcecli/testPackageRelease"
918
910
  ],
919
911
  "flags": {
920
912
  "json": {
@@ -928,7 +920,7 @@
928
920
  "name": "repository",
929
921
  "type": "option",
930
922
  "char": "r",
931
- "summary": "The github owner/repo",
923
+ "summary": "GitHub owner/repo for which you want to configure GitHub Actions.",
932
924
  "required": true,
933
925
  "multiple": false
934
926
  },
@@ -936,7 +928,7 @@
936
928
  "name": "dry-run",
937
929
  "type": "boolean",
938
930
  "char": "d",
939
- "summary": "Make no changes",
931
+ "summary": "Make no changes.",
940
932
  "allowNo": false,
941
933
  "aliases": [
942
934
  "dryrun"
@@ -946,7 +938,7 @@
946
938
  "name": "bot",
947
939
  "type": "option",
948
940
  "char": "b",
949
- "summary": "The github login/username for the bot.",
941
+ "summary": "GitHub login/username for the bot.",
950
942
  "multiple": false,
951
943
  "default": "SF-CLI-BOT"
952
944
  }
@@ -955,15 +947,16 @@
955
947
  },
956
948
  "dev:configure:secrets": {
957
949
  "id": "dev:configure:secrets",
958
- "summary": "Ensures a repo has correct access to secrets based on its workflows",
959
- "description": "Inspects a repo's yaml files and verifies that secrets required are available for the repo (either set at the repo level or shared via organization-level secrets).\n\nThis command requires scope:admin permissions to inspect the org secrets and admin access to the repo to inspect the repo secrets",
950
+ "summary": "Ensures a GitHub repo has correct access to secrets based on its workflows.",
951
+ "description": "Inspects a repo's yaml files and verifies that secrets required are available for the repo (either set at the repo level or shared via organization-level secrets).\n\nThis command requires scope:admin permissions to inspect the org secrets and admin access to the repo to inspect the repo secrets.",
960
952
  "strict": true,
961
953
  "pluginName": "@salesforce/plugin-dev",
962
954
  "pluginAlias": "@salesforce/plugin-dev",
963
955
  "pluginType": "jit",
964
956
  "aliases": [],
965
957
  "examples": [
966
- "<%= config.bin %> <%= command.id %> -r salesforcecli/testPackageRelease"
958
+ "Ensure secrets access for the repo \"testPackageRelease\", with owner \"salesforcecli\":",
959
+ "<%= config.bin %> <%= command.id %> --repository salesforcecli/testPackageRelease"
967
960
  ],
968
961
  "flags": {
969
962
  "json": {
@@ -977,7 +970,7 @@
977
970
  "name": "repository",
978
971
  "type": "option",
979
972
  "char": "r",
980
- "summary": "The github owner/repo",
973
+ "summary": "Github owner/repo.",
981
974
  "required": true,
982
975
  "multiple": false
983
976
  },
@@ -985,7 +978,7 @@
985
978
  "name": "dry-run",
986
979
  "type": "boolean",
987
980
  "char": "d",
988
- "summary": "Make no changes",
981
+ "summary": "Make no changes.",
989
982
  "allowNo": false,
990
983
  "aliases": [
991
984
  "dryrun"
@@ -996,15 +989,16 @@
996
989
  },
997
990
  "dev:convert:messages": {
998
991
  "id": "dev:convert:messages",
999
- "summary": "Convert a .json messages file",
992
+ "summary": "Convert a .json messages file into Markdown.",
1000
993
  "strict": true,
1001
994
  "pluginName": "@salesforce/plugin-dev",
1002
995
  "pluginAlias": "@salesforce/plugin-dev",
1003
996
  "pluginType": "jit",
1004
997
  "aliases": [],
1005
998
  "examples": [
1006
- "<%= config.bin %> <%= command.id %> --filename something.json",
1007
- "<%= config.bin %> <%= command.id %> --project-dir ./path/to/plugin --filename something.json"
999
+ "Convert the my-command.json message file into my-command.md with the standard messages headers:\n<%= config.bin %> <%= command.id %> --filename my-command.json",
1000
+ "Similar to previous example, but specify the plugin project directory:",
1001
+ "<%= config.bin %> <%= command.id %> --project-dir ./path/to/plugin --filename my-command.json"
1008
1002
  ],
1009
1003
  "flags": {
1010
1004
  "json": {
@@ -1018,8 +1012,7 @@
1018
1012
  "name": "project-dir",
1019
1013
  "type": "option",
1020
1014
  "char": "p",
1021
- "summary": "Location of the project whose messages are to be audited.",
1022
- "description": "Location of the project whose messages are to be audited.",
1015
+ "summary": "Location of the project whose messages are to be converted.",
1023
1016
  "multiple": false,
1024
1017
  "default": ".",
1025
1018
  "aliases": [
@@ -1030,7 +1023,7 @@
1030
1023
  "name": "file-name",
1031
1024
  "type": "option",
1032
1025
  "char": "f",
1033
- "summary": "Filename to convert",
1026
+ "summary": "Filename to convert.",
1034
1027
  "required": true,
1035
1028
  "multiple": true,
1036
1029
  "aliases": [
@@ -1040,6 +1033,44 @@
1040
1033
  },
1041
1034
  "args": {}
1042
1035
  },
1036
+ "dev:convert:script": {
1037
+ "id": "dev:convert:script",
1038
+ "summary": "Convert a script file that contains deprecated sfdx-style commands to use the new sf-style commands instead.",
1039
+ "description": "Important: Use this command only to get started on the sfdx->sf script migration. We don't guarantee that the new sf-style command replacements work correctly or as you expect. You must test, and probably update, the new script before putting it into production. We also don't guarantee that the JSON results are the same as before. \n\nThis command can convert a large part of your script, but possibly not all. There are some sfdx-style commands that don't have an obvious sf-style equivalent. In this case, this command doesn't replace the sfdx-style command but instead adds a comment to remind you that you must convert it manually. See the Salesforce CLI Command Reference for migration information about each deprecated sfdx-style command: https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference.htm.\n\nThis command is interactive; as it scans your script, it prompts you when it finds an sfdx-style command or flag and asks if you want to convert it to the displayed suggestion. The command doesn't update the script file directly; rather, it creates a new file whose name is the original name but with \"-converted\" appended to it. The script replaces all instances of \"sfdx\" with \"sf\". For each prompt you answer \"y\" to, the command replaces the sfdx-style names with their equivalent sf-style ones. For example, \"sfdx force:apex:execute --targetusername myscratch\" is replaced with \"sf apex run --target-org myscratch\".",
1040
+ "strict": true,
1041
+ "pluginName": "@salesforce/plugin-dev",
1042
+ "pluginAlias": "@salesforce/plugin-dev",
1043
+ "pluginType": "jit",
1044
+ "aliases": [],
1045
+ "examples": [
1046
+ "Convert the YAML file called \"myScript.yml\" located in the current directory; the new file that contains the replacements is called \"myScript-converted.yml\":\n<%= config.bin %> <%= command.id %> --script ./myScript.yml"
1047
+ ],
1048
+ "flags": {
1049
+ "json": {
1050
+ "name": "json",
1051
+ "type": "boolean",
1052
+ "description": "Format output as json.",
1053
+ "helpGroup": "GLOBAL",
1054
+ "allowNo": false
1055
+ },
1056
+ "script": {
1057
+ "name": "script",
1058
+ "type": "option",
1059
+ "char": "s",
1060
+ "summary": "Filepath to the script you want to convert.",
1061
+ "required": true,
1062
+ "multiple": false
1063
+ },
1064
+ "no-prompt": {
1065
+ "name": "no-prompt",
1066
+ "type": "boolean",
1067
+ "summary": "Don't prompt for suggested replacements.",
1068
+ "hidden": true,
1069
+ "allowNo": false
1070
+ }
1071
+ },
1072
+ "args": {}
1073
+ },
1043
1074
  "dev:generate:command": {
1044
1075
  "id": "dev:generate:command",
1045
1076
  "summary": "Generate a new sf command.",
@@ -2390,7 +2421,6 @@
2390
2421
  "pluginType": "jit",
2391
2422
  "hidden": true,
2392
2423
  "aliases": [
2393
- "force:package:beta:convert",
2394
2424
  "force:package:convert"
2395
2425
  ],
2396
2426
  "examples": [
@@ -2531,7 +2561,6 @@
2531
2561
  "pluginAlias": "@salesforce/plugin-packaging",
2532
2562
  "pluginType": "jit",
2533
2563
  "aliases": [
2534
- "force:package:beta:create",
2535
2564
  "force:package:create"
2536
2565
  ],
2537
2566
  "examples": [
@@ -2673,7 +2702,6 @@
2673
2702
  "pluginAlias": "@salesforce/plugin-packaging",
2674
2703
  "pluginType": "jit",
2675
2704
  "aliases": [
2676
- "force:package:beta:delete",
2677
2705
  "force:package:delete"
2678
2706
  ],
2679
2707
  "examples": [
@@ -2765,7 +2793,6 @@
2765
2793
  "pluginAlias": "@salesforce/plugin-packaging",
2766
2794
  "pluginType": "jit",
2767
2795
  "aliases": [
2768
- "force:package:beta:install",
2769
2796
  "force:package:install"
2770
2797
  ],
2771
2798
  "examples": [
@@ -2953,7 +2980,6 @@
2953
2980
  "pluginAlias": "@salesforce/plugin-packaging",
2954
2981
  "pluginType": "jit",
2955
2982
  "aliases": [
2956
- "force:package:beta:list",
2957
2983
  "force:package:list"
2958
2984
  ],
2959
2985
  "examples": [
@@ -3024,7 +3050,6 @@
3024
3050
  "pluginAlias": "@salesforce/plugin-packaging",
3025
3051
  "pluginType": "jit",
3026
3052
  "aliases": [
3027
- "force:package:beta:uninstall",
3028
3053
  "force:package:uninstall"
3029
3054
  ],
3030
3055
  "examples": [
@@ -3109,7 +3134,6 @@
3109
3134
  "pluginAlias": "@salesforce/plugin-packaging",
3110
3135
  "pluginType": "jit",
3111
3136
  "aliases": [
3112
- "force:package:beta:update",
3113
3137
  "force:package:update"
3114
3138
  ],
3115
3139
  "examples": [
@@ -3195,6 +3219,14 @@
3195
3219
  "aliases": [
3196
3220
  "errornotificationusername"
3197
3221
  ]
3222
+ },
3223
+ "enable-app-analytics": {
3224
+ "name": "enable-app-analytics",
3225
+ "type": "boolean",
3226
+ "summary": "Enable AppExchange App Analytics usage data collection on this managed package and its components.",
3227
+ "hidden": true,
3228
+ "allowNo": true,
3229
+ "deprecateAliases": true
3198
3230
  }
3199
3231
  },
3200
3232
  "args": {},
@@ -3209,7 +3241,6 @@
3209
3241
  "pluginAlias": "@salesforce/plugin-packaging",
3210
3242
  "pluginType": "jit",
3211
3243
  "aliases": [
3212
- "force:package:beta:install:report",
3213
3244
  "force:package:install:report"
3214
3245
  ],
3215
3246
  "examples": [
@@ -3283,7 +3314,6 @@
3283
3314
  "pluginAlias": "@salesforce/plugin-packaging",
3284
3315
  "pluginType": "jit",
3285
3316
  "aliases": [
3286
- "force:package:beta:installed:list",
3287
3317
  "force:package:installed:list"
3288
3318
  ],
3289
3319
  "examples": [
@@ -3346,7 +3376,6 @@
3346
3376
  "pluginAlias": "@salesforce/plugin-packaging",
3347
3377
  "pluginType": "jit",
3348
3378
  "aliases": [
3349
- "force:package:beta:uninstall:report",
3350
3379
  "force:package:uninstall:report"
3351
3380
  ],
3352
3381
  "examples": [
@@ -3421,7 +3450,6 @@
3421
3450
  "pluginAlias": "@salesforce/plugin-packaging",
3422
3451
  "pluginType": "jit",
3423
3452
  "aliases": [
3424
- "force:package:beta:version:create",
3425
3453
  "force:package:version:create"
3426
3454
  ],
3427
3455
  "examples": [
@@ -3730,7 +3758,6 @@
3730
3758
  "pluginAlias": "@salesforce/plugin-packaging",
3731
3759
  "pluginType": "jit",
3732
3760
  "aliases": [
3733
- "force:package:beta:version:delete",
3734
3761
  "force:package:version:delete"
3735
3762
  ],
3736
3763
  "examples": [
@@ -3821,7 +3848,6 @@
3821
3848
  "pluginAlias": "@salesforce/plugin-packaging",
3822
3849
  "pluginType": "jit",
3823
3850
  "aliases": [
3824
- "force:package:beta:version:displayancestry",
3825
3851
  "force:package:version:displayancestry"
3826
3852
  ],
3827
3853
  "examples": [
@@ -3915,7 +3941,6 @@
3915
3941
  "pluginAlias": "@salesforce/plugin-packaging",
3916
3942
  "pluginType": "jit",
3917
3943
  "aliases": [
3918
- "force:package:beta:version:list",
3919
3944
  "force:package:version:list"
3920
3945
  ],
3921
3946
  "examples": [
@@ -4045,7 +4070,6 @@
4045
4070
  "pluginAlias": "@salesforce/plugin-packaging",
4046
4071
  "pluginType": "jit",
4047
4072
  "aliases": [
4048
- "force:package:beta:version:promote",
4049
4073
  "force:package:version:promote"
4050
4074
  ],
4051
4075
  "examples": [
@@ -4130,7 +4154,6 @@
4130
4154
  "pluginAlias": "@salesforce/plugin-packaging",
4131
4155
  "pluginType": "jit",
4132
4156
  "aliases": [
4133
- "force:package:beta:version:report",
4134
4157
  "force:package:version:report"
4135
4158
  ],
4136
4159
  "examples": [
@@ -4201,6 +4224,78 @@
4201
4224
  "requiresProject": true,
4202
4225
  "hasDynamicHelp": true
4203
4226
  },
4227
+ "package:version:retrieve": {
4228
+ "id": "package:version:retrieve",
4229
+ "summary": "Retrieve package metadata for a specified package version.",
4230
+ "description": "Retrieving a package version downloads the metadata into the directory you specify.\n\nYou can retrieve metadata for a second- or first-generation managed package, or an unlocked package.\n\nSpecify the subscriber package version ID (starts with 04t) and the path to an empty directory when you run this command.",
4231
+ "strict": true,
4232
+ "pluginName": "@salesforce/plugin-packaging",
4233
+ "pluginAlias": "@salesforce/plugin-packaging",
4234
+ "pluginType": "jit",
4235
+ "hidden": true,
4236
+ "aliases": [],
4237
+ "examples": [
4238
+ "Retrieve package metadata for a subscriber package version ID (starts with 04t) into my-folder/ within your Salesforce DX project directory:\n<%= config.bin %> <%= command.id %> --package 04t... --output-dir my-folder –-target-org my-scratch\nIf you omit --target-org, this command runs against your default org."
4239
+ ],
4240
+ "flags": {
4241
+ "json": {
4242
+ "name": "json",
4243
+ "type": "boolean",
4244
+ "description": "Format output as json.",
4245
+ "helpGroup": "GLOBAL",
4246
+ "allowNo": false
4247
+ },
4248
+ "loglevel": {
4249
+ "name": "loglevel",
4250
+ "type": "option",
4251
+ "hidden": true,
4252
+ "multiple": false,
4253
+ "deprecated": {
4254
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
4255
+ }
4256
+ },
4257
+ "api-version": {
4258
+ "name": "api-version",
4259
+ "type": "option",
4260
+ "description": "Override the api version used for api requests made by this command",
4261
+ "multiple": false,
4262
+ "aliases": [
4263
+ "apiversion"
4264
+ ]
4265
+ },
4266
+ "target-org": {
4267
+ "name": "target-org",
4268
+ "type": "option",
4269
+ "char": "o",
4270
+ "summary": "Username or alias of the target org.",
4271
+ "required": true,
4272
+ "multiple": false,
4273
+ "aliases": [
4274
+ "targetusername",
4275
+ "u"
4276
+ ]
4277
+ },
4278
+ "package": {
4279
+ "name": "package",
4280
+ "type": "option",
4281
+ "char": "p",
4282
+ "summary": "Subscriber package version ID (starts with 04t).",
4283
+ "required": true,
4284
+ "multiple": false
4285
+ },
4286
+ "output-dir": {
4287
+ "name": "output-dir",
4288
+ "type": "option",
4289
+ "char": "d",
4290
+ "summary": "Path within your Salesforce DX project directory in which to download the metadata. This directory must be empty.",
4291
+ "multiple": false,
4292
+ "default": "force-app"
4293
+ }
4294
+ },
4295
+ "args": {},
4296
+ "requiresProject": true,
4297
+ "hasDynamicHelp": true
4298
+ },
4204
4299
  "package:version:update": {
4205
4300
  "id": "package:version:update",
4206
4301
  "summary": "Update a package version.",
@@ -4210,7 +4305,6 @@
4210
4305
  "pluginAlias": "@salesforce/plugin-packaging",
4211
4306
  "pluginType": "jit",
4212
4307
  "aliases": [
4213
- "force:package:beta:version:update",
4214
4308
  "force:package:version:update"
4215
4309
  ],
4216
4310
  "examples": [
@@ -4333,7 +4427,6 @@
4333
4427
  "pluginAlias": "@salesforce/plugin-packaging",
4334
4428
  "pluginType": "jit",
4335
4429
  "aliases": [
4336
- "force:package1:beta:version:create",
4337
4430
  "force:package1:version:create"
4338
4431
  ],
4339
4432
  "examples": [
@@ -4488,7 +4581,6 @@
4488
4581
  "pluginAlias": "@salesforce/plugin-packaging",
4489
4582
  "pluginType": "jit",
4490
4583
  "aliases": [
4491
- "force:package1:beta:version:display",
4492
4584
  "force:package1:version:display"
4493
4585
  ],
4494
4586
  "examples": [
@@ -4562,7 +4654,6 @@
4562
4654
  "pluginAlias": "@salesforce/plugin-packaging",
4563
4655
  "pluginType": "jit",
4564
4656
  "aliases": [
4565
- "force:package1:beta:version:list",
4566
4657
  "force:package1:version:list"
4567
4658
  ],
4568
4659
  "examples": [
@@ -4637,7 +4728,6 @@
4637
4728
  "pluginAlias": "@salesforce/plugin-packaging",
4638
4729
  "pluginType": "jit",
4639
4730
  "aliases": [
4640
- "force:package:beta:version:create:list",
4641
4731
  "force:package:version:create:list"
4642
4732
  ],
4643
4733
  "examples": [
@@ -4728,7 +4818,6 @@
4728
4818
  "pluginAlias": "@salesforce/plugin-packaging",
4729
4819
  "pluginType": "jit",
4730
4820
  "aliases": [
4731
- "force:package:beta:version:create:report",
4732
4821
  "force:package:version:create:report"
4733
4822
  ],
4734
4823
  "examples": [
@@ -4802,7 +4891,6 @@
4802
4891
  "pluginAlias": "@salesforce/plugin-packaging",
4803
4892
  "pluginType": "jit",
4804
4893
  "aliases": [
4805
- "force:package1:beta:version:create:get",
4806
4894
  "force:package1:version:create:get"
4807
4895
  ],
4808
4896
  "examples": [
@@ -6272,13 +6360,13 @@
6272
6360
  "id": "scanner:run:dfa",
6273
6361
  "description": "scan codebase with all DFA rules",
6274
6362
  "strict": true,
6275
- "usage": "<%= command.id %> -t <array> [-c <array>] [-f csv|html|json|junit|sarif|table|xml] [-o <string>] [-s <integer> | --json] [--normalize-severity] [-p <array>] [--rule-thread-count <integer>] [--rule-thread-timeout <integer>] [--rule-disable-warning-violation] [--sfgejvmargs <string>] [--pathexplimit <integer>] [--verbose] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]",
6363
+ "usage": "<%= command.id %> -t <array> [-c <array>] [-f csv|html|json|junit|sarif|table|xml] [-o <string>] [-s <integer> | --json] [--normalize-severity] [-p <array>] [--with-pilot] [--rule-thread-count <integer>] [--rule-thread-timeout <integer>] [--rule-disable-warning-violation] [--sfgejvmargs <string>] [--pathexplimit <integer>] [--verbose] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]",
6276
6364
  "pluginName": "@salesforce/sfdx-scanner",
6277
6365
  "pluginAlias": "@salesforce/sfdx-scanner",
6278
6366
  "pluginType": "jit",
6279
6367
  "aliases": [],
6280
6368
  "examples": [
6281
- "The paths specified for --projectdir must contain all files specified through --target cumulatively.\n\t$ sfdx scanner:run:dfa --target \"./myproject/main/default/classes/*.cls\" --projectdir \"./myproject/\"\n\t$ sfdx scanner:run:dfa --target \"./**/*.cls\" --projectdir \"./\"\n\t$ sfdx scanner:run:dfa --target \"./dir1/file1.cls,./dir2/file2.cls\" --projectdir \"./dir1/,./dir2/\"\nThis example fails because the set of files included in --target is larger than that contained in --projectdir:\n\t$ sfdx scanner:run:dfa --target \"./**/*.cls\" --projectdir \"./myproject/\"\nGlobs must be wrapped in quotes, as in these Windows and Unix examples, which evaluate rules against all .cls files in the current directory and subdirectories except for IgnoreMe.cls:\nUnix example:\n\t$ sfdx scanner:run:dfa --target \"./**/*.cls,!./**/IgnoreMe.cls\" ...\nWindows example:\n\t$ sfdx scanner:run:dfa --target \".\\**\\*.cls,!.\\**\\IgnoreMe.cls\" ...\nYou can target individual methods within a file with a suffix hash (#) on the file's path, and with a semi-colon-delimited list of method names. This syntax is incompatible with globs and directories. This example evaluates rules against all methods named Method1 or Method2 in File1.cls, and all methods named Method3 in File2.cls:\n\t$ sfdx scanner:run:dfa --target \"./File1.cls#Method1;Method2,./File2.cls#Method3\" ...\nUse --normalize-severity to output a normalized severity across all engines, in addition to the engine-specific severity. Normalized severity is 1 (high), 2 (moderate), and 3 (low):\n\t$ sfdx scanner:run:dfa --target \"./some-project/\" --projectdir \"./some-project/\" --format csv --normalize-severity\nUse --severity-threshold to throw a non-zero exit code when rule violations of a specific normalized severity or greater are found. If there are any rule violations with a severity of 2 or 1, the exit code is equal to the severity of the most severe violation:\n\t$ sfdx scanner:run:dfa --target \"./some-project/\" --projectdir \"./some-project/\" --severity-threshold 2\nuse --rule-thread-count to allow more (or fewer) entrypoints to be evaluated concurrently:\n\t$ sfdx scanner:run:dfa --rule-thread-count 6 ...\nUse --rule-thread-timeout to increase or decrease the maximum runtime for a single entrypoint evaluation. This increases the timeout from the 15-minute default to 150 minutes:\n\t$ sfdx scanner:run:dfa --rule-thread-timeout 9000000 ...\nUse --sfgejvmargs to pass Java Virtual Machine args to override system defaults while executing Salesforce Graph Engine's rules.\nThe example overrides the system's default heap space allocation to 8 GB and decreases chances of encountering OutOfMemory error.\n\t$ sfdx scanner:run:dfa --sfgejvmargs \"-Xmx8g\" ...\n"
6369
+ "The paths specified for --projectdir must contain all files specified through --target cumulatively.\n\t$ sfdx scanner:run:dfa --target \"./myproject/main/default/classes/*.cls\" --projectdir \"./myproject/\"\n\t$ sfdx scanner:run:dfa --target \"./**/*.cls\" --projectdir \"./\"\n\t$ sfdx scanner:run:dfa --target \"./dir1/file1.cls,./dir2/file2.cls\" --projectdir \"./dir1/,./dir2/\"\nThis example fails because the set of files included in --target is larger than that contained in --projectdir:\n\t$ sfdx scanner:run:dfa --target \"./**/*.cls\" --projectdir \"./myproject/\"\nGlobs must be wrapped in quotes, as in these Windows and Unix examples, which evaluate rules against all .cls files in the current directory and subdirectories except for IgnoreMe.cls:\nUnix example:\n\t$ sfdx scanner:run:dfa --target \"./**/*.cls,!./**/IgnoreMe.cls\" ...\nWindows example:\n\t$ sfdx scanner:run:dfa --target \".\\**\\*.cls,!.\\**\\IgnoreMe.cls\" ...\nYou can target individual methods within a file with a suffix hash (#) on the file's path, and with a semi-colon-delimited list of method names. This syntax is incompatible with globs and directories. This example evaluates rules against all methods named Method1 or Method2 in File1.cls, and all methods named Method3 in File2.cls:\n\t$ sfdx scanner:run:dfa --target \"./File1.cls#Method1;Method2,./File2.cls#Method3\" ...\nUse --normalize-severity to output a normalized severity across all engines, in addition to the engine-specific severity. Normalized severity is 1 (high), 2 (moderate), and 3 (low):\n\t$ sfdx scanner:run:dfa --target \"./some-project/\" --projectdir \"./some-project/\" --format csv --normalize-severity\nUse --severity-threshold to throw a non-zero exit code when rule violations of a specific normalized severity or greater are found. If there are any rule violations with a severity of 2 or 1, the exit code is equal to the severity of the most severe violation:\n\t$ sfdx scanner:run:dfa --target \"./some-project/\" --projectdir \"./some-project/\" --severity-threshold 2\nuse --rule-thread-count to allow more (or fewer) entrypoints to be evaluated concurrently:\n\t$ sfdx scanner:run:dfa --rule-thread-count 6 ...\nUse --rule-thread-timeout to increase or decrease the maximum runtime for a single entrypoint evaluation. This increases the timeout from the 15-minute default to 150 minutes:\n\t$ sfdx scanner:run:dfa --rule-thread-timeout 9000000 ...\nUse --sfgejvmargs to pass Java Virtual Machine args to override system defaults while executing Salesforce Graph Engine's rules.\nThe example overrides the system's default heap space allocation to 8 GB and decreases chances of encountering OutOfMemory error.\n\t$ sfdx scanner:run:dfa --sfgejvmargs \"-Xmx8g\" ...\nUse --with-pilot to allow execution of pilot rules:\nThis example allows pilot rules in the \"Performance\" category to execute.\n\t$ sfdx scanner:run:dfa --category 'Performance' --with-pilot ...\n"
6282
6370
  ],
6283
6371
  "flags": {
6284
6372
  "json": {
@@ -6370,6 +6458,12 @@
6370
6458
  "description": "provide root directory of project",
6371
6459
  "multiple": false
6372
6460
  },
6461
+ "with-pilot": {
6462
+ "name": "with-pilot",
6463
+ "type": "boolean",
6464
+ "description": "allow pilot rules to execute",
6465
+ "allowNo": false
6466
+ },
6373
6467
  "target": {
6374
6468
  "name": "target",
6375
6469
  "type": "option",
@@ -6490,6 +6584,13 @@
6490
6584
  "multiple": false,
6491
6585
  "type": "option"
6492
6586
  },
6587
+ "with-pilot": {
6588
+ "kind": "boolean",
6589
+ "description": "allow pilot rules to execute",
6590
+ "longDescription": "Allows pilot rules to execute.",
6591
+ "allowNo": false,
6592
+ "type": "boolean"
6593
+ },
6493
6594
  "target": {
6494
6595
  "kind": "array",
6495
6596
  "char": "t",