@salesforce/cli 2.11.3 → 2.11.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "2.11.3",
2
+ "version": "2.11.5",
3
3
  "commands": {
4
4
  "cmdt:generate:field": {
5
5
  "id": "cmdt:generate:field",
@@ -2674,7 +2674,7 @@
2674
2674
  "description": "Path to function directory.",
2675
2675
  "hidden": true,
2676
2676
  "multiple": false,
2677
- "default": "/home/runner/work/cli/cli"
2677
+ "default": "/home/runner/work/plugin-functions/plugin-functions"
2678
2678
  },
2679
2679
  "port": {
2680
2680
  "name": "port",
@@ -2769,7 +2769,7 @@
2769
2769
  "description": "Path to function directory.",
2770
2770
  "hidden": true,
2771
2771
  "multiple": false,
2772
- "default": "/home/runner/work/cli/cli"
2772
+ "default": "/home/runner/work/plugin-functions/plugin-functions"
2773
2773
  },
2774
2774
  "port": {
2775
2775
  "name": "port",
@@ -6061,10 +6061,8 @@
6061
6061
  "scanner:run": {
6062
6062
  "id": "scanner:run",
6063
6063
  "description": "scan a codebase with a selection of rules",
6064
- "strict": true,
6065
6064
  "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]",
6066
6065
  "pluginName": "@salesforce/sfdx-scanner",
6067
- "pluginAlias": "@salesforce/sfdx-scanner",
6068
6066
  "pluginType": "jit",
6069
6067
  "aliases": [],
6070
6068
  "examples": [
@@ -6083,7 +6081,6 @@
6083
6081
  "description": "logging level for this command invocation",
6084
6082
  "required": false,
6085
6083
  "helpValue": "(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)",
6086
- "multiple": false,
6087
6084
  "options": [
6088
6085
  "trace",
6089
6086
  "debug",
@@ -6110,8 +6107,7 @@
6110
6107
  "name": "category",
6111
6108
  "type": "option",
6112
6109
  "char": "c",
6113
- "description": "one or more categories of rules to run",
6114
- "multiple": false
6110
+ "description": "one or more categories of rules to run"
6115
6111
  },
6116
6112
  "format": {
6117
6113
  "name": "format",
@@ -6119,7 +6115,6 @@
6119
6115
  "char": "f",
6120
6116
  "description": "specify results output format",
6121
6117
  "helpValue": "(csv|html|json|junit|sarif|table|xml)",
6122
- "multiple": false,
6123
6118
  "options": [
6124
6119
  "csv",
6125
6120
  "html",
@@ -6134,18 +6129,13 @@
6134
6129
  "name": "outfile",
6135
6130
  "type": "option",
6136
6131
  "char": "o",
6137
- "description": "write output to a file",
6138
- "multiple": false
6132
+ "description": "write output to a file"
6139
6133
  },
6140
6134
  "severity-threshold": {
6141
6135
  "name": "severity-threshold",
6142
6136
  "type": "option",
6143
6137
  "char": "s",
6144
- "description": "throw an error when a violation threshold is reached, the --normalize-severity is invoked, and severity levels are reset to the baseline",
6145
- "multiple": false,
6146
- "exclusive": [
6147
- "json"
6148
- ]
6138
+ "description": "throw an error when a violation threshold is reached, the --normalize-severity is invoked, and severity levels are reset to the baseline"
6149
6139
  },
6150
6140
  "normalize-severity": {
6151
6141
  "name": "normalize-severity",
@@ -6157,60 +6147,46 @@
6157
6147
  "name": "projectdir",
6158
6148
  "type": "option",
6159
6149
  "char": "p",
6160
- "description": "provide root directory of project",
6161
- "multiple": false
6150
+ "description": "provide root directory of project"
6162
6151
  },
6163
6152
  "ruleset": {
6164
6153
  "name": "ruleset",
6165
6154
  "type": "option",
6166
6155
  "char": "r",
6167
- "description": "[deprecated] rulesets to run",
6168
- "multiple": false,
6169
- "deprecated": {
6170
- "messageOverride": "The 'ruleset' command parameter is deprecated. Use 'category' instead."
6171
- }
6156
+ "description": "[deprecated] rulesets to run"
6172
6157
  },
6173
6158
  "engine": {
6174
6159
  "name": "engine",
6175
6160
  "type": "option",
6176
6161
  "char": "e",
6177
- "description": "specify which engines to run",
6178
- "multiple": false
6162
+ "description": "specify which engines to run"
6179
6163
  },
6180
6164
  "target": {
6181
6165
  "name": "target",
6182
6166
  "type": "option",
6183
6167
  "char": "t",
6184
6168
  "description": "source code location",
6185
- "required": true,
6186
- "multiple": false
6169
+ "required": true
6187
6170
  },
6188
6171
  "tsconfig": {
6189
6172
  "name": "tsconfig",
6190
6173
  "type": "option",
6191
- "description": "location of tsconfig.json file",
6192
- "multiple": false
6174
+ "description": "location of tsconfig.json file"
6193
6175
  },
6194
6176
  "eslintconfig": {
6195
6177
  "name": "eslintconfig",
6196
6178
  "type": "option",
6197
- "description": "specify the location of eslintrc config to customize eslint engine",
6198
- "multiple": false
6179
+ "description": "specify the location of eslintrc config to customize eslint engine"
6199
6180
  },
6200
6181
  "pmdconfig": {
6201
6182
  "name": "pmdconfig",
6202
6183
  "type": "option",
6203
- "description": "specify location of PMD rule reference XML file to customize rule selection",
6204
- "multiple": false
6184
+ "description": "specify location of PMD rule reference XML file to customize rule selection"
6205
6185
  },
6206
6186
  "env": {
6207
6187
  "name": "env",
6208
6188
  "type": "option",
6209
- "description": "[deprecated] override ESLint's default environment variables, in JSON-formatted string",
6210
- "multiple": false,
6211
- "deprecated": {
6212
- "messageOverride": "--env parameter is being deprecated, and will be removed in a future release."
6213
- }
6189
+ "description": "[deprecated] override ESLint's default environment variables, in JSON-formatted string"
6214
6190
  },
6215
6191
  "verbose-violations": {
6216
6192
  "name": "verbose-violations",
@@ -6219,169 +6195,17 @@
6219
6195
  "allowNo": false
6220
6196
  }
6221
6197
  },
6222
- "args": {
6223
- "file": {
6198
+ "args": [
6199
+ {
6224
6200
  "name": "file"
6225
6201
  }
6226
- },
6227
- "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.",
6228
- "flagsConfig": {
6229
- "verbose": {
6230
- "type": "boolean",
6231
- "kind": "boolean",
6232
- "description": "emit additional command output to stdout",
6233
- "longDescription": "Emit additional command output to stdout.",
6234
- "allowNo": false
6235
- },
6236
- "category": {
6237
- "kind": "array",
6238
- "char": "c",
6239
- "description": "one or more categories of rules to run",
6240
- "longDescription": "One or more categories of rules to run. Specify multiple values as a comma-separated list.",
6241
- "input": [],
6242
- "multiple": false,
6243
- "type": "option"
6244
- },
6245
- "format": {
6246
- "kind": "enum",
6247
- "helpValue": "(csv|html|json|junit|sarif|table|xml)",
6248
- "char": "f",
6249
- "description": "specify results output format",
6250
- "longDescription": "Specifies results output format written directly to the console.",
6251
- "options": [
6252
- "csv",
6253
- "html",
6254
- "json",
6255
- "junit",
6256
- "sarif",
6257
- "table",
6258
- "xml"
6259
- ],
6260
- "input": [],
6261
- "multiple": false,
6262
- "type": "option"
6263
- },
6264
- "outfile": {
6265
- "kind": "string",
6266
- "char": "o",
6267
- "description": "write output to a file",
6268
- "longDescription": "Writes output to a file.",
6269
- "input": [],
6270
- "multiple": false,
6271
- "type": "option"
6272
- },
6273
- "severity-threshold": {
6274
- "kind": "integer",
6275
- "char": "s",
6276
- "description": "throw an error when a violation threshold is reached, the --normalize-severity is invoked, and severity levels are reset to the baseline",
6277
- "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.",
6278
- "exclusive": [
6279
- "json"
6280
- ],
6281
- "min": 1,
6282
- "max": 3,
6283
- "input": [],
6284
- "multiple": false,
6285
- "type": "option"
6286
- },
6287
- "normalize-severity": {
6288
- "kind": "boolean",
6289
- "description": "return normalized severity 1 (high), 2 (moderate), and 3 (low), and the engine-specific severity",
6290
- "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.",
6291
- "allowNo": false,
6292
- "type": "boolean"
6293
- },
6294
- "projectdir": {
6295
- "kind": "array",
6296
- "char": "p",
6297
- "description": "provide root directory of project",
6298
- "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.",
6299
- "input": [],
6300
- "multiple": false,
6301
- "type": "option"
6302
- },
6303
- "ruleset": {
6304
- "kind": "array",
6305
- "char": "r",
6306
- "deprecated": {
6307
- "messageOverride": "The 'ruleset' command parameter is deprecated. Use 'category' instead."
6308
- },
6309
- "description": "[deprecated] rulesets to run",
6310
- "longDescription": "[deprecated] One or more rulesets to run. Specify multiple values as a comma-separated list.",
6311
- "input": [],
6312
- "multiple": false,
6313
- "type": "option"
6314
- },
6315
- "engine": {
6316
- "kind": "array",
6317
- "char": "e",
6318
- "description": "specify which engines to run",
6319
- "longDescription": "Specifies one or more engines to run. Submit multiple values as a comma-separated list.",
6320
- "input": [],
6321
- "multiple": false,
6322
- "type": "option"
6323
- },
6324
- "target": {
6325
- "kind": "array",
6326
- "char": "t",
6327
- "description": "source code location",
6328
- "longDescription": "Source code location. May use glob patterns. Specify multiple values as a comma-separated list.",
6329
- "required": true,
6330
- "input": [],
6331
- "multiple": false,
6332
- "type": "option"
6333
- },
6334
- "tsconfig": {
6335
- "kind": "string",
6336
- "description": "location of tsconfig.json file",
6337
- "longDescription": "Location of tsconfig.json file used by eslint-typescript engine.",
6338
- "input": [],
6339
- "multiple": false,
6340
- "type": "option"
6341
- },
6342
- "eslintconfig": {
6343
- "kind": "string",
6344
- "description": "specify the location of eslintrc config to customize eslint engine",
6345
- "longDescription": "Specifies the location of eslintrc config to customize eslint engine.",
6346
- "input": [],
6347
- "multiple": false,
6348
- "type": "option"
6349
- },
6350
- "pmdconfig": {
6351
- "kind": "string",
6352
- "description": "specify location of PMD rule reference XML file to customize rule selection",
6353
- "longDescription": "Specifies the location of PMD rule reference XML file to customize rule selection.",
6354
- "input": [],
6355
- "multiple": false,
6356
- "type": "option"
6357
- },
6358
- "env": {
6359
- "kind": "string",
6360
- "description": "[deprecated] override ESLint's default environment variables, in JSON-formatted string",
6361
- "longDescription": "[deprecated] Overrides ESLint's default environmental variables, in JSON-formatted string.",
6362
- "deprecated": {
6363
- "messageOverride": "--env parameter is being deprecated, and will be removed in a future release."
6364
- },
6365
- "input": [],
6366
- "multiple": false,
6367
- "type": "option"
6368
- },
6369
- "verbose-violations": {
6370
- "kind": "boolean",
6371
- "description": "return retire-js violation message details",
6372
- "longDescription": "Returns retire-js violation messages details about each vulnerability, including summary, Common Vulnerabilities and Exposures (CVE), and URLs.",
6373
- "allowNo": false,
6374
- "type": "boolean"
6375
- }
6376
- }
6202
+ ]
6377
6203
  },
6378
6204
  "scanner:rule:add": {
6379
6205
  "id": "scanner:rule:add",
6380
6206
  "description": "add custom rules to Salesforce Code Analyzer's registry",
6381
- "strict": true,
6382
6207
  "usage": "<%= command.id %> -l <string> -p <array> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]",
6383
6208
  "pluginName": "@salesforce/sfdx-scanner",
6384
- "pluginAlias": "@salesforce/sfdx-scanner",
6385
6209
  "pluginType": "jit",
6386
6210
  "aliases": [],
6387
6211
  "examples": [
@@ -6400,7 +6224,6 @@
6400
6224
  "description": "logging level for this command invocation",
6401
6225
  "required": false,
6402
6226
  "helpValue": "(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)",
6403
- "multiple": false,
6404
6227
  "options": [
6405
6228
  "trace",
6406
6229
  "debug",
@@ -6422,50 +6245,23 @@
6422
6245
  "type": "option",
6423
6246
  "char": "l",
6424
6247
  "description": "language that the custom rules are evaluated against",
6425
- "required": true,
6426
- "multiple": false
6248
+ "required": true
6427
6249
  },
6428
6250
  "path": {
6429
6251
  "name": "path",
6430
6252
  "type": "option",
6431
6253
  "char": "p",
6432
6254
  "description": "one or more paths (such as a directory or JAR file) to custom rule definitions",
6433
- "required": true,
6434
- "multiple": false
6255
+ "required": true
6435
6256
  }
6436
6257
  },
6437
- "args": {},
6438
- "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.",
6439
- "flagsConfig": {
6440
- "language": {
6441
- "kind": "string",
6442
- "char": "l",
6443
- "description": "language that the custom rules are evaluated against",
6444
- "longDescription": "Language that the custom rules are evaluated against.",
6445
- "required": true,
6446
- "input": [],
6447
- "multiple": false,
6448
- "type": "option"
6449
- },
6450
- "path": {
6451
- "kind": "array",
6452
- "char": "p",
6453
- "description": "one or more paths (such as a directory or JAR file) to custom rule definitions",
6454
- "longDescription": "One or more paths (such as a directory or JAR file) to custom rule definitions. Specify multiple values as a comma-separated list.",
6455
- "required": true,
6456
- "input": [],
6457
- "multiple": false,
6458
- "type": "option"
6459
- }
6460
- }
6258
+ "args": []
6461
6259
  },
6462
6260
  "scanner:rule:describe": {
6463
6261
  "id": "scanner:rule:describe",
6464
6262
  "description": "provide detailed information about a rule",
6465
- "strict": true,
6466
6263
  "usage": "<%= command.id %> -n <string> [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]",
6467
6264
  "pluginName": "@salesforce/sfdx-scanner",
6468
- "pluginAlias": "@salesforce/sfdx-scanner",
6469
6265
  "pluginType": "jit",
6470
6266
  "aliases": [],
6471
6267
  "examples": [
@@ -6484,7 +6280,6 @@
6484
6280
  "description": "logging level for this command invocation",
6485
6281
  "required": false,
6486
6282
  "helpValue": "(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)",
6487
- "multiple": false,
6488
6283
  "options": [
6489
6284
  "trace",
6490
6285
  "debug",
@@ -6506,8 +6301,7 @@
6506
6301
  "type": "option",
6507
6302
  "char": "n",
6508
6303
  "description": "the name of the rule",
6509
- "required": true,
6510
- "multiple": false
6304
+ "required": true
6511
6305
  },
6512
6306
  "verbose": {
6513
6307
  "name": "verbose",
@@ -6516,39 +6310,17 @@
6516
6310
  "allowNo": false
6517
6311
  }
6518
6312
  },
6519
- "args": {
6520
- "file": {
6313
+ "args": [
6314
+ {
6521
6315
  "name": "file"
6522
6316
  }
6523
- },
6524
- "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.",
6525
- "flagsConfig": {
6526
- "rulename": {
6527
- "kind": "string",
6528
- "char": "n",
6529
- "description": "the name of the rule",
6530
- "longDescription": "The name of the rule.",
6531
- "required": true,
6532
- "input": [],
6533
- "multiple": false,
6534
- "type": "option"
6535
- },
6536
- "verbose": {
6537
- "type": "boolean",
6538
- "kind": "boolean",
6539
- "description": "emit additional command output to stdout",
6540
- "longDescription": "Emit additional command output to stdout.",
6541
- "allowNo": false
6542
- }
6543
- }
6317
+ ]
6544
6318
  },
6545
6319
  "scanner:rule:list": {
6546
6320
  "id": "scanner:rule:list",
6547
6321
  "description": "list basic information about all rules matching provided criteria",
6548
- "strict": true,
6549
6322
  "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]",
6550
6323
  "pluginName": "@salesforce/sfdx-scanner",
6551
- "pluginAlias": "@salesforce/sfdx-scanner",
6552
6324
  "pluginType": "jit",
6553
6325
  "aliases": [],
6554
6326
  "examples": [
@@ -6567,7 +6339,6 @@
6567
6339
  "description": "logging level for this command invocation",
6568
6340
  "required": false,
6569
6341
  "helpValue": "(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)",
6570
- "multiple": false,
6571
6342
  "options": [
6572
6343
  "trace",
6573
6344
  "debug",
@@ -6594,96 +6365,38 @@
6594
6365
  "name": "category",
6595
6366
  "type": "option",
6596
6367
  "char": "c",
6597
- "description": "select rules by category",
6598
- "multiple": false
6368
+ "description": "select rules by category"
6599
6369
  },
6600
6370
  "ruleset": {
6601
6371
  "name": "ruleset",
6602
6372
  "type": "option",
6603
6373
  "char": "r",
6604
- "description": "[deprecated] select rules by ruleset",
6605
- "multiple": false,
6606
- "deprecated": {
6607
- "messageOverride": "The 'ruleset' command parameter is deprecated. Use 'category' instead"
6608
- }
6374
+ "description": "[deprecated] select rules by ruleset"
6609
6375
  },
6610
6376
  "language": {
6611
6377
  "name": "language",
6612
6378
  "type": "option",
6613
6379
  "char": "l",
6614
- "description": "select rules by language",
6615
- "multiple": false
6380
+ "description": "select rules by language"
6616
6381
  },
6617
6382
  "engine": {
6618
6383
  "name": "engine",
6619
6384
  "type": "option",
6620
6385
  "char": "e",
6621
- "description": "select rules by engine",
6622
- "multiple": false
6386
+ "description": "select rules by engine"
6623
6387
  }
6624
6388
  },
6625
- "args": {
6626
- "file": {
6389
+ "args": [
6390
+ {
6627
6391
  "name": "file"
6628
6392
  }
6629
- },
6630
- "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.",
6631
- "flagsConfig": {
6632
- "verbose": {
6633
- "type": "boolean",
6634
- "kind": "boolean",
6635
- "description": "emit additional command output to stdout",
6636
- "longDescription": "Emit additional command output to stdout.",
6637
- "allowNo": false
6638
- },
6639
- "category": {
6640
- "kind": "array",
6641
- "char": "c",
6642
- "description": "select rules by category",
6643
- "longDescription": "Selects rules by category. Enter multiple values as a comma-separated list.",
6644
- "input": [],
6645
- "multiple": false,
6646
- "type": "option"
6647
- },
6648
- "ruleset": {
6649
- "kind": "array",
6650
- "char": "r",
6651
- "deprecated": {
6652
- "messageOverride": "The 'ruleset' command parameter is deprecated. Use 'category' instead"
6653
- },
6654
- "description": "[deprecated] select rules by ruleset",
6655
- "longDescription": "[deprecated] Selects rules by ruleset. Enter multiple values as a comma-separated list.",
6656
- "input": [],
6657
- "multiple": false,
6658
- "type": "option"
6659
- },
6660
- "language": {
6661
- "kind": "array",
6662
- "char": "l",
6663
- "description": "select rules by language",
6664
- "longDescription": "Selects rules by language. Enter multiple values as a comma-separated list.",
6665
- "input": [],
6666
- "multiple": false,
6667
- "type": "option"
6668
- },
6669
- "engine": {
6670
- "kind": "array",
6671
- "char": "e",
6672
- "description": "select rules by engine",
6673
- "longDescription": "Selects rules by engine. Enter multiple engines as a comma-separated list.",
6674
- "input": [],
6675
- "multiple": false,
6676
- "type": "option"
6677
- }
6678
- }
6393
+ ]
6679
6394
  },
6680
6395
  "scanner:rule:remove": {
6681
6396
  "id": "scanner:rule:remove",
6682
6397
  "description": "remove custom rules from the registry of available rules",
6683
- "strict": true,
6684
6398
  "usage": "<%= command.id %> [-f] [-p <array>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]",
6685
6399
  "pluginName": "@salesforce/sfdx-scanner",
6686
- "pluginAlias": "@salesforce/sfdx-scanner",
6687
6400
  "pluginType": "jit",
6688
6401
  "aliases": [],
6689
6402
  "examples": [
@@ -6702,7 +6415,6 @@
6702
6415
  "description": "logging level for this command invocation",
6703
6416
  "required": false,
6704
6417
  "helpValue": "(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)",
6705
- "multiple": false,
6706
6418
  "options": [
6707
6419
  "trace",
6708
6420
  "debug",
@@ -6736,50 +6448,20 @@
6736
6448
  "name": "path",
6737
6449
  "type": "option",
6738
6450
  "char": "p",
6739
- "description": "one or more paths to remove",
6740
- "multiple": false
6451
+ "description": "one or more paths to remove"
6741
6452
  }
6742
6453
  },
6743
- "args": {
6744
- "file": {
6454
+ "args": [
6455
+ {
6745
6456
  "name": "file"
6746
6457
  }
6747
- },
6748
- "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.",
6749
- "flagsConfig": {
6750
- "verbose": {
6751
- "type": "boolean",
6752
- "kind": "boolean",
6753
- "description": "emit additional command output to stdout",
6754
- "longDescription": "Emit additional command output to stdout.",
6755
- "allowNo": false
6756
- },
6757
- "force": {
6758
- "kind": "boolean",
6759
- "char": "f",
6760
- "description": "bypass the confirmation prompt and immediately remove the rules",
6761
- "longDescription": "Bypasses the confirmation prompt and immediately removes the rules.",
6762
- "allowNo": false,
6763
- "type": "boolean"
6764
- },
6765
- "path": {
6766
- "kind": "array",
6767
- "char": "p",
6768
- "description": "one or more paths to remove",
6769
- "longDescription": "One or more paths to remove. Specify multiple values with a comma-separated list.",
6770
- "input": [],
6771
- "multiple": false,
6772
- "type": "option"
6773
- }
6774
- }
6458
+ ]
6775
6459
  },
6776
6460
  "scanner:run:dfa": {
6777
6461
  "id": "scanner:run:dfa",
6778
6462
  "description": "scan codebase with all DFA rules",
6779
- "strict": true,
6780
6463
  "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]",
6781
6464
  "pluginName": "@salesforce/sfdx-scanner",
6782
- "pluginAlias": "@salesforce/sfdx-scanner",
6783
6465
  "pluginType": "jit",
6784
6466
  "aliases": [],
6785
6467
  "examples": [
@@ -6798,7 +6480,6 @@
6798
6480
  "description": "logging level for this command invocation",
6799
6481
  "required": false,
6800
6482
  "helpValue": "(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)",
6801
- "multiple": false,
6802
6483
  "options": [
6803
6484
  "trace",
6804
6485
  "debug",
@@ -6825,8 +6506,7 @@
6825
6506
  "name": "category",
6826
6507
  "type": "option",
6827
6508
  "char": "c",
6828
- "description": "one or more categories of rules to run",
6829
- "multiple": false
6509
+ "description": "one or more categories of rules to run"
6830
6510
  },
6831
6511
  "format": {
6832
6512
  "name": "format",
@@ -6834,7 +6514,6 @@
6834
6514
  "char": "f",
6835
6515
  "description": "specify results output format",
6836
6516
  "helpValue": "(csv|html|json|junit|sarif|table|xml)",
6837
- "multiple": false,
6838
6517
  "options": [
6839
6518
  "csv",
6840
6519
  "html",
@@ -6849,18 +6528,13 @@
6849
6528
  "name": "outfile",
6850
6529
  "type": "option",
6851
6530
  "char": "o",
6852
- "description": "write output to a file",
6853
- "multiple": false
6531
+ "description": "write output to a file"
6854
6532
  },
6855
6533
  "severity-threshold": {
6856
6534
  "name": "severity-threshold",
6857
6535
  "type": "option",
6858
6536
  "char": "s",
6859
- "description": "throw an error when a violation threshold is reached, the --normalize-severity is invoked, and severity levels are reset to the baseline",
6860
- "multiple": false,
6861
- "exclusive": [
6862
- "json"
6863
- ]
6537
+ "description": "throw an error when a violation threshold is reached, the --normalize-severity is invoked, and severity levels are reset to the baseline"
6864
6538
  },
6865
6539
  "normalize-severity": {
6866
6540
  "name": "normalize-severity",
@@ -6872,8 +6546,7 @@
6872
6546
  "name": "projectdir",
6873
6547
  "type": "option",
6874
6548
  "char": "p",
6875
- "description": "provide root directory of project",
6876
- "multiple": false
6549
+ "description": "provide root directory of project"
6877
6550
  },
6878
6551
  "with-pilot": {
6879
6552
  "name": "with-pilot",
@@ -6886,20 +6559,17 @@
6886
6559
  "type": "option",
6887
6560
  "char": "t",
6888
6561
  "description": "return location of source code",
6889
- "required": true,
6890
- "multiple": false
6562
+ "required": true
6891
6563
  },
6892
6564
  "rule-thread-count": {
6893
6565
  "name": "rule-thread-count",
6894
6566
  "type": "option",
6895
- "description": "specify number of threads that evaluate DFA rules. Alternatively, set value using environment variable `SFGE_RULE_THREAD_COUNT`. Default is 4",
6896
- "multiple": false
6567
+ "description": "specify number of threads that evaluate DFA rules. Alternatively, set value using environment variable `SFGE_RULE_THREAD_COUNT`. Default is 4"
6897
6568
  },
6898
6569
  "rule-thread-timeout": {
6899
6570
  "name": "rule-thread-timeout",
6900
6571
  "type": "option",
6901
- "description": "specify timeout for individual rule threads in milliseconds. Alternatively, set the timeout value using environment variable `SFGE_RULE_THREAD_TIMEOUT`. Default: 90000 ms",
6902
- "multiple": false
6572
+ "description": "specify timeout for individual rule threads in milliseconds. Alternatively, set the timeout value using environment variable `SFGE_RULE_THREAD_TIMEOUT`. Default: 90000 ms"
6903
6573
  },
6904
6574
  "rule-disable-warning-violation": {
6905
6575
  "name": "rule-disable-warning-violation",
@@ -6910,158 +6580,19 @@
6910
6580
  "sfgejvmargs": {
6911
6581
  "name": "sfgejvmargs",
6912
6582
  "type": "option",
6913
- "description": "specify Java Virtual Machine (JVM) arguments to optimize Salesforce Graph Engine execution to your system (optional)",
6914
- "multiple": false
6583
+ "description": "specify Java Virtual Machine (JVM) arguments to optimize Salesforce Graph Engine execution to your system (optional)"
6915
6584
  },
6916
6585
  "pathexplimit": {
6917
6586
  "name": "pathexplimit",
6918
6587
  "type": "option",
6919
- "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`",
6920
- "multiple": false
6588
+ "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`"
6921
6589
  }
6922
6590
  },
6923
- "args": {
6924
- "file": {
6591
+ "args": [
6592
+ {
6925
6593
  "name": "file"
6926
6594
  }
6927
- },
6928
- "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.",
6929
- "flagsConfig": {
6930
- "verbose": {
6931
- "type": "boolean",
6932
- "kind": "boolean",
6933
- "description": "emit additional command output to stdout",
6934
- "longDescription": "Emit additional command output to stdout.",
6935
- "allowNo": false
6936
- },
6937
- "category": {
6938
- "kind": "array",
6939
- "char": "c",
6940
- "description": "one or more categories of rules to run",
6941
- "longDescription": "One or more categories of rules to run. Specify multiple values as a comma-separated list.",
6942
- "input": [],
6943
- "multiple": false,
6944
- "type": "option"
6945
- },
6946
- "format": {
6947
- "kind": "enum",
6948
- "helpValue": "(csv|html|json|junit|sarif|table|xml)",
6949
- "char": "f",
6950
- "description": "specify results output format",
6951
- "longDescription": "Specifies results output format written directly to the console.",
6952
- "options": [
6953
- "csv",
6954
- "html",
6955
- "json",
6956
- "junit",
6957
- "sarif",
6958
- "table",
6959
- "xml"
6960
- ],
6961
- "input": [],
6962
- "multiple": false,
6963
- "type": "option"
6964
- },
6965
- "outfile": {
6966
- "kind": "string",
6967
- "char": "o",
6968
- "description": "write output to a file",
6969
- "longDescription": "Writes output to a file.",
6970
- "input": [],
6971
- "multiple": false,
6972
- "type": "option"
6973
- },
6974
- "severity-threshold": {
6975
- "kind": "integer",
6976
- "char": "s",
6977
- "description": "throw an error when a violation threshold is reached, the --normalize-severity is invoked, and severity levels are reset to the baseline",
6978
- "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.",
6979
- "exclusive": [
6980
- "json"
6981
- ],
6982
- "min": 1,
6983
- "max": 3,
6984
- "input": [],
6985
- "multiple": false,
6986
- "type": "option"
6987
- },
6988
- "normalize-severity": {
6989
- "kind": "boolean",
6990
- "description": "return normalized severity 1 (high), 2 (moderate), and 3 (low), and the engine-specific severity",
6991
- "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.",
6992
- "allowNo": false,
6993
- "type": "boolean"
6994
- },
6995
- "projectdir": {
6996
- "kind": "array",
6997
- "char": "p",
6998
- "description": "provide root directory of project",
6999
- "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.",
7000
- "input": [],
7001
- "multiple": false,
7002
- "type": "option"
7003
- },
7004
- "with-pilot": {
7005
- "kind": "boolean",
7006
- "description": "allow pilot rules to execute",
7007
- "longDescription": "Allows pilot rules to execute.",
7008
- "allowNo": false,
7009
- "type": "boolean"
7010
- },
7011
- "target": {
7012
- "kind": "array",
7013
- "char": "t",
7014
- "description": "return location of source code",
7015
- "longDescription": "Returns the source code location. Use glob patterns or specify individual methods with #-syntax. Multiple values are specified as a comma-separated list.",
7016
- "required": true,
7017
- "input": [],
7018
- "multiple": false,
7019
- "type": "option"
7020
- },
7021
- "rule-thread-count": {
7022
- "kind": "integer",
7023
- "description": "specify number of threads that evaluate DFA rules. Alternatively, set value using environment variable `SFGE_RULE_THREAD_COUNT`. Default is 4",
7024
- "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.",
7025
- "env": "SFGE_RULE_THREAD_COUNT",
7026
- "input": [],
7027
- "multiple": false,
7028
- "type": "option"
7029
- },
7030
- "rule-thread-timeout": {
7031
- "kind": "integer",
7032
- "description": "specify timeout for individual rule threads in milliseconds. Alternatively, set the timeout value using environment variable `SFGE_RULE_THREAD_TIMEOUT`. Default: 90000 ms",
7033
- "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.",
7034
- "env": "SFGE_RULE_THREAD_TIMEOUT",
7035
- "input": [],
7036
- "multiple": false,
7037
- "type": "option"
7038
- },
7039
- "rule-disable-warning-violation": {
7040
- "kind": "boolean",
7041
- "description": "disable warning violations from Salesforce Graph Engine. Alternatively, set value using environment variable `SFGE_RULE_DISABLE_WARNING_VIOLATION`",
7042
- "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.",
7043
- "allowNo": false,
7044
- "type": "boolean"
7045
- },
7046
- "sfgejvmargs": {
7047
- "kind": "string",
7048
- "description": "specify Java Virtual Machine (JVM) arguments to optimize Salesforce Graph Engine execution to your system (optional)",
7049
- "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.",
7050
- "env": "SFGE_JVM_ARGS",
7051
- "input": [],
7052
- "multiple": false,
7053
- "type": "option"
7054
- },
7055
- "pathexplimit": {
7056
- "kind": "integer",
7057
- "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`",
7058
- "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.",
7059
- "env": "SFGE_PATH_EXPANSION_LIMIT",
7060
- "input": [],
7061
- "multiple": false,
7062
- "type": "option"
7063
- }
7064
- }
6595
+ ]
7065
6596
  }
7066
6597
  }
7067
6598
  }