@salesforce/cli 2.48.3 → 2.48.5
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 +17 -17
- package/npm-shrinkwrap.json +1285 -1112
- package/oclif.lock +837 -604
- package/oclif.manifest.json +80 -122
- package/package.json +9 -9
package/oclif.manifest.json
CHANGED
|
@@ -4685,9 +4685,9 @@
|
|
|
4685
4685
|
"scanner:run": {
|
|
4686
4686
|
"aliases": [],
|
|
4687
4687
|
"args": {},
|
|
4688
|
-
"description": "
|
|
4688
|
+
"description": "Specify the format of the output, such as XML or JUnit. Print the output to the console (default) or to a file using the --outfile parameter.",
|
|
4689
4689
|
"examples": [
|
|
4690
|
-
"This example evaluates all rules against somefile.js
|
|
4690
|
+
"This example evaluates all rules against somefile.js. Invoking code analyzer without specifying any rules causes all rules to be run.\n<%= config.bin %> <%= command.id %> --format xml --target \"somefile.js\"\nThis example evaluates all rules in the Design and Best Practices categories. When you specify multiple categories or rulesets, the results are combined with a logical OR.\n<%= config.bin %> <%= command.id %> --format xml --target \"somefile.js\" --\nThese examples evaluate rules against all .js files in the current directory, except for IgnoreMe.js. Unix example:\n<%= config.bin %> <%= command.id %> --target './**/*.js,!./**/IgnoreMe.js' ...\nWindows example:\n<%= config.bin %> <%= command.id %> --target \".\\**\\*.js,!.\\**\\IgnoreMe.js\" ...\nThis example scans the project contained in '/my-project' if the current working directory is another directory. Specify tsconfig.json if the current working directory does not contain the tsconfig.json that corresponds to the TypeScript files being scanned.\n<%= config.bin %> <%= command.id %> --target \"/my-project/**/*.ts\" --tsconfig \"/my-project/tsconfig.json\"\nThis example evaluates rules against somefile.js, including Jasmine in the environment variables. Uses --env to override the default ESLint environment variables to add frameworks.\n<%= config.bin %> <%= command.id %> --target \"somefile.js\" --env '{\"jasmine\": true}'\nThis example evaluates rules aginst somefile.js using eslint-lwc and pmd engines. Use --engine to include or exclude engines. Any engine listed will be run, regardless of its current 'disabled' attribute.\n<%= config.bin %> <%= command.id %> --target \"somefile.js\" --engine \"eslint-lwc,pmd\"\nThis example executes CPD engine against known file extensions in \"/some/dir\". CPD helps detect blocks of code duplication in selected languages. Use --engine to invoke engines that are not enabled by default.\n<%= config.bin %> <%= command.id %> --target \"/some/dir\" --engine cpd\nThis example executes rules defined in pmd_rule_ref.xml against the files in 'src'. To use PMD with your own rule reference file, use --pmdconfig. Note that rule filters are not applied.\n<%= config.bin %> <%= command.id %> --target \"src\" --pmdconfig \"pmd_rule_ref.xml\"\nThis example uses a custom config to scan the files in 'src'. To use ESLint with your own .eslintrc.json file, use --eslintconfig. Make sure that the directory you run the command from has all the NPM dependencies installed.\n<%= config.bin %> <%= command.id %> --target \"src\" --eslintconfig \"/home/my/setup/.eslintrc.json\"\nThis example uses --normalize-severity to output normalized severity and engine-specific severity across all engines. Normalized severity is: 1 (high), 2 (moderate), and 3 (low).\n<%= config.bin %> <%= command.id %> --target \"/some-project/\" --format csv --normalize-severity\nThis example uses --severity-threshold to throw a non-zero exit code when rule violations of normalized severity 2 or greater are found. If any violations with the specified severity (or greater) are found, the exit code equals the severity of the most severe violation.\n<%= config.bin %> <%= command.id %> --target \"/some-project/\" --severity-threshold 2\nThese examples explain that the paths specified for --projectdir must contain all files specified through --target cumulatively.\n<%= config.bin %> <%= command.id %> --target \"./myproject/main/default/classes/*.cls\" --projectdir \"./myproject/\"\n<%= config.bin %> <%= command.id %> --target \"./**/*.cls\" --projectdir \"./\"\n<%= config.bin %> <%= command.id %> --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<%= config.bin %> <%= command.id %> --target \"./**/*.cls\" --projectdir \"./myproject/\""
|
|
4691
4691
|
],
|
|
4692
4692
|
"flags": {
|
|
4693
4693
|
"json": {
|
|
@@ -4698,17 +4698,16 @@
|
|
|
4698
4698
|
"type": "boolean"
|
|
4699
4699
|
},
|
|
4700
4700
|
"verbose": {
|
|
4701
|
-
"description": "Emit additional command output to stdout.",
|
|
4702
4701
|
"name": "verbose",
|
|
4703
|
-
"summary": "
|
|
4702
|
+
"summary": "Emit additional command output to stdout.",
|
|
4704
4703
|
"allowNo": false,
|
|
4705
4704
|
"type": "boolean"
|
|
4706
4705
|
},
|
|
4707
4706
|
"category": {
|
|
4708
4707
|
"char": "c",
|
|
4709
|
-
"description": "
|
|
4708
|
+
"description": "Specify multiple values as a comma-separated list.",
|
|
4710
4709
|
"name": "category",
|
|
4711
|
-
"summary": "
|
|
4710
|
+
"summary": "One or more categories of rules to run.",
|
|
4712
4711
|
"delimiter": ",",
|
|
4713
4712
|
"hasDynamicHelp": false,
|
|
4714
4713
|
"multiple": true,
|
|
@@ -4716,9 +4715,8 @@
|
|
|
4716
4715
|
},
|
|
4717
4716
|
"format": {
|
|
4718
4717
|
"char": "f",
|
|
4719
|
-
"description": "Specifies the output format for results written directly to the console.",
|
|
4720
4718
|
"name": "format",
|
|
4721
|
-
"summary": "
|
|
4719
|
+
"summary": "The output format for results written directly to the console.",
|
|
4722
4720
|
"hasDynamicHelp": false,
|
|
4723
4721
|
"multiple": false,
|
|
4724
4722
|
"options": [
|
|
@@ -4734,37 +4732,36 @@
|
|
|
4734
4732
|
},
|
|
4735
4733
|
"outfile": {
|
|
4736
4734
|
"char": "o",
|
|
4737
|
-
"description": "Writes output to a file.",
|
|
4738
4735
|
"name": "outfile",
|
|
4739
|
-
"summary": "write output to
|
|
4736
|
+
"summary": "File to write output to.",
|
|
4740
4737
|
"hasDynamicHelp": false,
|
|
4741
4738
|
"multiple": false,
|
|
4742
4739
|
"type": "option"
|
|
4743
4740
|
},
|
|
4744
4741
|
"severity-threshold": {
|
|
4745
4742
|
"char": "s",
|
|
4746
|
-
"description": "
|
|
4743
|
+
"description": "Values are 1 (high), 2 (moderate), and 3 (low). Exit code is the most severe violation. Using this flag also invokes the --normalize-severity flag.",
|
|
4747
4744
|
"exclusive": [
|
|
4748
4745
|
"json"
|
|
4749
4746
|
],
|
|
4750
4747
|
"name": "severity-threshold",
|
|
4751
|
-
"summary": "
|
|
4748
|
+
"summary": "An error will be thrown when a violation is found with a severity equal to or greater than the specified level.",
|
|
4752
4749
|
"hasDynamicHelp": false,
|
|
4753
4750
|
"multiple": false,
|
|
4754
4751
|
"type": "option"
|
|
4755
4752
|
},
|
|
4756
4753
|
"normalize-severity": {
|
|
4757
|
-
"description": "
|
|
4754
|
+
"description": "For the html option, the normalized severity is displayed instead of the engine severity.",
|
|
4758
4755
|
"name": "normalize-severity",
|
|
4759
|
-
"summary": "
|
|
4756
|
+
"summary": "Include normalized severity levels 1 (high), 2 (moderate), and 3 (low) with the results.",
|
|
4760
4757
|
"allowNo": false,
|
|
4761
4758
|
"type": "boolean"
|
|
4762
4759
|
},
|
|
4763
4760
|
"projectdir": {
|
|
4764
4761
|
"char": "p",
|
|
4765
|
-
"description": "
|
|
4762
|
+
"description": "Specify multiple values as a comma-separated list. Each project directory must be a path, not a glob. If --projectdir isn’t specified, a default value is calculated. The default value is a directory that contains all the target files.",
|
|
4766
4763
|
"name": "projectdir",
|
|
4767
|
-
"summary": "root
|
|
4764
|
+
"summary": "The relative or absolute root project directories used to set the context for Graph Engine's analysis.",
|
|
4768
4765
|
"delimiter": ",",
|
|
4769
4766
|
"hasDynamicHelp": false,
|
|
4770
4767
|
"multiple": true,
|
|
@@ -4775,9 +4772,9 @@
|
|
|
4775
4772
|
"deprecated": {
|
|
4776
4773
|
"message": "The 'ruleset' command parameter is deprecated. Use 'category' instead."
|
|
4777
4774
|
},
|
|
4778
|
-
"description": "
|
|
4775
|
+
"description": "Use category instead. One or more rulesets to run. Specify multiple values as a comma-separated list.",
|
|
4779
4776
|
"name": "ruleset",
|
|
4780
|
-
"summary": "[Deprecated]
|
|
4777
|
+
"summary": "[Deprecated] Rulesets to run.",
|
|
4781
4778
|
"delimiter": ",",
|
|
4782
4779
|
"hasDynamicHelp": false,
|
|
4783
4780
|
"multiple": true,
|
|
@@ -4785,9 +4782,9 @@
|
|
|
4785
4782
|
},
|
|
4786
4783
|
"engine": {
|
|
4787
4784
|
"char": "e",
|
|
4788
|
-
"description": "
|
|
4785
|
+
"description": "Submit multiple values as a comma-separated list.",
|
|
4789
4786
|
"name": "engine",
|
|
4790
|
-
"summary": "
|
|
4787
|
+
"summary": "Specify which engines to run.",
|
|
4791
4788
|
"delimiter": ",",
|
|
4792
4789
|
"hasDynamicHelp": false,
|
|
4793
4790
|
"multiple": true,
|
|
@@ -4805,60 +4802,49 @@
|
|
|
4805
4802
|
},
|
|
4806
4803
|
"target": {
|
|
4807
4804
|
"char": "t",
|
|
4808
|
-
"description": "
|
|
4805
|
+
"description": "Specify multiple values as a comma-separated list. Can use glob patterns. Default is \".\".",
|
|
4809
4806
|
"name": "target",
|
|
4810
|
-
"summary": "
|
|
4807
|
+
"summary": "Source code location.",
|
|
4811
4808
|
"delimiter": ",",
|
|
4812
4809
|
"hasDynamicHelp": false,
|
|
4813
4810
|
"multiple": true,
|
|
4814
4811
|
"type": "option"
|
|
4815
4812
|
},
|
|
4816
4813
|
"tsconfig": {
|
|
4817
|
-
"description": "The location of the tsconfig.json file used by the eslint-typescript engine. The --tsconfig flag can’t be used with --eslintconfig flag.",
|
|
4818
4814
|
"name": "tsconfig",
|
|
4819
|
-
"summary": "
|
|
4815
|
+
"summary": "Location of tsconfig.json file used by the eslint-typescript engine. The --tsconfig flag can’t be used with --eslintconfig flag.",
|
|
4820
4816
|
"hasDynamicHelp": false,
|
|
4821
4817
|
"multiple": false,
|
|
4822
4818
|
"type": "option"
|
|
4823
4819
|
},
|
|
4824
4820
|
"eslintconfig": {
|
|
4825
|
-
"description": "Specifies the location of eslintrc config to customize ESLint engine. The --tsconfig flag can’t be used with --eslintconfig flag.",
|
|
4826
4821
|
"name": "eslintconfig",
|
|
4827
|
-
"summary": "
|
|
4822
|
+
"summary": "Specify the location of eslintrc config to customize eslint engine. The --tsconfig flag can’t be used with --eslintconfig flag.",
|
|
4828
4823
|
"hasDynamicHelp": false,
|
|
4829
4824
|
"multiple": false,
|
|
4830
4825
|
"type": "option"
|
|
4831
4826
|
},
|
|
4832
4827
|
"pmdconfig": {
|
|
4833
|
-
"description": "Specifies the location of the PMD rule reference XML file to customize rule selection.",
|
|
4834
4828
|
"name": "pmdconfig",
|
|
4835
|
-
"summary": "
|
|
4829
|
+
"summary": "Location of PMD rule reference XML file to customize rule selection.",
|
|
4836
4830
|
"hasDynamicHelp": false,
|
|
4837
4831
|
"multiple": false,
|
|
4838
4832
|
"type": "option"
|
|
4839
4833
|
},
|
|
4840
|
-
"preview-pmd7": {
|
|
4841
|
-
"description": "Uses PMD version 7.0.0-rc4 instead of 6.55.0 when running PMD and CPD engines.",
|
|
4842
|
-
"name": "preview-pmd7",
|
|
4843
|
-
"summary": "use PMD version 7.0.0-rc4 when running PMD and CPD",
|
|
4844
|
-
"allowNo": false,
|
|
4845
|
-
"type": "boolean"
|
|
4846
|
-
},
|
|
4847
4834
|
"env": {
|
|
4848
4835
|
"deprecated": {
|
|
4849
4836
|
"message": "--env parameter is being deprecated, and will be removed in a future release."
|
|
4850
4837
|
},
|
|
4851
|
-
"description": "
|
|
4838
|
+
"description": "Overrides ESLint's default environmental variables, in JSON-formatted string.",
|
|
4852
4839
|
"name": "env",
|
|
4853
|
-
"summary": "[Deprecated]
|
|
4840
|
+
"summary": "[Deprecated] Override ESLint's default environment variables, in JSON-formatted string.",
|
|
4854
4841
|
"hasDynamicHelp": false,
|
|
4855
4842
|
"multiple": false,
|
|
4856
4843
|
"type": "option"
|
|
4857
4844
|
},
|
|
4858
4845
|
"verbose-violations": {
|
|
4859
|
-
"description": "Returns retire-js violation-message details about each vulnerability, including summary, common vulnerabilities and exposures (CVE), and URLs.",
|
|
4860
4846
|
"name": "verbose-violations",
|
|
4861
|
-
"summary": "
|
|
4847
|
+
"summary": "Includes Retire-js violation-message details about each vulnerability in the results, including summary, common vulnerabilities and exposures (CVE), and URLs.",
|
|
4862
4848
|
"allowNo": false,
|
|
4863
4849
|
"type": "boolean"
|
|
4864
4850
|
}
|
|
@@ -4870,7 +4856,7 @@
|
|
|
4870
4856
|
"pluginName": "@salesforce/sfdx-scanner",
|
|
4871
4857
|
"pluginType": "jit",
|
|
4872
4858
|
"strict": true,
|
|
4873
|
-
"summary": "
|
|
4859
|
+
"summary": "Scan a codebase with all the rules in the registry, or use parameters to filter the rules based on rulename, category, or ruleset.",
|
|
4874
4860
|
"enableJsonFlag": true,
|
|
4875
4861
|
"SF_ENV": "SF_ENV",
|
|
4876
4862
|
"invocation": "scanner run",
|
|
@@ -4890,9 +4876,9 @@
|
|
|
4890
4876
|
"scanner:rule:add": {
|
|
4891
4877
|
"aliases": [],
|
|
4892
4878
|
"args": {},
|
|
4893
|
-
"description": "
|
|
4879
|
+
"description": "Bundle custom PMD rules in JAR files. Follow PMD conventions, such as defining the custom rules in XML files under a `/category/` directory. Compile and test custom rules separately before adding them. See PMD's documentation for more information on writing rules.",
|
|
4894
4880
|
"examples": [
|
|
4895
|
-
"
|
|
4881
|
+
"This example shows how to specify two JAR files directly.\n<%= config.bin %> <%= command.id %> --language apex --path \"/Users/me/rules/Jar1.jar,/Users/me/rules/Jar2.jar\"\nThis example shows how to specify a directory containing one or more JARs, all of which are added to the registry.\n<%= config.bin %> <%= command.id %> --language apex --path \"/Users/me/rules\""
|
|
4896
4882
|
],
|
|
4897
4883
|
"flags": {
|
|
4898
4884
|
"json": {
|
|
@@ -4904,20 +4890,19 @@
|
|
|
4904
4890
|
},
|
|
4905
4891
|
"language": {
|
|
4906
4892
|
"char": "l",
|
|
4907
|
-
"description": "Language that the custom rules are evaluated against.",
|
|
4908
4893
|
"name": "language",
|
|
4909
4894
|
"required": true,
|
|
4910
|
-
"summary": "
|
|
4895
|
+
"summary": "Language that the custom rules are evaluated against.",
|
|
4911
4896
|
"hasDynamicHelp": false,
|
|
4912
4897
|
"multiple": false,
|
|
4913
4898
|
"type": "option"
|
|
4914
4899
|
},
|
|
4915
4900
|
"path": {
|
|
4916
4901
|
"char": "p",
|
|
4917
|
-
"description": "
|
|
4902
|
+
"description": "Specify multiple values as a comma-separated list.",
|
|
4918
4903
|
"name": "path",
|
|
4919
4904
|
"required": true,
|
|
4920
|
-
"summary": "
|
|
4905
|
+
"summary": "One or more paths (such as a directory or JAR file) to custom rule definitions.",
|
|
4921
4906
|
"delimiter": ",",
|
|
4922
4907
|
"hasDynamicHelp": false,
|
|
4923
4908
|
"multiple": true,
|
|
@@ -4931,7 +4916,7 @@
|
|
|
4931
4916
|
"pluginName": "@salesforce/sfdx-scanner",
|
|
4932
4917
|
"pluginType": "jit",
|
|
4933
4918
|
"strict": true,
|
|
4934
|
-
"summary": "
|
|
4919
|
+
"summary": "Add custom rules to Salesforce Code Analyzer's registry to run them along with the built-in rules.",
|
|
4935
4920
|
"enableJsonFlag": true,
|
|
4936
4921
|
"SF_ENV": "SF_ENV",
|
|
4937
4922
|
"isESM": false,
|
|
@@ -4955,9 +4940,8 @@
|
|
|
4955
4940
|
"scanner:rule:describe": {
|
|
4956
4941
|
"aliases": [],
|
|
4957
4942
|
"args": {},
|
|
4958
|
-
"description": "Provides detailed information about a rule. Information includes the rule's language (such as Apex or Java), the violation it detects, and example code of the violation. The command output also includes the rule's categories and rulesets.",
|
|
4959
4943
|
"examples": [
|
|
4960
|
-
"
|
|
4944
|
+
"This example shows how to describe the ApexBadCrypto rule.\n<%= config.bin %> <%= command.id %> --rulename ApexBadCrypto"
|
|
4961
4945
|
],
|
|
4962
4946
|
"flags": {
|
|
4963
4947
|
"json": {
|
|
@@ -4969,25 +4953,16 @@
|
|
|
4969
4953
|
},
|
|
4970
4954
|
"rulename": {
|
|
4971
4955
|
"char": "n",
|
|
4972
|
-
"description": "The name of the rule.",
|
|
4973
4956
|
"name": "rulename",
|
|
4974
4957
|
"required": true,
|
|
4975
|
-
"summary": "
|
|
4958
|
+
"summary": "The name of the rule.",
|
|
4976
4959
|
"hasDynamicHelp": false,
|
|
4977
4960
|
"multiple": false,
|
|
4978
4961
|
"type": "option"
|
|
4979
4962
|
},
|
|
4980
4963
|
"verbose": {
|
|
4981
|
-
"description": "Emit additional command output to stdout.",
|
|
4982
4964
|
"name": "verbose",
|
|
4983
|
-
"summary": "
|
|
4984
|
-
"allowNo": false,
|
|
4985
|
-
"type": "boolean"
|
|
4986
|
-
},
|
|
4987
|
-
"preview-pmd7": {
|
|
4988
|
-
"description": "Uses PMD version 7.0.0-rc4 instead of 6.55.0 to describe PMD and CPD rules.",
|
|
4989
|
-
"name": "preview-pmd7",
|
|
4990
|
-
"summary": "use PMD version 7.0.0-rc4 to describe PMD and CPD rules",
|
|
4965
|
+
"summary": "Emit additional command output to stdout.",
|
|
4991
4966
|
"allowNo": false,
|
|
4992
4967
|
"type": "boolean"
|
|
4993
4968
|
}
|
|
@@ -4999,7 +4974,7 @@
|
|
|
4999
4974
|
"pluginName": "@salesforce/sfdx-scanner",
|
|
5000
4975
|
"pluginType": "jit",
|
|
5001
4976
|
"strict": true,
|
|
5002
|
-
"summary": "
|
|
4977
|
+
"summary": "Provide detailed information about a rule that includes the rule's language (such as Apex or Java), the violation it detects, example code of the violation, and the rule's categories and rulesets.",
|
|
5003
4978
|
"enableJsonFlag": true,
|
|
5004
4979
|
"SF_ENV": "SF_ENV",
|
|
5005
4980
|
"isESM": false,
|
|
@@ -5023,9 +4998,9 @@
|
|
|
5023
4998
|
"scanner:rule:list": {
|
|
5024
4999
|
"aliases": [],
|
|
5025
5000
|
"args": {},
|
|
5026
|
-
"description": "
|
|
5001
|
+
"description": "Filter the output to view a smaller set of rules. Use the `scanner rule describe` command to get information about a specific rule.",
|
|
5027
5002
|
"examples": [
|
|
5028
|
-
"This example invokes the command without filter criteria, which returns all rules.\n
|
|
5003
|
+
"This example invokes the command without filter criteria, which returns all rules.\n<%= config.bin %> <%= command.id %>\nThis example returns all rules for Apex OR Javascript. Values supplied to a single filter are handled with a logical OR.\n<%= config.bin %> <%= command.id %> --language apex,javascript\nThis example returns all rules that target Apex OR Javascript, AND are members of the Braces OR Security rulesets. The different filters are combined with a logical AND.\n<%= config.bin %> <%= command.id %> --language apex,javascript --ruleset Braces,Security"
|
|
5029
5004
|
],
|
|
5030
5005
|
"flags": {
|
|
5031
5006
|
"json": {
|
|
@@ -5036,17 +5011,16 @@
|
|
|
5036
5011
|
"type": "boolean"
|
|
5037
5012
|
},
|
|
5038
5013
|
"verbose": {
|
|
5039
|
-
"description": "Emit additional command output to stdout.",
|
|
5040
5014
|
"name": "verbose",
|
|
5041
|
-
"summary": "
|
|
5015
|
+
"summary": "Emit additional command output to stdout.",
|
|
5042
5016
|
"allowNo": false,
|
|
5043
5017
|
"type": "boolean"
|
|
5044
5018
|
},
|
|
5045
5019
|
"category": {
|
|
5046
5020
|
"char": "c",
|
|
5047
|
-
"description": "
|
|
5021
|
+
"description": "Specify multiple values as a comma-separated list.",
|
|
5048
5022
|
"name": "category",
|
|
5049
|
-
"summary": "
|
|
5023
|
+
"summary": "Select rules by category.",
|
|
5050
5024
|
"delimiter": ",",
|
|
5051
5025
|
"hasDynamicHelp": false,
|
|
5052
5026
|
"multiple": true,
|
|
@@ -5057,9 +5031,8 @@
|
|
|
5057
5031
|
"deprecated": {
|
|
5058
5032
|
"message": "The 'ruleset' command parameter is deprecated. Use 'category' instead"
|
|
5059
5033
|
},
|
|
5060
|
-
"description": "Deprecated. Use category instead. Selects rules by ruleset. Enter multiple values as a comma-separated list.",
|
|
5061
5034
|
"name": "ruleset",
|
|
5062
|
-
"summary": "
|
|
5035
|
+
"summary": "Deprecated. Use category instead. Select rules by ruleset.",
|
|
5063
5036
|
"delimiter": ",",
|
|
5064
5037
|
"hasDynamicHelp": false,
|
|
5065
5038
|
"multiple": true,
|
|
@@ -5067,9 +5040,9 @@
|
|
|
5067
5040
|
},
|
|
5068
5041
|
"language": {
|
|
5069
5042
|
"char": "l",
|
|
5070
|
-
"description": "
|
|
5043
|
+
"description": "Specify multiple values as a comma-separated list.",
|
|
5071
5044
|
"name": "language",
|
|
5072
|
-
"summary": "
|
|
5045
|
+
"summary": "Select rules by language.",
|
|
5073
5046
|
"delimiter": ",",
|
|
5074
5047
|
"hasDynamicHelp": false,
|
|
5075
5048
|
"multiple": true,
|
|
@@ -5077,9 +5050,9 @@
|
|
|
5077
5050
|
},
|
|
5078
5051
|
"engine": {
|
|
5079
5052
|
"char": "e",
|
|
5080
|
-
"description": "
|
|
5053
|
+
"description": "Specify multiple values as a comma-separated list.",
|
|
5081
5054
|
"name": "engine",
|
|
5082
|
-
"summary": "
|
|
5055
|
+
"summary": "Select rules by engine.",
|
|
5083
5056
|
"delimiter": ",",
|
|
5084
5057
|
"hasDynamicHelp": false,
|
|
5085
5058
|
"multiple": true,
|
|
@@ -5094,13 +5067,6 @@
|
|
|
5094
5067
|
"sfge"
|
|
5095
5068
|
],
|
|
5096
5069
|
"type": "option"
|
|
5097
|
-
},
|
|
5098
|
-
"preview-pmd7": {
|
|
5099
|
-
"description": "Uses PMD version 7.0.0-rc4 instead of 6.55.0 to list PMD and CPD rules.",
|
|
5100
|
-
"name": "preview-pmd7",
|
|
5101
|
-
"summary": "use PMD version 7.0.0-rc4 to list PMD and CPD rules",
|
|
5102
|
-
"allowNo": false,
|
|
5103
|
-
"type": "boolean"
|
|
5104
5070
|
}
|
|
5105
5071
|
},
|
|
5106
5072
|
"hasDynamicHelp": false,
|
|
@@ -5110,7 +5076,7 @@
|
|
|
5110
5076
|
"pluginName": "@salesforce/sfdx-scanner",
|
|
5111
5077
|
"pluginType": "jit",
|
|
5112
5078
|
"strict": true,
|
|
5113
|
-
"summary": "
|
|
5079
|
+
"summary": "List basic information about all rules matching provided criteria.",
|
|
5114
5080
|
"enableJsonFlag": true,
|
|
5115
5081
|
"SF_ENV": "SF_ENV",
|
|
5116
5082
|
"isESM": false,
|
|
@@ -5134,9 +5100,9 @@
|
|
|
5134
5100
|
"scanner:rule:remove": {
|
|
5135
5101
|
"aliases": [],
|
|
5136
5102
|
"args": {},
|
|
5137
|
-
"description": "
|
|
5103
|
+
"description": "Use the `-p|--path` parameter to specify one or more paths to remove. If you don't specify any parameters, the command lists all valid custom paths but doesn't remove any.",
|
|
5138
5104
|
"examples": [
|
|
5139
|
-
"This example runs the command without arguments to see a list of registered custom paths.\n
|
|
5105
|
+
"This example runs the command without arguments to see a list of registered custom paths.\n<%= config.bin %> <%= command.id %>\nThis example uses the --path parameter to deregister the rules defined in somerules.jar and any JARs/XMLs contained in the rules folder.\n<%= config.bin %> <%= command.id %> --path \"~/path/to/somerules.jar,~/path/to/folder/containing/rules\"\nThis example uses the --force flag to bypass the confirmation prompt, removing all rules defined in somerules.jar. By default, a list of all rules that will be unregistered is displayed, and the action must be confirmed. To bypass that confirmation, use the --force flag.\n<%= config.bin %> <%= command.id %> --force --path \"~/path/to/somerules.jar\""
|
|
5140
5106
|
],
|
|
5141
5107
|
"flags": {
|
|
5142
5108
|
"json": {
|
|
@@ -5147,25 +5113,23 @@
|
|
|
5147
5113
|
"type": "boolean"
|
|
5148
5114
|
},
|
|
5149
5115
|
"verbose": {
|
|
5150
|
-
"description": "Emit additional command output to stdout.",
|
|
5151
5116
|
"name": "verbose",
|
|
5152
|
-
"summary": "
|
|
5117
|
+
"summary": "Emit additional command output to stdout.",
|
|
5153
5118
|
"allowNo": false,
|
|
5154
5119
|
"type": "boolean"
|
|
5155
5120
|
},
|
|
5156
5121
|
"force": {
|
|
5157
5122
|
"char": "f",
|
|
5158
|
-
"description": "Bypasses the confirmation prompt and immediately removes the rules.",
|
|
5159
5123
|
"name": "force",
|
|
5160
|
-
"summary": "
|
|
5124
|
+
"summary": "Bypass the confirmation prompt and immediately remove the rules.",
|
|
5161
5125
|
"allowNo": false,
|
|
5162
5126
|
"type": "boolean"
|
|
5163
5127
|
},
|
|
5164
5128
|
"path": {
|
|
5165
5129
|
"char": "p",
|
|
5166
|
-
"description": "
|
|
5130
|
+
"description": "Specify multiple values with a comma-separated list.",
|
|
5167
5131
|
"name": "path",
|
|
5168
|
-
"summary": "
|
|
5132
|
+
"summary": "One or more paths to remove.",
|
|
5169
5133
|
"delimiter": ",",
|
|
5170
5134
|
"hasDynamicHelp": false,
|
|
5171
5135
|
"multiple": true,
|
|
@@ -5179,7 +5143,7 @@
|
|
|
5179
5143
|
"pluginName": "@salesforce/sfdx-scanner",
|
|
5180
5144
|
"pluginType": "jit",
|
|
5181
5145
|
"strict": true,
|
|
5182
|
-
"summary": "
|
|
5146
|
+
"summary": "Remove custom rules from the registry of available rules.",
|
|
5183
5147
|
"enableJsonFlag": true,
|
|
5184
5148
|
"SF_ENV": "SF_ENV",
|
|
5185
5149
|
"isESM": false,
|
|
@@ -5203,9 +5167,9 @@
|
|
|
5203
5167
|
"scanner:run:dfa": {
|
|
5204
5168
|
"aliases": [],
|
|
5205
5169
|
"args": {},
|
|
5206
|
-
"description": "
|
|
5170
|
+
"description": "Specify the format of output and print results directly or as contents of a file that you provide with --outfile flag.",
|
|
5207
5171
|
"examples": [
|
|
5208
|
-
"
|
|
5172
|
+
"These examples show how the paths specified for --projectdir must contain all files specified through --target cumulatively.\n<%= config.bin %> <%= command.id %> --target \"./**/*.cls\" --projectdir \"./\"\n<%= config.bin %> <%= command.id %> --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<%= config.bin %> <%= command.id %> --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. Unix example:\n<%= config.bin %> <%= command.id %> --target \"./**/*.cls,!./**/IgnoreMe.cls\" ...\nWindows example:\n<%= config.bin %> <%= command.id %> --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<%= config.bin %> <%= command.id %> --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<%= config.bin %> <%= command.id %> --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<%= config.bin %> <%= command.id %> --target \"./some-project/\" --projectdir \"./some-project/\" --severity-threshold 2\nUse --rule-thread-count to allow more (or fewer) entrypoints to be evaluated concurrently.\n<%= config.bin %> <%= command.id %> --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<%= config.bin %> <%= command.id %> --rule-thread-timeout 9000000 ...\nUse --sfgejvmargs to pass Java Virtual Machine args to override system defaults while executing Salesforce Graph Engine's rules. The example overrides the system's default heap space allocation to 8 GB and decreases chances of encountering OutOfMemory error.\n<%= config.bin %> <%= command.id %> --sfgejvmargs \"-Xmx8g\" ...\nUse --with-pilot to allow execution of pilot rules. This example allows pilot rules in the \"Performance\" category to execute.\n<%= config.bin %> <%= command.id %> --category 'Performance' --with-pilot ..."
|
|
5209
5173
|
],
|
|
5210
5174
|
"flags": {
|
|
5211
5175
|
"json": {
|
|
@@ -5216,17 +5180,16 @@
|
|
|
5216
5180
|
"type": "boolean"
|
|
5217
5181
|
},
|
|
5218
5182
|
"verbose": {
|
|
5219
|
-
"description": "Emit additional command output to stdout.",
|
|
5220
5183
|
"name": "verbose",
|
|
5221
|
-
"summary": "
|
|
5184
|
+
"summary": "Emit additional command output to stdout.",
|
|
5222
5185
|
"allowNo": false,
|
|
5223
5186
|
"type": "boolean"
|
|
5224
5187
|
},
|
|
5225
5188
|
"category": {
|
|
5226
5189
|
"char": "c",
|
|
5227
|
-
"description": "
|
|
5190
|
+
"description": "Specify multiple values as a comma-separated list.",
|
|
5228
5191
|
"name": "category",
|
|
5229
|
-
"summary": "
|
|
5192
|
+
"summary": "One or more categories of rules to run.",
|
|
5230
5193
|
"delimiter": ",",
|
|
5231
5194
|
"hasDynamicHelp": false,
|
|
5232
5195
|
"multiple": true,
|
|
@@ -5234,9 +5197,8 @@
|
|
|
5234
5197
|
},
|
|
5235
5198
|
"format": {
|
|
5236
5199
|
"char": "f",
|
|
5237
|
-
"description": "Specifies the output format for results written directly to the console.",
|
|
5238
5200
|
"name": "format",
|
|
5239
|
-
"summary": "
|
|
5201
|
+
"summary": "The output format for results written directly to the console.",
|
|
5240
5202
|
"hasDynamicHelp": false,
|
|
5241
5203
|
"multiple": false,
|
|
5242
5204
|
"options": [
|
|
@@ -5252,98 +5214,94 @@
|
|
|
5252
5214
|
},
|
|
5253
5215
|
"outfile": {
|
|
5254
5216
|
"char": "o",
|
|
5255
|
-
"description": "Writes output to a file.",
|
|
5256
5217
|
"name": "outfile",
|
|
5257
|
-
"summary": "write output to
|
|
5218
|
+
"summary": "File to write output to.",
|
|
5258
5219
|
"hasDynamicHelp": false,
|
|
5259
5220
|
"multiple": false,
|
|
5260
5221
|
"type": "option"
|
|
5261
5222
|
},
|
|
5262
5223
|
"severity-threshold": {
|
|
5263
5224
|
"char": "s",
|
|
5264
|
-
"description": "
|
|
5225
|
+
"description": "Values are 1 (high), 2 (moderate), and 3 (low). Exit code is the most severe violation. Using this flag also invokes the --normalize-severity flag.",
|
|
5265
5226
|
"exclusive": [
|
|
5266
5227
|
"json"
|
|
5267
5228
|
],
|
|
5268
5229
|
"name": "severity-threshold",
|
|
5269
|
-
"summary": "
|
|
5230
|
+
"summary": "An error will be thrown when a violation is found with a severity equal to or greater than the specified level.",
|
|
5270
5231
|
"hasDynamicHelp": false,
|
|
5271
5232
|
"multiple": false,
|
|
5272
5233
|
"type": "option"
|
|
5273
5234
|
},
|
|
5274
5235
|
"normalize-severity": {
|
|
5275
|
-
"description": "
|
|
5236
|
+
"description": "For the html option, the normalized severity is displayed instead of the engine severity.",
|
|
5276
5237
|
"name": "normalize-severity",
|
|
5277
|
-
"summary": "
|
|
5238
|
+
"summary": "Include normalized severity levels 1 (high), 2 (moderate), and 3 (low) with the results.",
|
|
5278
5239
|
"allowNo": false,
|
|
5279
5240
|
"type": "boolean"
|
|
5280
5241
|
},
|
|
5281
5242
|
"projectdir": {
|
|
5282
5243
|
"char": "p",
|
|
5283
|
-
"description": "
|
|
5244
|
+
"description": "Specify multiple values as a comma-separated list. Each project directory must be a path, not a glob. If --projectdir isn’t specified, a default value is calculated. The default value is a directory that contains all the target files.",
|
|
5284
5245
|
"name": "projectdir",
|
|
5285
|
-
"summary": "root
|
|
5246
|
+
"summary": "The relative or absolute root project directories used to set the context for Graph Engine's analysis.",
|
|
5286
5247
|
"delimiter": ",",
|
|
5287
5248
|
"hasDynamicHelp": false,
|
|
5288
5249
|
"multiple": true,
|
|
5289
5250
|
"type": "option"
|
|
5290
5251
|
},
|
|
5291
5252
|
"with-pilot": {
|
|
5292
|
-
"description": "Allows pilot rules to execute.",
|
|
5293
5253
|
"name": "with-pilot",
|
|
5294
|
-
"summary": "
|
|
5254
|
+
"summary": "Allow pilot rules to execute.",
|
|
5295
5255
|
"allowNo": false,
|
|
5296
5256
|
"type": "boolean"
|
|
5297
5257
|
},
|
|
5298
5258
|
"target": {
|
|
5299
5259
|
"char": "t",
|
|
5300
|
-
"description": "
|
|
5260
|
+
"description": "Use glob patterns or specify individual methods with #-syntax. Multiple values are specified as a comma-separated list. Default is \".\".",
|
|
5301
5261
|
"name": "target",
|
|
5302
|
-
"summary": "
|
|
5262
|
+
"summary": "Source code location.",
|
|
5303
5263
|
"delimiter": ",",
|
|
5304
5264
|
"hasDynamicHelp": false,
|
|
5305
5265
|
"multiple": true,
|
|
5306
5266
|
"type": "option"
|
|
5307
5267
|
},
|
|
5308
5268
|
"rule-thread-count": {
|
|
5309
|
-
"description": "Specifies the number of rule-evaluation threads or how many entry points can be evaluated concurrently. Inherits its value from the SFGE_RULE_THREAD_COUNT environment variable, if set. The default is 4.",
|
|
5310
5269
|
"env": "SFGE_RULE_THREAD_COUNT",
|
|
5311
5270
|
"name": "rule-thread-count",
|
|
5312
|
-
"summary": "
|
|
5271
|
+
"summary": "Number of DFA rule-evaluation threads or how many entry points can be evaluated concurrently. Inherits its value from the SFGE_RULE_THREAD_COUNT environment variable, if set.",
|
|
5313
5272
|
"hasDynamicHelp": false,
|
|
5314
5273
|
"multiple": false,
|
|
5315
5274
|
"type": "option"
|
|
5316
5275
|
},
|
|
5317
5276
|
"rule-thread-timeout": {
|
|
5318
|
-
"description": "Specifies the time limit for evaluating a single entry point in milliseconds. Inherits its value from the SFGE_RULE_THREAD_TIMEOUT environment variable, if set. The default is 900,000 ms or 15 minutes.",
|
|
5319
5277
|
"env": "SFGE_RULE_THREAD_TIMEOUT",
|
|
5320
5278
|
"name": "rule-thread-timeout",
|
|
5321
|
-
"summary": "
|
|
5279
|
+
"summary": "Time limit, in milliseconds, for evaluating a single entry point. Inherits its value from the \"SFGE_RULE_THREAD_TIMEOUT\" environment variable, if set.",
|
|
5322
5280
|
"hasDynamicHelp": false,
|
|
5323
5281
|
"multiple": false,
|
|
5324
5282
|
"type": "option"
|
|
5325
5283
|
},
|
|
5326
5284
|
"rule-disable-warning-violation": {
|
|
5327
|
-
"description": "
|
|
5285
|
+
"description": "Examples of warning violations include those on StripInaccessible READ access, to get only high-severity violations.",
|
|
5328
5286
|
"name": "rule-disable-warning-violation",
|
|
5329
|
-
"summary": "
|
|
5287
|
+
"summary": "Disable warning violations from Salesforce Graph Engine. Inherits value from SFGE_RULE_DISABLE_WARNING_VIOLATION env-var, if set.",
|
|
5330
5288
|
"allowNo": false,
|
|
5331
5289
|
"type": "boolean"
|
|
5332
5290
|
},
|
|
5333
5291
|
"sfgejvmargs": {
|
|
5334
|
-
"description": "
|
|
5292
|
+
"description": "Separate multiple arguments by a space.",
|
|
5335
5293
|
"env": "SFGE_JVM_ARGS",
|
|
5336
5294
|
"name": "sfgejvmargs",
|
|
5337
|
-
"summary": "
|
|
5295
|
+
"summary": "Java Virtual Machine (JVM) arguments to override system defaults while executing Salesforce Graph Engine.",
|
|
5338
5296
|
"hasDynamicHelp": false,
|
|
5339
5297
|
"multiple": false,
|
|
5340
5298
|
"type": "option"
|
|
5341
5299
|
},
|
|
5342
5300
|
"pathexplimit": {
|
|
5343
|
-
"description": "
|
|
5301
|
+
"description": "Set the value to -1 to remove any upper boundary. Its default value is derived from JVM heap space allocation.",
|
|
5344
5302
|
"env": "SFGE_PATH_EXPANSION_LIMIT",
|
|
5345
5303
|
"name": "pathexplimit",
|
|
5346
|
-
"summary": "
|
|
5304
|
+
"summary": "Path expansion upper boundary to limit the complexity of code that Graph Engine analyzes before failing test. Inherits it value from the \"SFGE_PATH_EXPANSION_LIMIT\", if set.",
|
|
5347
5305
|
"hasDynamicHelp": false,
|
|
5348
5306
|
"multiple": false,
|
|
5349
5307
|
"type": "option"
|
|
@@ -5356,7 +5314,7 @@
|
|
|
5356
5314
|
"pluginName": "@salesforce/sfdx-scanner",
|
|
5357
5315
|
"pluginType": "jit",
|
|
5358
5316
|
"strict": true,
|
|
5359
|
-
"summary": "
|
|
5317
|
+
"summary": "Scan codebase with all DFA rules by default.",
|
|
5360
5318
|
"enableJsonFlag": true,
|
|
5361
5319
|
"SF_ENV": "SF_ENV",
|
|
5362
5320
|
"invocation": "scanner run dfa",
|
|
@@ -5379,5 +5337,5 @@
|
|
|
5379
5337
|
]
|
|
5380
5338
|
}
|
|
5381
5339
|
},
|
|
5382
|
-
"version": "2.48.
|
|
5340
|
+
"version": "2.48.5"
|
|
5383
5341
|
}
|