@salesforce/cli 2.101.1 → 2.101.3-dev.0

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.
@@ -3353,16 +3353,16 @@
3353
3353
  "snapshot:create:org"
3354
3354
  ]
3355
3355
  },
3356
- "org:list:shape": {
3356
+ "org:delete:shape": {
3357
3357
  "aliases": [
3358
- "force:org:shape:list"
3358
+ "force:org:shape:delete"
3359
3359
  ],
3360
3360
  "args": {},
3361
3361
  "deprecateAliases": true,
3362
- "description": "The output includes the alias, username, and ID of the source org, the status of the org shape creation, and more. Use the org ID to update your scratch org configuration file so you can create a scratch org based on this org shape.",
3362
+ "description": "A source org can have only one active org shape. If you try to create an org shape for a source org that already has one, the previous shape is marked inactive and replaced by a new active shape. If you don’t want to create scratch orgs based on this shape, you can delete the org shape.",
3363
3363
  "examples": [
3364
- "List all org shapes you've created:\n<%= config.bin %> <%= command.id %>",
3365
- "List all org shapes in JSON format and write the output to a file:\n<%= config.bin %> <%= command.id %> --json > tmp/MyOrgShapeList.json"
3364
+ "Delete all org shapes for the source org with alias SourceOrg:\n<%= config.bin %> <%= command.id %> --target-org SourceOrg",
3365
+ "Delete all org shapes without prompting:\n<%= config.bin %> <%= command.id %> --target-org SourceOrg --no-prompt"
3366
3366
  ],
3367
3367
  "flags": {
3368
3368
  "json": {
@@ -3380,12 +3380,31 @@
3380
3380
  "multiple": false,
3381
3381
  "type": "option"
3382
3382
  },
3383
- "verbose": {
3384
- "hidden": true,
3385
- "name": "verbose",
3386
- "summary": "List more information about each org shape.",
3387
- "allowNo": false,
3388
- "type": "boolean"
3383
+ "target-org": {
3384
+ "aliases": [
3385
+ "targetusername",
3386
+ "u"
3387
+ ],
3388
+ "char": "o",
3389
+ "deprecateAliases": true,
3390
+ "name": "target-org",
3391
+ "noCacheDefault": true,
3392
+ "required": true,
3393
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
3394
+ "hasDynamicHelp": true,
3395
+ "multiple": false,
3396
+ "type": "option"
3397
+ },
3398
+ "api-version": {
3399
+ "aliases": [
3400
+ "apiversion"
3401
+ ],
3402
+ "deprecateAliases": true,
3403
+ "description": "Override the api version used for api requests made by this command",
3404
+ "name": "api-version",
3405
+ "hasDynamicHelp": false,
3406
+ "multiple": false,
3407
+ "type": "option"
3389
3408
  },
3390
3409
  "loglevel": {
3391
3410
  "deprecated": {
@@ -3396,70 +3415,81 @@
3396
3415
  "hasDynamicHelp": false,
3397
3416
  "multiple": false,
3398
3417
  "type": "option"
3418
+ },
3419
+ "no-prompt": {
3420
+ "aliases": [
3421
+ "noprompt"
3422
+ ],
3423
+ "char": "p",
3424
+ "deprecateAliases": true,
3425
+ "name": "no-prompt",
3426
+ "summary": "Don't prompt for confirmation.",
3427
+ "allowNo": false,
3428
+ "type": "boolean"
3399
3429
  }
3400
3430
  },
3401
- "hasDynamicHelp": false,
3431
+ "hasDynamicHelp": true,
3402
3432
  "hiddenAliases": [],
3403
- "id": "org:list:shape",
3433
+ "id": "org:delete:shape",
3404
3434
  "pluginAlias": "@salesforce/plugin-signups",
3405
3435
  "pluginName": "@salesforce/plugin-signups",
3406
3436
  "pluginType": "jit",
3407
3437
  "strict": true,
3408
- "summary": "List all org shapes you’ve created.",
3438
+ "summary": "Delete all org shapes for a target org.",
3409
3439
  "enableJsonFlag": true,
3410
3440
  "isESM": true,
3411
3441
  "relativePath": [
3412
3442
  "lib",
3413
3443
  "commands",
3414
3444
  "org",
3415
- "list",
3445
+ "delete",
3416
3446
  "shape.js"
3417
3447
  ],
3418
3448
  "aliasPermutations": [
3419
- "force:org:shape:list",
3420
- "org:force:shape:list",
3421
- "org:shape:force:list",
3422
- "org:shape:list:force",
3423
- "force:shape:org:list",
3424
- "shape:force:org:list",
3425
- "shape:org:force:list",
3426
- "shape:org:list:force",
3427
- "force:shape:list:org",
3428
- "shape:force:list:org",
3429
- "shape:list:force:org",
3430
- "shape:list:org:force",
3431
- "force:org:list:shape",
3432
- "org:force:list:shape",
3433
- "org:list:force:shape",
3434
- "org:list:shape:force",
3435
- "force:list:org:shape",
3436
- "list:force:org:shape",
3437
- "list:org:force:shape",
3438
- "list:org:shape:force",
3439
- "force:list:shape:org",
3440
- "list:force:shape:org",
3441
- "list:shape:force:org",
3442
- "list:shape:org:force"
3449
+ "force:org:shape:delete",
3450
+ "org:force:shape:delete",
3451
+ "org:shape:force:delete",
3452
+ "org:shape:delete:force",
3453
+ "force:shape:org:delete",
3454
+ "shape:force:org:delete",
3455
+ "shape:org:force:delete",
3456
+ "shape:org:delete:force",
3457
+ "force:shape:delete:org",
3458
+ "shape:force:delete:org",
3459
+ "shape:delete:force:org",
3460
+ "shape:delete:org:force",
3461
+ "force:org:delete:shape",
3462
+ "org:force:delete:shape",
3463
+ "org:delete:force:shape",
3464
+ "org:delete:shape:force",
3465
+ "force:delete:org:shape",
3466
+ "delete:force:org:shape",
3467
+ "delete:org:force:shape",
3468
+ "delete:org:shape:force",
3469
+ "force:delete:shape:org",
3470
+ "delete:force:shape:org",
3471
+ "delete:shape:force:org",
3472
+ "delete:shape:org:force"
3443
3473
  ],
3444
3474
  "permutations": [
3445
- "org:list:shape",
3446
- "list:org:shape",
3447
- "list:shape:org",
3448
- "org:shape:list",
3449
- "shape:org:list",
3450
- "shape:list:org"
3475
+ "org:delete:shape",
3476
+ "delete:org:shape",
3477
+ "delete:shape:org",
3478
+ "org:shape:delete",
3479
+ "shape:org:delete",
3480
+ "shape:delete:org"
3451
3481
  ]
3452
3482
  },
3453
- "org:list:snapshot": {
3483
+ "org:delete:snapshot": {
3454
3484
  "aliases": [
3455
- "force:org:snapshot:list"
3485
+ "force:org:snapshot:delete"
3456
3486
  ],
3457
3487
  "args": {},
3458
3488
  "deprecateAliases": true,
3459
- "description": "You can view all the snapshots in a Dev Hub that you have access to. If you’re an admin, you can see all snapshots associated with the Dev Hub org. If you’re a user, you can see only your snapshots unless a Dev Hub admin gives you View All permissions.\n\nTo create a snapshot, use the \"<%= config.bin %> org create snapshot\" command. To get details about a snapshot request, use \"<%= config.bin %> org get snapshot\".",
3489
+ "description": "Dev Hub admins can delete any snapshot. Users can delete only their own snapshots, unless a Dev Hub admin gives the user Modify All permission, which works only with the Salesforce license.",
3460
3490
  "examples": [
3461
- "List snapshots in the default Dev Hub:\n<%= config.bin %> <%= command.id %>",
3462
- "List snapshots in the Dev Hub with alias SnapshotDevHub:\n<%= config.bin %> <%= command.id %> --target-dev-hub SnapshotDevHub"
3491
+ "Delete a snapshot from the default Dev Hub using the snapshot ID:\n<%= config.bin %> <%= command.id %> --snapshot 0Oo...",
3492
+ "Delete a snapshot from the specified Dev Hub using the snapshot name:\n<%= config.bin %> <%= command.id %> --snapshot BaseSnapshot --target-dev-hub SnapshotDevHub"
3463
3493
  ],
3464
3494
  "flags": {
3465
3495
  "json": {
@@ -3511,58 +3541,75 @@
3511
3541
  "hasDynamicHelp": false,
3512
3542
  "multiple": false,
3513
3543
  "type": "option"
3544
+ },
3545
+ "snapshot": {
3546
+ "char": "s",
3547
+ "description": "The IDs of scratch org snapshots start with 0Oo.",
3548
+ "name": "snapshot",
3549
+ "required": true,
3550
+ "summary": "Name or ID of snapshot to delete.",
3551
+ "hasDynamicHelp": false,
3552
+ "multiple": false,
3553
+ "type": "option"
3554
+ },
3555
+ "no-prompt": {
3556
+ "char": "p",
3557
+ "name": "no-prompt",
3558
+ "summary": "Don't prompt the user to confirm the deletion.",
3559
+ "allowNo": false,
3560
+ "type": "boolean"
3514
3561
  }
3515
3562
  },
3516
3563
  "hasDynamicHelp": true,
3517
3564
  "hiddenAliases": [],
3518
- "id": "org:list:snapshot",
3565
+ "id": "org:delete:snapshot",
3519
3566
  "pluginAlias": "@salesforce/plugin-signups",
3520
3567
  "pluginName": "@salesforce/plugin-signups",
3521
3568
  "pluginType": "jit",
3522
3569
  "strict": true,
3523
- "summary": "List scratch org snapshots.",
3570
+ "summary": "Delete a scratch org snapshot.",
3524
3571
  "enableJsonFlag": true,
3525
3572
  "isESM": true,
3526
3573
  "relativePath": [
3527
3574
  "lib",
3528
3575
  "commands",
3529
3576
  "org",
3530
- "list",
3577
+ "delete",
3531
3578
  "snapshot.js"
3532
3579
  ],
3533
3580
  "aliasPermutations": [
3534
- "force:org:snapshot:list",
3535
- "org:force:snapshot:list",
3536
- "org:snapshot:force:list",
3537
- "org:snapshot:list:force",
3538
- "force:snapshot:org:list",
3539
- "snapshot:force:org:list",
3540
- "snapshot:org:force:list",
3541
- "snapshot:org:list:force",
3542
- "force:snapshot:list:org",
3543
- "snapshot:force:list:org",
3544
- "snapshot:list:force:org",
3545
- "snapshot:list:org:force",
3546
- "force:org:list:snapshot",
3547
- "org:force:list:snapshot",
3548
- "org:list:force:snapshot",
3549
- "org:list:snapshot:force",
3550
- "force:list:org:snapshot",
3551
- "list:force:org:snapshot",
3552
- "list:org:force:snapshot",
3553
- "list:org:snapshot:force",
3554
- "force:list:snapshot:org",
3555
- "list:force:snapshot:org",
3556
- "list:snapshot:force:org",
3557
- "list:snapshot:org:force"
3581
+ "force:org:snapshot:delete",
3582
+ "org:force:snapshot:delete",
3583
+ "org:snapshot:force:delete",
3584
+ "org:snapshot:delete:force",
3585
+ "force:snapshot:org:delete",
3586
+ "snapshot:force:org:delete",
3587
+ "snapshot:org:force:delete",
3588
+ "snapshot:org:delete:force",
3589
+ "force:snapshot:delete:org",
3590
+ "snapshot:force:delete:org",
3591
+ "snapshot:delete:force:org",
3592
+ "snapshot:delete:org:force",
3593
+ "force:org:delete:snapshot",
3594
+ "org:force:delete:snapshot",
3595
+ "org:delete:force:snapshot",
3596
+ "org:delete:snapshot:force",
3597
+ "force:delete:org:snapshot",
3598
+ "delete:force:org:snapshot",
3599
+ "delete:org:force:snapshot",
3600
+ "delete:org:snapshot:force",
3601
+ "force:delete:snapshot:org",
3602
+ "delete:force:snapshot:org",
3603
+ "delete:snapshot:force:org",
3604
+ "delete:snapshot:org:force"
3558
3605
  ],
3559
3606
  "permutations": [
3560
- "org:list:snapshot",
3561
- "list:org:snapshot",
3562
- "list:snapshot:org",
3563
- "org:snapshot:list",
3564
- "snapshot:org:list",
3565
- "snapshot:list:org"
3607
+ "org:delete:snapshot",
3608
+ "delete:org:snapshot",
3609
+ "delete:snapshot:org",
3610
+ "org:snapshot:delete",
3611
+ "snapshot:org:delete",
3612
+ "snapshot:delete:org"
3566
3613
  ]
3567
3614
  },
3568
3615
  "org:get:snapshot": {
@@ -3690,16 +3737,16 @@
3690
3737
  "snapshot:get:org"
3691
3738
  ]
3692
3739
  },
3693
- "org:delete:shape": {
3740
+ "org:list:shape": {
3694
3741
  "aliases": [
3695
- "force:org:shape:delete"
3742
+ "force:org:shape:list"
3696
3743
  ],
3697
3744
  "args": {},
3698
3745
  "deprecateAliases": true,
3699
- "description": "A source org can have only one active org shape. If you try to create an org shape for a source org that already has one, the previous shape is marked inactive and replaced by a new active shape. If you don’t want to create scratch orgs based on this shape, you can delete the org shape.",
3746
+ "description": "The output includes the alias, username, and ID of the source org, the status of the org shape creation, and more. Use the org ID to update your scratch org configuration file so you can create a scratch org based on this org shape.",
3700
3747
  "examples": [
3701
- "Delete all org shapes for the source org with alias SourceOrg:\n<%= config.bin %> <%= command.id %> --target-org SourceOrg",
3702
- "Delete all org shapes without prompting:\n<%= config.bin %> <%= command.id %> --target-org SourceOrg --no-prompt"
3748
+ "List all org shapes you've created:\n<%= config.bin %> <%= command.id %>",
3749
+ "List all org shapes in JSON format and write the output to a file:\n<%= config.bin %> <%= command.id %> --json > tmp/MyOrgShapeList.json"
3703
3750
  ],
3704
3751
  "flags": {
3705
3752
  "json": {
@@ -3717,31 +3764,12 @@
3717
3764
  "multiple": false,
3718
3765
  "type": "option"
3719
3766
  },
3720
- "target-org": {
3721
- "aliases": [
3722
- "targetusername",
3723
- "u"
3724
- ],
3725
- "char": "o",
3726
- "deprecateAliases": true,
3727
- "name": "target-org",
3728
- "noCacheDefault": true,
3729
- "required": true,
3730
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
3731
- "hasDynamicHelp": true,
3732
- "multiple": false,
3733
- "type": "option"
3734
- },
3735
- "api-version": {
3736
- "aliases": [
3737
- "apiversion"
3738
- ],
3739
- "deprecateAliases": true,
3740
- "description": "Override the api version used for api requests made by this command",
3741
- "name": "api-version",
3742
- "hasDynamicHelp": false,
3743
- "multiple": false,
3744
- "type": "option"
3767
+ "verbose": {
3768
+ "hidden": true,
3769
+ "name": "verbose",
3770
+ "summary": "List more information about each org shape.",
3771
+ "allowNo": false,
3772
+ "type": "boolean"
3745
3773
  },
3746
3774
  "loglevel": {
3747
3775
  "deprecated": {
@@ -3752,81 +3780,70 @@
3752
3780
  "hasDynamicHelp": false,
3753
3781
  "multiple": false,
3754
3782
  "type": "option"
3755
- },
3756
- "no-prompt": {
3757
- "aliases": [
3758
- "noprompt"
3759
- ],
3760
- "char": "p",
3761
- "deprecateAliases": true,
3762
- "name": "no-prompt",
3763
- "summary": "Don't prompt for confirmation.",
3764
- "allowNo": false,
3765
- "type": "boolean"
3766
3783
  }
3767
3784
  },
3768
- "hasDynamicHelp": true,
3785
+ "hasDynamicHelp": false,
3769
3786
  "hiddenAliases": [],
3770
- "id": "org:delete:shape",
3787
+ "id": "org:list:shape",
3771
3788
  "pluginAlias": "@salesforce/plugin-signups",
3772
3789
  "pluginName": "@salesforce/plugin-signups",
3773
3790
  "pluginType": "jit",
3774
3791
  "strict": true,
3775
- "summary": "Delete all org shapes for a target org.",
3792
+ "summary": "List all org shapes you’ve created.",
3776
3793
  "enableJsonFlag": true,
3777
3794
  "isESM": true,
3778
3795
  "relativePath": [
3779
3796
  "lib",
3780
3797
  "commands",
3781
3798
  "org",
3782
- "delete",
3799
+ "list",
3783
3800
  "shape.js"
3784
3801
  ],
3785
3802
  "aliasPermutations": [
3786
- "force:org:shape:delete",
3787
- "org:force:shape:delete",
3788
- "org:shape:force:delete",
3789
- "org:shape:delete:force",
3790
- "force:shape:org:delete",
3791
- "shape:force:org:delete",
3792
- "shape:org:force:delete",
3793
- "shape:org:delete:force",
3794
- "force:shape:delete:org",
3795
- "shape:force:delete:org",
3796
- "shape:delete:force:org",
3797
- "shape:delete:org:force",
3798
- "force:org:delete:shape",
3799
- "org:force:delete:shape",
3800
- "org:delete:force:shape",
3801
- "org:delete:shape:force",
3802
- "force:delete:org:shape",
3803
- "delete:force:org:shape",
3804
- "delete:org:force:shape",
3805
- "delete:org:shape:force",
3806
- "force:delete:shape:org",
3807
- "delete:force:shape:org",
3808
- "delete:shape:force:org",
3809
- "delete:shape:org:force"
3803
+ "force:org:shape:list",
3804
+ "org:force:shape:list",
3805
+ "org:shape:force:list",
3806
+ "org:shape:list:force",
3807
+ "force:shape:org:list",
3808
+ "shape:force:org:list",
3809
+ "shape:org:force:list",
3810
+ "shape:org:list:force",
3811
+ "force:shape:list:org",
3812
+ "shape:force:list:org",
3813
+ "shape:list:force:org",
3814
+ "shape:list:org:force",
3815
+ "force:org:list:shape",
3816
+ "org:force:list:shape",
3817
+ "org:list:force:shape",
3818
+ "org:list:shape:force",
3819
+ "force:list:org:shape",
3820
+ "list:force:org:shape",
3821
+ "list:org:force:shape",
3822
+ "list:org:shape:force",
3823
+ "force:list:shape:org",
3824
+ "list:force:shape:org",
3825
+ "list:shape:force:org",
3826
+ "list:shape:org:force"
3810
3827
  ],
3811
3828
  "permutations": [
3812
- "org:delete:shape",
3813
- "delete:org:shape",
3814
- "delete:shape:org",
3815
- "org:shape:delete",
3816
- "shape:org:delete",
3817
- "shape:delete:org"
3829
+ "org:list:shape",
3830
+ "list:org:shape",
3831
+ "list:shape:org",
3832
+ "org:shape:list",
3833
+ "shape:org:list",
3834
+ "shape:list:org"
3818
3835
  ]
3819
3836
  },
3820
- "org:delete:snapshot": {
3837
+ "org:list:snapshot": {
3821
3838
  "aliases": [
3822
- "force:org:snapshot:delete"
3839
+ "force:org:snapshot:list"
3823
3840
  ],
3824
3841
  "args": {},
3825
3842
  "deprecateAliases": true,
3826
- "description": "Dev Hub admins can delete any snapshot. Users can delete only their own snapshots, unless a Dev Hub admin gives the user Modify All permission, which works only with the Salesforce license.",
3843
+ "description": "You can view all the snapshots in a Dev Hub that you have access to. If you’re an admin, you can see all snapshots associated with the Dev Hub org. If you’re a user, you can see only your snapshots unless a Dev Hub admin gives you View All permissions.\n\nTo create a snapshot, use the \"<%= config.bin %> org create snapshot\" command. To get details about a snapshot request, use \"<%= config.bin %> org get snapshot\".",
3827
3844
  "examples": [
3828
- "Delete a snapshot from the default Dev Hub using the snapshot ID:\n<%= config.bin %> <%= command.id %> --snapshot 0Oo...",
3829
- "Delete a snapshot from the specified Dev Hub using the snapshot name:\n<%= config.bin %> <%= command.id %> --snapshot BaseSnapshot --target-dev-hub SnapshotDevHub"
3845
+ "List snapshots in the default Dev Hub:\n<%= config.bin %> <%= command.id %>",
3846
+ "List snapshots in the Dev Hub with alias SnapshotDevHub:\n<%= config.bin %> <%= command.id %> --target-dev-hub SnapshotDevHub"
3830
3847
  ],
3831
3848
  "flags": {
3832
3849
  "json": {
@@ -3878,75 +3895,58 @@
3878
3895
  "hasDynamicHelp": false,
3879
3896
  "multiple": false,
3880
3897
  "type": "option"
3881
- },
3882
- "snapshot": {
3883
- "char": "s",
3884
- "description": "The IDs of scratch org snapshots start with 0Oo.",
3885
- "name": "snapshot",
3886
- "required": true,
3887
- "summary": "Name or ID of snapshot to delete.",
3888
- "hasDynamicHelp": false,
3889
- "multiple": false,
3890
- "type": "option"
3891
- },
3892
- "no-prompt": {
3893
- "char": "p",
3894
- "name": "no-prompt",
3895
- "summary": "Don't prompt the user to confirm the deletion.",
3896
- "allowNo": false,
3897
- "type": "boolean"
3898
3898
  }
3899
3899
  },
3900
3900
  "hasDynamicHelp": true,
3901
3901
  "hiddenAliases": [],
3902
- "id": "org:delete:snapshot",
3902
+ "id": "org:list:snapshot",
3903
3903
  "pluginAlias": "@salesforce/plugin-signups",
3904
3904
  "pluginName": "@salesforce/plugin-signups",
3905
3905
  "pluginType": "jit",
3906
3906
  "strict": true,
3907
- "summary": "Delete a scratch org snapshot.",
3907
+ "summary": "List scratch org snapshots.",
3908
3908
  "enableJsonFlag": true,
3909
3909
  "isESM": true,
3910
3910
  "relativePath": [
3911
3911
  "lib",
3912
3912
  "commands",
3913
3913
  "org",
3914
- "delete",
3914
+ "list",
3915
3915
  "snapshot.js"
3916
3916
  ],
3917
3917
  "aliasPermutations": [
3918
- "force:org:snapshot:delete",
3919
- "org:force:snapshot:delete",
3920
- "org:snapshot:force:delete",
3921
- "org:snapshot:delete:force",
3922
- "force:snapshot:org:delete",
3923
- "snapshot:force:org:delete",
3924
- "snapshot:org:force:delete",
3925
- "snapshot:org:delete:force",
3926
- "force:snapshot:delete:org",
3927
- "snapshot:force:delete:org",
3928
- "snapshot:delete:force:org",
3929
- "snapshot:delete:org:force",
3930
- "force:org:delete:snapshot",
3931
- "org:force:delete:snapshot",
3932
- "org:delete:force:snapshot",
3933
- "org:delete:snapshot:force",
3934
- "force:delete:org:snapshot",
3935
- "delete:force:org:snapshot",
3936
- "delete:org:force:snapshot",
3937
- "delete:org:snapshot:force",
3938
- "force:delete:snapshot:org",
3939
- "delete:force:snapshot:org",
3940
- "delete:snapshot:force:org",
3941
- "delete:snapshot:org:force"
3918
+ "force:org:snapshot:list",
3919
+ "org:force:snapshot:list",
3920
+ "org:snapshot:force:list",
3921
+ "org:snapshot:list:force",
3922
+ "force:snapshot:org:list",
3923
+ "snapshot:force:org:list",
3924
+ "snapshot:org:force:list",
3925
+ "snapshot:org:list:force",
3926
+ "force:snapshot:list:org",
3927
+ "snapshot:force:list:org",
3928
+ "snapshot:list:force:org",
3929
+ "snapshot:list:org:force",
3930
+ "force:org:list:snapshot",
3931
+ "org:force:list:snapshot",
3932
+ "org:list:force:snapshot",
3933
+ "org:list:snapshot:force",
3934
+ "force:list:org:snapshot",
3935
+ "list:force:org:snapshot",
3936
+ "list:org:force:snapshot",
3937
+ "list:org:snapshot:force",
3938
+ "force:list:snapshot:org",
3939
+ "list:force:snapshot:org",
3940
+ "list:snapshot:force:org",
3941
+ "list:snapshot:org:force"
3942
3942
  ],
3943
3943
  "permutations": [
3944
- "org:delete:snapshot",
3945
- "delete:org:snapshot",
3946
- "delete:snapshot:org",
3947
- "org:snapshot:delete",
3948
- "snapshot:org:delete",
3949
- "snapshot:delete:org"
3944
+ "org:list:snapshot",
3945
+ "list:org:snapshot",
3946
+ "list:snapshot:org",
3947
+ "org:snapshot:list",
3948
+ "snapshot:org:list",
3949
+ "snapshot:list:org"
3950
3950
  ]
3951
3951
  },
3952
3952
  "force:lightning:lwc:test:create": {
@@ -4156,680 +4156,7 @@
4156
4156
  "args": {},
4157
4157
  "longDescription": "Installs Jest unit testing tools for Lightning Web Components. For more information, see the Lightning Web Components Dev Guide: https://developer.salesforce.com/docs/component-library/documentation/lwc/lwc.testing",
4158
4158
  "requiresProject": true
4159
- },
4160
- "scanner:run": {
4161
- "aliases": [],
4162
- "args": {},
4163
- "description": "Specify the format of the output, such as XML or JUnit. Print the output to the console (default) or to a file using the --outfile parameter.",
4164
- "examples": [
4165
- "This example evaluates all rules against somefile.js. Invoking code analyzer without specifying any rules causes all rules to be run.\n<%= config.bin %> <%= command.id %> --format xml --target \"somefile.js\"\nThis example evaluates all rules in the Design and Best Practices categories. When you specify multiple categories or rulesets, the results are combined with a logical OR.\n<%= config.bin %> <%= command.id %> --format xml --target \"somefile.js\" --\nThese examples evaluate rules against all .js files in the current directory, except for IgnoreMe.js. Unix example:\n<%= config.bin %> <%= command.id %> --target './**/*.js,!./**/IgnoreMe.js' ...\nWindows example:\n<%= config.bin %> <%= command.id %> --target \".\\**\\*.js,!.\\**\\IgnoreMe.js\" ...\nThis example scans the project contained in '/my-project' if the current working directory is another directory. Specify tsconfig.json if the current working directory does not contain the tsconfig.json that corresponds to the TypeScript files being scanned.\n<%= config.bin %> <%= command.id %> --target \"/my-project/**/*.ts\" --tsconfig \"/my-project/tsconfig.json\"\nThis example evaluates rules against somefile.js, including Jasmine in the environment variables. Uses --env to override the default ESLint environment variables to add frameworks.\n<%= config.bin %> <%= command.id %> --target \"somefile.js\" --env '{\"jasmine\": true}'\nThis example evaluates rules aginst somefile.js using eslint-lwc and pmd engines. Use --engine to include or exclude engines. Any engine listed will be run, regardless of its current 'disabled' attribute.\n<%= config.bin %> <%= command.id %> --target \"somefile.js\" --engine \"eslint-lwc,pmd\"\nThis example executes CPD engine against known file extensions in \"/some/dir\". CPD helps detect blocks of code duplication in selected languages. Use --engine to invoke engines that are not enabled by default.\n<%= config.bin %> <%= command.id %> --target \"/some/dir\" --engine cpd\nThis example executes rules defined in pmd_rule_ref.xml against the files in 'src'. To use PMD with your own rule reference file, use --pmdconfig. Note that rule filters are not applied.\n<%= config.bin %> <%= command.id %> --target \"src\" --pmdconfig \"pmd_rule_ref.xml\"\nThis example uses a custom config to scan the files in 'src'. To use ESLint with your own .eslintrc.json file, use --eslintconfig. Make sure that the directory you run the command from has all the NPM dependencies installed.\n<%= config.bin %> <%= command.id %> --target \"src\" --eslintconfig \"/home/my/setup/.eslintrc.json\"\nThis example uses --normalize-severity to output normalized severity and engine-specific severity across all engines. Normalized severity is: 1 (high), 2 (moderate), and 3 (low).\n<%= config.bin %> <%= command.id %> --target \"/some-project/\" --format csv --normalize-severity\nThis example uses --severity-threshold to throw a non-zero exit code when rule violations of normalized severity 2 or greater are found. If any violations with the specified severity (or greater) are found, the exit code equals the severity of the most severe violation.\n<%= config.bin %> <%= command.id %> --target \"/some-project/\" --severity-threshold 2\nThese examples explain that the paths specified for --projectdir must contain all files specified through --target cumulatively.\n<%= config.bin %> <%= command.id %> --target \"./myproject/main/default/classes/*.cls\" --projectdir \"./myproject/\"\n<%= config.bin %> <%= command.id %> --target \"./**/*.cls\" --projectdir \"./\"\n<%= config.bin %> <%= command.id %> --target \"./dir1/file1.cls,./dir2/file2.cls\" --projectdir \"./dir1/,./dir2/\"\nThis example fails because the set of files included in --target is larger than that contained in --projectdir.\n<%= config.bin %> <%= command.id %> --target \"./**/*.cls\" --projectdir \"./myproject/\""
4166
- ],
4167
- "flags": {
4168
- "json": {
4169
- "description": "Format output as json.",
4170
- "helpGroup": "GLOBAL",
4171
- "name": "json",
4172
- "allowNo": false,
4173
- "type": "boolean"
4174
- },
4175
- "verbose": {
4176
- "name": "verbose",
4177
- "summary": "Emit additional command output to stdout.",
4178
- "allowNo": false,
4179
- "type": "boolean"
4180
- },
4181
- "category": {
4182
- "char": "c",
4183
- "description": "Specify multiple values as a comma-separated list.",
4184
- "name": "category",
4185
- "summary": "One or more categories of rules to run.",
4186
- "delimiter": ",",
4187
- "hasDynamicHelp": false,
4188
- "multiple": true,
4189
- "type": "option"
4190
- },
4191
- "format": {
4192
- "char": "f",
4193
- "name": "format",
4194
- "summary": "The output format for results written directly to the console.",
4195
- "hasDynamicHelp": false,
4196
- "multiple": false,
4197
- "options": [
4198
- "csv",
4199
- "html",
4200
- "json",
4201
- "junit",
4202
- "sarif",
4203
- "table",
4204
- "xml"
4205
- ],
4206
- "type": "option"
4207
- },
4208
- "outfile": {
4209
- "char": "o",
4210
- "name": "outfile",
4211
- "summary": "File to write output to.",
4212
- "hasDynamicHelp": false,
4213
- "multiple": false,
4214
- "type": "option"
4215
- },
4216
- "severity-threshold": {
4217
- "char": "s",
4218
- "description": "Values are 1 (high), 2 (moderate), and 3 (low). Exit code is the most severe violation. Using this flag also invokes the --normalize-severity flag.",
4219
- "exclusive": [
4220
- "json"
4221
- ],
4222
- "name": "severity-threshold",
4223
- "summary": "An error will be thrown when a violation is found with a severity equal to or greater than the specified level.",
4224
- "hasDynamicHelp": false,
4225
- "multiple": false,
4226
- "type": "option"
4227
- },
4228
- "normalize-severity": {
4229
- "description": "For the html option, the normalized severity is displayed instead of the engine severity.",
4230
- "name": "normalize-severity",
4231
- "summary": "Include normalized severity levels 1 (high), 2 (moderate), and 3 (low) with the results.",
4232
- "allowNo": false,
4233
- "type": "boolean"
4234
- },
4235
- "projectdir": {
4236
- "char": "p",
4237
- "description": "Specify multiple values as a comma-separated list. Each project directory must be a path, not a glob. If --projectdir isn’t specified, a default value is calculated. The default value is a directory that contains all the target files.",
4238
- "name": "projectdir",
4239
- "summary": "The relative or absolute root project directories used to set the context for Graph Engine's analysis.",
4240
- "delimiter": ",",
4241
- "hasDynamicHelp": false,
4242
- "multiple": true,
4243
- "type": "option"
4244
- },
4245
- "ruleset": {
4246
- "char": "r",
4247
- "deprecated": {
4248
- "message": "The 'ruleset' command parameter is deprecated. Use 'category' instead."
4249
- },
4250
- "description": "Use category instead. One or more rulesets to run. Specify multiple values as a comma-separated list.",
4251
- "name": "ruleset",
4252
- "summary": "[Deprecated] Rulesets to run.",
4253
- "delimiter": ",",
4254
- "hasDynamicHelp": false,
4255
- "multiple": true,
4256
- "type": "option"
4257
- },
4258
- "engine": {
4259
- "char": "e",
4260
- "description": "Submit multiple values as a comma-separated list.",
4261
- "name": "engine",
4262
- "summary": "Specify which engines to run.",
4263
- "delimiter": ",",
4264
- "hasDynamicHelp": false,
4265
- "multiple": true,
4266
- "options": [
4267
- "eslint",
4268
- "eslint-lwc",
4269
- "eslint-typescript",
4270
- "pmd",
4271
- "pmd-appexchange",
4272
- "retire-js",
4273
- "sfge",
4274
- "cpd"
4275
- ],
4276
- "type": "option"
4277
- },
4278
- "target": {
4279
- "char": "t",
4280
- "description": "Specify multiple values as a comma-separated list. Can use glob patterns. Default is \".\".",
4281
- "name": "target",
4282
- "summary": "Source code location.",
4283
- "delimiter": ",",
4284
- "hasDynamicHelp": false,
4285
- "multiple": true,
4286
- "type": "option"
4287
- },
4288
- "tsconfig": {
4289
- "name": "tsconfig",
4290
- "summary": "Location of tsconfig.json file used by the eslint-typescript engine. The --tsconfig flag can’t be used with --eslintconfig flag.",
4291
- "hasDynamicHelp": false,
4292
- "multiple": false,
4293
- "type": "option"
4294
- },
4295
- "eslintconfig": {
4296
- "name": "eslintconfig",
4297
- "summary": "Specify the location of eslintrc config to customize eslint engine. The --tsconfig flag can’t be used with --eslintconfig flag.",
4298
- "hasDynamicHelp": false,
4299
- "multiple": false,
4300
- "type": "option"
4301
- },
4302
- "pmdconfig": {
4303
- "name": "pmdconfig",
4304
- "summary": "Location of PMD rule reference XML file to customize rule selection.",
4305
- "hasDynamicHelp": false,
4306
- "multiple": false,
4307
- "type": "option"
4308
- },
4309
- "env": {
4310
- "deprecated": {
4311
- "message": "--env parameter is being deprecated, and will be removed in a future release."
4312
- },
4313
- "description": "Overrides ESLint's default environmental variables, in JSON-formatted string.",
4314
- "name": "env",
4315
- "summary": "[Deprecated] Override ESLint's default environment variables, in JSON-formatted string.",
4316
- "hasDynamicHelp": false,
4317
- "multiple": false,
4318
- "type": "option"
4319
- },
4320
- "verbose-violations": {
4321
- "name": "verbose-violations",
4322
- "summary": "Includes Retire-js violation-message details about each vulnerability in the results, including summary, common vulnerabilities and exposures (CVE), and URLs.",
4323
- "allowNo": false,
4324
- "type": "boolean"
4325
- }
4326
- },
4327
- "hasDynamicHelp": false,
4328
- "hiddenAliases": [],
4329
- "id": "scanner:run",
4330
- "pluginAlias": "@salesforce/sfdx-scanner",
4331
- "pluginName": "@salesforce/sfdx-scanner",
4332
- "pluginType": "jit",
4333
- "strict": true,
4334
- "summary": "Scan a codebase with all the rules in the registry, or use parameters to filter the rules based on rulename, category, or ruleset.",
4335
- "enableJsonFlag": true,
4336
- "SF_ENV": "SF_ENV",
4337
- "invocation": "scanner run",
4338
- "isESM": false,
4339
- "relativePath": [
4340
- "lib",
4341
- "commands",
4342
- "scanner",
4343
- "run.js"
4344
- ],
4345
- "aliasPermutations": [],
4346
- "permutations": [
4347
- "scanner:run",
4348
- "run:scanner"
4349
- ]
4350
- },
4351
- "scanner:rule:add": {
4352
- "aliases": [],
4353
- "args": {},
4354
- "description": "Bundle custom PMD rules in JAR files. Follow PMD conventions, such as defining the custom rules in XML files under a `/category/` directory. Compile and test custom rules separately before adding them. See PMD's documentation for more information on writing rules.",
4355
- "examples": [
4356
- "This example shows how to specify two JAR files directly.\n<%= config.bin %> <%= command.id %> --language apex --path \"/Users/me/rules/Jar1.jar,/Users/me/rules/Jar2.jar\"\nThis example shows how to specify a directory containing one or more JARs, all of which are added to the registry.\n<%= config.bin %> <%= command.id %> --language apex --path \"/Users/me/rules\""
4357
- ],
4358
- "flags": {
4359
- "json": {
4360
- "description": "Format output as json.",
4361
- "helpGroup": "GLOBAL",
4362
- "name": "json",
4363
- "allowNo": false,
4364
- "type": "boolean"
4365
- },
4366
- "language": {
4367
- "char": "l",
4368
- "name": "language",
4369
- "required": true,
4370
- "summary": "Language that the custom rules are evaluated against.",
4371
- "hasDynamicHelp": false,
4372
- "multiple": false,
4373
- "type": "option"
4374
- },
4375
- "path": {
4376
- "char": "p",
4377
- "description": "Specify multiple values as a comma-separated list.",
4378
- "name": "path",
4379
- "required": true,
4380
- "summary": "One or more paths (such as a directory or JAR file) to custom rule definitions.",
4381
- "delimiter": ",",
4382
- "hasDynamicHelp": false,
4383
- "multiple": true,
4384
- "type": "option"
4385
- }
4386
- },
4387
- "hasDynamicHelp": false,
4388
- "hiddenAliases": [],
4389
- "id": "scanner:rule:add",
4390
- "pluginAlias": "@salesforce/sfdx-scanner",
4391
- "pluginName": "@salesforce/sfdx-scanner",
4392
- "pluginType": "jit",
4393
- "strict": true,
4394
- "summary": "Add custom rules to Salesforce Code Analyzer's registry to run them along with the built-in rules.",
4395
- "enableJsonFlag": true,
4396
- "SF_ENV": "SF_ENV",
4397
- "isESM": false,
4398
- "relativePath": [
4399
- "lib",
4400
- "commands",
4401
- "scanner",
4402
- "rule",
4403
- "add.js"
4404
- ],
4405
- "aliasPermutations": [],
4406
- "permutations": [
4407
- "scanner:rule:add",
4408
- "rule:scanner:add",
4409
- "rule:add:scanner",
4410
- "scanner:add:rule",
4411
- "add:scanner:rule",
4412
- "add:rule:scanner"
4413
- ]
4414
- },
4415
- "scanner:rule:describe": {
4416
- "aliases": [],
4417
- "args": {},
4418
- "examples": [
4419
- "This example shows how to describe the ApexBadCrypto rule.\n<%= config.bin %> <%= command.id %> --rulename ApexBadCrypto"
4420
- ],
4421
- "flags": {
4422
- "json": {
4423
- "description": "Format output as json.",
4424
- "helpGroup": "GLOBAL",
4425
- "name": "json",
4426
- "allowNo": false,
4427
- "type": "boolean"
4428
- },
4429
- "rulename": {
4430
- "char": "n",
4431
- "name": "rulename",
4432
- "required": true,
4433
- "summary": "The name of the rule.",
4434
- "hasDynamicHelp": false,
4435
- "multiple": false,
4436
- "type": "option"
4437
- },
4438
- "verbose": {
4439
- "name": "verbose",
4440
- "summary": "Emit additional command output to stdout.",
4441
- "allowNo": false,
4442
- "type": "boolean"
4443
- }
4444
- },
4445
- "hasDynamicHelp": false,
4446
- "hiddenAliases": [],
4447
- "id": "scanner:rule:describe",
4448
- "pluginAlias": "@salesforce/sfdx-scanner",
4449
- "pluginName": "@salesforce/sfdx-scanner",
4450
- "pluginType": "jit",
4451
- "strict": true,
4452
- "summary": "Provide detailed information about a rule that includes the rule's language (such as Apex or Java), the violation it detects, example code of the violation, and the rule's categories and rulesets.",
4453
- "enableJsonFlag": true,
4454
- "SF_ENV": "SF_ENV",
4455
- "isESM": false,
4456
- "relativePath": [
4457
- "lib",
4458
- "commands",
4459
- "scanner",
4460
- "rule",
4461
- "describe.js"
4462
- ],
4463
- "aliasPermutations": [],
4464
- "permutations": [
4465
- "scanner:rule:describe",
4466
- "rule:scanner:describe",
4467
- "rule:describe:scanner",
4468
- "scanner:describe:rule",
4469
- "describe:scanner:rule",
4470
- "describe:rule:scanner"
4471
- ]
4472
- },
4473
- "scanner:rule:list": {
4474
- "aliases": [],
4475
- "args": {},
4476
- "description": "Filter the output to view a smaller set of rules. Use the `scanner rule describe` command to get information about a specific rule.",
4477
- "examples": [
4478
- "This example invokes the command without filter criteria, which returns all rules.\n<%= config.bin %> <%= command.id %>\nThis example returns all rules for Apex OR Javascript. Values supplied to a single filter are handled with a logical OR.\n<%= config.bin %> <%= command.id %> --language apex,javascript\nThis example returns all rules that target Apex OR Javascript, AND are members of the Braces OR Security rulesets. The different filters are combined with a logical AND.\n<%= config.bin %> <%= command.id %> --language apex,javascript --ruleset Braces,Security"
4479
- ],
4480
- "flags": {
4481
- "json": {
4482
- "description": "Format output as json.",
4483
- "helpGroup": "GLOBAL",
4484
- "name": "json",
4485
- "allowNo": false,
4486
- "type": "boolean"
4487
- },
4488
- "verbose": {
4489
- "name": "verbose",
4490
- "summary": "Emit additional command output to stdout.",
4491
- "allowNo": false,
4492
- "type": "boolean"
4493
- },
4494
- "category": {
4495
- "char": "c",
4496
- "description": "Specify multiple values as a comma-separated list.",
4497
- "name": "category",
4498
- "summary": "Select rules by category.",
4499
- "delimiter": ",",
4500
- "hasDynamicHelp": false,
4501
- "multiple": true,
4502
- "type": "option"
4503
- },
4504
- "ruleset": {
4505
- "char": "r",
4506
- "deprecated": {
4507
- "message": "The 'ruleset' command parameter is deprecated. Use 'category' instead"
4508
- },
4509
- "name": "ruleset",
4510
- "summary": "Deprecated. Use category instead. Select rules by ruleset.",
4511
- "delimiter": ",",
4512
- "hasDynamicHelp": false,
4513
- "multiple": true,
4514
- "type": "option"
4515
- },
4516
- "language": {
4517
- "char": "l",
4518
- "description": "Specify multiple values as a comma-separated list.",
4519
- "name": "language",
4520
- "summary": "Select rules by language.",
4521
- "delimiter": ",",
4522
- "hasDynamicHelp": false,
4523
- "multiple": true,
4524
- "type": "option"
4525
- },
4526
- "engine": {
4527
- "char": "e",
4528
- "description": "Specify multiple values as a comma-separated list.",
4529
- "name": "engine",
4530
- "summary": "Select rules by engine.",
4531
- "delimiter": ",",
4532
- "hasDynamicHelp": false,
4533
- "multiple": true,
4534
- "options": [
4535
- "eslint",
4536
- "eslint-lwc",
4537
- "eslint-typescript",
4538
- "pmd",
4539
- "pmd-appexchange",
4540
- "retire-js",
4541
- "cpd",
4542
- "sfge"
4543
- ],
4544
- "type": "option"
4545
- }
4546
- },
4547
- "hasDynamicHelp": false,
4548
- "hiddenAliases": [],
4549
- "id": "scanner:rule:list",
4550
- "pluginAlias": "@salesforce/sfdx-scanner",
4551
- "pluginName": "@salesforce/sfdx-scanner",
4552
- "pluginType": "jit",
4553
- "strict": true,
4554
- "summary": "List basic information about all rules matching provided criteria.",
4555
- "enableJsonFlag": true,
4556
- "SF_ENV": "SF_ENV",
4557
- "isESM": false,
4558
- "relativePath": [
4559
- "lib",
4560
- "commands",
4561
- "scanner",
4562
- "rule",
4563
- "list.js"
4564
- ],
4565
- "aliasPermutations": [],
4566
- "permutations": [
4567
- "scanner:rule:list",
4568
- "rule:scanner:list",
4569
- "rule:list:scanner",
4570
- "scanner:list:rule",
4571
- "list:scanner:rule",
4572
- "list:rule:scanner"
4573
- ]
4574
- },
4575
- "scanner:rule:remove": {
4576
- "aliases": [],
4577
- "args": {},
4578
- "description": "Use the `-p|--path` parameter to specify one or more paths to remove. If you don't specify any parameters, the command lists all valid custom paths but doesn't remove any.",
4579
- "examples": [
4580
- "This example runs the command without arguments to see a list of registered custom paths.\n<%= config.bin %> <%= command.id %>\nThis example uses the --path parameter to deregister the rules defined in somerules.jar and any JARs/XMLs contained in the rules folder.\n<%= config.bin %> <%= command.id %> --path \"~/path/to/somerules.jar,~/path/to/folder/containing/rules\"\nThis example uses the --force flag to bypass the confirmation prompt, removing all rules defined in somerules.jar. By default, a list of all rules that will be unregistered is displayed, and the action must be confirmed. To bypass that confirmation, use the --force flag.\n<%= config.bin %> <%= command.id %> --force --path \"~/path/to/somerules.jar\""
4581
- ],
4582
- "flags": {
4583
- "json": {
4584
- "description": "Format output as json.",
4585
- "helpGroup": "GLOBAL",
4586
- "name": "json",
4587
- "allowNo": false,
4588
- "type": "boolean"
4589
- },
4590
- "verbose": {
4591
- "name": "verbose",
4592
- "summary": "Emit additional command output to stdout.",
4593
- "allowNo": false,
4594
- "type": "boolean"
4595
- },
4596
- "force": {
4597
- "char": "f",
4598
- "name": "force",
4599
- "summary": "Bypass the confirmation prompt and immediately remove the rules.",
4600
- "allowNo": false,
4601
- "type": "boolean"
4602
- },
4603
- "path": {
4604
- "char": "p",
4605
- "description": "Specify multiple values with a comma-separated list.",
4606
- "name": "path",
4607
- "summary": "One or more paths to remove.",
4608
- "delimiter": ",",
4609
- "hasDynamicHelp": false,
4610
- "multiple": true,
4611
- "type": "option"
4612
- }
4613
- },
4614
- "hasDynamicHelp": false,
4615
- "hiddenAliases": [],
4616
- "id": "scanner:rule:remove",
4617
- "pluginAlias": "@salesforce/sfdx-scanner",
4618
- "pluginName": "@salesforce/sfdx-scanner",
4619
- "pluginType": "jit",
4620
- "strict": true,
4621
- "summary": "Remove custom rules from the registry of available rules.",
4622
- "enableJsonFlag": true,
4623
- "SF_ENV": "SF_ENV",
4624
- "isESM": false,
4625
- "relativePath": [
4626
- "lib",
4627
- "commands",
4628
- "scanner",
4629
- "rule",
4630
- "remove.js"
4631
- ],
4632
- "aliasPermutations": [],
4633
- "permutations": [
4634
- "scanner:rule:remove",
4635
- "rule:scanner:remove",
4636
- "rule:remove:scanner",
4637
- "scanner:remove:rule",
4638
- "remove:scanner:rule",
4639
- "remove:rule:scanner"
4640
- ]
4641
- },
4642
- "scanner:run:dfa": {
4643
- "aliases": [],
4644
- "args": {},
4645
- "description": "Specify the format of output and print results directly or as contents of a file that you provide with --outfile flag.",
4646
- "examples": [
4647
- "These examples show how the paths specified for --projectdir must contain all files specified through --target cumulatively.\n<%= config.bin %> <%= command.id %> --target \"./**/*.cls\" --projectdir \"./\"\n<%= config.bin %> <%= command.id %> --target \"./dir1/file1.cls,./dir2/file2.cls\" --projectdir \"./dir1/,./dir2/\"\nThis example fails because the set of files included in --target is larger than that contained in --projectdir.\n<%= config.bin %> <%= command.id %> --target \"./**/*.cls\" --projectdir \"./myproject/\"\nGlobs must be wrapped in quotes, as in these Windows and Unix examples, which evaluate rules against all .cls files in the current directory and subdirectories except for IgnoreMe.cls. Unix example:\n<%= config.bin %> <%= command.id %> --target \"./**/*.cls,!./**/IgnoreMe.cls\" ...\nWindows example:\n<%= config.bin %> <%= command.id %> --target \".\\**\\*.cls,!.\\**\\IgnoreMe.cls\" ...\nYou can target individual methods within a file with a suffix hash (#) on the file's path, and with a semi-colon-delimited list of method names. This syntax is incompatible with globs and directories. This example evaluates rules against all methods named Method1 or Method2 in File1.cls, and all methods named Method3 in File2.cls.\n<%= config.bin %> <%= command.id %> --target \"./File1.cls#Method1;Method2,./File2.cls#Method3\" ...\nUse --normalize-severity to output a normalized severity across all engines, in addition to the engine-specific severity. Normalized severity is 1 (high), 2 (moderate), and 3 (low).\n<%= config.bin %> <%= command.id %> --target \"./some-project/\" --projectdir \"./some-project/\" --format csv --normalize-severity\nUse --severity-threshold to throw a non-zero exit code when rule violations of a specific normalized severity or greater are found. If there are any rule violations with a severity of 2 or 1, the exit code is equal to the severity of the most severe violation.\n<%= config.bin %> <%= command.id %> --target \"./some-project/\" --projectdir \"./some-project/\" --severity-threshold 2\nUse --rule-thread-count to allow more (or fewer) entrypoints to be evaluated concurrently.\n<%= config.bin %> <%= command.id %> --rule-thread-count 6 ...\nUse --rule-thread-timeout to increase or decrease the maximum runtime for a single entrypoint evaluation. This increases the timeout from the 15-minute default to 150 minutes.\n<%= config.bin %> <%= command.id %> --rule-thread-timeout 9000000 ...\nUse --sfgejvmargs to pass Java Virtual Machine args to override system defaults while executing Salesforce Graph Engine's rules. The example overrides the system's default heap space allocation to 8 GB and decreases chances of encountering OutOfMemory error.\n<%= config.bin %> <%= command.id %> --sfgejvmargs \"-Xmx8g\" ...\nUse --with-pilot to allow execution of pilot rules. This example allows pilot rules in the \"Performance\" category to execute.\n<%= config.bin %> <%= command.id %> --category 'Performance' --with-pilot ..."
4648
- ],
4649
- "flags": {
4650
- "json": {
4651
- "description": "Format output as json.",
4652
- "helpGroup": "GLOBAL",
4653
- "name": "json",
4654
- "allowNo": false,
4655
- "type": "boolean"
4656
- },
4657
- "verbose": {
4658
- "name": "verbose",
4659
- "summary": "Emit additional command output to stdout.",
4660
- "allowNo": false,
4661
- "type": "boolean"
4662
- },
4663
- "category": {
4664
- "char": "c",
4665
- "description": "Specify multiple values as a comma-separated list.",
4666
- "name": "category",
4667
- "summary": "One or more categories of rules to run.",
4668
- "delimiter": ",",
4669
- "hasDynamicHelp": false,
4670
- "multiple": true,
4671
- "type": "option"
4672
- },
4673
- "format": {
4674
- "char": "f",
4675
- "name": "format",
4676
- "summary": "The output format for results written directly to the console.",
4677
- "hasDynamicHelp": false,
4678
- "multiple": false,
4679
- "options": [
4680
- "csv",
4681
- "html",
4682
- "json",
4683
- "junit",
4684
- "sarif",
4685
- "table",
4686
- "xml"
4687
- ],
4688
- "type": "option"
4689
- },
4690
- "outfile": {
4691
- "char": "o",
4692
- "name": "outfile",
4693
- "summary": "File to write output to.",
4694
- "hasDynamicHelp": false,
4695
- "multiple": false,
4696
- "type": "option"
4697
- },
4698
- "severity-threshold": {
4699
- "char": "s",
4700
- "description": "Values are 1 (high), 2 (moderate), and 3 (low). Exit code is the most severe violation. Using this flag also invokes the --normalize-severity flag.",
4701
- "exclusive": [
4702
- "json"
4703
- ],
4704
- "name": "severity-threshold",
4705
- "summary": "An error will be thrown when a violation is found with a severity equal to or greater than the specified level.",
4706
- "hasDynamicHelp": false,
4707
- "multiple": false,
4708
- "type": "option"
4709
- },
4710
- "normalize-severity": {
4711
- "description": "For the html option, the normalized severity is displayed instead of the engine severity.",
4712
- "name": "normalize-severity",
4713
- "summary": "Include normalized severity levels 1 (high), 2 (moderate), and 3 (low) with the results.",
4714
- "allowNo": false,
4715
- "type": "boolean"
4716
- },
4717
- "projectdir": {
4718
- "char": "p",
4719
- "description": "Specify multiple values as a comma-separated list. Each project directory must be a path, not a glob. If --projectdir isn’t specified, a default value is calculated. The default value is a directory that contains all the target files.",
4720
- "name": "projectdir",
4721
- "summary": "The relative or absolute root project directories used to set the context for Graph Engine's analysis.",
4722
- "delimiter": ",",
4723
- "hasDynamicHelp": false,
4724
- "multiple": true,
4725
- "type": "option"
4726
- },
4727
- "with-pilot": {
4728
- "name": "with-pilot",
4729
- "summary": "Allow pilot rules to execute.",
4730
- "allowNo": false,
4731
- "type": "boolean"
4732
- },
4733
- "target": {
4734
- "char": "t",
4735
- "description": "Use glob patterns or specify individual methods with #-syntax. Multiple values are specified as a comma-separated list. Default is \".\".",
4736
- "name": "target",
4737
- "summary": "Source code location.",
4738
- "delimiter": ",",
4739
- "hasDynamicHelp": false,
4740
- "multiple": true,
4741
- "type": "option"
4742
- },
4743
- "rule-thread-count": {
4744
- "env": "SFGE_RULE_THREAD_COUNT",
4745
- "name": "rule-thread-count",
4746
- "summary": "Number of DFA rule-evaluation threads or how many entry points can be evaluated concurrently. Inherits its value from the SFGE_RULE_THREAD_COUNT environment variable, if set.",
4747
- "hasDynamicHelp": false,
4748
- "multiple": false,
4749
- "type": "option"
4750
- },
4751
- "rule-thread-timeout": {
4752
- "env": "SFGE_RULE_THREAD_TIMEOUT",
4753
- "name": "rule-thread-timeout",
4754
- "summary": "Time limit, in milliseconds, for evaluating a single entry point. Inherits its value from the \"SFGE_RULE_THREAD_TIMEOUT\" environment variable, if set.",
4755
- "hasDynamicHelp": false,
4756
- "multiple": false,
4757
- "type": "option"
4758
- },
4759
- "rule-disable-warning-violation": {
4760
- "description": "Examples of warning violations include those on StripInaccessible READ access, to get only high-severity violations.",
4761
- "name": "rule-disable-warning-violation",
4762
- "summary": "Disable warning violations from Salesforce Graph Engine. Inherits value from SFGE_RULE_DISABLE_WARNING_VIOLATION env-var, if set.",
4763
- "allowNo": false,
4764
- "type": "boolean"
4765
- },
4766
- "sfgejvmargs": {
4767
- "description": "Separate multiple arguments by a space.",
4768
- "env": "SFGE_JVM_ARGS",
4769
- "name": "sfgejvmargs",
4770
- "summary": "Java Virtual Machine (JVM) arguments to override system defaults while executing Salesforce Graph Engine.",
4771
- "hasDynamicHelp": false,
4772
- "multiple": false,
4773
- "type": "option"
4774
- },
4775
- "pathexplimit": {
4776
- "description": "Set the value to -1 to remove any upper boundary. Its default value is derived from JVM heap space allocation.",
4777
- "env": "SFGE_PATH_EXPANSION_LIMIT",
4778
- "name": "pathexplimit",
4779
- "summary": "Path expansion upper boundary to limit the complexity of code that Graph Engine analyzes before failing test. Inherits it value from the \"SFGE_PATH_EXPANSION_LIMIT\", if set.",
4780
- "hasDynamicHelp": false,
4781
- "multiple": false,
4782
- "type": "option"
4783
- },
4784
- "enablecaching": {
4785
- "description": "",
4786
- "env": "SFGE_ENABLE_CACHING",
4787
- "hidden": true,
4788
- "name": "enablecaching",
4789
- "summary": "",
4790
- "allowNo": false,
4791
- "type": "boolean"
4792
- },
4793
- "cachepath": {
4794
- "description": "",
4795
- "env": "SFGE_FILES_TO_ENTRIES_CACHE_LOCATION",
4796
- "hidden": true,
4797
- "name": "cachepath",
4798
- "summary": "",
4799
- "hasDynamicHelp": false,
4800
- "multiple": false,
4801
- "type": "option"
4802
- }
4803
- },
4804
- "hasDynamicHelp": false,
4805
- "hiddenAliases": [],
4806
- "id": "scanner:run:dfa",
4807
- "pluginAlias": "@salesforce/sfdx-scanner",
4808
- "pluginName": "@salesforce/sfdx-scanner",
4809
- "pluginType": "jit",
4810
- "strict": true,
4811
- "summary": "Scan codebase with all DFA rules by default.",
4812
- "enableJsonFlag": true,
4813
- "SF_ENV": "SF_ENV",
4814
- "invocation": "scanner run dfa",
4815
- "isESM": false,
4816
- "relativePath": [
4817
- "lib",
4818
- "commands",
4819
- "scanner",
4820
- "run",
4821
- "dfa.js"
4822
- ],
4823
- "aliasPermutations": [],
4824
- "permutations": [
4825
- "scanner:run:dfa",
4826
- "run:scanner:dfa",
4827
- "run:dfa:scanner",
4828
- "scanner:dfa:run",
4829
- "dfa:scanner:run",
4830
- "dfa:run:scanner"
4831
- ]
4832
4159
  }
4833
4160
  },
4834
- "version": "2.101.1"
4161
+ "version": "2.101.3-dev.0"
4835
4162
  }