@salesforce/cli 2.16.6 → 2.17.0

package/oclif.manifest.json

@@ -2939,6 +2939,13 @@
           "description": "The directory containing metadata that will be deployed on the build org prior to attempting conversion.",
           "multiple": false,
           "deprecateAliases": true
+        },
+        "verbose": {
+          "name": "verbose",
+          "type": "boolean",
+          "summary": "Display verbose command output.",
+          "allowNo": false,
+          "deprecateAliases": true
         }
       },
       "args": {},
@@ -6059,62 +6066,38 @@
       "requiresProject": true
     },
     "scanner:run": {
-      "id": "scanner:run",
-      "description": "scan a codebase with a selection of rules",
-      "usage": "<%= command.id %> -t <array> [-c <array>] [-f csv|html|json|junit|sarif|table|xml] [-o <string>] [-s <integer> | --json] [--normalize-severity] [-p <array>] [-r <array>] [-e <array>] [--tsconfig <string>] [--eslintconfig <string>] [--pmdconfig <string>] [--env <string>] [--verbose-violations] [--verbose] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]",
-      "pluginName": "@salesforce/sfdx-scanner",
-      "pluginType": "jit",
       "aliases": [],
+      "args": {},
+      "description": "scan a codebase with a selection of rules",
       "examples": [
         "This example evaluates all rules against somefile.js.\nInvoking code analyzer without specifying any rules causes all rules to be run.\n\t$ sfdx scanner:run --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$ sfdx scanner:run --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$ sfdx scanner:run --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$ sfdx scanner:run --target './**/*.js,!./**/IgnoreMe.js' ...\nWindows example:\n\t$ sfdx scanner:run --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$ sfdx scanner:run --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$ sfdx scanner:run --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$ sfdx scanner:run --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$ sfdx scanner:run --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$ sfdx scanner:run --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$ sfdx scanner:run --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$ sfdx scanner:run --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$ sfdx scanner:run --target \"/some-project/\" --severity-threshold 2\n\nThe paths specified for --projectdir must contain all files specified through --target cumulatively.\n\t$ sfdx scanner:run --target \"./myproject/main/default/classes/*.cls\" --projectdir \"./myproject/\"\n\t$ sfdx scanner:run --target \"./**/*.cls\" --projectdir \"./\"\n\t$ sfdx scanner:run --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$ sfdx scanner:run --target \"./**/*.cls\" --projectdir \"./myproject/\"\n"
       ],
-      "flags": {
-        "json": {
-          "name": "json",
-          "type": "boolean",
-          "description": "format output as json",
-          "allowNo": false
-        },
-        "loglevel": {
-          "name": "loglevel",
-          "type": "option",
-          "description": "logging level for this command invocation",
-          "required": false,
-          "helpValue": "(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)",
-          "options": [
-            "trace",
-            "debug",
-            "info",
-            "warn",
-            "error",
-            "fatal",
-            "TRACE",
-            "DEBUG",
-            "INFO",
-            "WARN",
-            "ERROR",
-            "FATAL"
-          ],
-          "default": "warn"
-        },
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "scanner:run",
+      "pluginAlias": "@salesforce/sfdx-scanner",
+      "pluginName": "@salesforce/sfdx-scanner",
+      "pluginType": "jit",
+      "flagsConfig": {
         "verbose": {
-          "name": "verbose",
-          "type": "boolean",
-          "description": "emit additional command output to stdout",
-          "allowNo": false
+          "type": "builtin"
         },
         "category": {
-          "name": "category",
-          "type": "option",
+          "kind": "array",
           "char": "c",
-          "description": "one or more categories of rules to run"
+          "description": "one or more categories of rules to run",
+          "longDescription": "One or more categories of rules to run. Specify multiple values as a comma-separated list.",
+          "input": [],
+          "multiple": false,
+          "type": "option"
         },
         "format": {
-          "name": "format",
-          "type": "option",
+          "kind": "enum",
+          "helpValue": "(csv|html|json|junit|sarif|table|xml)",
           "char": "f",
           "description": "specify results output format",
-          "helpValue": "(csv|html|json|junit|sarif|table|xml)",
+          "longDescription": "Specifies results output format written directly to the console.",
           "options": [
             "csv",
             "html",
@@ -6123,107 +6106,160 @@
             "sarif",
             "table",
             "xml"
-          ]
+          ],
+          "input": [],
+          "multiple": false,
+          "type": "option"
         },
         "outfile": {
-          "name": "outfile",
-          "type": "option",
+          "kind": "string",
           "char": "o",
-          "description": "write output to a file"
+          "description": "write output to a file",
+          "longDescription": "Writes output to a file.",
+          "input": [],
+          "multiple": false,
+          "type": "option"
         },
         "severity-threshold": {
-          "name": "severity-threshold",
-          "type": "option",
+          "kind": "integer",
           "char": "s",
-          "description": "throw an error when a violation threshold is reached, the --normalize-severity is invoked, and severity levels are reset to the baseline"
+          "description": "throw an error when a violation threshold is reached, the --normalize-severity is invoked, and severity levels are reset to the baseline",
+          "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.",
+          "exclusive": [
+            "json"
+          ],
+          "min": 1,
+          "max": 3,
+          "input": [],
+          "multiple": false,
+          "type": "option"
         },
         "normalize-severity": {
-          "name": "normalize-severity",
-          "type": "boolean",
+          "kind": "boolean",
           "description": "return normalized severity 1 (high), 2 (moderate), and 3 (low), and the engine-specific severity",
-          "allowNo": false
+          "longDescription": "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.",
+          "allowNo": false,
+          "type": "boolean"
         },
         "projectdir": {
-          "name": "projectdir",
-          "type": "option",
+          "kind": "array",
           "char": "p",
-          "description": "provide root directory of project"
+          "description": "provide root directory of project",
+          "longDescription": "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.",
+          "input": [],
+          "multiple": false,
+          "type": "option"
         },
         "ruleset": {
-          "name": "ruleset",
-          "type": "option",
+          "kind": "array",
           "char": "r",
-          "description": "[deprecated] rulesets to run"
+          "deprecated": {
+            "messageOverride": "The 'ruleset' command parameter is deprecated. Use 'category' instead."
+          },
+          "description": "[deprecated] rulesets to run",
+          "longDescription": "[deprecated] One or more rulesets to run. Specify multiple values as a comma-separated list.",
+          "input": [],
+          "multiple": false,
+          "type": "option"
         },
         "engine": {
-          "name": "engine",
-          "type": "option",
+          "kind": "array",
           "char": "e",
-          "description": "specify which engines to run"
+          "description": "specify which engines to run",
+          "longDescription": "Specifies one or more engines to run. Submit multiple values as a comma-separated list.",
+          "input": [],
+          "multiple": false,
+          "type": "option"
         },
         "target": {
-          "name": "target",
-          "type": "option",
+          "kind": "array",
           "char": "t",
           "description": "source code location",
-          "required": true
+          "longDescription": "Source code location. May use glob patterns. Specify multiple values as a comma-separated list.",
+          "required": true,
+          "input": [],
+          "multiple": false,
+          "type": "option"
         },
         "tsconfig": {
-          "name": "tsconfig",
-          "type": "option",
-          "description": "location of tsconfig.json file"
+          "kind": "string",
+          "description": "location of tsconfig.json file",
+          "longDescription": "Location of tsconfig.json file used by eslint-typescript engine.",
+          "input": [],
+          "multiple": false,
+          "type": "option"
         },
         "eslintconfig": {
-          "name": "eslintconfig",
-          "type": "option",
-          "description": "specify the location of eslintrc config to customize eslint engine"
+          "kind": "string",
+          "description": "specify the location of eslintrc config to customize eslint engine",
+          "longDescription": "Specifies the location of eslintrc config to customize eslint engine.",
+          "input": [],
+          "multiple": false,
+          "type": "option"
         },
         "pmdconfig": {
-          "name": "pmdconfig",
-          "type": "option",
-          "description": "specify location of PMD rule reference XML file to customize rule selection"
+          "kind": "string",
+          "description": "specify location of PMD rule reference XML file to customize rule selection",
+          "longDescription": "Specifies the location of PMD rule reference XML file to customize rule selection.",
+          "input": [],
+          "multiple": false,
+          "type": "option"
         },
         "env": {
-          "name": "env",
-          "type": "option",
-          "description": "[deprecated] override ESLint's default environment variables, in JSON-formatted string"
+          "kind": "string",
+          "description": "[deprecated] override ESLint's default environment variables, in JSON-formatted string",
+          "longDescription": "[deprecated] Overrides ESLint's default environmental variables, in JSON-formatted string.",
+          "deprecated": {
+            "messageOverride": "--env parameter is being deprecated, and will be removed in a future release."
+          },
+          "input": [],
+          "multiple": false,
+          "type": "option"
         },
         "verbose-violations": {
-          "name": "verbose-violations",
-          "type": "boolean",
+          "kind": "boolean",
           "description": "return retire-js violation message details",
-          "allowNo": false
+          "longDescription": "Returns retire-js violation messages details about each vulnerability, including summary, Common Vulnerabilities and Exposures (CVE), and URLs.",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
-      "args": [
-        {
-          "name": "file"
-        }
+      "longDescription": "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.",
+      "isESM": false,
+      "relativePath": [
+        "lib",
+        "commands",
+        "scanner",
+        "run.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "scanner:run",
+        "run:scanner"
       ]
     },
     "scanner:rule:add": {
-      "id": "scanner:rule:add",
-      "description": "add custom rules to Salesforce Code Analyzer's registry",
-      "usage": "<%= command.id %> -l <string> -p <array> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]",
-      "pluginName": "@salesforce/sfdx-scanner",
-      "pluginType": "jit",
       "aliases": [],
+      "args": {},
+      "description": "add custom rules to Salesforce Code Analyzer's registry",
       "examples": [
         "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$ sfdx scanner:rule:add --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$ sfdx scanner:rule:add --language apex --path \"/Users/me/rules\"\n\t\tSuccessfully added rules for apex."
       ],
       "flags": {
         "json": {
-          "name": "json",
-          "type": "boolean",
           "description": "format output as json",
-          "allowNo": false
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
         },
         "loglevel": {
-          "name": "loglevel",
-          "type": "option",
           "description": "logging level for this command invocation",
+          "name": "loglevel",
           "required": false,
+          "default": "warn",
+          "hasDynamicHelp": false,
           "helpValue": "(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)",
+          "multiple": false,
           "options": [
             "trace",
             "debug",
@@ -6238,48 +6274,98 @@
             "ERROR",
             "FATAL"
           ],
-          "default": "warn"
+          "type": "option"
         },
         "language": {
-          "name": "language",
-          "type": "option",
           "char": "l",
           "description": "language that the custom rules are evaluated against",
-          "required": true
+          "name": "language",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         },
         "path": {
+          "char": "p",
+          "description": "one or more paths (such as a directory or JAR file) to custom rule definitions",
           "name": "path",
-          "type": "option",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "scanner:rule:add",
+      "pluginAlias": "@salesforce/sfdx-scanner",
+      "pluginName": "@salesforce/sfdx-scanner",
+      "pluginType": "jit",
+      "strict": true,
+      "usage": "<%= command.id %> -l <string> -p <array> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]",
+      "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.",
+      "flagsConfig": {
+        "language": {
+          "kind": "string",
+          "char": "l",
+          "description": "language that the custom rules are evaluated against",
+          "longDescription": "Language that the custom rules are evaluated against.",
+          "required": true,
+          "input": [],
+          "multiple": false,
+          "type": "option"
+        },
+        "path": {
+          "kind": "array",
           "char": "p",
           "description": "one or more paths (such as a directory or JAR file) to custom rule definitions",
-          "required": true
+          "longDescription": "One or more paths (such as a directory or JAR file) to  custom rule definitions. Specify multiple values as a comma-separated list.",
+          "required": true,
+          "input": [],
+          "multiple": false,
+          "type": "option"
         }
       },
-      "args": []
+      "isESM": false,
+      "relativePath": [
+        "lib",
+        "commands",
+        "scanner",
+        "rule",
+        "add.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "scanner:rule:add",
+        "rule:scanner:add",
+        "rule:add:scanner",
+        "scanner:add:rule",
+        "add:scanner:rule",
+        "add:rule:scanner"
+      ]
     },
     "scanner:rule:describe": {
-      "id": "scanner:rule:describe",
-      "description": "provide detailed information about a rule",
-      "usage": "<%= command.id %> -n <string> [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]",
-      "pluginName": "@salesforce/sfdx-scanner",
-      "pluginType": "jit",
       "aliases": [],
+      "args": {},
+      "description": "provide detailed information about a rule",
       "examples": [
         "$ sfdx scanner:rule:describe --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\n\t"
       ],
       "flags": {
         "json": {
-          "name": "json",
-          "type": "boolean",
           "description": "format output as json",
-          "allowNo": false
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
         },
         "loglevel": {
-          "name": "loglevel",
-          "type": "option",
           "description": "logging level for this command invocation",
+          "name": "loglevel",
           "required": false,
+          "default": "warn",
+          "hasDynamicHelp": false,
           "helpValue": "(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)",
+          "multiple": false,
           "options": [
             "trace",
             "debug",
@@ -6294,51 +6380,92 @@
             "ERROR",
             "FATAL"
           ],
-          "default": "warn"
+          "type": "option"
         },
         "rulename": {
-          "name": "rulename",
-          "type": "option",
           "char": "n",
           "description": "the name of the rule",
-          "required": true
+          "name": "rulename",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         },
         "verbose": {
+          "description": "emit additional command output to stdout",
           "name": "verbose",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "scanner:rule:describe",
+      "pluginAlias": "@salesforce/sfdx-scanner",
+      "pluginName": "@salesforce/sfdx-scanner",
+      "pluginType": "jit",
+      "strict": true,
+      "usage": "<%= command.id %> -n <string> [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]",
+      "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.",
+      "flagsConfig": {
+        "rulename": {
+          "kind": "string",
+          "char": "n",
+          "description": "the name of the rule",
+          "longDescription": "The name of the rule.",
+          "required": true,
+          "input": [],
+          "multiple": false,
+          "type": "option"
+        },
+        "verbose": {
           "type": "boolean",
+          "kind": "boolean",
           "description": "emit additional command output to stdout",
+          "longDescription": "Emit additional command output to stdout.",
           "allowNo": false
         }
       },
-      "args": [
-        {
-          "name": "file"
-        }
+      "isESM": false,
+      "relativePath": [
+        "lib",
+        "commands",
+        "scanner",
+        "rule",
+        "describe.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "scanner:rule:describe",
+        "rule:scanner:describe",
+        "rule:describe:scanner",
+        "scanner:describe:rule",
+        "describe:scanner:rule",
+        "describe:rule:scanner"
       ]
     },
     "scanner:rule:list": {
-      "id": "scanner:rule:list",
-      "description": "list basic information about all rules matching provided criteria",
-      "usage": "<%= command.id %> [-c <array>] [-r <array>] [-l <array>] [-e <array>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]",
-      "pluginName": "@salesforce/sfdx-scanner",
-      "pluginType": "jit",
       "aliases": [],
+      "args": {},
+      "description": "list basic information about all rules matching provided criteria",
       "examples": [
         "\nThis example invokes the command without filter criteria, which returns all rules.\n\t$ sfdx scanner:rule:list\n\nThis example returns all rules for Apex OR Javascript. Values supplied to a single filter are handled with a logical OR.\n\t$ sfdx scanner:rule:list --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$ sfdx scanner:rule:list --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$ sfdx scanner:rule:list --language apex,javascript --ruleset Braces,Security\n"
       ],
       "flags": {
         "json": {
-          "name": "json",
-          "type": "boolean",
           "description": "format output as json",
-          "allowNo": false
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
         },
         "loglevel": {
-          "name": "loglevel",
-          "type": "option",
           "description": "logging level for this command invocation",
+          "name": "loglevel",
           "required": false,
+          "default": "warn",
+          "hasDynamicHelp": false,
           "helpValue": "(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)",
+          "multiple": false,
           "options": [
             "trace",
             "debug",
@@ -6353,68 +6480,147 @@
             "ERROR",
             "FATAL"
           ],
-          "default": "warn"
+          "type": "option"
         },
         "verbose": {
+          "description": "emit additional command output to stdout",
           "name": "verbose",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "category": {
+          "char": "c",
+          "description": "select rules by category",
+          "name": "category",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "ruleset": {
+          "char": "r",
+          "deprecated": {
+            "messageOverride": "The 'ruleset' command parameter is deprecated. Use 'category' instead"
+          },
+          "description": "[deprecated] select rules by ruleset",
+          "name": "ruleset",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "language": {
+          "char": "l",
+          "description": "select rules by language",
+          "name": "language",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "engine": {
+          "char": "e",
+          "description": "select rules by engine",
+          "name": "engine",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "scanner:rule:list",
+      "pluginAlias": "@salesforce/sfdx-scanner",
+      "pluginName": "@salesforce/sfdx-scanner",
+      "pluginType": "jit",
+      "strict": true,
+      "usage": "<%= command.id %> [-c <array>] [-r <array>] [-l <array>] [-e <array>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]",
+      "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.",
+      "flagsConfig": {
+        "verbose": {
           "type": "boolean",
+          "kind": "boolean",
           "description": "emit additional command output to stdout",
+          "longDescription": "Emit additional command output to stdout.",
           "allowNo": false
         },
         "category": {
-          "name": "category",
-          "type": "option",
+          "kind": "array",
           "char": "c",
-          "description": "select rules by category"
+          "description": "select rules by category",
+          "longDescription": "Selects rules by category. Enter multiple values as a comma-separated list.",
+          "input": [],
+          "multiple": false,
+          "type": "option"
         },
         "ruleset": {
-          "name": "ruleset",
-          "type": "option",
+          "kind": "array",
           "char": "r",
-          "description": "[deprecated] select rules by ruleset"
+          "deprecated": {
+            "messageOverride": "The 'ruleset' command parameter is deprecated. Use 'category' instead"
+          },
+          "description": "[deprecated] select rules by ruleset",
+          "longDescription": "[deprecated] Selects rules by ruleset. Enter multiple values as a comma-separated list.",
+          "input": [],
+          "multiple": false,
+          "type": "option"
         },
         "language": {
-          "name": "language",
-          "type": "option",
+          "kind": "array",
           "char": "l",
-          "description": "select rules by language"
+          "description": "select rules by language",
+          "longDescription": "Selects rules by language. Enter multiple values as a comma-separated list.",
+          "input": [],
+          "multiple": false,
+          "type": "option"
         },
         "engine": {
-          "name": "engine",
-          "type": "option",
+          "kind": "array",
           "char": "e",
-          "description": "select rules by engine"
+          "description": "select rules by engine",
+          "longDescription": "Selects rules by engine. Enter multiple engines as a comma-separated list.",
+          "input": [],
+          "multiple": false,
+          "type": "option"
         }
       },
-      "args": [
-        {
-          "name": "file"
-        }
+      "isESM": false,
+      "relativePath": [
+        "lib",
+        "commands",
+        "scanner",
+        "rule",
+        "list.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "scanner:rule:list",
+        "rule:scanner:list",
+        "rule:list:scanner",
+        "scanner:list:rule",
+        "list:scanner:rule",
+        "list:rule:scanner"
       ]
     },
     "scanner:rule:remove": {
-      "id": "scanner:rule:remove",
-      "description": "remove custom rules from the registry of available rules",
-      "usage": "<%= command.id %> [-f] [-p <array>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]",
-      "pluginName": "@salesforce/sfdx-scanner",
-      "pluginType": "jit",
       "aliases": [],
+      "args": {},
+      "description": "remove custom rules from the registry of available rules",
       "examples": [
         "This example runs the command without arguments to see a list of registered custom paths.\n\t$ sfdx scanner:rule:remove\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$ sfdx scanner:rule:remove --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$ sfdx scanner:rule:remove --force --path \"~/path/to/somerules.jar\"\n"
       ],
       "flags": {
         "json": {
-          "name": "json",
-          "type": "boolean",
           "description": "format output as json",
-          "allowNo": false
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
         },
         "loglevel": {
-          "name": "loglevel",
-          "type": "option",
           "description": "logging level for this command invocation",
+          "name": "loglevel",
           "required": false,
+          "default": "warn",
+          "hasDynamicHelp": false,
           "helpValue": "(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)",
+          "multiple": false,
           "options": [
             "trace",
             "debug",
@@ -6429,91 +6635,116 @@
             "ERROR",
             "FATAL"
           ],
-          "default": "warn"
+          "type": "option"
         },
         "verbose": {
+          "description": "emit additional command output to stdout",
           "name": "verbose",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "force": {
+          "char": "f",
+          "description": "bypass the confirmation prompt and immediately remove the rules",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "path": {
+          "char": "p",
+          "description": "one or more paths to remove",
+          "name": "path",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "scanner:rule:remove",
+      "pluginAlias": "@salesforce/sfdx-scanner",
+      "pluginName": "@salesforce/sfdx-scanner",
+      "pluginType": "jit",
+      "strict": true,
+      "usage": "<%= command.id %> [-f] [-p <array>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]",
+      "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.",
+      "flagsConfig": {
+        "verbose": {
           "type": "boolean",
+          "kind": "boolean",
           "description": "emit additional command output to stdout",
+          "longDescription": "Emit additional command output to stdout.",
           "allowNo": false
         },
         "force": {
-          "name": "force",
-          "type": "boolean",
+          "kind": "boolean",
           "char": "f",
           "description": "bypass the confirmation prompt and immediately remove the rules",
-          "allowNo": false
+          "longDescription": "Bypasses the confirmation prompt and immediately removes the rules.",
+          "allowNo": false,
+          "type": "boolean"
         },
         "path": {
-          "name": "path",
-          "type": "option",
+          "kind": "array",
           "char": "p",
-          "description": "one or more paths to remove"
+          "description": "one or more paths to remove",
+          "longDescription": "One or more paths to remove. Specify multiple values with a comma-separated list.",
+          "input": [],
+          "multiple": false,
+          "type": "option"
         }
       },
-      "args": [
-        {
-          "name": "file"
-        }
+      "isESM": false,
+      "relativePath": [
+        "lib",
+        "commands",
+        "scanner",
+        "rule",
+        "remove.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "scanner:rule:remove",
+        "rule:scanner:remove",
+        "rule:remove:scanner",
+        "scanner:remove:rule",
+        "remove:scanner:rule",
+        "remove:rule:scanner"
       ]
     },
     "scanner:run:dfa": {
-      "id": "scanner:run:dfa",
-      "description": "scan codebase with all DFA rules",
-      "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]",
-      "pluginName": "@salesforce/sfdx-scanner",
-      "pluginType": "jit",
       "aliases": [],
+      "args": {},
+      "description": "scan codebase with all DFA rules",
       "examples": [
         "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"
       ],
-      "flags": {
-        "json": {
-          "name": "json",
-          "type": "boolean",
-          "description": "format output as json",
-          "allowNo": false
-        },
-        "loglevel": {
-          "name": "loglevel",
-          "type": "option",
-          "description": "logging level for this command invocation",
-          "required": false,
-          "helpValue": "(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)",
-          "options": [
-            "trace",
-            "debug",
-            "info",
-            "warn",
-            "error",
-            "fatal",
-            "TRACE",
-            "DEBUG",
-            "INFO",
-            "WARN",
-            "ERROR",
-            "FATAL"
-          ],
-          "default": "warn"
-        },
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "scanner:run:dfa",
+      "pluginAlias": "@salesforce/sfdx-scanner",
+      "pluginName": "@salesforce/sfdx-scanner",
+      "pluginType": "jit",
+      "flagsConfig": {
         "verbose": {
-          "name": "verbose",
-          "type": "boolean",
-          "description": "emit additional command output to stdout",
-          "allowNo": false
+          "type": "builtin"
         },
         "category": {
-          "name": "category",
-          "type": "option",
+          "kind": "array",
           "char": "c",
-          "description": "one or more categories of rules to run"
+          "description": "one or more categories of rules to run",
+          "longDescription": "One or more categories of rules to run. Specify multiple values as a comma-separated list.",
+          "input": [],
+          "multiple": false,
+          "type": "option"
         },
         "format": {
-          "name": "format",
-          "type": "option",
+          "kind": "enum",
+          "helpValue": "(csv|html|json|junit|sarif|table|xml)",
           "char": "f",
           "description": "specify results output format",
-          "helpValue": "(csv|html|json|junit|sarif|table|xml)",
+          "longDescription": "Specifies results output format written directly to the console.",
           "options": [
             "csv",
             "html",
@@ -6522,78 +6753,130 @@
             "sarif",
             "table",
             "xml"
-          ]
+          ],
+          "input": [],
+          "multiple": false,
+          "type": "option"
         },
         "outfile": {
-          "name": "outfile",
-          "type": "option",
+          "kind": "string",
           "char": "o",
-          "description": "write output to a file"
+          "description": "write output to a file",
+          "longDescription": "Writes output to a file.",
+          "input": [],
+          "multiple": false,
+          "type": "option"
         },
         "severity-threshold": {
-          "name": "severity-threshold",
-          "type": "option",
+          "kind": "integer",
           "char": "s",
-          "description": "throw an error when a violation threshold is reached, the --normalize-severity is invoked, and severity levels are reset to the baseline"
+          "description": "throw an error when a violation threshold is reached, the --normalize-severity is invoked, and severity levels are reset to the baseline",
+          "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.",
+          "exclusive": [
+            "json"
+          ],
+          "min": 1,
+          "max": 3,
+          "input": [],
+          "multiple": false,
+          "type": "option"
         },
         "normalize-severity": {
-          "name": "normalize-severity",
-          "type": "boolean",
+          "kind": "boolean",
           "description": "return normalized severity 1 (high), 2 (moderate), and 3 (low), and the engine-specific severity",
-          "allowNo": false
+          "longDescription": "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.",
+          "allowNo": false,
+          "type": "boolean"
         },
         "projectdir": {
-          "name": "projectdir",
-          "type": "option",
+          "kind": "array",
           "char": "p",
-          "description": "provide root directory of project"
+          "description": "provide root directory of project",
+          "longDescription": "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.",
+          "input": [],
+          "multiple": false,
+          "type": "option"
         },
         "with-pilot": {
-          "name": "with-pilot",
-          "type": "boolean",
+          "kind": "boolean",
           "description": "allow pilot rules to execute",
-          "allowNo": false
+          "longDescription": "Allows pilot rules to execute.",
+          "allowNo": false,
+          "type": "boolean"
         },
         "target": {
-          "name": "target",
-          "type": "option",
+          "kind": "array",
           "char": "t",
           "description": "return location of source code",
-          "required": true
+          "longDescription": "Returns the source code location. Use glob patterns or specify individual methods with #-syntax. Multiple values are specified as a comma-separated list.",
+          "required": true,
+          "input": [],
+          "multiple": false,
+          "type": "option"
         },
         "rule-thread-count": {
-          "name": "rule-thread-count",
-          "type": "option",
-          "description": "specify number of threads that evaluate DFA rules. Alternatively, set value using environment variable `SFGE_RULE_THREAD_COUNT`. Default is 4"
+          "kind": "integer",
+          "description": "specify number of threads that evaluate DFA rules. Alternatively, set value using environment variable `SFGE_RULE_THREAD_COUNT`. Default is 4",
+          "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.",
+          "env": "SFGE_RULE_THREAD_COUNT",
+          "input": [],
+          "multiple": false,
+          "type": "option"
         },
         "rule-thread-timeout": {
-          "name": "rule-thread-timeout",
-          "type": "option",
-          "description": "specify timeout for individual rule threads in milliseconds. Alternatively, set the timeout value using environment variable `SFGE_RULE_THREAD_TIMEOUT`. Default: 90000 ms"
+          "kind": "integer",
+          "description": "specify timeout for individual rule threads in milliseconds. Alternatively, set the timeout value using environment variable `SFGE_RULE_THREAD_TIMEOUT`. Default: 90000 ms",
+          "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.",
+          "env": "SFGE_RULE_THREAD_TIMEOUT",
+          "input": [],
+          "multiple": false,
+          "type": "option"
         },
         "rule-disable-warning-violation": {
-          "name": "rule-disable-warning-violation",
-          "type": "boolean",
+          "kind": "boolean",
           "description": "disable warning violations from Salesforce Graph Engine. Alternatively, set value using environment variable `SFGE_RULE_DISABLE_WARNING_VIOLATION`",
-          "allowNo": false
+          "longDescription": "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.",
+          "allowNo": false,
+          "type": "boolean"
         },
         "sfgejvmargs": {
-          "name": "sfgejvmargs",
-          "type": "option",
-          "description": "specify Java Virtual Machine (JVM) arguments to optimize Salesforce Graph Engine execution to your system (optional)"
+          "kind": "string",
+          "description": "specify Java Virtual Machine (JVM) arguments to optimize Salesforce Graph Engine execution to your system (optional)",
+          "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.",
+          "env": "SFGE_JVM_ARGS",
+          "input": [],
+          "multiple": false,
+          "type": "option"
         },
         "pathexplimit": {
-          "name": "pathexplimit",
-          "type": "option",
-          "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`"
+          "kind": "integer",
+          "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`",
+          "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.",
+          "env": "SFGE_PATH_EXPANSION_LIMIT",
+          "input": [],
+          "multiple": false,
+          "type": "option"
         }
       },
-      "args": [
-        {
-          "name": "file"
-        }
+      "longDescription": "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.",
+      "isESM": false,
+      "relativePath": [
+        "lib",
+        "commands",
+        "scanner",
+        "run",
+        "dfa.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "scanner:run:dfa",
+        "run:scanner:dfa",
+        "run:dfa:scanner",
+        "scanner:dfa:run",
+        "dfa:scanner:run",
+        "dfa:run:scanner"
       ]
     }
   },
-  "version": "2.16.6"
+  "version": "2.17.0"
 }