@salesforce/cli 2.24.4 → 2.25.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.
- package/README.md +29 -24
- package/npm-shrinkwrap.json +63 -63
- package/oclif.manifest.json +222 -394
- package/package.json +7 -7
package/oclif.manifest.json
CHANGED
|
@@ -4420,36 +4420,34 @@
|
|
|
4420
4420
|
"scanner:run": {
|
|
4421
4421
|
"aliases": [],
|
|
4422
4422
|
"args": {},
|
|
4423
|
-
"description": "
|
|
4423
|
+
"description": "Scans a codebase with a selection of rules. You can scan the codebase with all the rules in the registry, or use parameters to filter the rules based on rulename, category, or ruleset. You can specify the format of the output, such as XML or JUnit. You can print the output to the console (default) or to a file using the --outfile parameter.",
|
|
4424
4424
|
"examples": [
|
|
4425
|
-
"This example evaluates all rules against somefile.js.\nInvoking code analyzer without specifying any rules causes all rules to be run.\n\t$
|
|
4425
|
+
"This example evaluates all rules against somefile.js.\nInvoking code analyzer without specifying any rules causes all rules to be run.\n\t$ <%= config.bin %> <%= command.id %> --format xml --target \"somefile.js\"\n\nThis example evaluates all rules in the Design and Best Practices categories.\nWhen you specify multiple categories or rulesets, the results are combined with a logical OR.\n\t$ <%= config.bin %> <%= command.id %> --format xml --target \"somefile.js\" --\n\nThis example evaluates all rules except those in the Design or Best Practices categories.\nExclude categories by specifying the negation operator and enclosing the values in single quotes.\n\t$ <%= config.bin %> <%= command.id %> --format xml --target \"somefile.js\" --category '!Design,!Best Practices'\n\nWrap globs in quotes. These examples evaluate rules against all .js files in the current directory, except for IgnoreMe.js.\nUnix example:\n\t$ <%= config.bin %> <%= command.id %> --target './**/*.js,!./**/IgnoreMe.js' ...\nWindows example:\n\t$ <%= config.bin %> <%= command.id %> --target \".\\**\\*.js,!.\\**\\IgnoreMe.js\" ...\n\nThis example scans the project contained in '/my-project' if the current working directory is another directory.\nSpecify tsconfig.json if the current working directory does not contain the tsconfig.json that corresponds to the TypeScript files being scanned.\n\t$ <%= config.bin %> <%= command.id %> --target \"/my-project/**/*.ts\" --tsconfig \"/my-project/tsconfig.json\"\n\nThis example evaluates rules against somefile.js, including Jasmine in the environment variables.\nUses --env to override the default ESLint environment variables to add frameworks.\n\t$ <%= config.bin %> <%= command.id %> --target \"somefile.js\" --env '{\"jasmine\": true}'\n\nThis example evaluates rules aginst somefile.js using eslint-lwc and pmd engines.\nUse --engine to include or exclude engines. Any engine listed will be run, regardless of its current 'disabled' attribute.\n\t$ <%= config.bin %> <%= command.id %> --target \"somefile.js\" --engine \"eslint-lwc,pmd\"\n\nThis example executes CPD engine against known file extensions in \"/some/dir\". CPD helps detect blocks of code duplication in selected languages.\nUse --engine to invoke engines that are not enabled by default.\n\t$ <%= config.bin %> <%= command.id %> --target \"/some/dir\" --engine cpd\n\nThis example executes rules defined in pmd_rule_ref.xml against the files in 'src'.\nTo use PMD with your own rule reference file, use --pmdconfig. Note that rule filters are not applied.\n\t$ <%= config.bin %> <%= command.id %> --target \"src\" --pmdconfig \"pmd_rule_ref.xml\"\n\nThis example uses a custom config to scan the files in 'src'.\nTo 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\t$ <%= config.bin %> <%= command.id %> --target \"src\" --eslintconfig \"/home/my/setup/.eslintrc.json\"\n\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\t$ <%= config.bin %> <%= command.id %> --target \"/some-project/\" --format csv --normalize-severity\n\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\t$ <%= config.bin %> <%= command.id %> --target \"/some-project/\" --severity-threshold 2\n\nThe paths specified for --projectdir must contain all files specified through --target cumulatively.\n\t$ <%= config.bin %> <%= command.id %> --target \"./myproject/main/default/classes/*.cls\" --projectdir \"./myproject/\"\n\t$ <%= config.bin %> <%= command.id %> --target \"./**/*.cls\" --projectdir \"./\"\n\t$ <%= config.bin %> <%= command.id %> --target \"./dir1/file1.cls,./dir2/file2.cls\" --projectdir \"./dir1/,./dir2/\"\n\nThis example fails because the set of files included in --target is larger than that contained in --projectdir:\n\t$ <%= config.bin %> <%= command.id %> --target \"./**/*.cls\" --projectdir \"./myproject/\""
|
|
4426
4426
|
],
|
|
4427
|
-
"flags": {
|
|
4428
|
-
"hasDynamicHelp": false,
|
|
4429
|
-
"hiddenAliases": [],
|
|
4430
|
-
"id": "scanner:run",
|
|
4431
|
-
"pluginAlias": "@salesforce/sfdx-scanner",
|
|
4432
|
-
"pluginName": "@salesforce/sfdx-scanner",
|
|
4433
|
-
"pluginType": "jit",
|
|
4434
|
-
"flagsConfig": {
|
|
4427
|
+
"flags": {
|
|
4435
4428
|
"verbose": {
|
|
4436
|
-
"
|
|
4429
|
+
"name": "verbose",
|
|
4430
|
+
"summary": "emit additional command output to stdout",
|
|
4431
|
+
"allowNo": false,
|
|
4432
|
+
"type": "boolean"
|
|
4437
4433
|
},
|
|
4438
4434
|
"category": {
|
|
4439
|
-
"kind": "array",
|
|
4440
4435
|
"char": "c",
|
|
4441
|
-
"description": "
|
|
4442
|
-
"
|
|
4443
|
-
"
|
|
4444
|
-
"
|
|
4436
|
+
"description": "One or more categories of rules to run. Specify multiple values as a comma-separated list.",
|
|
4437
|
+
"name": "category",
|
|
4438
|
+
"summary": "one or more categories of rules to run",
|
|
4439
|
+
"delimiter": ",",
|
|
4440
|
+
"hasDynamicHelp": false,
|
|
4441
|
+
"multiple": true,
|
|
4445
4442
|
"type": "option"
|
|
4446
4443
|
},
|
|
4447
4444
|
"format": {
|
|
4448
|
-
"kind": "enum",
|
|
4449
|
-
"helpValue": "(csv|html|json|junit|sarif|table|xml)",
|
|
4450
4445
|
"char": "f",
|
|
4451
|
-
"description": "
|
|
4452
|
-
"
|
|
4446
|
+
"description": "Specifies results output format written directly to the console.",
|
|
4447
|
+
"name": "format",
|
|
4448
|
+
"summary": "specify results output format",
|
|
4449
|
+
"hasDynamicHelp": false,
|
|
4450
|
+
"multiple": false,
|
|
4453
4451
|
"options": [
|
|
4454
4452
|
"csv",
|
|
4455
4453
|
"html",
|
|
@@ -4459,124 +4457,139 @@
|
|
|
4459
4457
|
"table",
|
|
4460
4458
|
"xml"
|
|
4461
4459
|
],
|
|
4462
|
-
"input": [],
|
|
4463
|
-
"multiple": false,
|
|
4464
4460
|
"type": "option"
|
|
4465
4461
|
},
|
|
4466
4462
|
"outfile": {
|
|
4467
|
-
"kind": "string",
|
|
4468
4463
|
"char": "o",
|
|
4469
|
-
"description": "
|
|
4470
|
-
"
|
|
4471
|
-
"
|
|
4464
|
+
"description": "Writes output to a file.",
|
|
4465
|
+
"name": "outfile",
|
|
4466
|
+
"summary": "write output to a file",
|
|
4467
|
+
"hasDynamicHelp": false,
|
|
4472
4468
|
"multiple": false,
|
|
4473
4469
|
"type": "option"
|
|
4474
4470
|
},
|
|
4475
4471
|
"severity-threshold": {
|
|
4476
|
-
"kind": "integer",
|
|
4477
4472
|
"char": "s",
|
|
4478
|
-
"description": "
|
|
4479
|
-
"longDescription": "Throws an error when violations are found with equal or greater severity than the provided value. 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.",
|
|
4473
|
+
"description": "Throws an error when violations are found with equal or greater severity than the provided value. 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.",
|
|
4480
4474
|
"exclusive": [
|
|
4481
4475
|
"json"
|
|
4482
4476
|
],
|
|
4483
|
-
"
|
|
4484
|
-
"
|
|
4485
|
-
"
|
|
4477
|
+
"name": "severity-threshold",
|
|
4478
|
+
"summary": "throw an error when a violation threshold is reached, the --normalize-severity is invoked, and severity levels are reset to the baseline",
|
|
4479
|
+
"hasDynamicHelp": false,
|
|
4486
4480
|
"multiple": false,
|
|
4487
4481
|
"type": "option"
|
|
4488
4482
|
},
|
|
4489
4483
|
"normalize-severity": {
|
|
4490
|
-
"
|
|
4491
|
-
"
|
|
4492
|
-
"
|
|
4484
|
+
"description": "Returns normalized severity 1 (high), 2 (moderate), and 3 (low), and the engine-specific severity. For the html option, the normalized severity is displayed instead of the engine severity.",
|
|
4485
|
+
"name": "normalize-severity",
|
|
4486
|
+
"summary": "return normalized severity 1 (high), 2 (moderate), and 3 (low), and the engine-specific severity",
|
|
4493
4487
|
"allowNo": false,
|
|
4494
4488
|
"type": "boolean"
|
|
4495
4489
|
},
|
|
4496
4490
|
"projectdir": {
|
|
4497
|
-
"kind": "array",
|
|
4498
4491
|
"char": "p",
|
|
4499
|
-
"description": "
|
|
4500
|
-
"
|
|
4501
|
-
"
|
|
4492
|
+
"description": "Provides the relative or absolute root project directory used to set the context for Graph Engine's analysis. Project directory must be a path, not a glob. Specify multiple values as a comma-separated list.",
|
|
4493
|
+
"name": "projectdir",
|
|
4494
|
+
"summary": "provide root directory of project",
|
|
4495
|
+
"hasDynamicHelp": false,
|
|
4502
4496
|
"multiple": false,
|
|
4503
4497
|
"type": "option"
|
|
4504
4498
|
},
|
|
4505
4499
|
"ruleset": {
|
|
4506
|
-
"kind": "array",
|
|
4507
4500
|
"char": "r",
|
|
4508
4501
|
"deprecated": {
|
|
4509
|
-
"
|
|
4502
|
+
"message": "The 'ruleset' command parameter is deprecated. Use 'category' instead."
|
|
4510
4503
|
},
|
|
4511
|
-
"description": "[deprecated] rulesets to run",
|
|
4512
|
-
"
|
|
4513
|
-
"
|
|
4514
|
-
"
|
|
4504
|
+
"description": "[deprecated] One or more rulesets to run. Specify multiple values as a comma-separated list.",
|
|
4505
|
+
"name": "ruleset",
|
|
4506
|
+
"summary": "[deprecated] rulesets to run",
|
|
4507
|
+
"delimiter": ",",
|
|
4508
|
+
"hasDynamicHelp": false,
|
|
4509
|
+
"multiple": true,
|
|
4515
4510
|
"type": "option"
|
|
4516
4511
|
},
|
|
4517
4512
|
"engine": {
|
|
4518
|
-
"kind": "array",
|
|
4519
4513
|
"char": "e",
|
|
4520
|
-
"description": "
|
|
4521
|
-
"
|
|
4522
|
-
"
|
|
4523
|
-
"
|
|
4514
|
+
"description": "Specifies one or more engines to run. Submit multiple values as a comma-separated list.",
|
|
4515
|
+
"name": "engine",
|
|
4516
|
+
"summary": "specify which engines to run",
|
|
4517
|
+
"delimiter": ",",
|
|
4518
|
+
"hasDynamicHelp": false,
|
|
4519
|
+
"multiple": true,
|
|
4520
|
+
"options": [
|
|
4521
|
+
"eslint",
|
|
4522
|
+
"eslint-lwc",
|
|
4523
|
+
"eslint-typescript",
|
|
4524
|
+
"pmd",
|
|
4525
|
+
"pmd-appexchange",
|
|
4526
|
+
"retire-js",
|
|
4527
|
+
"sfge",
|
|
4528
|
+
"cpd"
|
|
4529
|
+
],
|
|
4524
4530
|
"type": "option"
|
|
4525
4531
|
},
|
|
4526
4532
|
"target": {
|
|
4527
|
-
"kind": "array",
|
|
4528
4533
|
"char": "t",
|
|
4529
|
-
"description": "
|
|
4530
|
-
"
|
|
4534
|
+
"description": "Source code location. May use glob patterns. Specify multiple values as a comma-separated list.",
|
|
4535
|
+
"name": "target",
|
|
4531
4536
|
"required": true,
|
|
4532
|
-
"
|
|
4533
|
-
"
|
|
4537
|
+
"summary": "source code location",
|
|
4538
|
+
"delimiter": ",",
|
|
4539
|
+
"hasDynamicHelp": false,
|
|
4540
|
+
"multiple": true,
|
|
4534
4541
|
"type": "option"
|
|
4535
4542
|
},
|
|
4536
4543
|
"tsconfig": {
|
|
4537
|
-
"
|
|
4538
|
-
"
|
|
4539
|
-
"
|
|
4540
|
-
"
|
|
4544
|
+
"description": "Location of tsconfig.json file used by eslint-typescript engine.",
|
|
4545
|
+
"name": "tsconfig",
|
|
4546
|
+
"summary": "location of tsconfig.json file",
|
|
4547
|
+
"hasDynamicHelp": false,
|
|
4541
4548
|
"multiple": false,
|
|
4542
4549
|
"type": "option"
|
|
4543
4550
|
},
|
|
4544
4551
|
"eslintconfig": {
|
|
4545
|
-
"
|
|
4546
|
-
"
|
|
4547
|
-
"
|
|
4548
|
-
"
|
|
4552
|
+
"description": "Specifies the location of eslintrc config to customize eslint engine.",
|
|
4553
|
+
"name": "eslintconfig",
|
|
4554
|
+
"summary": "specify the location of eslintrc config to customize eslint engine",
|
|
4555
|
+
"hasDynamicHelp": false,
|
|
4549
4556
|
"multiple": false,
|
|
4550
4557
|
"type": "option"
|
|
4551
4558
|
},
|
|
4552
4559
|
"pmdconfig": {
|
|
4553
|
-
"
|
|
4554
|
-
"
|
|
4555
|
-
"
|
|
4556
|
-
"
|
|
4560
|
+
"description": "Specifies the location of PMD rule reference XML file to customize rule selection.",
|
|
4561
|
+
"name": "pmdconfig",
|
|
4562
|
+
"summary": "specify location of PMD rule reference XML file to customize rule selection",
|
|
4563
|
+
"hasDynamicHelp": false,
|
|
4557
4564
|
"multiple": false,
|
|
4558
4565
|
"type": "option"
|
|
4559
4566
|
},
|
|
4560
4567
|
"env": {
|
|
4561
|
-
"kind": "string",
|
|
4562
|
-
"description": "[deprecated] override ESLint's default environment variables, in JSON-formatted string",
|
|
4563
|
-
"longDescription": "[deprecated] Overrides ESLint's default environmental variables, in JSON-formatted string.",
|
|
4564
4568
|
"deprecated": {
|
|
4565
|
-
"
|
|
4569
|
+
"message": "--env parameter is being deprecated, and will be removed in a future release."
|
|
4566
4570
|
},
|
|
4567
|
-
"
|
|
4571
|
+
"description": "[deprecated] Overrides ESLint's default environmental variables, in JSON-formatted string.",
|
|
4572
|
+
"name": "env",
|
|
4573
|
+
"summary": "[deprecated] override ESLint's default environment variables, in JSON-formatted string",
|
|
4574
|
+
"hasDynamicHelp": false,
|
|
4568
4575
|
"multiple": false,
|
|
4569
4576
|
"type": "option"
|
|
4570
4577
|
},
|
|
4571
4578
|
"verbose-violations": {
|
|
4572
|
-
"
|
|
4573
|
-
"
|
|
4574
|
-
"
|
|
4579
|
+
"description": "Returns retire-js violation messages details about each vulnerability, including summary, Common Vulnerabilities and Exposures (CVE), and URLs.",
|
|
4580
|
+
"name": "verbose-violations",
|
|
4581
|
+
"summary": "return retire-js violation message details",
|
|
4575
4582
|
"allowNo": false,
|
|
4576
4583
|
"type": "boolean"
|
|
4577
4584
|
}
|
|
4578
4585
|
},
|
|
4579
|
-
"
|
|
4586
|
+
"hasDynamicHelp": false,
|
|
4587
|
+
"hiddenAliases": [],
|
|
4588
|
+
"id": "scanner:run",
|
|
4589
|
+
"pluginAlias": "@salesforce/sfdx-scanner",
|
|
4590
|
+
"pluginName": "@salesforce/sfdx-scanner",
|
|
4591
|
+
"pluginType": "jit",
|
|
4592
|
+
"summary": "scan a codebase with a selection of rules",
|
|
4580
4593
|
"isESM": false,
|
|
4581
4594
|
"relativePath": [
|
|
4582
4595
|
"lib",
|
|
@@ -4593,57 +4606,37 @@
|
|
|
4593
4606
|
"scanner:rule:add": {
|
|
4594
4607
|
"aliases": [],
|
|
4595
4608
|
"args": {},
|
|
4596
|
-
"description": "
|
|
4609
|
+
"description": "Adds custom rules to Salesforce Code Analyzer's registry so that you can run them along with the built-in rules. Compile and test custom rules separately before adding them.",
|
|
4597
4610
|
"examples": [
|
|
4598
|
-
"Bundle custom PMD rules in JAR files. Follow PMD conventions, such as defining the custom rules in XML files under a `/category/` directory.\nSee PMD's documentation for more information on writing rules.\n\nThis example shows how to specify two JAR files directly.\n\t$
|
|
4611
|
+
"Bundle custom PMD rules in JAR files. Follow PMD conventions, such as defining the custom rules in XML files under a `/category/` directory.\nSee PMD's documentation for more information on writing rules.\n\nThis example shows how to specify two JAR files directly.\n\t$ <%= config.bin %> <%= command.id %> --language apex --path \"/Users/me/rules/Jar1.jar,/Users/me/rules/Jar2.jar\"\n\t\tSuccessfully added rules for apex.\n\t\t2 path(s) added:\n\t\t/Users/me/rules/Jar1.jar,/Users/me/rules/Jar2.jar\n\nThis example shows how to specify a directory containing one or more JARs, all of which are added to the registry.\n\t$ <%= config.bin %> <%= command.id %> --language apex --path \"/Users/me/rules\"\n\t\tSuccessfully added rules for apex."
|
|
4599
4612
|
],
|
|
4600
4613
|
"flags": {
|
|
4601
4614
|
"json": {
|
|
4602
|
-
"description": "
|
|
4615
|
+
"description": "Format output as json.",
|
|
4616
|
+
"helpGroup": "GLOBAL",
|
|
4603
4617
|
"name": "json",
|
|
4604
4618
|
"allowNo": false,
|
|
4605
4619
|
"type": "boolean"
|
|
4606
4620
|
},
|
|
4607
|
-
"loglevel": {
|
|
4608
|
-
"description": "logging level for this command invocation",
|
|
4609
|
-
"name": "loglevel",
|
|
4610
|
-
"required": false,
|
|
4611
|
-
"default": "warn",
|
|
4612
|
-
"hasDynamicHelp": false,
|
|
4613
|
-
"helpValue": "(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)",
|
|
4614
|
-
"multiple": false,
|
|
4615
|
-
"options": [
|
|
4616
|
-
"trace",
|
|
4617
|
-
"debug",
|
|
4618
|
-
"info",
|
|
4619
|
-
"warn",
|
|
4620
|
-
"error",
|
|
4621
|
-
"fatal",
|
|
4622
|
-
"TRACE",
|
|
4623
|
-
"DEBUG",
|
|
4624
|
-
"INFO",
|
|
4625
|
-
"WARN",
|
|
4626
|
-
"ERROR",
|
|
4627
|
-
"FATAL"
|
|
4628
|
-
],
|
|
4629
|
-
"type": "option"
|
|
4630
|
-
},
|
|
4631
4621
|
"language": {
|
|
4632
4622
|
"char": "l",
|
|
4633
|
-
"description": "
|
|
4623
|
+
"description": "Language that the custom rules are evaluated against.",
|
|
4634
4624
|
"name": "language",
|
|
4635
4625
|
"required": true,
|
|
4626
|
+
"summary": "language that the custom rules are evaluated against",
|
|
4636
4627
|
"hasDynamicHelp": false,
|
|
4637
4628
|
"multiple": false,
|
|
4638
4629
|
"type": "option"
|
|
4639
4630
|
},
|
|
4640
4631
|
"path": {
|
|
4641
4632
|
"char": "p",
|
|
4642
|
-
"description": "
|
|
4633
|
+
"description": "One or more paths (such as a directory or JAR file) to custom rule definitions. Specify multiple values as a comma-separated list.",
|
|
4643
4634
|
"name": "path",
|
|
4644
4635
|
"required": true,
|
|
4636
|
+
"summary": "one or more paths (such as a directory or JAR file) to custom rule definitions",
|
|
4637
|
+
"delimiter": ",",
|
|
4645
4638
|
"hasDynamicHelp": false,
|
|
4646
|
-
"multiple":
|
|
4639
|
+
"multiple": true,
|
|
4647
4640
|
"type": "option"
|
|
4648
4641
|
}
|
|
4649
4642
|
},
|
|
@@ -4654,30 +4647,7 @@
|
|
|
4654
4647
|
"pluginName": "@salesforce/sfdx-scanner",
|
|
4655
4648
|
"pluginType": "jit",
|
|
4656
4649
|
"strict": true,
|
|
4657
|
-
"
|
|
4658
|
-
"longDescription": "Adds custom rules to Salesforce Code Analyzer's registry so that you can run them along with the built-in rules. Compile and test custom rules separately before adding them.",
|
|
4659
|
-
"flagsConfig": {
|
|
4660
|
-
"language": {
|
|
4661
|
-
"kind": "string",
|
|
4662
|
-
"char": "l",
|
|
4663
|
-
"description": "language that the custom rules are evaluated against",
|
|
4664
|
-
"longDescription": "Language that the custom rules are evaluated against.",
|
|
4665
|
-
"required": true,
|
|
4666
|
-
"input": [],
|
|
4667
|
-
"multiple": false,
|
|
4668
|
-
"type": "option"
|
|
4669
|
-
},
|
|
4670
|
-
"path": {
|
|
4671
|
-
"kind": "array",
|
|
4672
|
-
"char": "p",
|
|
4673
|
-
"description": "one or more paths (such as a directory or JAR file) to custom rule definitions",
|
|
4674
|
-
"longDescription": "One or more paths (such as a directory or JAR file) to custom rule definitions. Specify multiple values as a comma-separated list.",
|
|
4675
|
-
"required": true,
|
|
4676
|
-
"input": [],
|
|
4677
|
-
"multiple": false,
|
|
4678
|
-
"type": "option"
|
|
4679
|
-
}
|
|
4680
|
-
},
|
|
4650
|
+
"summary": "add custom rules to Salesforce Code Analyzer's registry",
|
|
4681
4651
|
"isESM": false,
|
|
4682
4652
|
"relativePath": [
|
|
4683
4653
|
"lib",
|
|
@@ -4699,53 +4669,31 @@
|
|
|
4699
4669
|
"scanner:rule:describe": {
|
|
4700
4670
|
"aliases": [],
|
|
4701
4671
|
"args": {},
|
|
4702
|
-
"description": "
|
|
4672
|
+
"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.",
|
|
4703
4673
|
"examples": [
|
|
4704
|
-
"$
|
|
4674
|
+
"$ <%= config.bin %> <%= command.id %> --rulename ExampleRule\n\tname: AvoidWithStatement\n\tcategories: Best Practices\n\trulesets: Controversial Ecmascript\n\tlanguages: javascript\n\tdescription: Avoid using with - it's bad news\n\tmessage: Avoid using with - it's bad news"
|
|
4705
4675
|
],
|
|
4706
4676
|
"flags": {
|
|
4707
4677
|
"json": {
|
|
4708
|
-
"description": "
|
|
4678
|
+
"description": "Format output as json.",
|
|
4679
|
+
"helpGroup": "GLOBAL",
|
|
4709
4680
|
"name": "json",
|
|
4710
4681
|
"allowNo": false,
|
|
4711
4682
|
"type": "boolean"
|
|
4712
4683
|
},
|
|
4713
|
-
"loglevel": {
|
|
4714
|
-
"description": "logging level for this command invocation",
|
|
4715
|
-
"name": "loglevel",
|
|
4716
|
-
"required": false,
|
|
4717
|
-
"default": "warn",
|
|
4718
|
-
"hasDynamicHelp": false,
|
|
4719
|
-
"helpValue": "(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)",
|
|
4720
|
-
"multiple": false,
|
|
4721
|
-
"options": [
|
|
4722
|
-
"trace",
|
|
4723
|
-
"debug",
|
|
4724
|
-
"info",
|
|
4725
|
-
"warn",
|
|
4726
|
-
"error",
|
|
4727
|
-
"fatal",
|
|
4728
|
-
"TRACE",
|
|
4729
|
-
"DEBUG",
|
|
4730
|
-
"INFO",
|
|
4731
|
-
"WARN",
|
|
4732
|
-
"ERROR",
|
|
4733
|
-
"FATAL"
|
|
4734
|
-
],
|
|
4735
|
-
"type": "option"
|
|
4736
|
-
},
|
|
4737
4684
|
"rulename": {
|
|
4738
4685
|
"char": "n",
|
|
4739
|
-
"description": "
|
|
4686
|
+
"description": "The name of the rule.",
|
|
4740
4687
|
"name": "rulename",
|
|
4741
4688
|
"required": true,
|
|
4689
|
+
"summary": "the name of the rule",
|
|
4742
4690
|
"hasDynamicHelp": false,
|
|
4743
4691
|
"multiple": false,
|
|
4744
4692
|
"type": "option"
|
|
4745
4693
|
},
|
|
4746
4694
|
"verbose": {
|
|
4747
|
-
"description": "emit additional command output to stdout",
|
|
4748
4695
|
"name": "verbose",
|
|
4696
|
+
"summary": "emit additional command output to stdout",
|
|
4749
4697
|
"allowNo": false,
|
|
4750
4698
|
"type": "boolean"
|
|
4751
4699
|
}
|
|
@@ -4757,27 +4705,7 @@
|
|
|
4757
4705
|
"pluginName": "@salesforce/sfdx-scanner",
|
|
4758
4706
|
"pluginType": "jit",
|
|
4759
4707
|
"strict": true,
|
|
4760
|
-
"
|
|
4761
|
-
"longDescription": "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.",
|
|
4762
|
-
"flagsConfig": {
|
|
4763
|
-
"rulename": {
|
|
4764
|
-
"kind": "string",
|
|
4765
|
-
"char": "n",
|
|
4766
|
-
"description": "the name of the rule",
|
|
4767
|
-
"longDescription": "The name of the rule.",
|
|
4768
|
-
"required": true,
|
|
4769
|
-
"input": [],
|
|
4770
|
-
"multiple": false,
|
|
4771
|
-
"type": "option"
|
|
4772
|
-
},
|
|
4773
|
-
"verbose": {
|
|
4774
|
-
"type": "boolean",
|
|
4775
|
-
"kind": "boolean",
|
|
4776
|
-
"description": "emit additional command output to stdout",
|
|
4777
|
-
"longDescription": "Emit additional command output to stdout.",
|
|
4778
|
-
"allowNo": false
|
|
4779
|
-
}
|
|
4780
|
-
},
|
|
4708
|
+
"summary": "provide detailed information about a rule",
|
|
4781
4709
|
"isESM": false,
|
|
4782
4710
|
"relativePath": [
|
|
4783
4711
|
"lib",
|
|
@@ -4799,80 +4727,75 @@
|
|
|
4799
4727
|
"scanner:rule:list": {
|
|
4800
4728
|
"aliases": [],
|
|
4801
4729
|
"args": {},
|
|
4802
|
-
"description": "
|
|
4730
|
+
"description": "Lists all the rules available in the catalog. You can filter the output to view a smaller set of rules. To get more information about a specific rule, use the `scanner rule describe` command.",
|
|
4803
4731
|
"examples": [
|
|
4804
|
-
"
|
|
4732
|
+
"This example invokes the command without filter criteria, which returns all rules.\n\t$ <%= config.bin %> <%= command.id %>\n\nThis example returns all rules for Apex OR Javascript. Values supplied to a single filter are handled with a logical OR.\n\t$ <%= config.bin %> <%= command.id %> --language apex,javascript\n\nThis example returns all rules except those in the Design or Best Practices categories. Exclude categories by specifying the negation operator and enclosing the values in single quotes.\n\t$ <%= config.bin %> <%= command.id %> --category '!Design,!Best Practices'\n\nThis example returns all rules that target Apex OR Javascript, AND are members of the Braces OR Security rulesets.\nThe different filters are combined with a logical AND.\n\t$ <%= config.bin %> <%= command.id %> --language apex,javascript --ruleset Braces,Security"
|
|
4805
4733
|
],
|
|
4806
4734
|
"flags": {
|
|
4807
4735
|
"json": {
|
|
4808
|
-
"description": "
|
|
4736
|
+
"description": "Format output as json.",
|
|
4737
|
+
"helpGroup": "GLOBAL",
|
|
4809
4738
|
"name": "json",
|
|
4810
4739
|
"allowNo": false,
|
|
4811
4740
|
"type": "boolean"
|
|
4812
4741
|
},
|
|
4813
|
-
"loglevel": {
|
|
4814
|
-
"description": "logging level for this command invocation",
|
|
4815
|
-
"name": "loglevel",
|
|
4816
|
-
"required": false,
|
|
4817
|
-
"default": "warn",
|
|
4818
|
-
"hasDynamicHelp": false,
|
|
4819
|
-
"helpValue": "(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)",
|
|
4820
|
-
"multiple": false,
|
|
4821
|
-
"options": [
|
|
4822
|
-
"trace",
|
|
4823
|
-
"debug",
|
|
4824
|
-
"info",
|
|
4825
|
-
"warn",
|
|
4826
|
-
"error",
|
|
4827
|
-
"fatal",
|
|
4828
|
-
"TRACE",
|
|
4829
|
-
"DEBUG",
|
|
4830
|
-
"INFO",
|
|
4831
|
-
"WARN",
|
|
4832
|
-
"ERROR",
|
|
4833
|
-
"FATAL"
|
|
4834
|
-
],
|
|
4835
|
-
"type": "option"
|
|
4836
|
-
},
|
|
4837
4742
|
"verbose": {
|
|
4838
|
-
"description": "emit additional command output to stdout",
|
|
4839
4743
|
"name": "verbose",
|
|
4744
|
+
"summary": "emit additional command output to stdout",
|
|
4840
4745
|
"allowNo": false,
|
|
4841
4746
|
"type": "boolean"
|
|
4842
4747
|
},
|
|
4843
4748
|
"category": {
|
|
4844
4749
|
"char": "c",
|
|
4845
|
-
"description": "
|
|
4750
|
+
"description": "Selects rules by category. Enter multiple values as a comma-separated list.",
|
|
4846
4751
|
"name": "category",
|
|
4752
|
+
"summary": "select rules by category",
|
|
4753
|
+
"delimiter": ",",
|
|
4847
4754
|
"hasDynamicHelp": false,
|
|
4848
|
-
"multiple":
|
|
4755
|
+
"multiple": true,
|
|
4849
4756
|
"type": "option"
|
|
4850
4757
|
},
|
|
4851
4758
|
"ruleset": {
|
|
4852
4759
|
"char": "r",
|
|
4853
4760
|
"deprecated": {
|
|
4854
|
-
"
|
|
4761
|
+
"message": "The 'ruleset' command parameter is deprecated. Use 'category' instead"
|
|
4855
4762
|
},
|
|
4856
|
-
"description": "[deprecated]
|
|
4763
|
+
"description": "[deprecated] Selects rules by ruleset. Enter multiple values as a comma-separated list.",
|
|
4857
4764
|
"name": "ruleset",
|
|
4765
|
+
"summary": "[deprecated] select rules by ruleset",
|
|
4766
|
+
"delimiter": ",",
|
|
4858
4767
|
"hasDynamicHelp": false,
|
|
4859
|
-
"multiple":
|
|
4768
|
+
"multiple": true,
|
|
4860
4769
|
"type": "option"
|
|
4861
4770
|
},
|
|
4862
4771
|
"language": {
|
|
4863
4772
|
"char": "l",
|
|
4864
|
-
"description": "
|
|
4773
|
+
"description": "Selects rules by language. Enter multiple values as a comma-separated list.",
|
|
4865
4774
|
"name": "language",
|
|
4775
|
+
"summary": "select rules by language",
|
|
4776
|
+
"delimiter": ",",
|
|
4866
4777
|
"hasDynamicHelp": false,
|
|
4867
|
-
"multiple":
|
|
4778
|
+
"multiple": true,
|
|
4868
4779
|
"type": "option"
|
|
4869
4780
|
},
|
|
4870
4781
|
"engine": {
|
|
4871
4782
|
"char": "e",
|
|
4872
|
-
"description": "
|
|
4783
|
+
"description": "Selects rules by engine. Enter multiple engines as a comma-separated list.",
|
|
4873
4784
|
"name": "engine",
|
|
4785
|
+
"summary": "select rules by engine",
|
|
4786
|
+
"delimiter": ",",
|
|
4874
4787
|
"hasDynamicHelp": false,
|
|
4875
|
-
"multiple":
|
|
4788
|
+
"multiple": true,
|
|
4789
|
+
"options": [
|
|
4790
|
+
"eslint",
|
|
4791
|
+
"eslint-lwc",
|
|
4792
|
+
"eslint-typescript",
|
|
4793
|
+
"pmd",
|
|
4794
|
+
"pmd-appexchange",
|
|
4795
|
+
"retire-js",
|
|
4796
|
+
"cpd",
|
|
4797
|
+
"sfge"
|
|
4798
|
+
],
|
|
4876
4799
|
"type": "option"
|
|
4877
4800
|
}
|
|
4878
4801
|
},
|
|
@@ -4883,56 +4806,7 @@
|
|
|
4883
4806
|
"pluginName": "@salesforce/sfdx-scanner",
|
|
4884
4807
|
"pluginType": "jit",
|
|
4885
4808
|
"strict": true,
|
|
4886
|
-
"
|
|
4887
|
-
"longDescription": "Lists all the rules available in the catalog. You can filter the output to view a smaller set of rules. To get more information about a specific rule, use the `scanner:rule:describe` command.",
|
|
4888
|
-
"flagsConfig": {
|
|
4889
|
-
"verbose": {
|
|
4890
|
-
"type": "boolean",
|
|
4891
|
-
"kind": "boolean",
|
|
4892
|
-
"description": "emit additional command output to stdout",
|
|
4893
|
-
"longDescription": "Emit additional command output to stdout.",
|
|
4894
|
-
"allowNo": false
|
|
4895
|
-
},
|
|
4896
|
-
"category": {
|
|
4897
|
-
"kind": "array",
|
|
4898
|
-
"char": "c",
|
|
4899
|
-
"description": "select rules by category",
|
|
4900
|
-
"longDescription": "Selects rules by category. Enter multiple values as a comma-separated list.",
|
|
4901
|
-
"input": [],
|
|
4902
|
-
"multiple": false,
|
|
4903
|
-
"type": "option"
|
|
4904
|
-
},
|
|
4905
|
-
"ruleset": {
|
|
4906
|
-
"kind": "array",
|
|
4907
|
-
"char": "r",
|
|
4908
|
-
"deprecated": {
|
|
4909
|
-
"messageOverride": "The 'ruleset' command parameter is deprecated. Use 'category' instead"
|
|
4910
|
-
},
|
|
4911
|
-
"description": "[deprecated] select rules by ruleset",
|
|
4912
|
-
"longDescription": "[deprecated] Selects rules by ruleset. Enter multiple values as a comma-separated list.",
|
|
4913
|
-
"input": [],
|
|
4914
|
-
"multiple": false,
|
|
4915
|
-
"type": "option"
|
|
4916
|
-
},
|
|
4917
|
-
"language": {
|
|
4918
|
-
"kind": "array",
|
|
4919
|
-
"char": "l",
|
|
4920
|
-
"description": "select rules by language",
|
|
4921
|
-
"longDescription": "Selects rules by language. Enter multiple values as a comma-separated list.",
|
|
4922
|
-
"input": [],
|
|
4923
|
-
"multiple": false,
|
|
4924
|
-
"type": "option"
|
|
4925
|
-
},
|
|
4926
|
-
"engine": {
|
|
4927
|
-
"kind": "array",
|
|
4928
|
-
"char": "e",
|
|
4929
|
-
"description": "select rules by engine",
|
|
4930
|
-
"longDescription": "Selects rules by engine. Enter multiple engines as a comma-separated list.",
|
|
4931
|
-
"input": [],
|
|
4932
|
-
"multiple": false,
|
|
4933
|
-
"type": "option"
|
|
4934
|
-
}
|
|
4935
|
-
},
|
|
4809
|
+
"summary": "list basic information about all rules matching provided criteria",
|
|
4936
4810
|
"isESM": false,
|
|
4937
4811
|
"relativePath": [
|
|
4938
4812
|
"lib",
|
|
@@ -4954,60 +4828,40 @@
|
|
|
4954
4828
|
"scanner:rule:remove": {
|
|
4955
4829
|
"aliases": [],
|
|
4956
4830
|
"args": {},
|
|
4957
|
-
"description": "
|
|
4831
|
+
"description": "Removes custom rules from the registry of available rules. 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.",
|
|
4958
4832
|
"examples": [
|
|
4959
|
-
"This example runs the command without arguments to see a list of registered custom paths.\n\t$
|
|
4833
|
+
"This example runs the command without arguments to see a list of registered custom paths.\n\t$ <%= config.bin %> <%= command.id %>\n\nThis example uses the --path parameter to deregister the rules defined in somerules.jar and any JARs/XMLs contained in the rules folder.\n\t$ <%= config.bin %> <%= command.id %> --path \"~/path/to/somerules.jar,~/path/to/folder/containing/rules\"\n\nThis example uses the --force flag to bypass the confirmation prompt, removing all rules defined in somerules.jar.\nBy 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\t$ <%= config.bin %> <%= command.id %> --force --path \"~/path/to/somerules.jar\""
|
|
4960
4834
|
],
|
|
4961
4835
|
"flags": {
|
|
4962
4836
|
"json": {
|
|
4963
|
-
"description": "
|
|
4837
|
+
"description": "Format output as json.",
|
|
4838
|
+
"helpGroup": "GLOBAL",
|
|
4964
4839
|
"name": "json",
|
|
4965
4840
|
"allowNo": false,
|
|
4966
4841
|
"type": "boolean"
|
|
4967
4842
|
},
|
|
4968
|
-
"loglevel": {
|
|
4969
|
-
"description": "logging level for this command invocation",
|
|
4970
|
-
"name": "loglevel",
|
|
4971
|
-
"required": false,
|
|
4972
|
-
"default": "warn",
|
|
4973
|
-
"hasDynamicHelp": false,
|
|
4974
|
-
"helpValue": "(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)",
|
|
4975
|
-
"multiple": false,
|
|
4976
|
-
"options": [
|
|
4977
|
-
"trace",
|
|
4978
|
-
"debug",
|
|
4979
|
-
"info",
|
|
4980
|
-
"warn",
|
|
4981
|
-
"error",
|
|
4982
|
-
"fatal",
|
|
4983
|
-
"TRACE",
|
|
4984
|
-
"DEBUG",
|
|
4985
|
-
"INFO",
|
|
4986
|
-
"WARN",
|
|
4987
|
-
"ERROR",
|
|
4988
|
-
"FATAL"
|
|
4989
|
-
],
|
|
4990
|
-
"type": "option"
|
|
4991
|
-
},
|
|
4992
4843
|
"verbose": {
|
|
4993
|
-
"description": "emit additional command output to stdout",
|
|
4994
4844
|
"name": "verbose",
|
|
4845
|
+
"summary": "emit additional command output to stdout",
|
|
4995
4846
|
"allowNo": false,
|
|
4996
4847
|
"type": "boolean"
|
|
4997
4848
|
},
|
|
4998
4849
|
"force": {
|
|
4999
4850
|
"char": "f",
|
|
5000
|
-
"description": "
|
|
4851
|
+
"description": "Bypasses the confirmation prompt and immediately removes the rules.",
|
|
5001
4852
|
"name": "force",
|
|
4853
|
+
"summary": "bypass the confirmation prompt and immediately remove the rules",
|
|
5002
4854
|
"allowNo": false,
|
|
5003
4855
|
"type": "boolean"
|
|
5004
4856
|
},
|
|
5005
4857
|
"path": {
|
|
5006
4858
|
"char": "p",
|
|
5007
|
-
"description": "
|
|
4859
|
+
"description": "One or more paths to remove. Specify multiple values with a comma-separated list.",
|
|
5008
4860
|
"name": "path",
|
|
4861
|
+
"summary": "one or more paths to remove",
|
|
4862
|
+
"delimiter": ",",
|
|
5009
4863
|
"hasDynamicHelp": false,
|
|
5010
|
-
"multiple":
|
|
4864
|
+
"multiple": true,
|
|
5011
4865
|
"type": "option"
|
|
5012
4866
|
}
|
|
5013
4867
|
},
|
|
@@ -5018,34 +4872,7 @@
|
|
|
5018
4872
|
"pluginName": "@salesforce/sfdx-scanner",
|
|
5019
4873
|
"pluginType": "jit",
|
|
5020
4874
|
"strict": true,
|
|
5021
|
-
"
|
|
5022
|
-
"longDescription": "Removes custom rules from the registry of available rules. 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.",
|
|
5023
|
-
"flagsConfig": {
|
|
5024
|
-
"verbose": {
|
|
5025
|
-
"type": "boolean",
|
|
5026
|
-
"kind": "boolean",
|
|
5027
|
-
"description": "emit additional command output to stdout",
|
|
5028
|
-
"longDescription": "Emit additional command output to stdout.",
|
|
5029
|
-
"allowNo": false
|
|
5030
|
-
},
|
|
5031
|
-
"force": {
|
|
5032
|
-
"kind": "boolean",
|
|
5033
|
-
"char": "f",
|
|
5034
|
-
"description": "bypass the confirmation prompt and immediately remove the rules",
|
|
5035
|
-
"longDescription": "Bypasses the confirmation prompt and immediately removes the rules.",
|
|
5036
|
-
"allowNo": false,
|
|
5037
|
-
"type": "boolean"
|
|
5038
|
-
},
|
|
5039
|
-
"path": {
|
|
5040
|
-
"kind": "array",
|
|
5041
|
-
"char": "p",
|
|
5042
|
-
"description": "one or more paths to remove",
|
|
5043
|
-
"longDescription": "One or more paths to remove. Specify multiple values with a comma-separated list.",
|
|
5044
|
-
"input": [],
|
|
5045
|
-
"multiple": false,
|
|
5046
|
-
"type": "option"
|
|
5047
|
-
}
|
|
5048
|
-
},
|
|
4875
|
+
"summary": "remove custom rules from the registry of available rules",
|
|
5049
4876
|
"isESM": false,
|
|
5050
4877
|
"relativePath": [
|
|
5051
4878
|
"lib",
|
|
@@ -5067,36 +4894,34 @@
|
|
|
5067
4894
|
"scanner:run:dfa": {
|
|
5068
4895
|
"aliases": [],
|
|
5069
4896
|
"args": {},
|
|
5070
|
-
"description": "
|
|
4897
|
+
"description": "Scans codebase with all DFA rules by default.\n\tSpecify the format of output and print results directly or as contents of a file that you provide with --outfile flag.",
|
|
5071
4898
|
"examples": [
|
|
5072
|
-
"The paths specified for --projectdir must contain all files specified through --target cumulatively.\n\t$
|
|
4899
|
+
"The paths specified for --projectdir must contain all files specified through --target cumulatively.\n\t$ <%= config.bin %> <%= command.id %> --target \"./myproject/main/default/classes/*.cls\" --projectdir \"./myproject/\"\n\t$ <%= config.bin %> <%= command.id %> --target \"./**/*.cls\" --projectdir \"./\"\n\t$ <%= 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\t$ <%= 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:\nUnix example:\n\t$ <%= config.bin %> <%= command.id %> --target \"./**/*.cls,!./**/IgnoreMe.cls\" ...\nWindows example:\n\t$ <%= 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\t$ <%= 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\t$ <%= 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\t$ <%= 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\t$ <%= 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\t$ <%= 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.\nThe example overrides the system's default heap space allocation to 8 GB and decreases chances of encountering OutOfMemory error.\n\t$ <%= config.bin %> <%= command.id %> --sfgejvmargs \"-Xmx8g\" ...\nUse --with-pilot to allow execution of pilot rules:\nThis example allows pilot rules in the \"Performance\" category to execute.\n\t$ <%= config.bin %> <%= command.id %> --category 'Performance' --with-pilot ..."
|
|
5073
4900
|
],
|
|
5074
|
-
"flags": {
|
|
5075
|
-
"hasDynamicHelp": false,
|
|
5076
|
-
"hiddenAliases": [],
|
|
5077
|
-
"id": "scanner:run:dfa",
|
|
5078
|
-
"pluginAlias": "@salesforce/sfdx-scanner",
|
|
5079
|
-
"pluginName": "@salesforce/sfdx-scanner",
|
|
5080
|
-
"pluginType": "jit",
|
|
5081
|
-
"flagsConfig": {
|
|
4901
|
+
"flags": {
|
|
5082
4902
|
"verbose": {
|
|
5083
|
-
"
|
|
4903
|
+
"name": "verbose",
|
|
4904
|
+
"summary": "emit additional command output to stdout",
|
|
4905
|
+
"allowNo": false,
|
|
4906
|
+
"type": "boolean"
|
|
5084
4907
|
},
|
|
5085
4908
|
"category": {
|
|
5086
|
-
"kind": "array",
|
|
5087
4909
|
"char": "c",
|
|
5088
|
-
"description": "
|
|
5089
|
-
"
|
|
5090
|
-
"
|
|
5091
|
-
"
|
|
4910
|
+
"description": "One or more categories of rules to run. Specify multiple values as a comma-separated list.",
|
|
4911
|
+
"name": "category",
|
|
4912
|
+
"summary": "one or more categories of rules to run",
|
|
4913
|
+
"delimiter": ",",
|
|
4914
|
+
"hasDynamicHelp": false,
|
|
4915
|
+
"multiple": true,
|
|
5092
4916
|
"type": "option"
|
|
5093
4917
|
},
|
|
5094
4918
|
"format": {
|
|
5095
|
-
"kind": "enum",
|
|
5096
|
-
"helpValue": "(csv|html|json|junit|sarif|table|xml)",
|
|
5097
4919
|
"char": "f",
|
|
5098
|
-
"description": "
|
|
5099
|
-
"
|
|
4920
|
+
"description": "Specifies results output format written directly to the console.",
|
|
4921
|
+
"name": "format",
|
|
4922
|
+
"summary": "specify results output format",
|
|
4923
|
+
"hasDynamicHelp": false,
|
|
4924
|
+
"multiple": false,
|
|
5100
4925
|
"options": [
|
|
5101
4926
|
"csv",
|
|
5102
4927
|
"html",
|
|
@@ -5106,111 +4931,114 @@
|
|
|
5106
4931
|
"table",
|
|
5107
4932
|
"xml"
|
|
5108
4933
|
],
|
|
5109
|
-
"input": [],
|
|
5110
|
-
"multiple": false,
|
|
5111
4934
|
"type": "option"
|
|
5112
4935
|
},
|
|
5113
4936
|
"outfile": {
|
|
5114
|
-
"kind": "string",
|
|
5115
4937
|
"char": "o",
|
|
5116
|
-
"description": "
|
|
5117
|
-
"
|
|
5118
|
-
"
|
|
4938
|
+
"description": "Writes output to a file.",
|
|
4939
|
+
"name": "outfile",
|
|
4940
|
+
"summary": "write output to a file",
|
|
4941
|
+
"hasDynamicHelp": false,
|
|
5119
4942
|
"multiple": false,
|
|
5120
4943
|
"type": "option"
|
|
5121
4944
|
},
|
|
5122
4945
|
"severity-threshold": {
|
|
5123
|
-
"kind": "integer",
|
|
5124
4946
|
"char": "s",
|
|
5125
|
-
"description": "
|
|
5126
|
-
"longDescription": "Throws an error when violations are found with equal or greater severity than the provided value. 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.",
|
|
4947
|
+
"description": "Throws an error when violations are found with equal or greater severity than the provided value. 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.",
|
|
5127
4948
|
"exclusive": [
|
|
5128
4949
|
"json"
|
|
5129
4950
|
],
|
|
5130
|
-
"
|
|
5131
|
-
"
|
|
5132
|
-
"
|
|
4951
|
+
"name": "severity-threshold",
|
|
4952
|
+
"summary": "throw an error when a violation threshold is reached, the --normalize-severity is invoked, and severity levels are reset to the baseline",
|
|
4953
|
+
"hasDynamicHelp": false,
|
|
5133
4954
|
"multiple": false,
|
|
5134
4955
|
"type": "option"
|
|
5135
4956
|
},
|
|
5136
4957
|
"normalize-severity": {
|
|
5137
|
-
"
|
|
5138
|
-
"
|
|
5139
|
-
"
|
|
4958
|
+
"description": "Returns normalized severity 1 (high), 2 (moderate), and 3 (low), and the engine-specific severity. For the html option, the normalized severity is displayed instead of the engine severity.",
|
|
4959
|
+
"name": "normalize-severity",
|
|
4960
|
+
"summary": "return normalized severity 1 (high), 2 (moderate), and 3 (low), and the engine-specific severity",
|
|
5140
4961
|
"allowNo": false,
|
|
5141
4962
|
"type": "boolean"
|
|
5142
4963
|
},
|
|
5143
4964
|
"projectdir": {
|
|
5144
|
-
"kind": "array",
|
|
5145
4965
|
"char": "p",
|
|
5146
|
-
"description": "
|
|
5147
|
-
"
|
|
5148
|
-
"
|
|
4966
|
+
"description": "Provides the relative or absolute root project directory used to set the context for Graph Engine's analysis. Project directory must be a path, not a glob. Specify multiple values as a comma-separated list.",
|
|
4967
|
+
"name": "projectdir",
|
|
4968
|
+
"summary": "provide root directory of project",
|
|
4969
|
+
"hasDynamicHelp": false,
|
|
5149
4970
|
"multiple": false,
|
|
5150
4971
|
"type": "option"
|
|
5151
4972
|
},
|
|
5152
4973
|
"with-pilot": {
|
|
5153
|
-
"
|
|
5154
|
-
"
|
|
5155
|
-
"
|
|
4974
|
+
"description": "Allows pilot rules to execute.",
|
|
4975
|
+
"name": "with-pilot",
|
|
4976
|
+
"summary": "allow pilot rules to execute",
|
|
5156
4977
|
"allowNo": false,
|
|
5157
4978
|
"type": "boolean"
|
|
5158
4979
|
},
|
|
5159
4980
|
"target": {
|
|
5160
|
-
"kind": "array",
|
|
5161
4981
|
"char": "t",
|
|
5162
|
-
"description": "
|
|
5163
|
-
"
|
|
4982
|
+
"description": "Returns the source code location. Use glob patterns or specify individual methods with #-syntax. Multiple values are specified as a comma-separated list.",
|
|
4983
|
+
"name": "target",
|
|
5164
4984
|
"required": true,
|
|
5165
|
-
"
|
|
5166
|
-
"
|
|
4985
|
+
"summary": "return location of source code",
|
|
4986
|
+
"delimiter": ",",
|
|
4987
|
+
"hasDynamicHelp": false,
|
|
4988
|
+
"multiple": true,
|
|
5167
4989
|
"type": "option"
|
|
5168
4990
|
},
|
|
5169
4991
|
"rule-thread-count": {
|
|
5170
|
-
"
|
|
5171
|
-
"description": "specify number of threads that evaluate DFA rules. Alternatively, set value using environment variable `SFGE_RULE_THREAD_COUNT`. Default is 4",
|
|
5172
|
-
"longDescription": "Specifies number of rule evaluation threads, or how many entrypoints can be evaluated concurrently. Inherits value from SFGE_RULE_THREAD_COUNT env-var, if set. Default is 4.",
|
|
4992
|
+
"description": "Specifies number of rule evaluation threads, or how many entrypoints can be evaluated concurrently. Inherits value from SFGE_RULE_THREAD_COUNT env-var, if set. Default is 4.",
|
|
5173
4993
|
"env": "SFGE_RULE_THREAD_COUNT",
|
|
5174
|
-
"
|
|
4994
|
+
"name": "rule-thread-count",
|
|
4995
|
+
"summary": "specify number of threads that evaluate DFA rules. Alternatively, set value using environment variable `SFGE_RULE_THREAD_COUNT`. Default is 4",
|
|
4996
|
+
"hasDynamicHelp": false,
|
|
5175
4997
|
"multiple": false,
|
|
5176
4998
|
"type": "option"
|
|
5177
4999
|
},
|
|
5178
5000
|
"rule-thread-timeout": {
|
|
5179
|
-
"
|
|
5180
|
-
"description": "specify timeout for individual rule threads in milliseconds. Alternatively, set the timeout value using environment variable `SFGE_RULE_THREAD_TIMEOUT`. Default: 90000 ms",
|
|
5181
|
-
"longDescription": "Specifies time limit for evaluating a single entrypoint in milliseconds. Inherits value from SFGE_RULE_THREAD_TIMEOUT env-var if set. Default is 900,000 ms, or 15 minutes.",
|
|
5001
|
+
"description": "Specifies time limit for evaluating a single entrypoint in milliseconds. Inherits value from SFGE_RULE_THREAD_TIMEOUT env-var if set. Default is 900,000 ms, or 15 minutes.",
|
|
5182
5002
|
"env": "SFGE_RULE_THREAD_TIMEOUT",
|
|
5183
|
-
"
|
|
5003
|
+
"name": "rule-thread-timeout",
|
|
5004
|
+
"summary": "specify timeout for individual rule threads in milliseconds. Alternatively, set the timeout value using environment variable `SFGE_RULE_THREAD_TIMEOUT`. Default: 90000 ms",
|
|
5005
|
+
"hasDynamicHelp": false,
|
|
5184
5006
|
"multiple": false,
|
|
5185
5007
|
"type": "option"
|
|
5186
5008
|
},
|
|
5187
5009
|
"rule-disable-warning-violation": {
|
|
5188
|
-
"
|
|
5189
|
-
"
|
|
5190
|
-
"
|
|
5010
|
+
"description": "Disables warning violations, such as those on StripInaccessible READ access, to get only high-severity violations (default: false). Inherits value from SFGE_RULE_DISABLE_WARNING_VIOLATION env-var if set.",
|
|
5011
|
+
"name": "rule-disable-warning-violation",
|
|
5012
|
+
"summary": "disable warning violations from Salesforce Graph Engine. Alternatively, set value using environment variable `SFGE_RULE_DISABLE_WARNING_VIOLATION`",
|
|
5191
5013
|
"allowNo": false,
|
|
5192
5014
|
"type": "boolean"
|
|
5193
5015
|
},
|
|
5194
5016
|
"sfgejvmargs": {
|
|
5195
|
-
"
|
|
5196
|
-
"description": "specify Java Virtual Machine (JVM) arguments to optimize Salesforce Graph Engine execution to your system (optional)",
|
|
5197
|
-
"longDescription": "Specifies Java Virtual Machine arguments to override system defaults while executing Salesforce Graph Engine. For multiple arguments, add them to the same string separated by space.",
|
|
5017
|
+
"description": "Specifies Java Virtual Machine arguments to override system defaults while executing Salesforce Graph Engine. For multiple arguments, add them to the same string separated by space.",
|
|
5198
5018
|
"env": "SFGE_JVM_ARGS",
|
|
5199
|
-
"
|
|
5019
|
+
"name": "sfgejvmargs",
|
|
5020
|
+
"summary": "specify Java Virtual Machine (JVM) arguments to optimize Salesforce Graph Engine execution to your system (optional)",
|
|
5021
|
+
"hasDynamicHelp": false,
|
|
5200
5022
|
"multiple": false,
|
|
5201
5023
|
"type": "option"
|
|
5202
5024
|
},
|
|
5203
5025
|
"pathexplimit": {
|
|
5204
|
-
"
|
|
5205
|
-
"description": "specify a path expansion upper boundary to limit the complexity of code that Graph Engine analyzes. Alternatively, set the value using environment variable `SFGE_PATH_EXPANSION_LIMIT`",
|
|
5206
|
-
"longDescription": "Specifies a path expansion upper boundary to limit the complexity of code Graph Engine analyzes before failing fast. Set the value to -1 to remove any upper boundary. --pathexplimit inherits value from SFGE_PATH_EXPANSION_LIMIT env-var, if set. Its default value is derived from JVM heap space allocation.",
|
|
5026
|
+
"description": "Specifies a path expansion upper boundary to limit the complexity of code Graph Engine analyzes before failing fast. Set the value to -1 to remove any upper boundary. --pathexplimit inherits value from SFGE_PATH_EXPANSION_LIMIT env-var, if set. Its default value is derived from JVM heap space allocation.",
|
|
5207
5027
|
"env": "SFGE_PATH_EXPANSION_LIMIT",
|
|
5208
|
-
"
|
|
5028
|
+
"name": "pathexplimit",
|
|
5029
|
+
"summary": "specify a path expansion upper boundary to limit the complexity of code that Graph Engine analyzes. Alternatively, set the value using environment variable `SFGE_PATH_EXPANSION_LIMIT`",
|
|
5030
|
+
"hasDynamicHelp": false,
|
|
5209
5031
|
"multiple": false,
|
|
5210
5032
|
"type": "option"
|
|
5211
5033
|
}
|
|
5212
5034
|
},
|
|
5213
|
-
"
|
|
5035
|
+
"hasDynamicHelp": false,
|
|
5036
|
+
"hiddenAliases": [],
|
|
5037
|
+
"id": "scanner:run:dfa",
|
|
5038
|
+
"pluginAlias": "@salesforce/sfdx-scanner",
|
|
5039
|
+
"pluginName": "@salesforce/sfdx-scanner",
|
|
5040
|
+
"pluginType": "jit",
|
|
5041
|
+
"summary": "scan codebase with all DFA rules",
|
|
5214
5042
|
"isESM": false,
|
|
5215
5043
|
"relativePath": [
|
|
5216
5044
|
"lib",
|
|
@@ -5230,5 +5058,5 @@
|
|
|
5230
5058
|
]
|
|
5231
5059
|
}
|
|
5232
5060
|
},
|
|
5233
|
-
"version": "2.
|
|
5061
|
+
"version": "2.25.1"
|
|
5234
5062
|
}
|