@rocketleap/rocketleap-projen 1.0.0 → 1.2.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.
- package/.jsii +3117 -101
- package/API.md +5185 -1265
- package/lib/cdk-project.d.ts +11 -1
- package/lib/cdk-project.js +55 -28
- package/lib/common/compile.d.ts +114 -1
- package/lib/common/compile.js +80 -44
- package/lib/common/package-json.d.ts +40 -1
- package/lib/common/package-json.js +39 -7
- package/lib/index.d.ts +1 -0
- package/lib/index.js +2 -1
- package/lib/library-cdk-project-options.generated.d.ts +1094 -0
- package/lib/library-cdk-project-options.generated.js +3 -0
- package/package.json +2 -5
package/.jsii
CHANGED
|
@@ -106,35 +106,35 @@
|
|
|
106
106
|
"@rocketleap/rocketleap-projen.actions": {
|
|
107
107
|
"locationInModule": {
|
|
108
108
|
"filename": "src/index.ts",
|
|
109
|
-
"line":
|
|
109
|
+
"line": 8
|
|
110
110
|
},
|
|
111
111
|
"symbolId": "src/common/actions:"
|
|
112
112
|
},
|
|
113
113
|
"@rocketleap/rocketleap-projen.format": {
|
|
114
114
|
"locationInModule": {
|
|
115
115
|
"filename": "src/index.ts",
|
|
116
|
-
"line":
|
|
116
|
+
"line": 4
|
|
117
117
|
},
|
|
118
118
|
"symbolId": "src/common/prettier:"
|
|
119
119
|
},
|
|
120
120
|
"@rocketleap/rocketleap-projen.git": {
|
|
121
121
|
"locationInModule": {
|
|
122
122
|
"filename": "src/index.ts",
|
|
123
|
-
"line":
|
|
123
|
+
"line": 7
|
|
124
124
|
},
|
|
125
125
|
"symbolId": "src/common/git:"
|
|
126
126
|
},
|
|
127
127
|
"@rocketleap/rocketleap-projen.lint": {
|
|
128
128
|
"locationInModule": {
|
|
129
129
|
"filename": "src/index.ts",
|
|
130
|
-
"line":
|
|
130
|
+
"line": 5
|
|
131
131
|
},
|
|
132
132
|
"symbolId": "src/common/eslint:"
|
|
133
133
|
},
|
|
134
134
|
"@rocketleap/rocketleap-projen.packages": {
|
|
135
135
|
"locationInModule": {
|
|
136
136
|
"filename": "src/index.ts",
|
|
137
|
-
"line":
|
|
137
|
+
"line": 6
|
|
138
138
|
},
|
|
139
139
|
"symbolId": "src/common/yarn:"
|
|
140
140
|
}
|
|
@@ -3593,28 +3593,28 @@
|
|
|
3593
3593
|
],
|
|
3594
3594
|
"symbolId": "src/cdk-project-options.generated:RocketleapCdkProjectOptions"
|
|
3595
3595
|
},
|
|
3596
|
-
"@rocketleap/rocketleap-projen.
|
|
3596
|
+
"@rocketleap/rocketleap-projen.RocketleapLibraryCdkProject": {
|
|
3597
3597
|
"assembly": "@rocketleap/rocketleap-projen",
|
|
3598
|
-
"base": "projen.
|
|
3598
|
+
"base": "projen.typescript.TypeScriptProject",
|
|
3599
3599
|
"docs": {
|
|
3600
|
-
"remarks": "This is for
|
|
3600
|
+
"remarks": "This is for CDK construct libraries (e.g., building-blocks-cdk).\nIncludes CDK peer dependencies and publishing configuration for GitHub Packages.",
|
|
3601
3601
|
"stability": "stable",
|
|
3602
|
-
"summary": "Projen project for Rocketleap
|
|
3602
|
+
"summary": "Projen project for Rocketleap CDK construct library projects."
|
|
3603
3603
|
},
|
|
3604
|
-
"fqn": "@rocketleap/rocketleap-projen.
|
|
3604
|
+
"fqn": "@rocketleap/rocketleap-projen.RocketleapLibraryCdkProject",
|
|
3605
3605
|
"initializer": {
|
|
3606
3606
|
"docs": {
|
|
3607
3607
|
"stability": "stable"
|
|
3608
3608
|
},
|
|
3609
3609
|
"locationInModule": {
|
|
3610
3610
|
"filename": "src/cdk-project.ts",
|
|
3611
|
-
"line":
|
|
3611
|
+
"line": 183
|
|
3612
3612
|
},
|
|
3613
3613
|
"parameters": [
|
|
3614
3614
|
{
|
|
3615
3615
|
"name": "options",
|
|
3616
3616
|
"type": {
|
|
3617
|
-
"fqn": "@rocketleap/rocketleap-projen.
|
|
3617
|
+
"fqn": "@rocketleap/rocketleap-projen.RocketleapLibraryCdkProjectOptions"
|
|
3618
3618
|
}
|
|
3619
3619
|
}
|
|
3620
3620
|
]
|
|
@@ -3622,141 +3622,3157 @@
|
|
|
3622
3622
|
"kind": "class",
|
|
3623
3623
|
"locationInModule": {
|
|
3624
3624
|
"filename": "src/cdk-project.ts",
|
|
3625
|
-
"line":
|
|
3625
|
+
"line": 182
|
|
3626
3626
|
},
|
|
3627
|
-
"
|
|
3627
|
+
"name": "RocketleapLibraryCdkProject",
|
|
3628
|
+
"symbolId": "src/cdk-project:RocketleapLibraryCdkProject"
|
|
3629
|
+
},
|
|
3630
|
+
"@rocketleap/rocketleap-projen.RocketleapLibraryCdkProjectOptions": {
|
|
3631
|
+
"assembly": "@rocketleap/rocketleap-projen",
|
|
3632
|
+
"datatype": true,
|
|
3633
|
+
"docs": {
|
|
3634
|
+
"stability": "stable",
|
|
3635
|
+
"summary": "RocketleapLibraryCdkProjectOptions."
|
|
3636
|
+
},
|
|
3637
|
+
"fqn": "@rocketleap/rocketleap-projen.RocketleapLibraryCdkProjectOptions",
|
|
3638
|
+
"kind": "interface",
|
|
3639
|
+
"locationInModule": {
|
|
3640
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
3641
|
+
"line": 7
|
|
3642
|
+
},
|
|
3643
|
+
"name": "RocketleapLibraryCdkProjectOptions",
|
|
3644
|
+
"properties": [
|
|
3628
3645
|
{
|
|
3646
|
+
"abstract": true,
|
|
3629
3647
|
"docs": {
|
|
3630
|
-
"stability": "stable"
|
|
3648
|
+
"stability": "stable",
|
|
3649
|
+
"summary": "The company identifier used for package scoping."
|
|
3631
3650
|
},
|
|
3651
|
+
"immutable": true,
|
|
3632
3652
|
"locationInModule": {
|
|
3633
|
-
"filename": "src/cdk-project.ts",
|
|
3634
|
-
"line":
|
|
3653
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
3654
|
+
"line": 1081
|
|
3635
3655
|
},
|
|
3636
|
-
"name": "
|
|
3637
|
-
"
|
|
3638
|
-
|
|
3639
|
-
|
|
3640
|
-
|
|
3641
|
-
"primitive": "string"
|
|
3642
|
-
}
|
|
3643
|
-
}
|
|
3644
|
-
],
|
|
3645
|
-
"protected": true
|
|
3646
|
-
}
|
|
3647
|
-
],
|
|
3648
|
-
"name": "RocketleapPlatformCdkProject",
|
|
3649
|
-
"properties": [
|
|
3656
|
+
"name": "company",
|
|
3657
|
+
"type": {
|
|
3658
|
+
"primitive": "string"
|
|
3659
|
+
}
|
|
3660
|
+
},
|
|
3650
3661
|
{
|
|
3662
|
+
"abstract": true,
|
|
3651
3663
|
"docs": {
|
|
3652
|
-
"stability": "stable"
|
|
3664
|
+
"stability": "stable",
|
|
3665
|
+
"summary": "The project name."
|
|
3653
3666
|
},
|
|
3654
3667
|
"immutable": true,
|
|
3655
3668
|
"locationInModule": {
|
|
3656
|
-
"filename": "src/cdk-project.ts",
|
|
3657
|
-
"line":
|
|
3669
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
3670
|
+
"line": 1085
|
|
3658
3671
|
},
|
|
3659
|
-
"name": "
|
|
3660
|
-
"protected": true,
|
|
3672
|
+
"name": "project",
|
|
3661
3673
|
"type": {
|
|
3662
3674
|
"primitive": "string"
|
|
3663
3675
|
}
|
|
3664
3676
|
},
|
|
3665
3677
|
{
|
|
3678
|
+
"abstract": true,
|
|
3666
3679
|
"docs": {
|
|
3667
|
-
"
|
|
3680
|
+
"default": "true",
|
|
3681
|
+
"remarks": "This is normally only allowed for libraries. For apps, there's no meaning\nfor specifying these.",
|
|
3682
|
+
"stability": "experimental",
|
|
3683
|
+
"summary": "Allow the project to include `peerDependencies` and `bundledDependencies`."
|
|
3668
3684
|
},
|
|
3669
3685
|
"immutable": true,
|
|
3670
3686
|
"locationInModule": {
|
|
3671
|
-
"filename": "src/cdk-project.ts",
|
|
3672
|
-
"line":
|
|
3687
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
3688
|
+
"line": 892
|
|
3673
3689
|
},
|
|
3674
|
-
"name": "
|
|
3675
|
-
"
|
|
3690
|
+
"name": "allowLibraryDependencies",
|
|
3691
|
+
"optional": true,
|
|
3692
|
+
"type": {
|
|
3693
|
+
"primitive": "boolean"
|
|
3694
|
+
}
|
|
3695
|
+
},
|
|
3696
|
+
{
|
|
3697
|
+
"abstract": true,
|
|
3698
|
+
"docs": {
|
|
3699
|
+
"default": "\"dist\"",
|
|
3700
|
+
"stability": "experimental",
|
|
3701
|
+
"summary": "A directory which will contain build artifacts."
|
|
3702
|
+
},
|
|
3703
|
+
"immutable": true,
|
|
3704
|
+
"locationInModule": {
|
|
3705
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
3706
|
+
"line": 384
|
|
3707
|
+
},
|
|
3708
|
+
"name": "artifactsDirectory",
|
|
3709
|
+
"optional": true,
|
|
3676
3710
|
"type": {
|
|
3677
3711
|
"primitive": "string"
|
|
3678
3712
|
}
|
|
3679
|
-
}
|
|
3680
|
-
],
|
|
3681
|
-
"symbolId": "src/cdk-project:RocketleapPlatformCdkProject"
|
|
3682
|
-
},
|
|
3683
|
-
"@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject": {
|
|
3684
|
-
"assembly": "@rocketleap/rocketleap-projen",
|
|
3685
|
-
"base": "projen.awscdk.AwsCdkTypeScriptApp",
|
|
3686
|
-
"docs": {
|
|
3687
|
-
"remarks": "This is for customer-specific workload code that runs on the platform.\nDoes NOT include the platform license.",
|
|
3688
|
-
"stability": "stable",
|
|
3689
|
-
"summary": "Projen project for customer workload CDK projects."
|
|
3690
|
-
},
|
|
3691
|
-
"fqn": "@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject",
|
|
3692
|
-
"initializer": {
|
|
3693
|
-
"docs": {
|
|
3694
|
-
"stability": "stable"
|
|
3695
3713
|
},
|
|
3696
|
-
|
|
3697
|
-
"
|
|
3698
|
-
"
|
|
3714
|
+
{
|
|
3715
|
+
"abstract": true,
|
|
3716
|
+
"docs": {
|
|
3717
|
+
"default": "false",
|
|
3718
|
+
"remarks": "When enabled, creates an \"audit\" task that checks for known security vulnerabilities\nin dependencies. By default, runs during every build and checks for \"high\" severity\nvulnerabilities or above in all dependencies (including dev dependencies).",
|
|
3719
|
+
"stability": "experimental",
|
|
3720
|
+
"summary": "Run security audit on dependencies."
|
|
3721
|
+
},
|
|
3722
|
+
"immutable": true,
|
|
3723
|
+
"locationInModule": {
|
|
3724
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
3725
|
+
"line": 378
|
|
3726
|
+
},
|
|
3727
|
+
"name": "auditDeps",
|
|
3728
|
+
"optional": true,
|
|
3729
|
+
"type": {
|
|
3730
|
+
"primitive": "boolean"
|
|
3731
|
+
}
|
|
3699
3732
|
},
|
|
3700
|
-
|
|
3701
|
-
|
|
3702
|
-
|
|
3703
|
-
"
|
|
3704
|
-
|
|
3705
|
-
|
|
3733
|
+
{
|
|
3734
|
+
"abstract": true,
|
|
3735
|
+
"docs": {
|
|
3736
|
+
"default": "- default options",
|
|
3737
|
+
"stability": "experimental",
|
|
3738
|
+
"summary": "Security audit options."
|
|
3739
|
+
},
|
|
3740
|
+
"immutable": true,
|
|
3741
|
+
"locationInModule": {
|
|
3742
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
3743
|
+
"line": 369
|
|
3744
|
+
},
|
|
3745
|
+
"name": "auditDepsOptions",
|
|
3746
|
+
"optional": true,
|
|
3747
|
+
"type": {
|
|
3748
|
+
"fqn": "projen.javascript.AuditOptions"
|
|
3706
3749
|
}
|
|
3707
|
-
|
|
3708
|
-
},
|
|
3709
|
-
"kind": "class",
|
|
3710
|
-
"locationInModule": {
|
|
3711
|
-
"filename": "src/cdk-project.ts",
|
|
3712
|
-
"line": 184
|
|
3713
|
-
},
|
|
3714
|
-
"methods": [
|
|
3750
|
+
},
|
|
3715
3751
|
{
|
|
3752
|
+
"abstract": true,
|
|
3716
3753
|
"docs": {
|
|
3717
|
-
"stability": "
|
|
3754
|
+
"stability": "experimental",
|
|
3755
|
+
"summary": "Author's e-mail."
|
|
3718
3756
|
},
|
|
3757
|
+
"immutable": true,
|
|
3719
3758
|
"locationInModule": {
|
|
3720
|
-
"filename": "src/cdk-project.ts",
|
|
3721
|
-
"line":
|
|
3759
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
3760
|
+
"line": 884
|
|
3722
3761
|
},
|
|
3723
|
-
"name": "
|
|
3724
|
-
"
|
|
3725
|
-
|
|
3726
|
-
|
|
3727
|
-
|
|
3728
|
-
|
|
3729
|
-
}
|
|
3730
|
-
}
|
|
3731
|
-
],
|
|
3732
|
-
"protected": true
|
|
3733
|
-
}
|
|
3734
|
-
],
|
|
3735
|
-
"name": "RocketleapWorkloadCdkProject",
|
|
3736
|
-
"properties": [
|
|
3762
|
+
"name": "authorEmail",
|
|
3763
|
+
"optional": true,
|
|
3764
|
+
"type": {
|
|
3765
|
+
"primitive": "string"
|
|
3766
|
+
}
|
|
3767
|
+
},
|
|
3737
3768
|
{
|
|
3769
|
+
"abstract": true,
|
|
3738
3770
|
"docs": {
|
|
3739
|
-
"stability": "
|
|
3771
|
+
"stability": "experimental",
|
|
3772
|
+
"summary": "Author's name."
|
|
3740
3773
|
},
|
|
3741
3774
|
"immutable": true,
|
|
3742
3775
|
"locationInModule": {
|
|
3743
|
-
"filename": "src/cdk-project.ts",
|
|
3744
|
-
"line":
|
|
3776
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
3777
|
+
"line": 879
|
|
3745
3778
|
},
|
|
3746
|
-
"name": "
|
|
3747
|
-
"
|
|
3779
|
+
"name": "authorName",
|
|
3780
|
+
"optional": true,
|
|
3748
3781
|
"type": {
|
|
3749
3782
|
"primitive": "string"
|
|
3750
3783
|
}
|
|
3751
3784
|
},
|
|
3752
3785
|
{
|
|
3786
|
+
"abstract": true,
|
|
3753
3787
|
"docs": {
|
|
3754
|
-
"stability": "
|
|
3788
|
+
"stability": "experimental",
|
|
3789
|
+
"summary": "Is the author an organization."
|
|
3755
3790
|
},
|
|
3756
3791
|
"immutable": true,
|
|
3757
3792
|
"locationInModule": {
|
|
3758
|
-
"filename": "src/cdk-project.ts",
|
|
3759
|
-
"line":
|
|
3793
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
3794
|
+
"line": 874
|
|
3795
|
+
},
|
|
3796
|
+
"name": "authorOrganization",
|
|
3797
|
+
"optional": true,
|
|
3798
|
+
"type": {
|
|
3799
|
+
"primitive": "boolean"
|
|
3800
|
+
}
|
|
3801
|
+
},
|
|
3802
|
+
{
|
|
3803
|
+
"abstract": true,
|
|
3804
|
+
"docs": {
|
|
3805
|
+
"stability": "experimental",
|
|
3806
|
+
"summary": "Author's URL / Website."
|
|
3807
|
+
},
|
|
3808
|
+
"immutable": true,
|
|
3809
|
+
"locationInModule": {
|
|
3810
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
3811
|
+
"line": 869
|
|
3812
|
+
},
|
|
3813
|
+
"name": "authorUrl",
|
|
3814
|
+
"optional": true,
|
|
3815
|
+
"type": {
|
|
3816
|
+
"primitive": "string"
|
|
3817
|
+
}
|
|
3818
|
+
},
|
|
3819
|
+
{
|
|
3820
|
+
"abstract": true,
|
|
3821
|
+
"docs": {
|
|
3822
|
+
"default": "- auto approve is disabled",
|
|
3823
|
+
"stability": "experimental",
|
|
3824
|
+
"summary": "Enable and configure the 'auto approve' workflow."
|
|
3825
|
+
},
|
|
3826
|
+
"immutable": true,
|
|
3827
|
+
"locationInModule": {
|
|
3828
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
3829
|
+
"line": 1008
|
|
3830
|
+
},
|
|
3831
|
+
"name": "autoApproveOptions",
|
|
3832
|
+
"optional": true,
|
|
3833
|
+
"type": {
|
|
3834
|
+
"fqn": "projen.github.AutoApproveOptions"
|
|
3835
|
+
}
|
|
3836
|
+
},
|
|
3837
|
+
{
|
|
3838
|
+
"abstract": true,
|
|
3839
|
+
"docs": {
|
|
3840
|
+
"default": "- true",
|
|
3841
|
+
"remarks": "Throw if set to true but `autoApproveOptions` are not defined.",
|
|
3842
|
+
"stability": "experimental",
|
|
3843
|
+
"summary": "Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured)."
|
|
3844
|
+
},
|
|
3845
|
+
"immutable": true,
|
|
3846
|
+
"locationInModule": {
|
|
3847
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
3848
|
+
"line": 363
|
|
3849
|
+
},
|
|
3850
|
+
"name": "autoApproveUpgrades",
|
|
3851
|
+
"optional": true,
|
|
3852
|
+
"type": {
|
|
3853
|
+
"primitive": "boolean"
|
|
3854
|
+
}
|
|
3855
|
+
},
|
|
3856
|
+
{
|
|
3857
|
+
"abstract": true,
|
|
3858
|
+
"docs": {
|
|
3859
|
+
"default": "true",
|
|
3860
|
+
"stability": "experimental",
|
|
3861
|
+
"summary": "Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section."
|
|
3862
|
+
},
|
|
3863
|
+
"immutable": true,
|
|
3864
|
+
"locationInModule": {
|
|
3865
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
3866
|
+
"line": 864
|
|
3867
|
+
},
|
|
3868
|
+
"name": "autoDetectBin",
|
|
3869
|
+
"optional": true,
|
|
3870
|
+
"type": {
|
|
3871
|
+
"primitive": "boolean"
|
|
3872
|
+
}
|
|
3873
|
+
},
|
|
3874
|
+
{
|
|
3875
|
+
"abstract": true,
|
|
3876
|
+
"docs": {
|
|
3877
|
+
"default": "true",
|
|
3878
|
+
"remarks": "Has no effect if `github.mergify`\nis set to false.",
|
|
3879
|
+
"stability": "experimental",
|
|
3880
|
+
"summary": "Enable automatic merging on GitHub."
|
|
3881
|
+
},
|
|
3882
|
+
"immutable": true,
|
|
3883
|
+
"locationInModule": {
|
|
3884
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
3885
|
+
"line": 1002
|
|
3886
|
+
},
|
|
3887
|
+
"name": "autoMerge",
|
|
3888
|
+
"optional": true,
|
|
3889
|
+
"type": {
|
|
3890
|
+
"primitive": "boolean"
|
|
3891
|
+
}
|
|
3892
|
+
},
|
|
3893
|
+
{
|
|
3894
|
+
"abstract": true,
|
|
3895
|
+
"docs": {
|
|
3896
|
+
"default": "- see defaults in `AutoMergeOptions`",
|
|
3897
|
+
"remarks": "Has no effect if\n`github.mergify` or `autoMerge` is set to false.",
|
|
3898
|
+
"stability": "experimental",
|
|
3899
|
+
"summary": "Configure options for automatic merging on GitHub."
|
|
3900
|
+
},
|
|
3901
|
+
"immutable": true,
|
|
3902
|
+
"locationInModule": {
|
|
3903
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
3904
|
+
"line": 994
|
|
3905
|
+
},
|
|
3906
|
+
"name": "autoMergeOptions",
|
|
3907
|
+
"optional": true,
|
|
3908
|
+
"type": {
|
|
3909
|
+
"fqn": "projen.github.AutoMergeOptions"
|
|
3910
|
+
}
|
|
3911
|
+
},
|
|
3912
|
+
{
|
|
3913
|
+
"abstract": true,
|
|
3914
|
+
"docs": {
|
|
3915
|
+
"remarks": "You can use this option to add/customize how binaries are represented in\nyour `package.json`, but unless `autoDetectBin` is `false`, every\nexecutable file under `bin` will automatically be added to this section.",
|
|
3916
|
+
"stability": "experimental",
|
|
3917
|
+
"summary": "Binary programs vended with your module."
|
|
3918
|
+
},
|
|
3919
|
+
"immutable": true,
|
|
3920
|
+
"locationInModule": {
|
|
3921
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
3922
|
+
"line": 858
|
|
3923
|
+
},
|
|
3924
|
+
"name": "bin",
|
|
3925
|
+
"optional": true,
|
|
3926
|
+
"type": {
|
|
3927
|
+
"collection": {
|
|
3928
|
+
"elementtype": {
|
|
3929
|
+
"primitive": "string"
|
|
3930
|
+
},
|
|
3931
|
+
"kind": "map"
|
|
3932
|
+
}
|
|
3933
|
+
}
|
|
3934
|
+
},
|
|
3935
|
+
{
|
|
3936
|
+
"abstract": true,
|
|
3937
|
+
"docs": {
|
|
3938
|
+
"default": "false",
|
|
3939
|
+
"stability": "experimental",
|
|
3940
|
+
"summary": "Setup Biome."
|
|
3941
|
+
},
|
|
3942
|
+
"immutable": true,
|
|
3943
|
+
"locationInModule": {
|
|
3944
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
3945
|
+
"line": 356
|
|
3946
|
+
},
|
|
3947
|
+
"name": "biome",
|
|
3948
|
+
"optional": true,
|
|
3949
|
+
"type": {
|
|
3950
|
+
"primitive": "boolean"
|
|
3951
|
+
}
|
|
3952
|
+
},
|
|
3953
|
+
{
|
|
3954
|
+
"abstract": true,
|
|
3955
|
+
"docs": {
|
|
3956
|
+
"default": "- default options",
|
|
3957
|
+
"stability": "experimental",
|
|
3958
|
+
"summary": "Biome options."
|
|
3959
|
+
},
|
|
3960
|
+
"immutable": true,
|
|
3961
|
+
"locationInModule": {
|
|
3962
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
3963
|
+
"line": 350
|
|
3964
|
+
},
|
|
3965
|
+
"name": "biomeOptions",
|
|
3966
|
+
"optional": true,
|
|
3967
|
+
"type": {
|
|
3968
|
+
"fqn": "projen.javascript.BiomeOptions"
|
|
3969
|
+
}
|
|
3970
|
+
},
|
|
3971
|
+
{
|
|
3972
|
+
"abstract": true,
|
|
3973
|
+
"docs": {
|
|
3974
|
+
"stability": "experimental",
|
|
3975
|
+
"summary": "The email address to which issues should be reported."
|
|
3976
|
+
},
|
|
3977
|
+
"immutable": true,
|
|
3978
|
+
"locationInModule": {
|
|
3979
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
3980
|
+
"line": 850
|
|
3981
|
+
},
|
|
3982
|
+
"name": "bugsEmail",
|
|
3983
|
+
"optional": true,
|
|
3984
|
+
"type": {
|
|
3985
|
+
"primitive": "string"
|
|
3986
|
+
}
|
|
3987
|
+
},
|
|
3988
|
+
{
|
|
3989
|
+
"abstract": true,
|
|
3990
|
+
"docs": {
|
|
3991
|
+
"stability": "experimental",
|
|
3992
|
+
"summary": "The url to your project's issue tracker."
|
|
3993
|
+
},
|
|
3994
|
+
"immutable": true,
|
|
3995
|
+
"locationInModule": {
|
|
3996
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
3997
|
+
"line": 845
|
|
3998
|
+
},
|
|
3999
|
+
"name": "bugsUrl",
|
|
4000
|
+
"optional": true,
|
|
4001
|
+
"type": {
|
|
4002
|
+
"primitive": "string"
|
|
4003
|
+
}
|
|
4004
|
+
},
|
|
4005
|
+
{
|
|
4006
|
+
"abstract": true,
|
|
4007
|
+
"docs": {
|
|
4008
|
+
"default": "- true if not a subproject",
|
|
4009
|
+
"stability": "experimental",
|
|
4010
|
+
"summary": "Define a GitHub workflow for building PRs."
|
|
4011
|
+
},
|
|
4012
|
+
"immutable": true,
|
|
4013
|
+
"locationInModule": {
|
|
4014
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4015
|
+
"line": 344
|
|
4016
|
+
},
|
|
4017
|
+
"name": "buildWorkflow",
|
|
4018
|
+
"optional": true,
|
|
4019
|
+
"type": {
|
|
4020
|
+
"primitive": "boolean"
|
|
4021
|
+
}
|
|
4022
|
+
},
|
|
4023
|
+
{
|
|
4024
|
+
"abstract": true,
|
|
4025
|
+
"docs": {
|
|
4026
|
+
"stability": "experimental",
|
|
4027
|
+
"summary": "Options for PR build workflow."
|
|
4028
|
+
},
|
|
4029
|
+
"immutable": true,
|
|
4030
|
+
"locationInModule": {
|
|
4031
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4032
|
+
"line": 338
|
|
4033
|
+
},
|
|
4034
|
+
"name": "buildWorkflowOptions",
|
|
4035
|
+
"optional": true,
|
|
4036
|
+
"type": {
|
|
4037
|
+
"fqn": "projen.javascript.BuildWorkflowOptions"
|
|
4038
|
+
}
|
|
4039
|
+
},
|
|
4040
|
+
{
|
|
4041
|
+
"abstract": true,
|
|
4042
|
+
"docs": {
|
|
4043
|
+
"default": "\"{ pullRequest: {}, workflowDispatch: {} }\"",
|
|
4044
|
+
"deprecated": "- Use `buildWorkflowOptions.workflowTriggers`",
|
|
4045
|
+
"stability": "deprecated",
|
|
4046
|
+
"summary": "Build workflow triggers."
|
|
4047
|
+
},
|
|
4048
|
+
"immutable": true,
|
|
4049
|
+
"locationInModule": {
|
|
4050
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4051
|
+
"line": 333
|
|
4052
|
+
},
|
|
4053
|
+
"name": "buildWorkflowTriggers",
|
|
4054
|
+
"optional": true,
|
|
4055
|
+
"type": {
|
|
4056
|
+
"fqn": "projen.github.workflows.Triggers"
|
|
4057
|
+
}
|
|
4058
|
+
},
|
|
4059
|
+
{
|
|
4060
|
+
"abstract": true,
|
|
4061
|
+
"docs": {
|
|
4062
|
+
"default": "- A recent version of \"commit-and-tag-version\"",
|
|
4063
|
+
"remarks": "This can be any compatible package version, including the deprecated `standard-version@9`.",
|
|
4064
|
+
"stability": "experimental",
|
|
4065
|
+
"summary": "The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string."
|
|
4066
|
+
},
|
|
4067
|
+
"immutable": true,
|
|
4068
|
+
"locationInModule": {
|
|
4069
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4070
|
+
"line": 591
|
|
4071
|
+
},
|
|
4072
|
+
"name": "bumpPackage",
|
|
4073
|
+
"optional": true,
|
|
4074
|
+
"type": {
|
|
4075
|
+
"primitive": "string"
|
|
4076
|
+
}
|
|
4077
|
+
},
|
|
4078
|
+
{
|
|
4079
|
+
"abstract": true,
|
|
4080
|
+
"docs": {
|
|
4081
|
+
"remarks": "These modules will be\nadded both to the `dependencies` section and `bundledDependencies` section of\nyour `package.json`.\n\nThe recommendation is to only specify the module name here (e.g.\n`express`). This will behave similar to `yarn add` or `npm install` in the\nsense that it will add the module as a dependency to your `package.json`\nfile with the latest version (`^`). You can specify semver requirements in\nthe same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and\nthis will be what you `package.json` will eventually include.",
|
|
4082
|
+
"stability": "experimental",
|
|
4083
|
+
"summary": "List of dependencies to bundle into this module."
|
|
4084
|
+
},
|
|
4085
|
+
"immutable": true,
|
|
4086
|
+
"locationInModule": {
|
|
4087
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4088
|
+
"line": 840
|
|
4089
|
+
},
|
|
4090
|
+
"name": "bundledDeps",
|
|
4091
|
+
"optional": true,
|
|
4092
|
+
"type": {
|
|
4093
|
+
"collection": {
|
|
4094
|
+
"elementtype": {
|
|
4095
|
+
"primitive": "string"
|
|
4096
|
+
},
|
|
4097
|
+
"kind": "array"
|
|
4098
|
+
}
|
|
4099
|
+
}
|
|
4100
|
+
},
|
|
4101
|
+
{
|
|
4102
|
+
"abstract": true,
|
|
4103
|
+
"docs": {
|
|
4104
|
+
"stability": "experimental",
|
|
4105
|
+
"summary": "Options for `Bundler`."
|
|
4106
|
+
},
|
|
4107
|
+
"immutable": true,
|
|
4108
|
+
"locationInModule": {
|
|
4109
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4110
|
+
"line": 326
|
|
4111
|
+
},
|
|
4112
|
+
"name": "bundlerOptions",
|
|
4113
|
+
"optional": true,
|
|
4114
|
+
"type": {
|
|
4115
|
+
"fqn": "projen.javascript.BundlerOptions"
|
|
4116
|
+
}
|
|
4117
|
+
},
|
|
4118
|
+
{
|
|
4119
|
+
"abstract": true,
|
|
4120
|
+
"docs": {
|
|
4121
|
+
"default": "\"latest\"",
|
|
4122
|
+
"stability": "experimental",
|
|
4123
|
+
"summary": "The version of Bun to use if using Bun as a package manager."
|
|
4124
|
+
},
|
|
4125
|
+
"immutable": true,
|
|
4126
|
+
"locationInModule": {
|
|
4127
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4128
|
+
"line": 825
|
|
4129
|
+
},
|
|
4130
|
+
"name": "bunVersion",
|
|
4131
|
+
"optional": true,
|
|
4132
|
+
"type": {
|
|
4133
|
+
"primitive": "string"
|
|
4134
|
+
}
|
|
4135
|
+
},
|
|
4136
|
+
{
|
|
4137
|
+
"abstract": true,
|
|
4138
|
+
"docs": {
|
|
4139
|
+
"default": "'2.238.0'",
|
|
4140
|
+
"stability": "stable",
|
|
4141
|
+
"summary": "The AWS CDK version to use as peer dependency."
|
|
4142
|
+
},
|
|
4143
|
+
"immutable": true,
|
|
4144
|
+
"locationInModule": {
|
|
4145
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4146
|
+
"line": 1090
|
|
4147
|
+
},
|
|
4148
|
+
"name": "cdkVersion",
|
|
4149
|
+
"optional": true,
|
|
4150
|
+
"type": {
|
|
4151
|
+
"primitive": "string"
|
|
4152
|
+
}
|
|
4153
|
+
},
|
|
4154
|
+
{
|
|
4155
|
+
"abstract": true,
|
|
4156
|
+
"docs": {
|
|
4157
|
+
"default": "- no license checks are run during the build and all licenses will be accepted",
|
|
4158
|
+
"remarks": "This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.",
|
|
4159
|
+
"stability": "experimental",
|
|
4160
|
+
"summary": "Configure which licenses should be deemed acceptable for use by dependencies."
|
|
4161
|
+
},
|
|
4162
|
+
"immutable": true,
|
|
4163
|
+
"locationInModule": {
|
|
4164
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4165
|
+
"line": 321
|
|
4166
|
+
},
|
|
4167
|
+
"name": "checkLicenses",
|
|
4168
|
+
"optional": true,
|
|
4169
|
+
"type": {
|
|
4170
|
+
"fqn": "projen.javascript.LicenseCheckerOptions"
|
|
4171
|
+
}
|
|
4172
|
+
},
|
|
4173
|
+
{
|
|
4174
|
+
"abstract": true,
|
|
4175
|
+
"docs": {
|
|
4176
|
+
"default": "- true, but false for subprojects",
|
|
4177
|
+
"stability": "experimental",
|
|
4178
|
+
"summary": "Add a `clobber` task which resets the repo to origin."
|
|
4179
|
+
},
|
|
4180
|
+
"immutable": true,
|
|
4181
|
+
"locationInModule": {
|
|
4182
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4183
|
+
"line": 986
|
|
4184
|
+
},
|
|
4185
|
+
"name": "clobber",
|
|
4186
|
+
"optional": true,
|
|
4187
|
+
"type": {
|
|
4188
|
+
"primitive": "boolean"
|
|
4189
|
+
}
|
|
4190
|
+
},
|
|
4191
|
+
{
|
|
4192
|
+
"abstract": true,
|
|
4193
|
+
"docs": {
|
|
4194
|
+
"default": "- undefined",
|
|
4195
|
+
"remarks": "This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact",
|
|
4196
|
+
"stability": "experimental",
|
|
4197
|
+
"summary": "Options for npm packages using AWS CodeArtifact."
|
|
4198
|
+
},
|
|
4199
|
+
"immutable": true,
|
|
4200
|
+
"locationInModule": {
|
|
4201
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4202
|
+
"line": 819
|
|
4203
|
+
},
|
|
4204
|
+
"name": "codeArtifactOptions",
|
|
4205
|
+
"optional": true,
|
|
4206
|
+
"type": {
|
|
4207
|
+
"fqn": "projen.javascript.CodeArtifactOptions"
|
|
4208
|
+
}
|
|
4209
|
+
},
|
|
4210
|
+
{
|
|
4211
|
+
"abstract": true,
|
|
4212
|
+
"docs": {
|
|
4213
|
+
"default": "false",
|
|
4214
|
+
"stability": "experimental",
|
|
4215
|
+
"summary": "Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`."
|
|
4216
|
+
},
|
|
4217
|
+
"immutable": true,
|
|
4218
|
+
"locationInModule": {
|
|
4219
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4220
|
+
"line": 314
|
|
4221
|
+
},
|
|
4222
|
+
"name": "codeCov",
|
|
4223
|
+
"optional": true,
|
|
4224
|
+
"type": {
|
|
4225
|
+
"primitive": "boolean"
|
|
4226
|
+
}
|
|
4227
|
+
},
|
|
4228
|
+
{
|
|
4229
|
+
"abstract": true,
|
|
4230
|
+
"docs": {
|
|
4231
|
+
"default": "- OIDC auth is used",
|
|
4232
|
+
"stability": "experimental",
|
|
4233
|
+
"summary": "Define the secret name for a specified https://codecov.io/ token."
|
|
4234
|
+
},
|
|
4235
|
+
"immutable": true,
|
|
4236
|
+
"locationInModule": {
|
|
4237
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4238
|
+
"line": 308
|
|
4239
|
+
},
|
|
4240
|
+
"name": "codeCovTokenSecret",
|
|
4241
|
+
"optional": true,
|
|
4242
|
+
"type": {
|
|
4243
|
+
"primitive": "string"
|
|
4244
|
+
}
|
|
4245
|
+
},
|
|
4246
|
+
{
|
|
4247
|
+
"abstract": true,
|
|
4248
|
+
"docs": {
|
|
4249
|
+
"default": "true",
|
|
4250
|
+
"stability": "experimental",
|
|
4251
|
+
"summary": "Whether to commit the managed files by default."
|
|
4252
|
+
},
|
|
4253
|
+
"immutable": true,
|
|
4254
|
+
"locationInModule": {
|
|
4255
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4256
|
+
"line": 1077
|
|
4257
|
+
},
|
|
4258
|
+
"name": "commitGenerated",
|
|
4259
|
+
"optional": true,
|
|
4260
|
+
"type": {
|
|
4261
|
+
"primitive": "boolean"
|
|
4262
|
+
}
|
|
4263
|
+
},
|
|
4264
|
+
{
|
|
4265
|
+
"abstract": true,
|
|
4266
|
+
"docs": {
|
|
4267
|
+
"default": "'10.4.5'",
|
|
4268
|
+
"stability": "stable",
|
|
4269
|
+
"summary": "The constructs library version to use as peer dependency."
|
|
4270
|
+
},
|
|
4271
|
+
"immutable": true,
|
|
4272
|
+
"locationInModule": {
|
|
4273
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4274
|
+
"line": 1095
|
|
4275
|
+
},
|
|
4276
|
+
"name": "constructVersion",
|
|
4277
|
+
"optional": true,
|
|
4278
|
+
"type": {
|
|
4279
|
+
"primitive": "string"
|
|
4280
|
+
}
|
|
4281
|
+
},
|
|
4282
|
+
{
|
|
4283
|
+
"abstract": true,
|
|
4284
|
+
"docs": {
|
|
4285
|
+
"default": "- defaults to the value of authorName or \"\" if `authorName` is undefined.",
|
|
4286
|
+
"stability": "experimental",
|
|
4287
|
+
"summary": "License copyright owner."
|
|
4288
|
+
},
|
|
4289
|
+
"immutable": true,
|
|
4290
|
+
"locationInModule": {
|
|
4291
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4292
|
+
"line": 302
|
|
4293
|
+
},
|
|
4294
|
+
"name": "copyrightOwner",
|
|
4295
|
+
"optional": true,
|
|
4296
|
+
"type": {
|
|
4297
|
+
"primitive": "string"
|
|
4298
|
+
}
|
|
4299
|
+
},
|
|
4300
|
+
{
|
|
4301
|
+
"abstract": true,
|
|
4302
|
+
"docs": {
|
|
4303
|
+
"default": "- current year",
|
|
4304
|
+
"stability": "experimental",
|
|
4305
|
+
"summary": "The copyright years to put in the LICENSE file."
|
|
4306
|
+
},
|
|
4307
|
+
"immutable": true,
|
|
4308
|
+
"locationInModule": {
|
|
4309
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4310
|
+
"line": 296
|
|
4311
|
+
},
|
|
4312
|
+
"name": "copyrightPeriod",
|
|
4313
|
+
"optional": true,
|
|
4314
|
+
"type": {
|
|
4315
|
+
"primitive": "string"
|
|
4316
|
+
}
|
|
4317
|
+
},
|
|
4318
|
+
{
|
|
4319
|
+
"abstract": true,
|
|
4320
|
+
"docs": {
|
|
4321
|
+
"default": "false",
|
|
4322
|
+
"remarks": "Cannot be used in conjunction with `depsUpgrade`.",
|
|
4323
|
+
"stability": "experimental",
|
|
4324
|
+
"summary": "Use dependabot to handle dependency upgrades."
|
|
4325
|
+
},
|
|
4326
|
+
"immutable": true,
|
|
4327
|
+
"locationInModule": {
|
|
4328
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4329
|
+
"line": 290
|
|
4330
|
+
},
|
|
4331
|
+
"name": "dependabot",
|
|
4332
|
+
"optional": true,
|
|
4333
|
+
"type": {
|
|
4334
|
+
"primitive": "boolean"
|
|
4335
|
+
}
|
|
4336
|
+
},
|
|
4337
|
+
{
|
|
4338
|
+
"abstract": true,
|
|
4339
|
+
"docs": {
|
|
4340
|
+
"default": "- default options",
|
|
4341
|
+
"stability": "experimental",
|
|
4342
|
+
"summary": "Options for dependabot."
|
|
4343
|
+
},
|
|
4344
|
+
"immutable": true,
|
|
4345
|
+
"locationInModule": {
|
|
4346
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4347
|
+
"line": 283
|
|
4348
|
+
},
|
|
4349
|
+
"name": "dependabotOptions",
|
|
4350
|
+
"optional": true,
|
|
4351
|
+
"type": {
|
|
4352
|
+
"fqn": "projen.github.DependabotOptions"
|
|
4353
|
+
}
|
|
4354
|
+
},
|
|
4355
|
+
{
|
|
4356
|
+
"abstract": true,
|
|
4357
|
+
"docs": {
|
|
4358
|
+
"custom": {
|
|
4359
|
+
"featured": "true"
|
|
4360
|
+
},
|
|
4361
|
+
"default": "[]",
|
|
4362
|
+
"remarks": "The recommendation is to only specify the module name here (e.g.\n`express`). This will behave similar to `yarn add` or `npm install` in the\nsense that it will add the module as a dependency to your `package.json`\nfile with the latest version (`^`). You can specify semver requirements in\nthe same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and\nthis will be what you `package.json` will eventually include.",
|
|
4363
|
+
"stability": "experimental",
|
|
4364
|
+
"summary": "Runtime dependencies of this module."
|
|
4365
|
+
},
|
|
4366
|
+
"immutable": true,
|
|
4367
|
+
"locationInModule": {
|
|
4368
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4369
|
+
"line": 812
|
|
4370
|
+
},
|
|
4371
|
+
"name": "deps",
|
|
4372
|
+
"optional": true,
|
|
4373
|
+
"type": {
|
|
4374
|
+
"collection": {
|
|
4375
|
+
"elementtype": {
|
|
4376
|
+
"primitive": "string"
|
|
4377
|
+
},
|
|
4378
|
+
"kind": "array"
|
|
4379
|
+
}
|
|
4380
|
+
}
|
|
4381
|
+
},
|
|
4382
|
+
{
|
|
4383
|
+
"abstract": true,
|
|
4384
|
+
"docs": {
|
|
4385
|
+
"default": "- `true` for root projects, `false` for subprojects",
|
|
4386
|
+
"remarks": "Cannot be used in conjunction with `dependabot`.",
|
|
4387
|
+
"stability": "experimental",
|
|
4388
|
+
"summary": "Use tasks and github workflows to handle dependency upgrades."
|
|
4389
|
+
},
|
|
4390
|
+
"immutable": true,
|
|
4391
|
+
"locationInModule": {
|
|
4392
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4393
|
+
"line": 277
|
|
4394
|
+
},
|
|
4395
|
+
"name": "depsUpgrade",
|
|
4396
|
+
"optional": true,
|
|
4397
|
+
"type": {
|
|
4398
|
+
"primitive": "boolean"
|
|
4399
|
+
}
|
|
4400
|
+
},
|
|
4401
|
+
{
|
|
4402
|
+
"abstract": true,
|
|
4403
|
+
"docs": {
|
|
4404
|
+
"default": "- default options",
|
|
4405
|
+
"stability": "experimental",
|
|
4406
|
+
"summary": "Options for `UpgradeDependencies`."
|
|
4407
|
+
},
|
|
4408
|
+
"immutable": true,
|
|
4409
|
+
"locationInModule": {
|
|
4410
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4411
|
+
"line": 270
|
|
4412
|
+
},
|
|
4413
|
+
"name": "depsUpgradeOptions",
|
|
4414
|
+
"optional": true,
|
|
4415
|
+
"type": {
|
|
4416
|
+
"fqn": "projen.javascript.UpgradeDependenciesOptions"
|
|
4417
|
+
}
|
|
4418
|
+
},
|
|
4419
|
+
{
|
|
4420
|
+
"abstract": true,
|
|
4421
|
+
"docs": {
|
|
4422
|
+
"custom": {
|
|
4423
|
+
"featured": "true"
|
|
4424
|
+
},
|
|
4425
|
+
"remarks": "It can be used when searching for packages in a package manager as well.\nSee https://classic.yarnpkg.com/en/docs/package-json/#toc-description",
|
|
4426
|
+
"stability": "experimental",
|
|
4427
|
+
"summary": "The description is just a string that helps people understand the purpose of the package."
|
|
4428
|
+
},
|
|
4429
|
+
"immutable": true,
|
|
4430
|
+
"locationInModule": {
|
|
4431
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4432
|
+
"line": 799
|
|
4433
|
+
},
|
|
4434
|
+
"name": "description",
|
|
4435
|
+
"optional": true,
|
|
4436
|
+
"type": {
|
|
4437
|
+
"primitive": "string"
|
|
4438
|
+
}
|
|
4439
|
+
},
|
|
4440
|
+
{
|
|
4441
|
+
"abstract": true,
|
|
4442
|
+
"docs": {
|
|
4443
|
+
"default": "false",
|
|
4444
|
+
"stability": "experimental",
|
|
4445
|
+
"summary": "Add a VSCode development environment (used for GitHub Codespaces)."
|
|
4446
|
+
},
|
|
4447
|
+
"immutable": true,
|
|
4448
|
+
"locationInModule": {
|
|
4449
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4450
|
+
"line": 980
|
|
4451
|
+
},
|
|
4452
|
+
"name": "devContainer",
|
|
4453
|
+
"optional": true,
|
|
4454
|
+
"type": {
|
|
4455
|
+
"primitive": "boolean"
|
|
4456
|
+
}
|
|
4457
|
+
},
|
|
4458
|
+
{
|
|
4459
|
+
"abstract": true,
|
|
4460
|
+
"docs": {
|
|
4461
|
+
"custom": {
|
|
4462
|
+
"featured": "true"
|
|
4463
|
+
},
|
|
4464
|
+
"default": "[]",
|
|
4465
|
+
"remarks": "These dependencies will only be\navailable in your build environment but will not be fetched when this\nmodule is consumed.\n\nThe recommendation is to only specify the module name here (e.g.\n`express`). This will behave similar to `yarn add` or `npm install` in the\nsense that it will add the module as a dependency to your `package.json`\nfile with the latest version (`^`). You can specify semver requirements in\nthe same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and\nthis will be what you `package.json` will eventually include.",
|
|
4466
|
+
"stability": "experimental",
|
|
4467
|
+
"summary": "Build dependencies for this module."
|
|
4468
|
+
},
|
|
4469
|
+
"immutable": true,
|
|
4470
|
+
"locationInModule": {
|
|
4471
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4472
|
+
"line": 791
|
|
4473
|
+
},
|
|
4474
|
+
"name": "devDeps",
|
|
4475
|
+
"optional": true,
|
|
4476
|
+
"type": {
|
|
4477
|
+
"collection": {
|
|
4478
|
+
"elementtype": {
|
|
4479
|
+
"primitive": "string"
|
|
4480
|
+
},
|
|
4481
|
+
"kind": "array"
|
|
4482
|
+
}
|
|
4483
|
+
}
|
|
4484
|
+
},
|
|
4485
|
+
{
|
|
4486
|
+
"abstract": true,
|
|
4487
|
+
"docs": {
|
|
4488
|
+
"default": "false",
|
|
4489
|
+
"stability": "experimental",
|
|
4490
|
+
"summary": "Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler)."
|
|
4491
|
+
},
|
|
4492
|
+
"immutable": true,
|
|
4493
|
+
"locationInModule": {
|
|
4494
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4495
|
+
"line": 120
|
|
4496
|
+
},
|
|
4497
|
+
"name": "disableTsconfig",
|
|
4498
|
+
"optional": true,
|
|
4499
|
+
"type": {
|
|
4500
|
+
"primitive": "boolean"
|
|
4501
|
+
}
|
|
4502
|
+
},
|
|
4503
|
+
{
|
|
4504
|
+
"abstract": true,
|
|
4505
|
+
"docs": {
|
|
4506
|
+
"default": "false",
|
|
4507
|
+
"stability": "experimental",
|
|
4508
|
+
"summary": "Do not generate a `tsconfig.dev.json` file."
|
|
4509
|
+
},
|
|
4510
|
+
"immutable": true,
|
|
4511
|
+
"locationInModule": {
|
|
4512
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4513
|
+
"line": 114
|
|
4514
|
+
},
|
|
4515
|
+
"name": "disableTsconfigDev",
|
|
4516
|
+
"optional": true,
|
|
4517
|
+
"type": {
|
|
4518
|
+
"primitive": "boolean"
|
|
4519
|
+
}
|
|
4520
|
+
},
|
|
4521
|
+
{
|
|
4522
|
+
"abstract": true,
|
|
4523
|
+
"docs": {
|
|
4524
|
+
"default": "false",
|
|
4525
|
+
"stability": "experimental",
|
|
4526
|
+
"summary": "Docgen by Typedoc."
|
|
4527
|
+
},
|
|
4528
|
+
"immutable": true,
|
|
4529
|
+
"locationInModule": {
|
|
4530
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4531
|
+
"line": 108
|
|
4532
|
+
},
|
|
4533
|
+
"name": "docgen",
|
|
4534
|
+
"optional": true,
|
|
4535
|
+
"type": {
|
|
4536
|
+
"primitive": "boolean"
|
|
4537
|
+
}
|
|
4538
|
+
},
|
|
4539
|
+
{
|
|
4540
|
+
"abstract": true,
|
|
4541
|
+
"docs": {
|
|
4542
|
+
"default": "\"docs\"",
|
|
4543
|
+
"stability": "experimental",
|
|
4544
|
+
"summary": "Docs directory."
|
|
4545
|
+
},
|
|
4546
|
+
"immutable": true,
|
|
4547
|
+
"locationInModule": {
|
|
4548
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4549
|
+
"line": 102
|
|
4550
|
+
},
|
|
4551
|
+
"name": "docsDirectory",
|
|
4552
|
+
"optional": true,
|
|
4553
|
+
"type": {
|
|
4554
|
+
"primitive": "string"
|
|
4555
|
+
}
|
|
4556
|
+
},
|
|
4557
|
+
{
|
|
4558
|
+
"abstract": true,
|
|
4559
|
+
"docs": {
|
|
4560
|
+
"default": "\"lib/index.js\"",
|
|
4561
|
+
"stability": "experimental",
|
|
4562
|
+
"summary": "Module entrypoint (`main` in `package.json`). Set to an empty string to not include `main` in your package.json."
|
|
4563
|
+
},
|
|
4564
|
+
"immutable": true,
|
|
4565
|
+
"locationInModule": {
|
|
4566
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4567
|
+
"line": 774
|
|
4568
|
+
},
|
|
4569
|
+
"name": "entrypoint",
|
|
4570
|
+
"optional": true,
|
|
4571
|
+
"type": {
|
|
4572
|
+
"primitive": "string"
|
|
4573
|
+
}
|
|
4574
|
+
},
|
|
4575
|
+
{
|
|
4576
|
+
"abstract": true,
|
|
4577
|
+
"docs": {
|
|
4578
|
+
"default": "- .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)",
|
|
4579
|
+
"stability": "experimental",
|
|
4580
|
+
"summary": "The .d.ts file that includes the type declarations for this module."
|
|
4581
|
+
},
|
|
4582
|
+
"immutable": true,
|
|
4583
|
+
"locationInModule": {
|
|
4584
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4585
|
+
"line": 96
|
|
4586
|
+
},
|
|
4587
|
+
"name": "entrypointTypes",
|
|
4588
|
+
"optional": true,
|
|
4589
|
+
"type": {
|
|
4590
|
+
"primitive": "string"
|
|
4591
|
+
}
|
|
4592
|
+
},
|
|
4593
|
+
{
|
|
4594
|
+
"abstract": true,
|
|
4595
|
+
"docs": {
|
|
4596
|
+
"default": "- true, unless biome is enabled",
|
|
4597
|
+
"stability": "experimental",
|
|
4598
|
+
"summary": "Setup eslint."
|
|
4599
|
+
},
|
|
4600
|
+
"immutable": true,
|
|
4601
|
+
"locationInModule": {
|
|
4602
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4603
|
+
"line": 90
|
|
4604
|
+
},
|
|
4605
|
+
"name": "eslint",
|
|
4606
|
+
"optional": true,
|
|
4607
|
+
"type": {
|
|
4608
|
+
"primitive": "boolean"
|
|
4609
|
+
}
|
|
4610
|
+
},
|
|
4611
|
+
{
|
|
4612
|
+
"abstract": true,
|
|
4613
|
+
"docs": {
|
|
4614
|
+
"default": "- opinionated default options",
|
|
4615
|
+
"stability": "experimental",
|
|
4616
|
+
"summary": "Eslint options."
|
|
4617
|
+
},
|
|
4618
|
+
"immutable": true,
|
|
4619
|
+
"locationInModule": {
|
|
4620
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4621
|
+
"line": 84
|
|
4622
|
+
},
|
|
4623
|
+
"name": "eslintOptions",
|
|
4624
|
+
"optional": true,
|
|
4625
|
+
"type": {
|
|
4626
|
+
"fqn": "projen.javascript.EslintOptions"
|
|
4627
|
+
}
|
|
4628
|
+
},
|
|
4629
|
+
{
|
|
4630
|
+
"abstract": true,
|
|
4631
|
+
"docs": {
|
|
4632
|
+
"default": "true",
|
|
4633
|
+
"remarks": "Enabled by default for root projects. Disabled for non-root projects.",
|
|
4634
|
+
"stability": "experimental",
|
|
4635
|
+
"summary": "Enable GitHub integration."
|
|
4636
|
+
},
|
|
4637
|
+
"immutable": true,
|
|
4638
|
+
"locationInModule": {
|
|
4639
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4640
|
+
"line": 974
|
|
4641
|
+
},
|
|
4642
|
+
"name": "github",
|
|
4643
|
+
"optional": true,
|
|
4644
|
+
"type": {
|
|
4645
|
+
"primitive": "boolean"
|
|
4646
|
+
}
|
|
4647
|
+
},
|
|
4648
|
+
{
|
|
4649
|
+
"abstract": true,
|
|
4650
|
+
"docs": {
|
|
4651
|
+
"default": "- see GitHubOptions",
|
|
4652
|
+
"stability": "experimental",
|
|
4653
|
+
"summary": "Options for GitHub integration."
|
|
4654
|
+
},
|
|
4655
|
+
"immutable": true,
|
|
4656
|
+
"locationInModule": {
|
|
4657
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4658
|
+
"line": 967
|
|
4659
|
+
},
|
|
4660
|
+
"name": "githubOptions",
|
|
4661
|
+
"optional": true,
|
|
4662
|
+
"type": {
|
|
4663
|
+
"fqn": "projen.github.GitHubOptions"
|
|
4664
|
+
}
|
|
4665
|
+
},
|
|
4666
|
+
{
|
|
4667
|
+
"abstract": true,
|
|
4668
|
+
"docs": {
|
|
4669
|
+
"stability": "experimental",
|
|
4670
|
+
"summary": "Additional entries to .gitignore."
|
|
4671
|
+
},
|
|
4672
|
+
"immutable": true,
|
|
4673
|
+
"locationInModule": {
|
|
4674
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4675
|
+
"line": 264
|
|
4676
|
+
},
|
|
4677
|
+
"name": "gitignore",
|
|
4678
|
+
"optional": true,
|
|
4679
|
+
"type": {
|
|
4680
|
+
"collection": {
|
|
4681
|
+
"elementtype": {
|
|
4682
|
+
"primitive": "string"
|
|
4683
|
+
},
|
|
4684
|
+
"kind": "array"
|
|
4685
|
+
}
|
|
4686
|
+
}
|
|
4687
|
+
},
|
|
4688
|
+
{
|
|
4689
|
+
"abstract": true,
|
|
4690
|
+
"docs": {
|
|
4691
|
+
"stability": "experimental",
|
|
4692
|
+
"summary": "Configuration options for .gitignore file."
|
|
4693
|
+
},
|
|
4694
|
+
"immutable": true,
|
|
4695
|
+
"locationInModule": {
|
|
4696
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4697
|
+
"line": 1071
|
|
4698
|
+
},
|
|
4699
|
+
"name": "gitIgnoreOptions",
|
|
4700
|
+
"optional": true,
|
|
4701
|
+
"type": {
|
|
4702
|
+
"fqn": "projen.IgnoreFileOptions"
|
|
4703
|
+
}
|
|
4704
|
+
},
|
|
4705
|
+
{
|
|
4706
|
+
"abstract": true,
|
|
4707
|
+
"docs": {
|
|
4708
|
+
"stability": "experimental",
|
|
4709
|
+
"summary": "Configuration options for git."
|
|
4710
|
+
},
|
|
4711
|
+
"immutable": true,
|
|
4712
|
+
"locationInModule": {
|
|
4713
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4714
|
+
"line": 1066
|
|
4715
|
+
},
|
|
4716
|
+
"name": "gitOptions",
|
|
4717
|
+
"optional": true,
|
|
4718
|
+
"type": {
|
|
4719
|
+
"fqn": "projen.GitOptions"
|
|
4720
|
+
}
|
|
4721
|
+
},
|
|
4722
|
+
{
|
|
4723
|
+
"abstract": true,
|
|
4724
|
+
"docs": {
|
|
4725
|
+
"default": "false",
|
|
4726
|
+
"stability": "experimental",
|
|
4727
|
+
"summary": "Add a Gitpod development environment."
|
|
4728
|
+
},
|
|
4729
|
+
"immutable": true,
|
|
4730
|
+
"locationInModule": {
|
|
4731
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4732
|
+
"line": 961
|
|
4733
|
+
},
|
|
4734
|
+
"name": "gitpod",
|
|
4735
|
+
"optional": true,
|
|
4736
|
+
"type": {
|
|
4737
|
+
"primitive": "boolean"
|
|
4738
|
+
}
|
|
4739
|
+
},
|
|
4740
|
+
{
|
|
4741
|
+
"abstract": true,
|
|
4742
|
+
"docs": {
|
|
4743
|
+
"stability": "experimental",
|
|
4744
|
+
"summary": "Package's Homepage / Website."
|
|
4745
|
+
},
|
|
4746
|
+
"immutable": true,
|
|
4747
|
+
"locationInModule": {
|
|
4748
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4749
|
+
"line": 767
|
|
4750
|
+
},
|
|
4751
|
+
"name": "homepage",
|
|
4752
|
+
"optional": true,
|
|
4753
|
+
"type": {
|
|
4754
|
+
"primitive": "string"
|
|
4755
|
+
}
|
|
4756
|
+
},
|
|
4757
|
+
{
|
|
4758
|
+
"abstract": true,
|
|
4759
|
+
"docs": {
|
|
4760
|
+
"default": "true",
|
|
4761
|
+
"stability": "experimental",
|
|
4762
|
+
"summary": "Setup jest unit tests."
|
|
4763
|
+
},
|
|
4764
|
+
"immutable": true,
|
|
4765
|
+
"locationInModule": {
|
|
4766
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4767
|
+
"line": 259
|
|
4768
|
+
},
|
|
4769
|
+
"name": "jest",
|
|
4770
|
+
"optional": true,
|
|
4771
|
+
"type": {
|
|
4772
|
+
"primitive": "boolean"
|
|
4773
|
+
}
|
|
4774
|
+
},
|
|
4775
|
+
{
|
|
4776
|
+
"abstract": true,
|
|
4777
|
+
"docs": {
|
|
4778
|
+
"default": "- default options",
|
|
4779
|
+
"stability": "experimental",
|
|
4780
|
+
"summary": "Jest options."
|
|
4781
|
+
},
|
|
4782
|
+
"immutable": true,
|
|
4783
|
+
"locationInModule": {
|
|
4784
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4785
|
+
"line": 253
|
|
4786
|
+
},
|
|
4787
|
+
"name": "jestOptions",
|
|
4788
|
+
"optional": true,
|
|
4789
|
+
"type": {
|
|
4790
|
+
"fqn": "projen.javascript.JestOptions"
|
|
4791
|
+
}
|
|
4792
|
+
},
|
|
4793
|
+
{
|
|
4794
|
+
"abstract": true,
|
|
4795
|
+
"docs": {
|
|
4796
|
+
"default": "\"latest\"",
|
|
4797
|
+
"stability": "experimental",
|
|
4798
|
+
"summary": "Version requirement of `publib` which is used to publish modules to npm."
|
|
4799
|
+
},
|
|
4800
|
+
"immutable": true,
|
|
4801
|
+
"locationInModule": {
|
|
4802
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4803
|
+
"line": 584
|
|
4804
|
+
},
|
|
4805
|
+
"name": "jsiiReleaseVersion",
|
|
4806
|
+
"optional": true,
|
|
4807
|
+
"type": {
|
|
4808
|
+
"primitive": "string"
|
|
4809
|
+
}
|
|
4810
|
+
},
|
|
4811
|
+
{
|
|
4812
|
+
"abstract": true,
|
|
4813
|
+
"docs": {
|
|
4814
|
+
"stability": "experimental",
|
|
4815
|
+
"summary": "Keywords to include in `package.json`."
|
|
4816
|
+
},
|
|
4817
|
+
"immutable": true,
|
|
4818
|
+
"locationInModule": {
|
|
4819
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4820
|
+
"line": 762
|
|
4821
|
+
},
|
|
4822
|
+
"name": "keywords",
|
|
4823
|
+
"optional": true,
|
|
4824
|
+
"type": {
|
|
4825
|
+
"collection": {
|
|
4826
|
+
"elementtype": {
|
|
4827
|
+
"primitive": "string"
|
|
4828
|
+
},
|
|
4829
|
+
"kind": "array"
|
|
4830
|
+
}
|
|
4831
|
+
}
|
|
4832
|
+
},
|
|
4833
|
+
{
|
|
4834
|
+
"abstract": true,
|
|
4835
|
+
"docs": {
|
|
4836
|
+
"default": "\"lib\"",
|
|
4837
|
+
"stability": "experimental",
|
|
4838
|
+
"summary": "Typescript artifacts output directory."
|
|
4839
|
+
},
|
|
4840
|
+
"immutable": true,
|
|
4841
|
+
"locationInModule": {
|
|
4842
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4843
|
+
"line": 78
|
|
4844
|
+
},
|
|
4845
|
+
"name": "libdir",
|
|
4846
|
+
"optional": true,
|
|
4847
|
+
"type": {
|
|
4848
|
+
"primitive": "string"
|
|
4849
|
+
}
|
|
4850
|
+
},
|
|
4851
|
+
{
|
|
4852
|
+
"abstract": true,
|
|
4853
|
+
"docs": {
|
|
4854
|
+
"default": "\"Apache-2.0\"",
|
|
4855
|
+
"remarks": "See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses.\nUse the `licensed` option if you want to no license to be specified.",
|
|
4856
|
+
"stability": "experimental",
|
|
4857
|
+
"summary": "License's SPDX identifier."
|
|
4858
|
+
},
|
|
4859
|
+
"immutable": true,
|
|
4860
|
+
"locationInModule": {
|
|
4861
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4862
|
+
"line": 757
|
|
4863
|
+
},
|
|
4864
|
+
"name": "license",
|
|
4865
|
+
"optional": true,
|
|
4866
|
+
"type": {
|
|
4867
|
+
"primitive": "string"
|
|
4868
|
+
}
|
|
4869
|
+
},
|
|
4870
|
+
{
|
|
4871
|
+
"abstract": true,
|
|
4872
|
+
"docs": {
|
|
4873
|
+
"default": "true",
|
|
4874
|
+
"stability": "experimental",
|
|
4875
|
+
"summary": "Indicates if a license should be added."
|
|
4876
|
+
},
|
|
4877
|
+
"immutable": true,
|
|
4878
|
+
"locationInModule": {
|
|
4879
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4880
|
+
"line": 749
|
|
4881
|
+
},
|
|
4882
|
+
"name": "licensed",
|
|
4883
|
+
"optional": true,
|
|
4884
|
+
"type": {
|
|
4885
|
+
"primitive": "boolean"
|
|
4886
|
+
}
|
|
4887
|
+
},
|
|
4888
|
+
{
|
|
4889
|
+
"abstract": true,
|
|
4890
|
+
"docs": {
|
|
4891
|
+
"default": "{}",
|
|
4892
|
+
"stability": "experimental",
|
|
4893
|
+
"summary": "Configure logging options such as verbosity."
|
|
4894
|
+
},
|
|
4895
|
+
"immutable": true,
|
|
4896
|
+
"locationInModule": {
|
|
4897
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4898
|
+
"line": 1061
|
|
4899
|
+
},
|
|
4900
|
+
"name": "logging",
|
|
4901
|
+
"optional": true,
|
|
4902
|
+
"type": {
|
|
4903
|
+
"fqn": "projen.LoggerOptions"
|
|
4904
|
+
}
|
|
4905
|
+
},
|
|
4906
|
+
{
|
|
4907
|
+
"abstract": true,
|
|
4908
|
+
"docs": {
|
|
4909
|
+
"default": "- Major version is not enforced.",
|
|
4910
|
+
"remarks": "If this is specified, we bump the latest version of this major version line.\nIf not specified, we bump the global latest version.",
|
|
4911
|
+
"stability": "experimental",
|
|
4912
|
+
"summary": "Major version to release from the default branch."
|
|
4913
|
+
},
|
|
4914
|
+
"immutable": true,
|
|
4915
|
+
"locationInModule": {
|
|
4916
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4917
|
+
"line": 578
|
|
4918
|
+
},
|
|
4919
|
+
"name": "majorVersion",
|
|
4920
|
+
"optional": true,
|
|
4921
|
+
"type": {
|
|
4922
|
+
"primitive": "number"
|
|
4923
|
+
}
|
|
4924
|
+
},
|
|
4925
|
+
{
|
|
4926
|
+
"abstract": true,
|
|
4927
|
+
"docs": {
|
|
4928
|
+
"default": "- no maximum version is enforced",
|
|
4929
|
+
"remarks": "Most projects should not use this option.\nThe value indicates that the package is incompatible with any newer versions of node.\nThis requirement is enforced via the engines field.\n\nYou will normally not need to set this option.\nConsider this option only if your package is known to not function with newer versions of node.",
|
|
4930
|
+
"stability": "experimental",
|
|
4931
|
+
"summary": "The maximum node version supported by this package."
|
|
4932
|
+
},
|
|
4933
|
+
"immutable": true,
|
|
4934
|
+
"locationInModule": {
|
|
4935
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4936
|
+
"line": 743
|
|
4937
|
+
},
|
|
4938
|
+
"name": "maxNodeVersion",
|
|
4939
|
+
"optional": true,
|
|
4940
|
+
"type": {
|
|
4941
|
+
"primitive": "string"
|
|
4942
|
+
}
|
|
4943
|
+
},
|
|
4944
|
+
{
|
|
4945
|
+
"abstract": true,
|
|
4946
|
+
"docs": {
|
|
4947
|
+
"default": "true",
|
|
4948
|
+
"deprecated": "use `githubOptions.mergify` instead",
|
|
4949
|
+
"stability": "deprecated",
|
|
4950
|
+
"summary": "Whether mergify should be enabled on this repository or not."
|
|
4951
|
+
},
|
|
4952
|
+
"immutable": true,
|
|
4953
|
+
"locationInModule": {
|
|
4954
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4955
|
+
"line": 955
|
|
4956
|
+
},
|
|
4957
|
+
"name": "mergify",
|
|
4958
|
+
"optional": true,
|
|
4959
|
+
"type": {
|
|
4960
|
+
"primitive": "boolean"
|
|
4961
|
+
}
|
|
4962
|
+
},
|
|
4963
|
+
{
|
|
4964
|
+
"abstract": true,
|
|
4965
|
+
"docs": {
|
|
4966
|
+
"default": "- default options",
|
|
4967
|
+
"deprecated": "use `githubOptions.mergifyOptions` instead",
|
|
4968
|
+
"stability": "deprecated",
|
|
4969
|
+
"summary": "Options for mergify."
|
|
4970
|
+
},
|
|
4971
|
+
"immutable": true,
|
|
4972
|
+
"locationInModule": {
|
|
4973
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4974
|
+
"line": 948
|
|
4975
|
+
},
|
|
4976
|
+
"name": "mergifyOptions",
|
|
4977
|
+
"optional": true,
|
|
4978
|
+
"type": {
|
|
4979
|
+
"fqn": "projen.github.MergifyOptions"
|
|
4980
|
+
}
|
|
4981
|
+
},
|
|
4982
|
+
{
|
|
4983
|
+
"abstract": true,
|
|
4984
|
+
"docs": {
|
|
4985
|
+
"default": "- No minimum version is being enforced",
|
|
4986
|
+
"remarks": "This can be useful to set to 1, as breaking changes before the 1.x major\nrelease are not incrementing the major version number.\n\nCan not be set together with `majorVersion`.",
|
|
4987
|
+
"stability": "experimental",
|
|
4988
|
+
"summary": "Minimal Major version to release."
|
|
4989
|
+
},
|
|
4990
|
+
"immutable": true,
|
|
4991
|
+
"locationInModule": {
|
|
4992
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
4993
|
+
"line": 570
|
|
4994
|
+
},
|
|
4995
|
+
"name": "minMajorVersion",
|
|
4996
|
+
"optional": true,
|
|
4997
|
+
"type": {
|
|
4998
|
+
"primitive": "number"
|
|
4999
|
+
}
|
|
5000
|
+
},
|
|
5001
|
+
{
|
|
5002
|
+
"abstract": true,
|
|
5003
|
+
"docs": {
|
|
5004
|
+
"default": "- no minimum version is enforced",
|
|
5005
|
+
"remarks": "Most projects should not use this option.\nThe value indicates that the package is incompatible with any older versions of node.\nThis requirement is enforced via the engines field.\n\nYou will normally not need to set this option, even if your package is incompatible with EOL versions of node.\nConsider this option only if your package depends on a specific feature, that is not available in other LTS versions.\nSetting this option has very high impact on the consumers of your package,\nas package managers will actively prevent usage with node versions you have marked as incompatible.\n\nTo change the node version of your CI/CD workflows, use `workflowNodeVersion`.",
|
|
5006
|
+
"stability": "experimental",
|
|
5007
|
+
"summary": "The minimum node version required by this package to function."
|
|
5008
|
+
},
|
|
5009
|
+
"immutable": true,
|
|
5010
|
+
"locationInModule": {
|
|
5011
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5012
|
+
"line": 732
|
|
5013
|
+
},
|
|
5014
|
+
"name": "minNodeVersion",
|
|
5015
|
+
"optional": true,
|
|
5016
|
+
"type": {
|
|
5017
|
+
"primitive": "string"
|
|
5018
|
+
}
|
|
5019
|
+
},
|
|
5020
|
+
{
|
|
5021
|
+
"abstract": true,
|
|
5022
|
+
"docs": {
|
|
5023
|
+
"default": "true",
|
|
5024
|
+
"deprecated": "- Use `buildWorkflowOptions.mutableBuild`",
|
|
5025
|
+
"remarks": "This means\nthat any files synthesized by projen or e.g. test snapshots will always be up-to-date\nbefore a PR is merged.\n\nImplies that PR builds do not have anti-tamper checks.",
|
|
5026
|
+
"stability": "deprecated",
|
|
5027
|
+
"summary": "Automatically update files modified during builds to pull-request branches."
|
|
5028
|
+
},
|
|
5029
|
+
"immutable": true,
|
|
5030
|
+
"locationInModule": {
|
|
5031
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5032
|
+
"line": 247
|
|
5033
|
+
},
|
|
5034
|
+
"name": "mutableBuild",
|
|
5035
|
+
"optional": true,
|
|
5036
|
+
"type": {
|
|
5037
|
+
"primitive": "boolean"
|
|
5038
|
+
}
|
|
5039
|
+
},
|
|
5040
|
+
{
|
|
5041
|
+
"abstract": true,
|
|
5042
|
+
"docs": {
|
|
5043
|
+
"default": "- The next version will be determined based on the commit history and project settings.",
|
|
5044
|
+
"remarks": "If present, this shell command will be run before the bump is executed, and\nit determines what version to release. It will be executed in the following\nenvironment:\n\n- Working directory: the project directory.\n- `$VERSION`: the current version. Looks like `1.2.3`.\n- `$LATEST_TAG`: the most recent tag. Looks like `prefix-v1.2.3`, or may be unset.\n- `$SUGGESTED_BUMP`: the suggested bump action based on commits. One of `major|minor|patch|none`.\n\nThe command should print one of the following to `stdout`:\n\n- Nothing: the next version number will be determined based on commit history.\n- `x.y.z`: the next version number will be `x.y.z`.\n- `major|minor|patch`: the next version number will be the current version number\n with the indicated component bumped.\n\nThis setting cannot be specified together with `minMajorVersion`; the invoked\nscript can be used to achieve the effects of `minMajorVersion`.",
|
|
5045
|
+
"stability": "experimental",
|
|
5046
|
+
"summary": "A shell command to control the next version to release."
|
|
5047
|
+
},
|
|
5048
|
+
"immutable": true,
|
|
5049
|
+
"locationInModule": {
|
|
5050
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5051
|
+
"line": 560
|
|
5052
|
+
},
|
|
5053
|
+
"name": "nextVersionCommand",
|
|
5054
|
+
"optional": true,
|
|
5055
|
+
"type": {
|
|
5056
|
+
"primitive": "string"
|
|
5057
|
+
}
|
|
5058
|
+
},
|
|
5059
|
+
{
|
|
5060
|
+
"abstract": true,
|
|
5061
|
+
"docs": {
|
|
5062
|
+
"default": "- for scoped packages (e.g. `foo@bar`), the default is\n`NpmAccess.RESTRICTED`, for non-scoped packages, the default is\n`NpmAccess.PUBLIC`.",
|
|
5063
|
+
"stability": "experimental",
|
|
5064
|
+
"summary": "Access level of the npm package."
|
|
5065
|
+
},
|
|
5066
|
+
"immutable": true,
|
|
5067
|
+
"locationInModule": {
|
|
5068
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5069
|
+
"line": 717
|
|
5070
|
+
},
|
|
5071
|
+
"name": "npmAccess",
|
|
5072
|
+
"optional": true,
|
|
5073
|
+
"type": {
|
|
5074
|
+
"fqn": "projen.javascript.NpmAccess"
|
|
5075
|
+
}
|
|
5076
|
+
},
|
|
5077
|
+
{
|
|
5078
|
+
"abstract": true,
|
|
5079
|
+
"docs": {
|
|
5080
|
+
"default": "\"latest\"",
|
|
5081
|
+
"remarks": "To set the npm dist-tag for release branches, set the `npmDistTag` property\nfor each branch.",
|
|
5082
|
+
"stability": "experimental",
|
|
5083
|
+
"summary": "The npmDistTag to use when publishing from the default branch."
|
|
5084
|
+
},
|
|
5085
|
+
"immutable": true,
|
|
5086
|
+
"locationInModule": {
|
|
5087
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5088
|
+
"line": 536
|
|
5089
|
+
},
|
|
5090
|
+
"name": "npmDistTag",
|
|
5091
|
+
"optional": true,
|
|
5092
|
+
"type": {
|
|
5093
|
+
"primitive": "string"
|
|
5094
|
+
}
|
|
5095
|
+
},
|
|
5096
|
+
{
|
|
5097
|
+
"abstract": true,
|
|
5098
|
+
"docs": {
|
|
5099
|
+
"deprecated": "- use `project.addPackageIgnore`",
|
|
5100
|
+
"stability": "deprecated",
|
|
5101
|
+
"summary": "Additional entries to .npmignore."
|
|
5102
|
+
},
|
|
5103
|
+
"immutable": true,
|
|
5104
|
+
"locationInModule": {
|
|
5105
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5106
|
+
"line": 235
|
|
5107
|
+
},
|
|
5108
|
+
"name": "npmignore",
|
|
5109
|
+
"optional": true,
|
|
5110
|
+
"type": {
|
|
5111
|
+
"collection": {
|
|
5112
|
+
"elementtype": {
|
|
5113
|
+
"primitive": "string"
|
|
5114
|
+
},
|
|
5115
|
+
"kind": "array"
|
|
5116
|
+
}
|
|
5117
|
+
}
|
|
5118
|
+
},
|
|
5119
|
+
{
|
|
5120
|
+
"abstract": true,
|
|
5121
|
+
"docs": {
|
|
5122
|
+
"default": "true",
|
|
5123
|
+
"stability": "experimental",
|
|
5124
|
+
"summary": "Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs."
|
|
5125
|
+
},
|
|
5126
|
+
"immutable": true,
|
|
5127
|
+
"locationInModule": {
|
|
5128
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5129
|
+
"line": 229
|
|
5130
|
+
},
|
|
5131
|
+
"name": "npmignoreEnabled",
|
|
5132
|
+
"optional": true,
|
|
5133
|
+
"type": {
|
|
5134
|
+
"primitive": "boolean"
|
|
5135
|
+
}
|
|
5136
|
+
},
|
|
5137
|
+
{
|
|
5138
|
+
"abstract": true,
|
|
5139
|
+
"docs": {
|
|
5140
|
+
"stability": "experimental",
|
|
5141
|
+
"summary": "Configuration options for .npmignore file."
|
|
5142
|
+
},
|
|
5143
|
+
"immutable": true,
|
|
5144
|
+
"locationInModule": {
|
|
5145
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5146
|
+
"line": 223
|
|
5147
|
+
},
|
|
5148
|
+
"name": "npmIgnoreOptions",
|
|
5149
|
+
"optional": true,
|
|
5150
|
+
"type": {
|
|
5151
|
+
"fqn": "projen.IgnoreFileOptions"
|
|
5152
|
+
}
|
|
5153
|
+
},
|
|
5154
|
+
{
|
|
5155
|
+
"abstract": true,
|
|
5156
|
+
"docs": {
|
|
5157
|
+
"default": "- true for public packages, false otherwise",
|
|
5158
|
+
"remarks": "A supported package manager is required to publish a package with npm provenance statements and\nyou will need to use a supported CI/CD provider.\n\nNote that the projen `Release` and `Publisher` components are using `publib` to publish packages,\nwhich is using npm internally and supports provenance statements independently of the package manager used.",
|
|
5159
|
+
"stability": "experimental",
|
|
5160
|
+
"summary": "Should provenance statements be generated when the package is published."
|
|
5161
|
+
},
|
|
5162
|
+
"immutable": true,
|
|
5163
|
+
"locationInModule": {
|
|
5164
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5165
|
+
"line": 709
|
|
5166
|
+
},
|
|
5167
|
+
"name": "npmProvenance",
|
|
5168
|
+
"optional": true,
|
|
5169
|
+
"type": {
|
|
5170
|
+
"primitive": "boolean"
|
|
5171
|
+
}
|
|
5172
|
+
},
|
|
5173
|
+
{
|
|
5174
|
+
"abstract": true,
|
|
5175
|
+
"docs": {
|
|
5176
|
+
"deprecated": "use `npmRegistryUrl` instead",
|
|
5177
|
+
"remarks": "Cannot be set together with `npmRegistryUrl`.",
|
|
5178
|
+
"stability": "deprecated",
|
|
5179
|
+
"summary": "The host name of the npm registry to publish to."
|
|
5180
|
+
},
|
|
5181
|
+
"immutable": true,
|
|
5182
|
+
"locationInModule": {
|
|
5183
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5184
|
+
"line": 698
|
|
5185
|
+
},
|
|
5186
|
+
"name": "npmRegistry",
|
|
5187
|
+
"optional": true,
|
|
5188
|
+
"type": {
|
|
5189
|
+
"primitive": "string"
|
|
5190
|
+
}
|
|
5191
|
+
},
|
|
5192
|
+
{
|
|
5193
|
+
"abstract": true,
|
|
5194
|
+
"docs": {
|
|
5195
|
+
"default": "\"https://registry.npmjs.org\"",
|
|
5196
|
+
"remarks": "Must be a URL (e.g. start with \"https://\" or \"http://\")",
|
|
5197
|
+
"stability": "experimental",
|
|
5198
|
+
"summary": "The base URL of the npm package registry."
|
|
5199
|
+
},
|
|
5200
|
+
"immutable": true,
|
|
5201
|
+
"locationInModule": {
|
|
5202
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5203
|
+
"line": 691
|
|
5204
|
+
},
|
|
5205
|
+
"name": "npmRegistryUrl",
|
|
5206
|
+
"optional": true,
|
|
5207
|
+
"type": {
|
|
5208
|
+
"primitive": "string"
|
|
5209
|
+
}
|
|
5210
|
+
},
|
|
5211
|
+
{
|
|
5212
|
+
"abstract": true,
|
|
5213
|
+
"docs": {
|
|
5214
|
+
"default": "\"NPM_TOKEN\"",
|
|
5215
|
+
"stability": "experimental",
|
|
5216
|
+
"summary": "GitHub secret which contains the NPM token to use when publishing packages."
|
|
5217
|
+
},
|
|
5218
|
+
"immutable": true,
|
|
5219
|
+
"locationInModule": {
|
|
5220
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5221
|
+
"line": 684
|
|
5222
|
+
},
|
|
5223
|
+
"name": "npmTokenSecret",
|
|
5224
|
+
"optional": true,
|
|
5225
|
+
"type": {
|
|
5226
|
+
"primitive": "string"
|
|
5227
|
+
}
|
|
5228
|
+
},
|
|
5229
|
+
{
|
|
5230
|
+
"abstract": true,
|
|
5231
|
+
"docs": {
|
|
5232
|
+
"default": "- false",
|
|
5233
|
+
"stability": "experimental",
|
|
5234
|
+
"summary": "Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work."
|
|
5235
|
+
},
|
|
5236
|
+
"immutable": true,
|
|
5237
|
+
"locationInModule": {
|
|
5238
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5239
|
+
"line": 678
|
|
5240
|
+
},
|
|
5241
|
+
"name": "npmTrustedPublishing",
|
|
5242
|
+
"optional": true,
|
|
5243
|
+
"type": {
|
|
5244
|
+
"primitive": "boolean"
|
|
5245
|
+
}
|
|
5246
|
+
},
|
|
5247
|
+
{
|
|
5248
|
+
"abstract": true,
|
|
5249
|
+
"docs": {
|
|
5250
|
+
"default": "\".\"",
|
|
5251
|
+
"remarks": "If this project has a parent, this directory is relative to the parent\ndirectory and it cannot be the same as the parent or any of it's other\nsubprojects.",
|
|
5252
|
+
"stability": "experimental",
|
|
5253
|
+
"summary": "The root directory of the project. Relative to this directory, all files are synthesized."
|
|
5254
|
+
},
|
|
5255
|
+
"immutable": true,
|
|
5256
|
+
"locationInModule": {
|
|
5257
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5258
|
+
"line": 1055
|
|
5259
|
+
},
|
|
5260
|
+
"name": "outdir",
|
|
5261
|
+
"optional": true,
|
|
5262
|
+
"type": {
|
|
5263
|
+
"primitive": "string"
|
|
5264
|
+
}
|
|
5265
|
+
},
|
|
5266
|
+
{
|
|
5267
|
+
"abstract": true,
|
|
5268
|
+
"docs": {
|
|
5269
|
+
"default": "true",
|
|
5270
|
+
"stability": "experimental",
|
|
5271
|
+
"summary": "Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`)."
|
|
5272
|
+
},
|
|
5273
|
+
"immutable": true,
|
|
5274
|
+
"locationInModule": {
|
|
5275
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5276
|
+
"line": 218
|
|
5277
|
+
},
|
|
5278
|
+
"name": "package",
|
|
5279
|
+
"optional": true,
|
|
5280
|
+
"type": {
|
|
5281
|
+
"primitive": "boolean"
|
|
5282
|
+
}
|
|
5283
|
+
},
|
|
5284
|
+
{
|
|
5285
|
+
"abstract": true,
|
|
5286
|
+
"docs": {
|
|
5287
|
+
"default": "NodePackageManager.YARN_CLASSIC",
|
|
5288
|
+
"stability": "experimental",
|
|
5289
|
+
"summary": "The Node Package Manager used to execute scripts."
|
|
5290
|
+
},
|
|
5291
|
+
"immutable": true,
|
|
5292
|
+
"locationInModule": {
|
|
5293
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5294
|
+
"line": 672
|
|
5295
|
+
},
|
|
5296
|
+
"name": "packageManager",
|
|
5297
|
+
"optional": true,
|
|
5298
|
+
"type": {
|
|
5299
|
+
"fqn": "projen.javascript.NodePackageManager"
|
|
5300
|
+
}
|
|
5301
|
+
},
|
|
5302
|
+
{
|
|
5303
|
+
"abstract": true,
|
|
5304
|
+
"docs": {
|
|
5305
|
+
"custom": {
|
|
5306
|
+
"featured": "true"
|
|
5307
|
+
},
|
|
5308
|
+
"default": "- defaults to project name",
|
|
5309
|
+
"stability": "experimental",
|
|
5310
|
+
"summary": "The \"name\" in package.json."
|
|
5311
|
+
},
|
|
5312
|
+
"immutable": true,
|
|
5313
|
+
"locationInModule": {
|
|
5314
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5315
|
+
"line": 666
|
|
5316
|
+
},
|
|
5317
|
+
"name": "packageName",
|
|
5318
|
+
"optional": true,
|
|
5319
|
+
"type": {
|
|
5320
|
+
"primitive": "string"
|
|
5321
|
+
}
|
|
5322
|
+
},
|
|
5323
|
+
{
|
|
5324
|
+
"abstract": true,
|
|
5325
|
+
"docs": {
|
|
5326
|
+
"stability": "experimental",
|
|
5327
|
+
"summary": "The parent project, if this project is part of a bigger project."
|
|
5328
|
+
},
|
|
5329
|
+
"immutable": true,
|
|
5330
|
+
"locationInModule": {
|
|
5331
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5332
|
+
"line": 1044
|
|
5333
|
+
},
|
|
5334
|
+
"name": "parent",
|
|
5335
|
+
"optional": true,
|
|
5336
|
+
"type": {
|
|
5337
|
+
"fqn": "projen.Project"
|
|
5338
|
+
}
|
|
5339
|
+
},
|
|
5340
|
+
{
|
|
5341
|
+
"abstract": true,
|
|
5342
|
+
"docs": {
|
|
5343
|
+
"stability": "experimental",
|
|
5344
|
+
"summary": "Options for `peerDeps`."
|
|
5345
|
+
},
|
|
5346
|
+
"immutable": true,
|
|
5347
|
+
"locationInModule": {
|
|
5348
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5349
|
+
"line": 659
|
|
5350
|
+
},
|
|
5351
|
+
"name": "peerDependencyOptions",
|
|
5352
|
+
"optional": true,
|
|
5353
|
+
"type": {
|
|
5354
|
+
"fqn": "projen.javascript.PeerDependencyOptions"
|
|
5355
|
+
}
|
|
5356
|
+
},
|
|
5357
|
+
{
|
|
5358
|
+
"abstract": true,
|
|
5359
|
+
"docs": {
|
|
5360
|
+
"default": "[]",
|
|
5361
|
+
"remarks": "Dependencies listed here are required to\nbe installed (and satisfied) by the _consumer_ of this library. Using peer\ndependencies allows you to ensure that only a single module of a certain\nlibrary exists in the `node_modules` tree of your consumers.\n\nNote that prior to npm@7, peer dependencies are _not_ automatically\ninstalled, which means that adding peer dependencies to a library will be a\nbreaking change for your customers.\n\nUnless `peerDependencyOptions.pinnedDevDependency` is disabled (it is\nenabled by default), projen will automatically add a dev dependency with a\npinned version for each peer dependency. This will ensure that you build &\ntest your module against the lowest peer version required.",
|
|
5362
|
+
"stability": "experimental",
|
|
5363
|
+
"summary": "Peer dependencies for this module."
|
|
5364
|
+
},
|
|
5365
|
+
"immutable": true,
|
|
5366
|
+
"locationInModule": {
|
|
5367
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5368
|
+
"line": 654
|
|
5369
|
+
},
|
|
5370
|
+
"name": "peerDeps",
|
|
5371
|
+
"optional": true,
|
|
5372
|
+
"type": {
|
|
5373
|
+
"collection": {
|
|
5374
|
+
"elementtype": {
|
|
5375
|
+
"primitive": "string"
|
|
5376
|
+
},
|
|
5377
|
+
"kind": "array"
|
|
5378
|
+
}
|
|
5379
|
+
}
|
|
5380
|
+
},
|
|
5381
|
+
{
|
|
5382
|
+
"abstract": true,
|
|
5383
|
+
"docs": {
|
|
5384
|
+
"default": "\"9\"",
|
|
5385
|
+
"stability": "experimental",
|
|
5386
|
+
"summary": "The version of PNPM to use if using PNPM as a package manager."
|
|
5387
|
+
},
|
|
5388
|
+
"immutable": true,
|
|
5389
|
+
"locationInModule": {
|
|
5390
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5391
|
+
"line": 635
|
|
5392
|
+
},
|
|
5393
|
+
"name": "pnpmVersion",
|
|
5394
|
+
"optional": true,
|
|
5395
|
+
"type": {
|
|
5396
|
+
"primitive": "string"
|
|
5397
|
+
}
|
|
5398
|
+
},
|
|
5399
|
+
{
|
|
5400
|
+
"abstract": true,
|
|
5401
|
+
"docs": {
|
|
5402
|
+
"default": "[]",
|
|
5403
|
+
"stability": "experimental",
|
|
5404
|
+
"summary": "Steps to execute after build as part of the release workflow."
|
|
5405
|
+
},
|
|
5406
|
+
"immutable": true,
|
|
5407
|
+
"locationInModule": {
|
|
5408
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5409
|
+
"line": 528
|
|
5410
|
+
},
|
|
5411
|
+
"name": "postBuildSteps",
|
|
5412
|
+
"optional": true,
|
|
5413
|
+
"type": {
|
|
5414
|
+
"collection": {
|
|
5415
|
+
"elementtype": {
|
|
5416
|
+
"fqn": "projen.github.workflows.JobStep"
|
|
5417
|
+
},
|
|
5418
|
+
"kind": "array"
|
|
5419
|
+
}
|
|
5420
|
+
}
|
|
5421
|
+
},
|
|
5422
|
+
{
|
|
5423
|
+
"abstract": true,
|
|
5424
|
+
"docs": {
|
|
5425
|
+
"default": "- normal semantic versions",
|
|
5426
|
+
"stability": "experimental",
|
|
5427
|
+
"summary": "Bump versions from the default branch as pre-releases (e.g. \"beta\", \"alpha\", \"pre\")."
|
|
5428
|
+
},
|
|
5429
|
+
"immutable": true,
|
|
5430
|
+
"locationInModule": {
|
|
5431
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5432
|
+
"line": 522
|
|
5433
|
+
},
|
|
5434
|
+
"name": "prerelease",
|
|
5435
|
+
"optional": true,
|
|
5436
|
+
"type": {
|
|
5437
|
+
"primitive": "string"
|
|
5438
|
+
}
|
|
5439
|
+
},
|
|
5440
|
+
{
|
|
5441
|
+
"abstract": true,
|
|
5442
|
+
"docs": {
|
|
5443
|
+
"default": "false",
|
|
5444
|
+
"stability": "experimental",
|
|
5445
|
+
"summary": "Setup prettier."
|
|
5446
|
+
},
|
|
5447
|
+
"immutable": true,
|
|
5448
|
+
"locationInModule": {
|
|
5449
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5450
|
+
"line": 212
|
|
5451
|
+
},
|
|
5452
|
+
"name": "prettier",
|
|
5453
|
+
"optional": true,
|
|
5454
|
+
"type": {
|
|
5455
|
+
"primitive": "boolean"
|
|
5456
|
+
}
|
|
5457
|
+
},
|
|
5458
|
+
{
|
|
5459
|
+
"abstract": true,
|
|
5460
|
+
"docs": {
|
|
5461
|
+
"default": "- default options",
|
|
5462
|
+
"stability": "experimental",
|
|
5463
|
+
"summary": "Prettier options."
|
|
5464
|
+
},
|
|
5465
|
+
"immutable": true,
|
|
5466
|
+
"locationInModule": {
|
|
5467
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5468
|
+
"line": 206
|
|
5469
|
+
},
|
|
5470
|
+
"name": "prettierOptions",
|
|
5471
|
+
"optional": true,
|
|
5472
|
+
"type": {
|
|
5473
|
+
"fqn": "projen.javascript.PrettierOptions"
|
|
5474
|
+
}
|
|
5475
|
+
},
|
|
5476
|
+
{
|
|
5477
|
+
"abstract": true,
|
|
5478
|
+
"docs": {
|
|
5479
|
+
"default": "ProjectType.UNKNOWN",
|
|
5480
|
+
"deprecated": "no longer supported at the base project level",
|
|
5481
|
+
"stability": "deprecated",
|
|
5482
|
+
"summary": "Which type of project this is (library/app)."
|
|
5483
|
+
},
|
|
5484
|
+
"immutable": true,
|
|
5485
|
+
"locationInModule": {
|
|
5486
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5487
|
+
"line": 941
|
|
5488
|
+
},
|
|
5489
|
+
"name": "projectType",
|
|
5490
|
+
"optional": true,
|
|
5491
|
+
"type": {
|
|
5492
|
+
"fqn": "projen.ProjectType"
|
|
5493
|
+
}
|
|
5494
|
+
},
|
|
5495
|
+
{
|
|
5496
|
+
"abstract": true,
|
|
5497
|
+
"docs": {
|
|
5498
|
+
"default": "\"npx projen\"",
|
|
5499
|
+
"remarks": "Can be used to customize in special environments.",
|
|
5500
|
+
"stability": "experimental",
|
|
5501
|
+
"summary": "The shell command to use in order to run the projen CLI."
|
|
5502
|
+
},
|
|
5503
|
+
"immutable": true,
|
|
5504
|
+
"locationInModule": {
|
|
5505
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5506
|
+
"line": 1039
|
|
5507
|
+
},
|
|
5508
|
+
"name": "projenCommand",
|
|
5509
|
+
"optional": true,
|
|
5510
|
+
"type": {
|
|
5511
|
+
"primitive": "string"
|
|
5512
|
+
}
|
|
5513
|
+
},
|
|
5514
|
+
{
|
|
5515
|
+
"abstract": true,
|
|
5516
|
+
"docs": {
|
|
5517
|
+
"default": "- use a personal access token named PROJEN_GITHUB_TOKEN",
|
|
5518
|
+
"stability": "experimental",
|
|
5519
|
+
"summary": "Choose a method of providing GitHub API access for projen workflows."
|
|
5520
|
+
},
|
|
5521
|
+
"immutable": true,
|
|
5522
|
+
"locationInModule": {
|
|
5523
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5524
|
+
"line": 934
|
|
5525
|
+
},
|
|
5526
|
+
"name": "projenCredentials",
|
|
5527
|
+
"optional": true,
|
|
5528
|
+
"type": {
|
|
5529
|
+
"fqn": "projen.github.GithubCredentials"
|
|
5530
|
+
}
|
|
5531
|
+
},
|
|
5532
|
+
{
|
|
5533
|
+
"abstract": true,
|
|
5534
|
+
"docs": {
|
|
5535
|
+
"default": "- true if not a subproject",
|
|
5536
|
+
"stability": "experimental",
|
|
5537
|
+
"summary": "Indicates of \"projen\" should be installed as a devDependency."
|
|
5538
|
+
},
|
|
5539
|
+
"immutable": true,
|
|
5540
|
+
"locationInModule": {
|
|
5541
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5542
|
+
"line": 200
|
|
5543
|
+
},
|
|
5544
|
+
"name": "projenDevDependency",
|
|
5545
|
+
"optional": true,
|
|
5546
|
+
"type": {
|
|
5547
|
+
"primitive": "boolean"
|
|
5548
|
+
}
|
|
5549
|
+
},
|
|
5550
|
+
{
|
|
5551
|
+
"abstract": true,
|
|
5552
|
+
"docs": {
|
|
5553
|
+
"default": "- true if projenrcJson is false",
|
|
5554
|
+
"stability": "experimental",
|
|
5555
|
+
"summary": "Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation."
|
|
5556
|
+
},
|
|
5557
|
+
"immutable": true,
|
|
5558
|
+
"locationInModule": {
|
|
5559
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5560
|
+
"line": 194
|
|
5561
|
+
},
|
|
5562
|
+
"name": "projenrcJs",
|
|
5563
|
+
"optional": true,
|
|
5564
|
+
"type": {
|
|
5565
|
+
"primitive": "boolean"
|
|
5566
|
+
}
|
|
5567
|
+
},
|
|
5568
|
+
{
|
|
5569
|
+
"abstract": true,
|
|
5570
|
+
"docs": {
|
|
5571
|
+
"default": "false",
|
|
5572
|
+
"stability": "experimental",
|
|
5573
|
+
"summary": "Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation."
|
|
5574
|
+
},
|
|
5575
|
+
"immutable": true,
|
|
5576
|
+
"locationInModule": {
|
|
5577
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5578
|
+
"line": 1032
|
|
5579
|
+
},
|
|
5580
|
+
"name": "projenrcJson",
|
|
5581
|
+
"optional": true,
|
|
5582
|
+
"type": {
|
|
5583
|
+
"primitive": "boolean"
|
|
5584
|
+
}
|
|
5585
|
+
},
|
|
5586
|
+
{
|
|
5587
|
+
"abstract": true,
|
|
5588
|
+
"docs": {
|
|
5589
|
+
"default": "- default options",
|
|
5590
|
+
"stability": "experimental",
|
|
5591
|
+
"summary": "Options for .projenrc.json."
|
|
5592
|
+
},
|
|
5593
|
+
"immutable": true,
|
|
5594
|
+
"locationInModule": {
|
|
5595
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5596
|
+
"line": 1026
|
|
5597
|
+
},
|
|
5598
|
+
"name": "projenrcJsonOptions",
|
|
5599
|
+
"optional": true,
|
|
5600
|
+
"type": {
|
|
5601
|
+
"fqn": "projen.ProjenrcJsonOptions"
|
|
5602
|
+
}
|
|
5603
|
+
},
|
|
5604
|
+
{
|
|
5605
|
+
"abstract": true,
|
|
5606
|
+
"docs": {
|
|
5607
|
+
"default": "- default options",
|
|
5608
|
+
"stability": "experimental",
|
|
5609
|
+
"summary": "Options for .projenrc.js."
|
|
5610
|
+
},
|
|
5611
|
+
"immutable": true,
|
|
5612
|
+
"locationInModule": {
|
|
5613
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5614
|
+
"line": 188
|
|
5615
|
+
},
|
|
5616
|
+
"name": "projenrcJsOptions",
|
|
5617
|
+
"optional": true,
|
|
5618
|
+
"type": {
|
|
5619
|
+
"fqn": "projen.javascript.ProjenrcOptions"
|
|
5620
|
+
}
|
|
5621
|
+
},
|
|
5622
|
+
{
|
|
5623
|
+
"abstract": true,
|
|
5624
|
+
"docs": {
|
|
5625
|
+
"custom": {
|
|
5626
|
+
"pjnew": "true"
|
|
5627
|
+
},
|
|
5628
|
+
"default": "false",
|
|
5629
|
+
"stability": "experimental",
|
|
5630
|
+
"summary": "Use TypeScript for your projenrc file (`.projenrc.ts`)."
|
|
5631
|
+
},
|
|
5632
|
+
"immutable": true,
|
|
5633
|
+
"locationInModule": {
|
|
5634
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5635
|
+
"line": 72
|
|
5636
|
+
},
|
|
5637
|
+
"name": "projenrcTs",
|
|
5638
|
+
"optional": true,
|
|
5639
|
+
"type": {
|
|
5640
|
+
"primitive": "boolean"
|
|
5641
|
+
}
|
|
5642
|
+
},
|
|
5643
|
+
{
|
|
5644
|
+
"abstract": true,
|
|
5645
|
+
"docs": {
|
|
5646
|
+
"stability": "experimental",
|
|
5647
|
+
"summary": "Options for .projenrc.ts."
|
|
5648
|
+
},
|
|
5649
|
+
"immutable": true,
|
|
5650
|
+
"locationInModule": {
|
|
5651
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5652
|
+
"line": 65
|
|
5653
|
+
},
|
|
5654
|
+
"name": "projenrcTsOptions",
|
|
5655
|
+
"optional": true,
|
|
5656
|
+
"type": {
|
|
5657
|
+
"fqn": "projen.typescript.ProjenrcOptions"
|
|
5658
|
+
}
|
|
5659
|
+
},
|
|
5660
|
+
{
|
|
5661
|
+
"abstract": true,
|
|
5662
|
+
"docs": {
|
|
5663
|
+
"default": "\"PROJEN_GITHUB_TOKEN\"",
|
|
5664
|
+
"deprecated": "use `projenCredentials`",
|
|
5665
|
+
"remarks": "This token needs to have the `repo`, `workflows`\nand `packages` scope.",
|
|
5666
|
+
"stability": "deprecated",
|
|
5667
|
+
"summary": "The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows."
|
|
5668
|
+
},
|
|
5669
|
+
"immutable": true,
|
|
5670
|
+
"locationInModule": {
|
|
5671
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5672
|
+
"line": 928
|
|
5673
|
+
},
|
|
5674
|
+
"name": "projenTokenSecret",
|
|
5675
|
+
"optional": true,
|
|
5676
|
+
"type": {
|
|
5677
|
+
"primitive": "string"
|
|
5678
|
+
}
|
|
5679
|
+
},
|
|
5680
|
+
{
|
|
5681
|
+
"abstract": true,
|
|
5682
|
+
"docs": {
|
|
5683
|
+
"default": "- Defaults to the latest version.",
|
|
5684
|
+
"stability": "experimental",
|
|
5685
|
+
"summary": "Version of projen to install."
|
|
5686
|
+
},
|
|
5687
|
+
"immutable": true,
|
|
5688
|
+
"locationInModule": {
|
|
5689
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5690
|
+
"line": 182
|
|
5691
|
+
},
|
|
5692
|
+
"name": "projenVersion",
|
|
5693
|
+
"optional": true,
|
|
5694
|
+
"type": {
|
|
5695
|
+
"primitive": "string"
|
|
5696
|
+
}
|
|
5697
|
+
},
|
|
5698
|
+
{
|
|
5699
|
+
"abstract": true,
|
|
5700
|
+
"docs": {
|
|
5701
|
+
"default": "false",
|
|
5702
|
+
"stability": "experimental",
|
|
5703
|
+
"summary": "Instead of actually publishing to package managers, just print the publishing command."
|
|
5704
|
+
},
|
|
5705
|
+
"immutable": true,
|
|
5706
|
+
"locationInModule": {
|
|
5707
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5708
|
+
"line": 516
|
|
5709
|
+
},
|
|
5710
|
+
"name": "publishDryRun",
|
|
5711
|
+
"optional": true,
|
|
5712
|
+
"type": {
|
|
5713
|
+
"primitive": "boolean"
|
|
5714
|
+
}
|
|
5715
|
+
},
|
|
5716
|
+
{
|
|
5717
|
+
"abstract": true,
|
|
5718
|
+
"docs": {
|
|
5719
|
+
"default": "false",
|
|
5720
|
+
"remarks": "Normally, publishing only happens within automated workflows. Enable this\nin order to create a publishing task for each publishing activity.",
|
|
5721
|
+
"stability": "experimental",
|
|
5722
|
+
"summary": "Define publishing tasks that can be executed manually as well as workflows."
|
|
5723
|
+
},
|
|
5724
|
+
"immutable": true,
|
|
5725
|
+
"locationInModule": {
|
|
5726
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5727
|
+
"line": 510
|
|
5728
|
+
},
|
|
5729
|
+
"name": "publishTasks",
|
|
5730
|
+
"optional": true,
|
|
5731
|
+
"type": {
|
|
5732
|
+
"primitive": "boolean"
|
|
5733
|
+
}
|
|
5734
|
+
},
|
|
5735
|
+
{
|
|
5736
|
+
"abstract": true,
|
|
5737
|
+
"docs": {
|
|
5738
|
+
"default": "true",
|
|
5739
|
+
"stability": "experimental",
|
|
5740
|
+
"summary": "Include a GitHub pull request template."
|
|
5741
|
+
},
|
|
5742
|
+
"immutable": true,
|
|
5743
|
+
"locationInModule": {
|
|
5744
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5745
|
+
"line": 176
|
|
5746
|
+
},
|
|
5747
|
+
"name": "pullRequestTemplate",
|
|
5748
|
+
"optional": true,
|
|
5749
|
+
"type": {
|
|
5750
|
+
"primitive": "boolean"
|
|
5751
|
+
}
|
|
5752
|
+
},
|
|
5753
|
+
{
|
|
5754
|
+
"abstract": true,
|
|
5755
|
+
"docs": {
|
|
5756
|
+
"default": "- default content",
|
|
5757
|
+
"stability": "experimental",
|
|
5758
|
+
"summary": "The contents of the pull request template."
|
|
5759
|
+
},
|
|
5760
|
+
"immutable": true,
|
|
5761
|
+
"locationInModule": {
|
|
5762
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5763
|
+
"line": 170
|
|
5764
|
+
},
|
|
5765
|
+
"name": "pullRequestTemplateContents",
|
|
5766
|
+
"optional": true,
|
|
5767
|
+
"type": {
|
|
5768
|
+
"collection": {
|
|
5769
|
+
"elementtype": {
|
|
5770
|
+
"primitive": "string"
|
|
5771
|
+
},
|
|
5772
|
+
"kind": "array"
|
|
5773
|
+
}
|
|
5774
|
+
}
|
|
5775
|
+
},
|
|
5776
|
+
{
|
|
5777
|
+
"abstract": true,
|
|
5778
|
+
"docs": {
|
|
5779
|
+
"default": "- { filename: 'README.md', contents: '# replace this' }",
|
|
5780
|
+
"stability": "experimental",
|
|
5781
|
+
"summary": "The README setup."
|
|
5782
|
+
},
|
|
5783
|
+
"immutable": true,
|
|
5784
|
+
"locationInModule": {
|
|
5785
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5786
|
+
"line": 919
|
|
5787
|
+
},
|
|
5788
|
+
"name": "readme",
|
|
5789
|
+
"optional": true,
|
|
5790
|
+
"type": {
|
|
5791
|
+
"fqn": "projen.SampleReadmeProps"
|
|
5792
|
+
}
|
|
5793
|
+
},
|
|
5794
|
+
{
|
|
5795
|
+
"abstract": true,
|
|
5796
|
+
"docs": {
|
|
5797
|
+
"default": "ReleasableCommits.everyCommit()",
|
|
5798
|
+
"stability": "experimental",
|
|
5799
|
+
"summary": "Find commits that should be considered releasable Used to decide if a release is required."
|
|
5800
|
+
},
|
|
5801
|
+
"immutable": true,
|
|
5802
|
+
"locationInModule": {
|
|
5803
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5804
|
+
"line": 502
|
|
5805
|
+
},
|
|
5806
|
+
"name": "releasableCommits",
|
|
5807
|
+
"optional": true,
|
|
5808
|
+
"type": {
|
|
5809
|
+
"fqn": "projen.ReleasableCommits"
|
|
5810
|
+
}
|
|
5811
|
+
},
|
|
5812
|
+
{
|
|
5813
|
+
"abstract": true,
|
|
5814
|
+
"docs": {
|
|
5815
|
+
"default": "- true (false for subprojects)",
|
|
5816
|
+
"stability": "experimental",
|
|
5817
|
+
"summary": "Add release management to this project."
|
|
5818
|
+
},
|
|
5819
|
+
"immutable": true,
|
|
5820
|
+
"locationInModule": {
|
|
5821
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5822
|
+
"line": 164
|
|
5823
|
+
},
|
|
5824
|
+
"name": "release",
|
|
5825
|
+
"optional": true,
|
|
5826
|
+
"type": {
|
|
5827
|
+
"primitive": "boolean"
|
|
5828
|
+
}
|
|
5829
|
+
},
|
|
5830
|
+
{
|
|
5831
|
+
"abstract": true,
|
|
5832
|
+
"docs": {
|
|
5833
|
+
"default": "- no additional branches are used for release. you can use\n`addBranch()` to add additional branches.",
|
|
5834
|
+
"remarks": "A workflow will be created for each\nrelease branch which will publish releases from commits in this branch.\nEach release branch _must_ be assigned a major version number which is used\nto enforce that versions published from that branch always use that major\nversion. If multiple branches are used, the `majorVersion` field must also\nbe provided for the default branch.",
|
|
5835
|
+
"stability": "experimental",
|
|
5836
|
+
"summary": "Defines additional release branches."
|
|
5837
|
+
},
|
|
5838
|
+
"immutable": true,
|
|
5839
|
+
"locationInModule": {
|
|
5840
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5841
|
+
"line": 496
|
|
5842
|
+
},
|
|
5843
|
+
"name": "releaseBranches",
|
|
5844
|
+
"optional": true,
|
|
5845
|
+
"type": {
|
|
5846
|
+
"collection": {
|
|
5847
|
+
"elementtype": {
|
|
5848
|
+
"fqn": "projen.release.BranchOptions"
|
|
5849
|
+
},
|
|
5850
|
+
"kind": "map"
|
|
5851
|
+
}
|
|
5852
|
+
}
|
|
5853
|
+
},
|
|
5854
|
+
{
|
|
5855
|
+
"abstract": true,
|
|
5856
|
+
"docs": {
|
|
5857
|
+
"default": "- no environment used, unless set at the artifact level",
|
|
5858
|
+
"remarks": "This can be used to add an explicit approval step to the release\nor limit who can initiate a release through environment protection rules.\n\nWhen multiple artifacts are released, the environment can be overwritten\non a per artifact basis.",
|
|
5859
|
+
"stability": "experimental",
|
|
5860
|
+
"summary": "The GitHub Actions environment used for the release."
|
|
5861
|
+
},
|
|
5862
|
+
"immutable": true,
|
|
5863
|
+
"locationInModule": {
|
|
5864
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5865
|
+
"line": 483
|
|
5866
|
+
},
|
|
5867
|
+
"name": "releaseEnvironment",
|
|
5868
|
+
"optional": true,
|
|
5869
|
+
"type": {
|
|
5870
|
+
"primitive": "string"
|
|
5871
|
+
}
|
|
5872
|
+
},
|
|
5873
|
+
{
|
|
5874
|
+
"abstract": true,
|
|
5875
|
+
"docs": {
|
|
5876
|
+
"default": "true",
|
|
5877
|
+
"deprecated": "Use `releaseTrigger: ReleaseTrigger.continuous()` instead",
|
|
5878
|
+
"stability": "deprecated",
|
|
5879
|
+
"summary": "Automatically release new versions every commit to one of branches in `releaseBranches`."
|
|
5880
|
+
},
|
|
5881
|
+
"immutable": true,
|
|
5882
|
+
"locationInModule": {
|
|
5883
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5884
|
+
"line": 472
|
|
5885
|
+
},
|
|
5886
|
+
"name": "releaseEveryCommit",
|
|
5887
|
+
"optional": true,
|
|
5888
|
+
"type": {
|
|
5889
|
+
"primitive": "boolean"
|
|
5890
|
+
}
|
|
5891
|
+
},
|
|
5892
|
+
{
|
|
5893
|
+
"abstract": true,
|
|
5894
|
+
"docs": {
|
|
5895
|
+
"default": "false",
|
|
5896
|
+
"stability": "experimental",
|
|
5897
|
+
"summary": "Create a github issue on every failed publishing task."
|
|
5898
|
+
},
|
|
5899
|
+
"immutable": true,
|
|
5900
|
+
"locationInModule": {
|
|
5901
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5902
|
+
"line": 465
|
|
5903
|
+
},
|
|
5904
|
+
"name": "releaseFailureIssue",
|
|
5905
|
+
"optional": true,
|
|
5906
|
+
"type": {
|
|
5907
|
+
"primitive": "boolean"
|
|
5908
|
+
}
|
|
5909
|
+
},
|
|
5910
|
+
{
|
|
5911
|
+
"abstract": true,
|
|
5912
|
+
"docs": {
|
|
5913
|
+
"default": "\"failed-release\"",
|
|
5914
|
+
"remarks": "Only applies if `releaseFailureIssue` is true.",
|
|
5915
|
+
"stability": "experimental",
|
|
5916
|
+
"summary": "The label to apply to issues indicating publish failures."
|
|
5917
|
+
},
|
|
5918
|
+
"immutable": true,
|
|
5919
|
+
"locationInModule": {
|
|
5920
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5921
|
+
"line": 459
|
|
5922
|
+
},
|
|
5923
|
+
"name": "releaseFailureIssueLabel",
|
|
5924
|
+
"optional": true,
|
|
5925
|
+
"type": {
|
|
5926
|
+
"primitive": "string"
|
|
5927
|
+
}
|
|
5928
|
+
},
|
|
5929
|
+
{
|
|
5930
|
+
"abstract": true,
|
|
5931
|
+
"docs": {
|
|
5932
|
+
"default": "- no scheduled releases",
|
|
5933
|
+
"deprecated": "Use `releaseTrigger: ReleaseTrigger.scheduled()` instead",
|
|
5934
|
+
"stability": "deprecated",
|
|
5935
|
+
"summary": "CRON schedule to trigger new releases."
|
|
5936
|
+
},
|
|
5937
|
+
"immutable": true,
|
|
5938
|
+
"locationInModule": {
|
|
5939
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5940
|
+
"line": 452
|
|
5941
|
+
},
|
|
5942
|
+
"name": "releaseSchedule",
|
|
5943
|
+
"optional": true,
|
|
5944
|
+
"type": {
|
|
5945
|
+
"primitive": "string"
|
|
5946
|
+
}
|
|
5947
|
+
},
|
|
5948
|
+
{
|
|
5949
|
+
"abstract": true,
|
|
5950
|
+
"docs": {
|
|
5951
|
+
"default": "\"v\"",
|
|
5952
|
+
"remarks": "Useful if you are releasing on multiple branches with overlapping version numbers.\nNote: this prefix is used to detect the latest tagged version\nwhen bumping, so if you change this on a project with an existing version\nhistory, you may need to manually tag your latest release\nwith the new prefix.",
|
|
5953
|
+
"stability": "experimental",
|
|
5954
|
+
"summary": "Automatically add the given prefix to release tags."
|
|
5955
|
+
},
|
|
5956
|
+
"immutable": true,
|
|
5957
|
+
"locationInModule": {
|
|
5958
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5959
|
+
"line": 445
|
|
5960
|
+
},
|
|
5961
|
+
"name": "releaseTagPrefix",
|
|
5962
|
+
"optional": true,
|
|
5963
|
+
"type": {
|
|
5964
|
+
"primitive": "string"
|
|
5965
|
+
}
|
|
5966
|
+
},
|
|
5967
|
+
{
|
|
5968
|
+
"abstract": true,
|
|
5969
|
+
"docs": {
|
|
5970
|
+
"default": "false",
|
|
5971
|
+
"stability": "experimental",
|
|
5972
|
+
"summary": "Automatically release to npm when new versions are introduced."
|
|
5973
|
+
},
|
|
5974
|
+
"immutable": true,
|
|
5975
|
+
"locationInModule": {
|
|
5976
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5977
|
+
"line": 158
|
|
5978
|
+
},
|
|
5979
|
+
"name": "releaseToNpm",
|
|
5980
|
+
"optional": true,
|
|
5981
|
+
"type": {
|
|
5982
|
+
"primitive": "boolean"
|
|
5983
|
+
}
|
|
5984
|
+
},
|
|
5985
|
+
{
|
|
5986
|
+
"abstract": true,
|
|
5987
|
+
"docs": {
|
|
5988
|
+
"default": "- Continuous releases (`ReleaseTrigger.continuous()`)",
|
|
5989
|
+
"stability": "experimental",
|
|
5990
|
+
"summary": "The release trigger to use."
|
|
5991
|
+
},
|
|
5992
|
+
"immutable": true,
|
|
5993
|
+
"locationInModule": {
|
|
5994
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
5995
|
+
"line": 435
|
|
5996
|
+
},
|
|
5997
|
+
"name": "releaseTrigger",
|
|
5998
|
+
"optional": true,
|
|
5999
|
+
"type": {
|
|
6000
|
+
"fqn": "projen.release.ReleaseTrigger"
|
|
6001
|
+
}
|
|
6002
|
+
},
|
|
6003
|
+
{
|
|
6004
|
+
"abstract": true,
|
|
6005
|
+
"docs": {
|
|
6006
|
+
"default": "- true if not a subproject",
|
|
6007
|
+
"deprecated": "see `release`.",
|
|
6008
|
+
"stability": "deprecated",
|
|
6009
|
+
"summary": "DEPRECATED: renamed to `release`."
|
|
6010
|
+
},
|
|
6011
|
+
"immutable": true,
|
|
6012
|
+
"locationInModule": {
|
|
6013
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6014
|
+
"line": 152
|
|
6015
|
+
},
|
|
6016
|
+
"name": "releaseWorkflow",
|
|
6017
|
+
"optional": true,
|
|
6018
|
+
"type": {
|
|
6019
|
+
"primitive": "boolean"
|
|
6020
|
+
}
|
|
6021
|
+
},
|
|
6022
|
+
{
|
|
6023
|
+
"abstract": true,
|
|
6024
|
+
"docs": {
|
|
6025
|
+
"default": "{}",
|
|
6026
|
+
"stability": "experimental",
|
|
6027
|
+
"summary": "Build environment variables for release workflows."
|
|
6028
|
+
},
|
|
6029
|
+
"immutable": true,
|
|
6030
|
+
"locationInModule": {
|
|
6031
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6032
|
+
"line": 429
|
|
6033
|
+
},
|
|
6034
|
+
"name": "releaseWorkflowEnv",
|
|
6035
|
+
"optional": true,
|
|
6036
|
+
"type": {
|
|
6037
|
+
"collection": {
|
|
6038
|
+
"elementtype": {
|
|
6039
|
+
"primitive": "string"
|
|
6040
|
+
},
|
|
6041
|
+
"kind": "map"
|
|
6042
|
+
}
|
|
6043
|
+
}
|
|
6044
|
+
},
|
|
6045
|
+
{
|
|
6046
|
+
"abstract": true,
|
|
6047
|
+
"docs": {
|
|
6048
|
+
"default": "\"release\"",
|
|
6049
|
+
"stability": "experimental",
|
|
6050
|
+
"summary": "The name of the default release workflow."
|
|
6051
|
+
},
|
|
6052
|
+
"immutable": true,
|
|
6053
|
+
"locationInModule": {
|
|
6054
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6055
|
+
"line": 423
|
|
6056
|
+
},
|
|
6057
|
+
"name": "releaseWorkflowName",
|
|
6058
|
+
"optional": true,
|
|
6059
|
+
"type": {
|
|
6060
|
+
"primitive": "string"
|
|
6061
|
+
}
|
|
6062
|
+
},
|
|
6063
|
+
{
|
|
6064
|
+
"abstract": true,
|
|
6065
|
+
"docs": {
|
|
6066
|
+
"stability": "experimental",
|
|
6067
|
+
"summary": "A set of workflow steps to execute in order to setup the workflow container."
|
|
6068
|
+
},
|
|
6069
|
+
"immutable": true,
|
|
6070
|
+
"locationInModule": {
|
|
6071
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6072
|
+
"line": 417
|
|
6073
|
+
},
|
|
6074
|
+
"name": "releaseWorkflowSetupSteps",
|
|
6075
|
+
"optional": true,
|
|
6076
|
+
"type": {
|
|
6077
|
+
"collection": {
|
|
6078
|
+
"elementtype": {
|
|
6079
|
+
"fqn": "projen.github.workflows.JobStep"
|
|
6080
|
+
},
|
|
6081
|
+
"kind": "array"
|
|
6082
|
+
}
|
|
6083
|
+
}
|
|
6084
|
+
},
|
|
6085
|
+
{
|
|
6086
|
+
"abstract": true,
|
|
6087
|
+
"docs": {
|
|
6088
|
+
"default": "false",
|
|
6089
|
+
"stability": "experimental",
|
|
6090
|
+
"summary": "Use renovatebot to handle dependency upgrades."
|
|
6091
|
+
},
|
|
6092
|
+
"immutable": true,
|
|
6093
|
+
"locationInModule": {
|
|
6094
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6095
|
+
"line": 1020
|
|
6096
|
+
},
|
|
6097
|
+
"name": "renovatebot",
|
|
6098
|
+
"optional": true,
|
|
6099
|
+
"type": {
|
|
6100
|
+
"primitive": "boolean"
|
|
6101
|
+
}
|
|
6102
|
+
},
|
|
6103
|
+
{
|
|
6104
|
+
"abstract": true,
|
|
6105
|
+
"docs": {
|
|
6106
|
+
"default": "- default options",
|
|
6107
|
+
"stability": "experimental",
|
|
6108
|
+
"summary": "Options for renovatebot."
|
|
6109
|
+
},
|
|
6110
|
+
"immutable": true,
|
|
6111
|
+
"locationInModule": {
|
|
6112
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6113
|
+
"line": 1014
|
|
6114
|
+
},
|
|
6115
|
+
"name": "renovatebotOptions",
|
|
6116
|
+
"optional": true,
|
|
6117
|
+
"type": {
|
|
6118
|
+
"fqn": "projen.RenovatebotOptions"
|
|
6119
|
+
}
|
|
6120
|
+
},
|
|
6121
|
+
{
|
|
6122
|
+
"abstract": true,
|
|
6123
|
+
"docs": {
|
|
6124
|
+
"remarks": "See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository",
|
|
6125
|
+
"stability": "experimental",
|
|
6126
|
+
"summary": "The repository is the location where the actual code for your package lives."
|
|
6127
|
+
},
|
|
6128
|
+
"immutable": true,
|
|
6129
|
+
"locationInModule": {
|
|
6130
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6131
|
+
"line": 629
|
|
6132
|
+
},
|
|
6133
|
+
"name": "repository",
|
|
6134
|
+
"optional": true,
|
|
6135
|
+
"type": {
|
|
6136
|
+
"primitive": "string"
|
|
6137
|
+
}
|
|
6138
|
+
},
|
|
6139
|
+
{
|
|
6140
|
+
"abstract": true,
|
|
6141
|
+
"docs": {
|
|
6142
|
+
"stability": "experimental",
|
|
6143
|
+
"summary": "If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives."
|
|
6144
|
+
},
|
|
6145
|
+
"immutable": true,
|
|
6146
|
+
"locationInModule": {
|
|
6147
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6148
|
+
"line": 623
|
|
6149
|
+
},
|
|
6150
|
+
"name": "repositoryDirectory",
|
|
6151
|
+
"optional": true,
|
|
6152
|
+
"type": {
|
|
6153
|
+
"primitive": "string"
|
|
6154
|
+
}
|
|
6155
|
+
},
|
|
6156
|
+
{
|
|
6157
|
+
"abstract": true,
|
|
6158
|
+
"docs": {
|
|
6159
|
+
"default": "true",
|
|
6160
|
+
"stability": "experimental",
|
|
6161
|
+
"summary": "Generate one-time sample in `src/` and `test/` if there are no files there."
|
|
6162
|
+
},
|
|
6163
|
+
"immutable": true,
|
|
6164
|
+
"locationInModule": {
|
|
6165
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6166
|
+
"line": 60
|
|
6167
|
+
},
|
|
6168
|
+
"name": "sampleCode",
|
|
6169
|
+
"optional": true,
|
|
6170
|
+
"type": {
|
|
6171
|
+
"primitive": "boolean"
|
|
6172
|
+
}
|
|
6173
|
+
},
|
|
6174
|
+
{
|
|
6175
|
+
"abstract": true,
|
|
6176
|
+
"docs": {
|
|
6177
|
+
"default": "- fetch all scoped packages from the public npm registry",
|
|
6178
|
+
"stability": "experimental",
|
|
6179
|
+
"summary": "Options for privately hosted scoped packages."
|
|
6180
|
+
},
|
|
6181
|
+
"immutable": true,
|
|
6182
|
+
"locationInModule": {
|
|
6183
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6184
|
+
"line": 618
|
|
6185
|
+
},
|
|
6186
|
+
"name": "scopedPackagesOptions",
|
|
6187
|
+
"optional": true,
|
|
6188
|
+
"type": {
|
|
6189
|
+
"collection": {
|
|
6190
|
+
"elementtype": {
|
|
6191
|
+
"fqn": "projen.javascript.ScopedPackagesOptions"
|
|
6192
|
+
},
|
|
6193
|
+
"kind": "array"
|
|
6194
|
+
}
|
|
6195
|
+
}
|
|
6196
|
+
},
|
|
6197
|
+
{
|
|
6198
|
+
"abstract": true,
|
|
6199
|
+
"docs": {
|
|
6200
|
+
"default": "{}",
|
|
6201
|
+
"deprecated": "use `project.addTask()` or `package.setScript()`",
|
|
6202
|
+
"remarks": "If a script has the same name as a standard script,\nthe standard script will be overwritten.\nAlso adds the script as a task.",
|
|
6203
|
+
"stability": "deprecated",
|
|
6204
|
+
"summary": "npm scripts to include."
|
|
6205
|
+
},
|
|
6206
|
+
"immutable": true,
|
|
6207
|
+
"locationInModule": {
|
|
6208
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6209
|
+
"line": 612
|
|
6210
|
+
},
|
|
6211
|
+
"name": "scripts",
|
|
6212
|
+
"optional": true,
|
|
6213
|
+
"type": {
|
|
6214
|
+
"collection": {
|
|
6215
|
+
"elementtype": {
|
|
6216
|
+
"primitive": "string"
|
|
6217
|
+
},
|
|
6218
|
+
"kind": "map"
|
|
6219
|
+
}
|
|
6220
|
+
}
|
|
6221
|
+
},
|
|
6222
|
+
{
|
|
6223
|
+
"abstract": true,
|
|
6224
|
+
"docs": {
|
|
6225
|
+
"default": "\"src\"",
|
|
6226
|
+
"stability": "experimental",
|
|
6227
|
+
"summary": "Typescript sources directory."
|
|
6228
|
+
},
|
|
6229
|
+
"immutable": true,
|
|
6230
|
+
"locationInModule": {
|
|
6231
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6232
|
+
"line": 54
|
|
6233
|
+
},
|
|
6234
|
+
"name": "srcdir",
|
|
6235
|
+
"optional": true,
|
|
6236
|
+
"type": {
|
|
6237
|
+
"primitive": "string"
|
|
6238
|
+
}
|
|
6239
|
+
},
|
|
6240
|
+
{
|
|
6241
|
+
"abstract": true,
|
|
6242
|
+
"docs": {
|
|
6243
|
+
"stability": "experimental",
|
|
6244
|
+
"summary": "Package's Stability."
|
|
6245
|
+
},
|
|
6246
|
+
"immutable": true,
|
|
6247
|
+
"locationInModule": {
|
|
6248
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6249
|
+
"line": 602
|
|
6250
|
+
},
|
|
6251
|
+
"name": "stability",
|
|
6252
|
+
"optional": true,
|
|
6253
|
+
"type": {
|
|
6254
|
+
"primitive": "string"
|
|
6255
|
+
}
|
|
6256
|
+
},
|
|
6257
|
+
{
|
|
6258
|
+
"abstract": true,
|
|
6259
|
+
"docs": {
|
|
6260
|
+
"default": "false",
|
|
6261
|
+
"remarks": "See `staleOptions` for options.",
|
|
6262
|
+
"stability": "experimental",
|
|
6263
|
+
"summary": "Auto-close of stale issues and pull request."
|
|
6264
|
+
},
|
|
6265
|
+
"immutable": true,
|
|
6266
|
+
"locationInModule": {
|
|
6267
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6268
|
+
"line": 913
|
|
6269
|
+
},
|
|
6270
|
+
"name": "stale",
|
|
6271
|
+
"optional": true,
|
|
6272
|
+
"type": {
|
|
6273
|
+
"primitive": "boolean"
|
|
6274
|
+
}
|
|
6275
|
+
},
|
|
6276
|
+
{
|
|
6277
|
+
"abstract": true,
|
|
6278
|
+
"docs": {
|
|
6279
|
+
"default": "- see defaults in `StaleOptions`",
|
|
6280
|
+
"remarks": "To disable set `stale` to `false`.",
|
|
6281
|
+
"stability": "experimental",
|
|
6282
|
+
"summary": "Auto-close stale issues and pull requests."
|
|
6283
|
+
},
|
|
6284
|
+
"immutable": true,
|
|
6285
|
+
"locationInModule": {
|
|
6286
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6287
|
+
"line": 906
|
|
6288
|
+
},
|
|
6289
|
+
"name": "staleOptions",
|
|
6290
|
+
"optional": true,
|
|
6291
|
+
"type": {
|
|
6292
|
+
"fqn": "projen.github.StaleOptions"
|
|
6293
|
+
}
|
|
6294
|
+
},
|
|
6295
|
+
{
|
|
6296
|
+
"abstract": true,
|
|
6297
|
+
"docs": {
|
|
6298
|
+
"default": "\"test\"",
|
|
6299
|
+
"remarks": "Tests files should be named `xxx.test.ts`.\nIf this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`),\nthen tests are going to be compiled into `lib/` and executed as javascript.\nIf the test directory is outside of `src`, then we configure jest to\ncompile the code in-memory.",
|
|
6300
|
+
"stability": "experimental",
|
|
6301
|
+
"summary": "Jest tests directory."
|
|
6302
|
+
},
|
|
6303
|
+
"immutable": true,
|
|
6304
|
+
"locationInModule": {
|
|
6305
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6306
|
+
"line": 48
|
|
6307
|
+
},
|
|
6308
|
+
"name": "testdir",
|
|
6309
|
+
"optional": true,
|
|
6310
|
+
"type": {
|
|
6311
|
+
"primitive": "string"
|
|
6312
|
+
}
|
|
6313
|
+
},
|
|
6314
|
+
{
|
|
6315
|
+
"abstract": true,
|
|
6316
|
+
"docs": {
|
|
6317
|
+
"default": "- default options",
|
|
6318
|
+
"stability": "experimental",
|
|
6319
|
+
"summary": "Custom TSConfig."
|
|
6320
|
+
},
|
|
6321
|
+
"immutable": true,
|
|
6322
|
+
"locationInModule": {
|
|
6323
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6324
|
+
"line": 38
|
|
6325
|
+
},
|
|
6326
|
+
"name": "tsconfig",
|
|
6327
|
+
"optional": true,
|
|
6328
|
+
"type": {
|
|
6329
|
+
"fqn": "projen.javascript.TypescriptConfigOptions"
|
|
6330
|
+
}
|
|
6331
|
+
},
|
|
6332
|
+
{
|
|
6333
|
+
"abstract": true,
|
|
6334
|
+
"docs": {
|
|
6335
|
+
"default": "- use the production tsconfig options",
|
|
6336
|
+
"stability": "experimental",
|
|
6337
|
+
"summary": "Custom tsconfig options for the development tsconfig.json file (used for testing)."
|
|
6338
|
+
},
|
|
6339
|
+
"immutable": true,
|
|
6340
|
+
"locationInModule": {
|
|
6341
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6342
|
+
"line": 32
|
|
6343
|
+
},
|
|
6344
|
+
"name": "tsconfigDev",
|
|
6345
|
+
"optional": true,
|
|
6346
|
+
"type": {
|
|
6347
|
+
"fqn": "projen.javascript.TypescriptConfigOptions"
|
|
6348
|
+
}
|
|
6349
|
+
},
|
|
6350
|
+
{
|
|
6351
|
+
"abstract": true,
|
|
6352
|
+
"docs": {
|
|
6353
|
+
"default": "\"tsconfig.dev.json\"",
|
|
6354
|
+
"stability": "experimental",
|
|
6355
|
+
"summary": "The name of the development tsconfig.json file."
|
|
6356
|
+
},
|
|
6357
|
+
"immutable": true,
|
|
6358
|
+
"locationInModule": {
|
|
6359
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6360
|
+
"line": 26
|
|
6361
|
+
},
|
|
6362
|
+
"name": "tsconfigDevFile",
|
|
6363
|
+
"optional": true,
|
|
6364
|
+
"type": {
|
|
6365
|
+
"primitive": "string"
|
|
6366
|
+
}
|
|
6367
|
+
},
|
|
6368
|
+
{
|
|
6369
|
+
"abstract": true,
|
|
6370
|
+
"docs": {
|
|
6371
|
+
"stability": "experimental",
|
|
6372
|
+
"summary": "Options for ts-jest."
|
|
6373
|
+
},
|
|
6374
|
+
"immutable": true,
|
|
6375
|
+
"locationInModule": {
|
|
6376
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6377
|
+
"line": 20
|
|
6378
|
+
},
|
|
6379
|
+
"name": "tsJestOptions",
|
|
6380
|
+
"optional": true,
|
|
6381
|
+
"type": {
|
|
6382
|
+
"fqn": "projen.typescript.TsJestOptions"
|
|
6383
|
+
}
|
|
6384
|
+
},
|
|
6385
|
+
{
|
|
6386
|
+
"abstract": true,
|
|
6387
|
+
"docs": {
|
|
6388
|
+
"default": "\"latest\"",
|
|
6389
|
+
"remarks": "NOTE: Typescript is not semantically versioned and should remain on the\nsame minor, so we recommend using a `~` dependency (e.g. `~1.2.3`).",
|
|
6390
|
+
"stability": "experimental",
|
|
6391
|
+
"summary": "TypeScript version to use."
|
|
6392
|
+
},
|
|
6393
|
+
"immutable": true,
|
|
6394
|
+
"locationInModule": {
|
|
6395
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6396
|
+
"line": 15
|
|
6397
|
+
},
|
|
6398
|
+
"name": "typescriptVersion",
|
|
6399
|
+
"optional": true,
|
|
6400
|
+
"type": {
|
|
6401
|
+
"primitive": "string"
|
|
6402
|
+
}
|
|
6403
|
+
},
|
|
6404
|
+
{
|
|
6405
|
+
"abstract": true,
|
|
6406
|
+
"docs": {
|
|
6407
|
+
"default": "- standard configuration applicable for GitHub repositories",
|
|
6408
|
+
"remarks": "Given values either append to default configuration or overwrite values in it.",
|
|
6409
|
+
"stability": "experimental",
|
|
6410
|
+
"summary": "Custom configuration used when creating changelog with commit-and-tag-version package."
|
|
6411
|
+
},
|
|
6412
|
+
"immutable": true,
|
|
6413
|
+
"locationInModule": {
|
|
6414
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6415
|
+
"line": 412
|
|
6416
|
+
},
|
|
6417
|
+
"name": "versionrcOptions",
|
|
6418
|
+
"optional": true,
|
|
6419
|
+
"type": {
|
|
6420
|
+
"collection": {
|
|
6421
|
+
"elementtype": {
|
|
6422
|
+
"primitive": "any"
|
|
6423
|
+
},
|
|
6424
|
+
"kind": "map"
|
|
6425
|
+
}
|
|
6426
|
+
}
|
|
6427
|
+
},
|
|
6428
|
+
{
|
|
6429
|
+
"abstract": true,
|
|
6430
|
+
"docs": {
|
|
6431
|
+
"default": "true",
|
|
6432
|
+
"remarks": "Enabled by default for root projects. Disabled for non-root projects.",
|
|
6433
|
+
"stability": "experimental",
|
|
6434
|
+
"summary": "Enable VSCode integration."
|
|
6435
|
+
},
|
|
6436
|
+
"immutable": true,
|
|
6437
|
+
"locationInModule": {
|
|
6438
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6439
|
+
"line": 899
|
|
6440
|
+
},
|
|
6441
|
+
"name": "vscode",
|
|
6442
|
+
"optional": true,
|
|
6443
|
+
"type": {
|
|
6444
|
+
"primitive": "boolean"
|
|
6445
|
+
}
|
|
6446
|
+
},
|
|
6447
|
+
{
|
|
6448
|
+
"abstract": true,
|
|
6449
|
+
"docs": {
|
|
6450
|
+
"default": "\"yarn install --frozen-lockfile && yarn projen\"",
|
|
6451
|
+
"stability": "experimental",
|
|
6452
|
+
"summary": "Workflow steps to use in order to bootstrap this repo."
|
|
6453
|
+
},
|
|
6454
|
+
"immutable": true,
|
|
6455
|
+
"locationInModule": {
|
|
6456
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6457
|
+
"line": 145
|
|
6458
|
+
},
|
|
6459
|
+
"name": "workflowBootstrapSteps",
|
|
6460
|
+
"optional": true,
|
|
6461
|
+
"type": {
|
|
6462
|
+
"collection": {
|
|
6463
|
+
"elementtype": {
|
|
6464
|
+
"fqn": "projen.github.workflows.JobStep"
|
|
6465
|
+
},
|
|
6466
|
+
"kind": "array"
|
|
6467
|
+
}
|
|
6468
|
+
}
|
|
6469
|
+
},
|
|
6470
|
+
{
|
|
6471
|
+
"abstract": true,
|
|
6472
|
+
"docs": {
|
|
6473
|
+
"default": "- default image",
|
|
6474
|
+
"stability": "experimental",
|
|
6475
|
+
"summary": "Container image to use for GitHub workflows."
|
|
6476
|
+
},
|
|
6477
|
+
"immutable": true,
|
|
6478
|
+
"locationInModule": {
|
|
6479
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6480
|
+
"line": 405
|
|
6481
|
+
},
|
|
6482
|
+
"name": "workflowContainerImage",
|
|
6483
|
+
"optional": true,
|
|
6484
|
+
"type": {
|
|
6485
|
+
"primitive": "string"
|
|
6486
|
+
}
|
|
6487
|
+
},
|
|
6488
|
+
{
|
|
6489
|
+
"abstract": true,
|
|
6490
|
+
"docs": {
|
|
6491
|
+
"default": "- default GitHub Actions user",
|
|
6492
|
+
"stability": "experimental",
|
|
6493
|
+
"summary": "The git identity to use in workflows."
|
|
6494
|
+
},
|
|
6495
|
+
"immutable": true,
|
|
6496
|
+
"locationInModule": {
|
|
6497
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6498
|
+
"line": 139
|
|
6499
|
+
},
|
|
6500
|
+
"name": "workflowGitIdentity",
|
|
6501
|
+
"optional": true,
|
|
6502
|
+
"type": {
|
|
6503
|
+
"fqn": "projen.github.GitIdentity"
|
|
6504
|
+
}
|
|
6505
|
+
},
|
|
6506
|
+
{
|
|
6507
|
+
"abstract": true,
|
|
6508
|
+
"docs": {
|
|
6509
|
+
"default": "- `minNodeVersion` if set, otherwise `lts/*`.",
|
|
6510
|
+
"remarks": "Always use this option if your GitHub Actions workflows require a specific to run.",
|
|
6511
|
+
"stability": "experimental",
|
|
6512
|
+
"summary": "The node version used in GitHub Actions workflows."
|
|
6513
|
+
},
|
|
6514
|
+
"immutable": true,
|
|
6515
|
+
"locationInModule": {
|
|
6516
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6517
|
+
"line": 133
|
|
6518
|
+
},
|
|
6519
|
+
"name": "workflowNodeVersion",
|
|
6520
|
+
"optional": true,
|
|
6521
|
+
"type": {
|
|
6522
|
+
"primitive": "string"
|
|
6523
|
+
}
|
|
6524
|
+
},
|
|
6525
|
+
{
|
|
6526
|
+
"abstract": true,
|
|
6527
|
+
"docs": {
|
|
6528
|
+
"default": "false",
|
|
6529
|
+
"stability": "experimental",
|
|
6530
|
+
"summary": "Enable Node.js package cache in GitHub workflows."
|
|
6531
|
+
},
|
|
6532
|
+
"immutable": true,
|
|
6533
|
+
"locationInModule": {
|
|
6534
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6535
|
+
"line": 126
|
|
6536
|
+
},
|
|
6537
|
+
"name": "workflowPackageCache",
|
|
6538
|
+
"optional": true,
|
|
6539
|
+
"type": {
|
|
6540
|
+
"primitive": "boolean"
|
|
6541
|
+
}
|
|
6542
|
+
},
|
|
6543
|
+
{
|
|
6544
|
+
"abstract": true,
|
|
6545
|
+
"docs": {
|
|
6546
|
+
"custom": {
|
|
6547
|
+
"description": "Defines a target Runner by labels",
|
|
6548
|
+
"throws": "{Error} if both `runsOn` and `runsOnGroup` are specified"
|
|
6549
|
+
},
|
|
6550
|
+
"default": "[\"ubuntu-latest\"]",
|
|
6551
|
+
"stability": "experimental",
|
|
6552
|
+
"summary": "Github Runner selection labels."
|
|
6553
|
+
},
|
|
6554
|
+
"immutable": true,
|
|
6555
|
+
"locationInModule": {
|
|
6556
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6557
|
+
"line": 399
|
|
6558
|
+
},
|
|
6559
|
+
"name": "workflowRunsOn",
|
|
6560
|
+
"optional": true,
|
|
6561
|
+
"type": {
|
|
6562
|
+
"collection": {
|
|
6563
|
+
"elementtype": {
|
|
6564
|
+
"primitive": "string"
|
|
6565
|
+
},
|
|
6566
|
+
"kind": "array"
|
|
6567
|
+
}
|
|
6568
|
+
}
|
|
6569
|
+
},
|
|
6570
|
+
{
|
|
6571
|
+
"abstract": true,
|
|
6572
|
+
"docs": {
|
|
6573
|
+
"custom": {
|
|
6574
|
+
"description": "Defines a target Runner Group by name and/or labels",
|
|
6575
|
+
"throws": "{Error} if both `runsOn` and `runsOnGroup` are specified"
|
|
6576
|
+
},
|
|
6577
|
+
"stability": "experimental",
|
|
6578
|
+
"summary": "Github Runner Group selection options."
|
|
6579
|
+
},
|
|
6580
|
+
"immutable": true,
|
|
6581
|
+
"locationInModule": {
|
|
6582
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6583
|
+
"line": 391
|
|
6584
|
+
},
|
|
6585
|
+
"name": "workflowRunsOnGroup",
|
|
6586
|
+
"optional": true,
|
|
6587
|
+
"type": {
|
|
6588
|
+
"fqn": "projen.GroupRunnerOptions"
|
|
6589
|
+
}
|
|
6590
|
+
},
|
|
6591
|
+
{
|
|
6592
|
+
"abstract": true,
|
|
6593
|
+
"docs": {
|
|
6594
|
+
"default": "- Yarn Berry v4 with all default options",
|
|
6595
|
+
"stability": "experimental",
|
|
6596
|
+
"summary": "Options for Yarn Berry."
|
|
6597
|
+
},
|
|
6598
|
+
"immutable": true,
|
|
6599
|
+
"locationInModule": {
|
|
6600
|
+
"filename": "src/library-cdk-project-options.generated.ts",
|
|
6601
|
+
"line": 597
|
|
6602
|
+
},
|
|
6603
|
+
"name": "yarnBerryOptions",
|
|
6604
|
+
"optional": true,
|
|
6605
|
+
"type": {
|
|
6606
|
+
"fqn": "projen.javascript.YarnBerryOptions"
|
|
6607
|
+
}
|
|
6608
|
+
}
|
|
6609
|
+
],
|
|
6610
|
+
"symbolId": "src/library-cdk-project-options.generated:RocketleapLibraryCdkProjectOptions"
|
|
6611
|
+
},
|
|
6612
|
+
"@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject": {
|
|
6613
|
+
"assembly": "@rocketleap/rocketleap-projen",
|
|
6614
|
+
"base": "projen.awscdk.AwsCdkTypeScriptApp",
|
|
6615
|
+
"docs": {
|
|
6616
|
+
"remarks": "This is for platform infrastructure code (e.g., root-cdk, vpc-cdk, iam-cdk).\nIncludes the Norberhuis Onderneming B.V. license.",
|
|
6617
|
+
"stability": "stable",
|
|
6618
|
+
"summary": "Projen project for Rocketleap Platform CDK projects."
|
|
6619
|
+
},
|
|
6620
|
+
"fqn": "@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject",
|
|
6621
|
+
"initializer": {
|
|
6622
|
+
"docs": {
|
|
6623
|
+
"stability": "stable"
|
|
6624
|
+
},
|
|
6625
|
+
"locationInModule": {
|
|
6626
|
+
"filename": "src/cdk-project.ts",
|
|
6627
|
+
"line": 127
|
|
6628
|
+
},
|
|
6629
|
+
"parameters": [
|
|
6630
|
+
{
|
|
6631
|
+
"name": "options",
|
|
6632
|
+
"type": {
|
|
6633
|
+
"fqn": "@rocketleap/rocketleap-projen.RocketleapCdkProjectOptions"
|
|
6634
|
+
}
|
|
6635
|
+
}
|
|
6636
|
+
]
|
|
6637
|
+
},
|
|
6638
|
+
"kind": "class",
|
|
6639
|
+
"locationInModule": {
|
|
6640
|
+
"filename": "src/cdk-project.ts",
|
|
6641
|
+
"line": 126
|
|
6642
|
+
},
|
|
6643
|
+
"methods": [
|
|
6644
|
+
{
|
|
6645
|
+
"docs": {
|
|
6646
|
+
"stability": "stable"
|
|
6647
|
+
},
|
|
6648
|
+
"locationInModule": {
|
|
6649
|
+
"filename": "src/cdk-project.ts",
|
|
6650
|
+
"line": 100
|
|
6651
|
+
},
|
|
6652
|
+
"name": "generateSampleProjenrc",
|
|
6653
|
+
"parameters": [
|
|
6654
|
+
{
|
|
6655
|
+
"name": "projectClass",
|
|
6656
|
+
"type": {
|
|
6657
|
+
"primitive": "string"
|
|
6658
|
+
}
|
|
6659
|
+
}
|
|
6660
|
+
],
|
|
6661
|
+
"protected": true
|
|
6662
|
+
}
|
|
6663
|
+
],
|
|
6664
|
+
"name": "RocketleapPlatformCdkProject",
|
|
6665
|
+
"properties": [
|
|
6666
|
+
{
|
|
6667
|
+
"docs": {
|
|
6668
|
+
"stability": "stable"
|
|
6669
|
+
},
|
|
6670
|
+
"immutable": true,
|
|
6671
|
+
"locationInModule": {
|
|
6672
|
+
"filename": "src/cdk-project.ts",
|
|
6673
|
+
"line": 31
|
|
6674
|
+
},
|
|
6675
|
+
"name": "company",
|
|
6676
|
+
"protected": true,
|
|
6677
|
+
"type": {
|
|
6678
|
+
"primitive": "string"
|
|
6679
|
+
}
|
|
6680
|
+
},
|
|
6681
|
+
{
|
|
6682
|
+
"docs": {
|
|
6683
|
+
"stability": "stable"
|
|
6684
|
+
},
|
|
6685
|
+
"immutable": true,
|
|
6686
|
+
"locationInModule": {
|
|
6687
|
+
"filename": "src/cdk-project.ts",
|
|
6688
|
+
"line": 32
|
|
6689
|
+
},
|
|
6690
|
+
"name": "projectName",
|
|
6691
|
+
"protected": true,
|
|
6692
|
+
"type": {
|
|
6693
|
+
"primitive": "string"
|
|
6694
|
+
}
|
|
6695
|
+
}
|
|
6696
|
+
],
|
|
6697
|
+
"symbolId": "src/cdk-project:RocketleapPlatformCdkProject"
|
|
6698
|
+
},
|
|
6699
|
+
"@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject": {
|
|
6700
|
+
"assembly": "@rocketleap/rocketleap-projen",
|
|
6701
|
+
"base": "projen.awscdk.AwsCdkTypeScriptApp",
|
|
6702
|
+
"docs": {
|
|
6703
|
+
"remarks": "This is for customer-specific workload code that runs on the platform.\nDoes NOT include the platform license.",
|
|
6704
|
+
"stability": "stable",
|
|
6705
|
+
"summary": "Projen project for customer workload CDK projects."
|
|
6706
|
+
},
|
|
6707
|
+
"fqn": "@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject",
|
|
6708
|
+
"initializer": {
|
|
6709
|
+
"docs": {
|
|
6710
|
+
"stability": "stable"
|
|
6711
|
+
},
|
|
6712
|
+
"locationInModule": {
|
|
6713
|
+
"filename": "src/cdk-project.ts",
|
|
6714
|
+
"line": 169
|
|
6715
|
+
},
|
|
6716
|
+
"parameters": [
|
|
6717
|
+
{
|
|
6718
|
+
"name": "options",
|
|
6719
|
+
"type": {
|
|
6720
|
+
"fqn": "@rocketleap/rocketleap-projen.RocketleapCdkProjectOptions"
|
|
6721
|
+
}
|
|
6722
|
+
}
|
|
6723
|
+
]
|
|
6724
|
+
},
|
|
6725
|
+
"kind": "class",
|
|
6726
|
+
"locationInModule": {
|
|
6727
|
+
"filename": "src/cdk-project.ts",
|
|
6728
|
+
"line": 168
|
|
6729
|
+
},
|
|
6730
|
+
"methods": [
|
|
6731
|
+
{
|
|
6732
|
+
"docs": {
|
|
6733
|
+
"stability": "stable"
|
|
6734
|
+
},
|
|
6735
|
+
"locationInModule": {
|
|
6736
|
+
"filename": "src/cdk-project.ts",
|
|
6737
|
+
"line": 100
|
|
6738
|
+
},
|
|
6739
|
+
"name": "generateSampleProjenrc",
|
|
6740
|
+
"parameters": [
|
|
6741
|
+
{
|
|
6742
|
+
"name": "projectClass",
|
|
6743
|
+
"type": {
|
|
6744
|
+
"primitive": "string"
|
|
6745
|
+
}
|
|
6746
|
+
}
|
|
6747
|
+
],
|
|
6748
|
+
"protected": true
|
|
6749
|
+
}
|
|
6750
|
+
],
|
|
6751
|
+
"name": "RocketleapWorkloadCdkProject",
|
|
6752
|
+
"properties": [
|
|
6753
|
+
{
|
|
6754
|
+
"docs": {
|
|
6755
|
+
"stability": "stable"
|
|
6756
|
+
},
|
|
6757
|
+
"immutable": true,
|
|
6758
|
+
"locationInModule": {
|
|
6759
|
+
"filename": "src/cdk-project.ts",
|
|
6760
|
+
"line": 31
|
|
6761
|
+
},
|
|
6762
|
+
"name": "company",
|
|
6763
|
+
"protected": true,
|
|
6764
|
+
"type": {
|
|
6765
|
+
"primitive": "string"
|
|
6766
|
+
}
|
|
6767
|
+
},
|
|
6768
|
+
{
|
|
6769
|
+
"docs": {
|
|
6770
|
+
"stability": "stable"
|
|
6771
|
+
},
|
|
6772
|
+
"immutable": true,
|
|
6773
|
+
"locationInModule": {
|
|
6774
|
+
"filename": "src/cdk-project.ts",
|
|
6775
|
+
"line": 32
|
|
3760
6776
|
},
|
|
3761
6777
|
"name": "projectName",
|
|
3762
6778
|
"protected": true,
|
|
@@ -3768,6 +6784,6 @@
|
|
|
3768
6784
|
"symbolId": "src/cdk-project:RocketleapWorkloadCdkProject"
|
|
3769
6785
|
}
|
|
3770
6786
|
},
|
|
3771
|
-
"version": "1.
|
|
3772
|
-
"fingerprint": "
|
|
6787
|
+
"version": "1.2.0",
|
|
6788
|
+
"fingerprint": "GNfhutAWd+USHtiJCEr9mCXtBQ6bGN0nRm1ECsv7/K0="
|
|
3773
6789
|
}
|