projen-modules 0.2.48__py3-none-any.whl → 0.2.50__py3-none-any.whl
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.
- projen_modules/__init__.py +4028 -5
- projen_modules/_jsii/__init__.py +1 -1
- projen_modules/_jsii/projen-modules@0.2.50.jsii.tgz +0 -0
- {projen_modules-0.2.48.dist-info → projen_modules-0.2.50.dist-info}/METADATA +7 -6
- projen_modules-0.2.50.dist-info/RECORD +9 -0
- projen_modules/_jsii/projen-modules@0.2.48.jsii.tgz +0 -0
- projen_modules-0.2.48.dist-info/RECORD +0 -9
- {projen_modules-0.2.48.dist-info → projen_modules-0.2.50.dist-info}/LICENSE +0 -0
- {projen_modules-0.2.48.dist-info → projen_modules-0.2.50.dist-info}/WHEEL +0 -0
- {projen_modules-0.2.48.dist-info → projen_modules-0.2.50.dist-info}/top_level.txt +0 -0
projen_modules/__init__.py
CHANGED
@@ -38,11 +38,12 @@ Some projects may have required fields that need to be specified as part of this
|
|
38
38
|
|
39
39
|
### Project Types
|
40
40
|
|
41
|
-
| Project type
|
42
|
-
|
|
43
|
-
| [
|
44
|
-
| [
|
45
|
-
| [
|
41
|
+
| Project type | Description |
|
42
|
+
| ---------------------------------------------- | -------------------------- |
|
43
|
+
| [cdk-typescript-app](API.md#cdktypescriptapp-) | A typescript CDK app |
|
44
|
+
| [npm-package](API.md#npmpackage-) | A typescript npm package |
|
45
|
+
| [python-package](API.md#pythonpackage-) | A python package |
|
46
|
+
| [jsii-package](API.md#jsiiproject-) | A typescript JSII package |
|
46
47
|
|
47
48
|
## Project Structure
|
48
49
|
|
@@ -87,6 +88,7 @@ def check_type(argname: str, value: object, expected_type: typing.Any) -> typing
|
|
87
88
|
from ._jsii import *
|
88
89
|
|
89
90
|
import projen as _projen_04054675
|
91
|
+
import projen.awscdk as _projen_awscdk_04054675
|
90
92
|
import projen.cdk as _projen_cdk_04054675
|
91
93
|
import projen.github as _projen_github_04054675
|
92
94
|
import projen.github.workflows as _projen_github_workflows_04054675
|
@@ -96,6 +98,3841 @@ import projen.release as _projen_release_04054675
|
|
96
98
|
import projen.typescript as _projen_typescript_04054675
|
97
99
|
|
98
100
|
|
101
|
+
class CdkTypeScriptApp(
|
102
|
+
_projen_awscdk_04054675.AwsCdkTypeScriptApp,
|
103
|
+
metaclass=jsii.JSIIMeta,
|
104
|
+
jsii_type="projen-modules.CdkTypeScriptApp",
|
105
|
+
):
|
106
|
+
'''A CDK application in TypeScript.
|
107
|
+
|
108
|
+
:pjid: cdk-typescript-app
|
109
|
+
'''
|
110
|
+
|
111
|
+
def __init__(
|
112
|
+
self,
|
113
|
+
*,
|
114
|
+
cdk_version: builtins.str,
|
115
|
+
code_owners: typing.Sequence[builtins.str],
|
116
|
+
name: builtins.str,
|
117
|
+
allow_library_dependencies: typing.Optional[builtins.bool] = None,
|
118
|
+
app_entrypoint: typing.Optional[builtins.str] = None,
|
119
|
+
artifacts_directory: typing.Optional[builtins.str] = None,
|
120
|
+
author_email: typing.Optional[builtins.str] = None,
|
121
|
+
author_name: typing.Optional[builtins.str] = None,
|
122
|
+
author_organization: typing.Optional[builtins.bool] = None,
|
123
|
+
author_url: typing.Optional[builtins.str] = None,
|
124
|
+
auto_approve_options: typing.Optional[typing.Union[_projen_github_04054675.AutoApproveOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
125
|
+
auto_approve_upgrades: typing.Optional[builtins.bool] = None,
|
126
|
+
auto_detect_bin: typing.Optional[builtins.bool] = None,
|
127
|
+
auto_merge: typing.Optional[builtins.bool] = None,
|
128
|
+
auto_merge_options: typing.Optional[typing.Union[_projen_github_04054675.AutoMergeOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
129
|
+
bin: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
130
|
+
bugs_email: typing.Optional[builtins.str] = None,
|
131
|
+
bugs_url: typing.Optional[builtins.str] = None,
|
132
|
+
build_command: typing.Optional[builtins.str] = None,
|
133
|
+
build_workflow: typing.Optional[builtins.bool] = None,
|
134
|
+
build_workflow_options: typing.Optional[typing.Union[_projen_javascript_04054675.BuildWorkflowOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
135
|
+
build_workflow_triggers: typing.Optional[typing.Union[_projen_github_workflows_04054675.Triggers, typing.Dict[builtins.str, typing.Any]]] = None,
|
136
|
+
bump_package: typing.Optional[builtins.str] = None,
|
137
|
+
bundled_deps: typing.Optional[typing.Sequence[builtins.str]] = None,
|
138
|
+
bundler_options: typing.Optional[typing.Union[_projen_javascript_04054675.BundlerOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
139
|
+
bun_version: typing.Optional[builtins.str] = None,
|
140
|
+
cdk_assert: typing.Optional[builtins.bool] = None,
|
141
|
+
cdk_assertions: typing.Optional[builtins.bool] = None,
|
142
|
+
cdk_cli_version: typing.Optional[builtins.str] = None,
|
143
|
+
cdk_dependencies: typing.Optional[typing.Sequence[builtins.str]] = None,
|
144
|
+
cdk_dependencies_as_deps: typing.Optional[builtins.bool] = None,
|
145
|
+
cdkout: typing.Optional[builtins.str] = None,
|
146
|
+
cdk_test_dependencies: typing.Optional[typing.Sequence[builtins.str]] = None,
|
147
|
+
cdk_version_pinning: typing.Optional[builtins.bool] = None,
|
148
|
+
check_licenses: typing.Optional[typing.Union[_projen_javascript_04054675.LicenseCheckerOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
149
|
+
clobber: typing.Optional[builtins.bool] = None,
|
150
|
+
code_artifact_options: typing.Optional[typing.Union[_projen_javascript_04054675.CodeArtifactOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
151
|
+
code_cov: typing.Optional[builtins.bool] = None,
|
152
|
+
code_cov_token_secret: typing.Optional[builtins.str] = None,
|
153
|
+
commit_generated: typing.Optional[builtins.bool] = None,
|
154
|
+
constructs_version: typing.Optional[builtins.str] = None,
|
155
|
+
context: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
|
156
|
+
copyright_owner: typing.Optional[builtins.str] = None,
|
157
|
+
copyright_period: typing.Optional[builtins.str] = None,
|
158
|
+
default_release_branch: typing.Optional[builtins.str] = None,
|
159
|
+
dependabot: typing.Optional[builtins.bool] = None,
|
160
|
+
dependabot_options: typing.Optional[typing.Union[_projen_github_04054675.DependabotOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
161
|
+
deps: typing.Optional[typing.Sequence[builtins.str]] = None,
|
162
|
+
deps_upgrade: typing.Optional[builtins.bool] = None,
|
163
|
+
deps_upgrade_options: typing.Optional[typing.Union[_projen_javascript_04054675.UpgradeDependenciesOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
164
|
+
description: typing.Optional[builtins.str] = None,
|
165
|
+
dev_container: typing.Optional[builtins.bool] = None,
|
166
|
+
dev_deps: typing.Optional[typing.Sequence[builtins.str]] = None,
|
167
|
+
disable_tsconfig: typing.Optional[builtins.bool] = None,
|
168
|
+
disable_tsconfig_dev: typing.Optional[builtins.bool] = None,
|
169
|
+
docgen: typing.Optional[builtins.bool] = None,
|
170
|
+
docs_directory: typing.Optional[builtins.str] = None,
|
171
|
+
edge_lambda_auto_discover: typing.Optional[builtins.bool] = None,
|
172
|
+
entrypoint: typing.Optional[builtins.str] = None,
|
173
|
+
entrypoint_types: typing.Optional[builtins.str] = None,
|
174
|
+
eslint: typing.Optional[builtins.bool] = None,
|
175
|
+
eslint_options: typing.Optional[typing.Union[_projen_javascript_04054675.EslintOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
176
|
+
experimental_integ_runner: typing.Optional[builtins.bool] = None,
|
177
|
+
feature_flags: typing.Optional[builtins.bool] = None,
|
178
|
+
github: typing.Optional[builtins.bool] = None,
|
179
|
+
github_options: typing.Optional[typing.Union[_projen_github_04054675.GitHubOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
180
|
+
gitignore: typing.Optional[typing.Sequence[builtins.str]] = None,
|
181
|
+
git_ignore_options: typing.Optional[typing.Union[_projen_04054675.IgnoreFileOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
182
|
+
git_options: typing.Optional[typing.Union[_projen_04054675.GitOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
183
|
+
gitpod: typing.Optional[builtins.bool] = None,
|
184
|
+
homepage: typing.Optional[builtins.str] = None,
|
185
|
+
integration_test_auto_discover: typing.Optional[builtins.bool] = None,
|
186
|
+
jest: typing.Optional[builtins.bool] = None,
|
187
|
+
jest_options: typing.Optional[typing.Union[_projen_javascript_04054675.JestOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
188
|
+
jsii_release_version: typing.Optional[builtins.str] = None,
|
189
|
+
keywords: typing.Optional[typing.Sequence[builtins.str]] = None,
|
190
|
+
lambda_auto_discover: typing.Optional[builtins.bool] = None,
|
191
|
+
lambda_extension_auto_discover: typing.Optional[builtins.bool] = None,
|
192
|
+
lambda_options: typing.Optional[typing.Union[_projen_awscdk_04054675.LambdaFunctionCommonOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
193
|
+
libdir: typing.Optional[builtins.str] = None,
|
194
|
+
license: typing.Optional[builtins.str] = None,
|
195
|
+
licensed: typing.Optional[builtins.bool] = None,
|
196
|
+
logging: typing.Optional[typing.Union[_projen_04054675.LoggerOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
197
|
+
major_version: typing.Optional[jsii.Number] = None,
|
198
|
+
max_node_version: typing.Optional[builtins.str] = None,
|
199
|
+
mergify: typing.Optional[builtins.bool] = None,
|
200
|
+
mergify_options: typing.Optional[typing.Union[_projen_github_04054675.MergifyOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
201
|
+
min_major_version: typing.Optional[jsii.Number] = None,
|
202
|
+
min_node_version: typing.Optional[builtins.str] = None,
|
203
|
+
mutable_build: typing.Optional[builtins.bool] = None,
|
204
|
+
next_version_command: typing.Optional[builtins.str] = None,
|
205
|
+
npm_access: typing.Optional[_projen_javascript_04054675.NpmAccess] = None,
|
206
|
+
npm_dist_tag: typing.Optional[builtins.str] = None,
|
207
|
+
npmignore: typing.Optional[typing.Sequence[builtins.str]] = None,
|
208
|
+
npmignore_enabled: typing.Optional[builtins.bool] = None,
|
209
|
+
npm_ignore_options: typing.Optional[typing.Union[_projen_04054675.IgnoreFileOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
210
|
+
npm_provenance: typing.Optional[builtins.bool] = None,
|
211
|
+
npm_registry: typing.Optional[builtins.str] = None,
|
212
|
+
npm_registry_url: typing.Optional[builtins.str] = None,
|
213
|
+
npm_token_secret: typing.Optional[builtins.str] = None,
|
214
|
+
outdir: typing.Optional[builtins.str] = None,
|
215
|
+
package: typing.Optional[builtins.bool] = None,
|
216
|
+
package_manager: typing.Optional[_projen_javascript_04054675.NodePackageManager] = None,
|
217
|
+
package_name: typing.Optional[builtins.str] = None,
|
218
|
+
parent: typing.Optional[_projen_04054675.Project] = None,
|
219
|
+
peer_dependency_options: typing.Optional[typing.Union[_projen_javascript_04054675.PeerDependencyOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
220
|
+
peer_deps: typing.Optional[typing.Sequence[builtins.str]] = None,
|
221
|
+
pnpm_version: typing.Optional[builtins.str] = None,
|
222
|
+
post_build_steps: typing.Optional[typing.Sequence[typing.Union[_projen_github_workflows_04054675.JobStep, typing.Dict[builtins.str, typing.Any]]]] = None,
|
223
|
+
prerelease: typing.Optional[builtins.str] = None,
|
224
|
+
prettier: typing.Optional[builtins.bool] = None,
|
225
|
+
prettier_options: typing.Optional[typing.Union[_projen_javascript_04054675.PrettierOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
226
|
+
project_type: typing.Optional[_projen_04054675.ProjectType] = None,
|
227
|
+
projen_command: typing.Optional[builtins.str] = None,
|
228
|
+
projen_credentials: typing.Optional[_projen_github_04054675.GithubCredentials] = None,
|
229
|
+
projen_dev_dependency: typing.Optional[builtins.bool] = None,
|
230
|
+
projenrc_js: typing.Optional[builtins.bool] = None,
|
231
|
+
projenrc_json: typing.Optional[builtins.bool] = None,
|
232
|
+
projenrc_json_options: typing.Optional[typing.Union[_projen_04054675.ProjenrcJsonOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
233
|
+
projenrc_js_options: typing.Optional[typing.Union[_projen_javascript_04054675.ProjenrcOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
234
|
+
projenrc_ts: typing.Optional[builtins.bool] = None,
|
235
|
+
projenrc_ts_options: typing.Optional[typing.Union[_projen_typescript_04054675.ProjenrcOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
236
|
+
projen_token_secret: typing.Optional[builtins.str] = None,
|
237
|
+
projen_version: typing.Optional[builtins.str] = None,
|
238
|
+
publish_dry_run: typing.Optional[builtins.bool] = None,
|
239
|
+
publish_tasks: typing.Optional[builtins.bool] = None,
|
240
|
+
pull_request_template: typing.Optional[builtins.bool] = None,
|
241
|
+
pull_request_template_contents: typing.Optional[typing.Sequence[builtins.str]] = None,
|
242
|
+
readme: typing.Optional[typing.Union["ReadmeOptions", typing.Dict[builtins.str, typing.Any]]] = None,
|
243
|
+
releasable_commits: typing.Optional[_projen_04054675.ReleasableCommits] = None,
|
244
|
+
release: typing.Optional[builtins.bool] = None,
|
245
|
+
release_branches: typing.Optional[typing.Mapping[builtins.str, typing.Union[_projen_release_04054675.BranchOptions, typing.Dict[builtins.str, typing.Any]]]] = None,
|
246
|
+
release_every_commit: typing.Optional[builtins.bool] = None,
|
247
|
+
release_failure_issue: typing.Optional[builtins.bool] = None,
|
248
|
+
release_failure_issue_label: typing.Optional[builtins.str] = None,
|
249
|
+
release_schedule: typing.Optional[builtins.str] = None,
|
250
|
+
release_tag_prefix: typing.Optional[builtins.str] = None,
|
251
|
+
release_to_npm: typing.Optional[builtins.bool] = None,
|
252
|
+
release_trigger: typing.Optional[_projen_release_04054675.ReleaseTrigger] = None,
|
253
|
+
release_workflow: typing.Optional[builtins.bool] = None,
|
254
|
+
release_workflow_name: typing.Optional[builtins.str] = None,
|
255
|
+
release_workflow_setup_steps: typing.Optional[typing.Sequence[typing.Union[_projen_github_workflows_04054675.JobStep, typing.Dict[builtins.str, typing.Any]]]] = None,
|
256
|
+
renovatebot: typing.Optional[builtins.bool] = None,
|
257
|
+
renovatebot_options: typing.Optional[typing.Union[_projen_04054675.RenovatebotOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
258
|
+
repository: typing.Optional[builtins.str] = None,
|
259
|
+
repository_directory: typing.Optional[builtins.str] = None,
|
260
|
+
require_approval: typing.Optional[_projen_awscdk_04054675.ApprovalLevel] = None,
|
261
|
+
sample_code: typing.Optional[builtins.bool] = None,
|
262
|
+
scoped_packages_options: typing.Optional[typing.Sequence[typing.Union[_projen_javascript_04054675.ScopedPackagesOptions, typing.Dict[builtins.str, typing.Any]]]] = None,
|
263
|
+
scripts: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
264
|
+
srcdir: typing.Optional[builtins.str] = None,
|
265
|
+
stability: typing.Optional[builtins.str] = None,
|
266
|
+
stale: typing.Optional[builtins.bool] = None,
|
267
|
+
stale_options: typing.Optional[typing.Union[_projen_github_04054675.StaleOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
268
|
+
testdir: typing.Optional[builtins.str] = None,
|
269
|
+
tsconfig: typing.Optional[typing.Union[_projen_javascript_04054675.TypescriptConfigOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
270
|
+
tsconfig_dev: typing.Optional[typing.Union[_projen_javascript_04054675.TypescriptConfigOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
271
|
+
tsconfig_dev_file: typing.Optional[builtins.str] = None,
|
272
|
+
ts_jest_options: typing.Optional[typing.Union[_projen_typescript_04054675.TsJestOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
273
|
+
typescript_version: typing.Optional[builtins.str] = None,
|
274
|
+
versionrc_options: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
|
275
|
+
vscode: typing.Optional[builtins.bool] = None,
|
276
|
+
watch_excludes: typing.Optional[typing.Sequence[builtins.str]] = None,
|
277
|
+
watch_includes: typing.Optional[typing.Sequence[builtins.str]] = None,
|
278
|
+
workflow_bootstrap_steps: typing.Optional[typing.Sequence[typing.Union[_projen_github_workflows_04054675.JobStep, typing.Dict[builtins.str, typing.Any]]]] = None,
|
279
|
+
workflow_container_image: typing.Optional[builtins.str] = None,
|
280
|
+
workflow_git_identity: typing.Optional[typing.Union[_projen_github_04054675.GitIdentity, typing.Dict[builtins.str, typing.Any]]] = None,
|
281
|
+
workflow_node_version: typing.Optional[builtins.str] = None,
|
282
|
+
workflow_package_cache: typing.Optional[builtins.bool] = None,
|
283
|
+
workflow_runs_on: typing.Optional[typing.Sequence[builtins.str]] = None,
|
284
|
+
workflow_runs_on_group: typing.Optional[typing.Union[_projen_04054675.GroupRunnerOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
285
|
+
yarn_berry_options: typing.Optional[typing.Union[_projen_javascript_04054675.YarnBerryOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
286
|
+
) -> None:
|
287
|
+
'''
|
288
|
+
:param cdk_version: (experimental) Minimum version of the AWS CDK to depend on. Default: "2.1.0"
|
289
|
+
:param code_owners: List of teams used to generate the CODEOWNERS file.
|
290
|
+
:param name: (experimental) This is the name of your project. Default: $BASEDIR
|
291
|
+
:param allow_library_dependencies: (experimental) Allow the project to include ``peerDependencies`` and ``bundledDependencies``. This is normally only allowed for libraries. For apps, there's no meaning for specifying these. Default: true
|
292
|
+
:param app_entrypoint: (experimental) The CDK app's entrypoint (relative to the source directory, which is "src" by default). Default: "main.ts"
|
293
|
+
:param artifacts_directory: (experimental) A directory which will contain build artifacts. Default: "dist"
|
294
|
+
:param author_email: (experimental) Author's e-mail.
|
295
|
+
:param author_name: (experimental) Author's name.
|
296
|
+
:param author_organization: (experimental) Is the author an organization.
|
297
|
+
:param author_url: (experimental) Author's URL / Website.
|
298
|
+
:param auto_approve_options: (experimental) Enable and configure the 'auto approve' workflow. Default: - auto approve is disabled
|
299
|
+
:param auto_approve_upgrades: (experimental) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). Throw if set to true but ``autoApproveOptions`` are not defined. Default: - true
|
300
|
+
:param auto_detect_bin: (experimental) Automatically add all executables under the ``bin`` directory to your ``package.json`` file under the ``bin`` section. Default: true
|
301
|
+
:param auto_merge: (experimental) Enable automatic merging on GitHub. Has no effect if ``github.mergify`` is set to false. Default: true
|
302
|
+
:param auto_merge_options: (experimental) Configure options for automatic merging on GitHub. Has no effect if ``github.mergify`` or ``autoMerge`` is set to false. Default: - see defaults in ``AutoMergeOptions``
|
303
|
+
:param bin: (experimental) Binary programs vended with your module. You can use this option to add/customize how binaries are represented in your ``package.json``, but unless ``autoDetectBin`` is ``false``, every executable file under ``bin`` will automatically be added to this section.
|
304
|
+
:param bugs_email: (experimental) The email address to which issues should be reported.
|
305
|
+
:param bugs_url: (experimental) The url to your project's issue tracker.
|
306
|
+
:param build_command: (experimental) A command to execute before synthesis. This command will be called when running ``cdk synth`` or when ``cdk watch`` identifies a change in your source code before redeployment. Default: - no build command
|
307
|
+
:param build_workflow: (experimental) Define a GitHub workflow for building PRs. Default: - true if not a subproject
|
308
|
+
:param build_workflow_options: (experimental) Options for PR build workflow.
|
309
|
+
:param build_workflow_triggers: (deprecated) Build workflow triggers. Default: "{ pullRequest: {}, workflowDispatch: {} }"
|
310
|
+
:param bump_package: (experimental) The ``commit-and-tag-version`` compatible package used to bump the package version, as a dependency string. This can be any compatible package version, including the deprecated ``standard-version@9``. Default: - A recent version of "commit-and-tag-version"
|
311
|
+
:param bundled_deps: (experimental) List of dependencies to bundle into this module. These modules will be added both to the ``dependencies`` section and ``bundledDependencies`` section of your ``package.json``. The recommendation is to only specify the module name here (e.g. ``express``). This will behave similar to ``yarn add`` or ``npm install`` in the sense that it will add the module as a dependency to your ``package.json`` file with the latest version (``^``). You can specify semver requirements in the same syntax passed to ``npm i`` or ``yarn add`` (e.g. ``express@^2``) and this will be what you ``package.json`` will eventually include.
|
312
|
+
:param bundler_options: (experimental) Options for ``Bundler``.
|
313
|
+
:param bun_version: (experimental) The version of Bun to use if using Bun as a package manager. Default: "latest"
|
314
|
+
:param cdk_assert: (deprecated) Warning: NodeJS only. Install the Default: - will be included by default for AWS CDK >= 1.0.0 < 2.0.0
|
315
|
+
:param cdk_assertions: (experimental) Install the assertions library? Only needed for CDK 1.x. If using CDK 2.x then assertions is already included in 'aws-cdk-lib' Default: - will be included by default for AWS CDK >= 1.111.0 < 2.0.0
|
316
|
+
:param cdk_cli_version: (experimental) Version range of the AWS CDK CLI to depend on. Can be either a specific version, or an NPM version range. By default, the latest 2.x version will be installed; you can use this option to restrict it to a specific version or version range. Default: "^2"
|
317
|
+
:param cdk_dependencies: (deprecated) Which AWS CDKv1 modules this project requires.
|
318
|
+
:param cdk_dependencies_as_deps: (deprecated) If this is enabled (default), all modules declared in ``cdkDependencies`` will be also added as normal ``dependencies`` (as well as ``peerDependencies``). This is to ensure that downstream consumers actually have your CDK dependencies installed when using npm < 7 or yarn, where peer dependencies are not automatically installed. If this is disabled, ``cdkDependencies`` will be added to ``devDependencies`` to ensure they are present during development. Note: this setting only applies to construct library projects Default: true
|
319
|
+
:param cdkout: (experimental) cdk.out directory. Default: "cdk.out"
|
320
|
+
:param cdk_test_dependencies: (deprecated) AWS CDK modules required for testing.
|
321
|
+
:param cdk_version_pinning: (experimental) Use pinned version instead of caret version for CDK. You can use this to prevent mixed versions for your CDK dependencies and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.
|
322
|
+
:param check_licenses: (experimental) Configure which licenses should be deemed acceptable for use by dependencies. This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered. Default: - no license checks are run during the build and all licenses will be accepted
|
323
|
+
:param clobber: (experimental) Add a ``clobber`` task which resets the repo to origin. Default: - true, but false for subprojects
|
324
|
+
:param code_artifact_options: (experimental) Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact Default: - undefined
|
325
|
+
:param code_cov: (experimental) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with ``@codeCovTokenSecret``. Default: false
|
326
|
+
:param code_cov_token_secret: (experimental) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. Default: - if this option is not specified, only public repositories are supported
|
327
|
+
:param commit_generated: (experimental) Whether to commit the managed files by default. Default: true
|
328
|
+
:param constructs_version: (experimental) Minimum version of the ``constructs`` library to depend on. Default: - for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
|
329
|
+
:param context: (experimental) Additional context to include in ``cdk.json``. Default: - no additional context
|
330
|
+
:param copyright_owner: (experimental) License copyright owner. Default: - defaults to the value of authorName or "" if ``authorName`` is undefined.
|
331
|
+
:param copyright_period: (experimental) The copyright years to put in the LICENSE file. Default: - current year
|
332
|
+
:param default_release_branch: (experimental) The name of the main release branch. Default: "main"
|
333
|
+
:param dependabot: (experimental) Use dependabot to handle dependency upgrades. Cannot be used in conjunction with ``depsUpgrade``. Default: false
|
334
|
+
:param dependabot_options: (experimental) Options for dependabot. Default: - default options
|
335
|
+
:param deps: (experimental) Runtime dependencies of this module. The recommendation is to only specify the module name here (e.g. ``express``). This will behave similar to ``yarn add`` or ``npm install`` in the sense that it will add the module as a dependency to your ``package.json`` file with the latest version (``^``). You can specify semver requirements in the same syntax passed to ``npm i`` or ``yarn add`` (e.g. ``express@^2``) and this will be what you ``package.json`` will eventually include. Default: []
|
336
|
+
:param deps_upgrade: (experimental) Use tasks and github workflows to handle dependency upgrades. Cannot be used in conjunction with ``dependabot``. Default: true
|
337
|
+
:param deps_upgrade_options: (experimental) Options for ``UpgradeDependencies``. Default: - default options
|
338
|
+
:param description: (experimental) The description is just a string that helps people understand the purpose of the package. It can be used when searching for packages in a package manager as well. See https://classic.yarnpkg.com/en/docs/package-json/#toc-description
|
339
|
+
:param dev_container: (experimental) Add a VSCode development environment (used for GitHub Codespaces). Default: false
|
340
|
+
:param dev_deps: (experimental) Build dependencies for this module. These dependencies will only be available in your build environment but will not be fetched when this module is consumed. The recommendation is to only specify the module name here (e.g. ``express``). This will behave similar to ``yarn add`` or ``npm install`` in the sense that it will add the module as a dependency to your ``package.json`` file with the latest version (``^``). You can specify semver requirements in the same syntax passed to ``npm i`` or ``yarn add`` (e.g. ``express@^2``) and this will be what you ``package.json`` will eventually include. Default: []
|
341
|
+
:param disable_tsconfig: (experimental) Do not generate a ``tsconfig.json`` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). Default: false
|
342
|
+
:param disable_tsconfig_dev: (experimental) Do not generate a ``tsconfig.dev.json`` file. Default: false
|
343
|
+
:param docgen: (experimental) Docgen by Typedoc. Default: false
|
344
|
+
:param docs_directory: (experimental) Docs directory. Default: "docs"
|
345
|
+
:param edge_lambda_auto_discover: (experimental) Automatically adds an ``cloudfront.experimental.EdgeFunction`` for each ``.edge-lambda.ts`` handler in your source tree. If this is disabled, you can manually add an ``awscdk.AutoDiscover`` component to your project. Default: true
|
346
|
+
:param entrypoint: (experimental) Module entrypoint (``main`` in ``package.json``). Set to an empty string to not include ``main`` in your package.json. Default: "lib/index.js"
|
347
|
+
:param entrypoint_types: (experimental) The .d.ts file that includes the type declarations for this module. Default: - .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
|
348
|
+
:param eslint: (experimental) Setup eslint. Default: true
|
349
|
+
:param eslint_options: (experimental) Eslint options. Default: - opinionated default options
|
350
|
+
:param experimental_integ_runner: (experimental) Enable experimental support for the AWS CDK integ-runner. Default: false
|
351
|
+
:param feature_flags: (experimental) Include all feature flags in cdk.json. Default: true
|
352
|
+
:param github: (experimental) Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. Default: true
|
353
|
+
:param github_options: (experimental) Options for GitHub integration. Default: - see GitHubOptions
|
354
|
+
:param gitignore: (experimental) Additional entries to .gitignore.
|
355
|
+
:param git_ignore_options: (experimental) Configuration options for .gitignore file.
|
356
|
+
:param git_options: (experimental) Configuration options for git.
|
357
|
+
:param gitpod: (experimental) Add a Gitpod development environment. Default: false
|
358
|
+
:param homepage: (experimental) Package's Homepage / Website.
|
359
|
+
:param integration_test_auto_discover: (experimental) Automatically discovers and creates integration tests for each ``.integ.ts`` file in under your test directory. Default: true
|
360
|
+
:param jest: (experimental) Setup jest unit tests. Default: true
|
361
|
+
:param jest_options: (experimental) Jest options. Default: - default options
|
362
|
+
:param jsii_release_version: (experimental) Version requirement of ``publib`` which is used to publish modules to npm. Default: "latest"
|
363
|
+
:param keywords: (experimental) Keywords to include in ``package.json``.
|
364
|
+
:param lambda_auto_discover: (experimental) Automatically adds an ``awscdk.LambdaFunction`` for each ``.lambda.ts`` handler in your source tree. If this is disabled, you can manually add an ``awscdk.AutoDiscover`` component to your project. Default: true
|
365
|
+
:param lambda_extension_auto_discover: (experimental) Automatically adds an ``awscdk.LambdaExtension`` for each ``.lambda-extension.ts`` entrypoint in your source tree. If this is disabled, you can manually add an ``awscdk.AutoDiscover`` component to your project. Default: true
|
366
|
+
:param lambda_options: (experimental) Common options for all AWS Lambda functions. Default: - default options
|
367
|
+
:param libdir: (experimental) Typescript artifacts output directory. Default: "lib"
|
368
|
+
:param license: (experimental) License's SPDX identifier. See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses. Use the ``licensed`` option if you want to no license to be specified. Default: "Apache-2.0"
|
369
|
+
:param licensed: (experimental) Indicates if a license should be added. Default: true
|
370
|
+
:param logging: (experimental) Configure logging options such as verbosity. Default: {}
|
371
|
+
:param major_version: (experimental) Major version to release from the default branch. If this is specified, we bump the latest version of this major version line. If not specified, we bump the global latest version. Default: - Major version is not enforced.
|
372
|
+
:param max_node_version: (experimental) The maximum node version supported by this package. Most projects should not use this option. The value indicates that the package is incompatible with any newer versions of node. This requirement is enforced via the engines field. You will normally not need to set this option. Consider this option only if your package is known to not function with newer versions of node. Default: - no maximum version is enforced
|
373
|
+
:param mergify: (deprecated) Whether mergify should be enabled on this repository or not. Default: true
|
374
|
+
:param mergify_options: (deprecated) Options for mergify. Default: - default options
|
375
|
+
:param min_major_version: (experimental) Minimal Major version to release. This can be useful to set to 1, as breaking changes before the 1.x major release are not incrementing the major version number. Can not be set together with ``majorVersion``. Default: - No minimum version is being enforced
|
376
|
+
:param min_node_version: (experimental) The minimum node version required by this package to function. Most projects should not use this option. The value indicates that the package is incompatible with any older versions of node. This requirement is enforced via the engines field. You will normally not need to set this option, even if your package is incompatible with EOL versions of node. Consider this option only if your package depends on a specific feature, that is not available in other LTS versions. Setting this option has very high impact on the consumers of your package, as package managers will actively prevent usage with node versions you have marked as incompatible. To change the node version of your CI/CD workflows, use ``workflowNodeVersion``. Default: - no minimum version is enforced
|
377
|
+
:param mutable_build: (deprecated) Automatically update files modified during builds to pull-request branches. This means that any files synthesized by projen or e.g. test snapshots will always be up-to-date before a PR is merged. Implies that PR builds do not have anti-tamper checks. Default: true
|
378
|
+
:param next_version_command: (experimental) A shell command to control the next version to release. If present, this shell command will be run before the bump is executed, and it determines what version to release. It will be executed in the following environment: - Working directory: the project directory. - ``$VERSION``: the current version. Looks like ``1.2.3``. - ``$LATEST_TAG``: the most recent tag. Looks like ``prefix-v1.2.3``, or may be unset. The command should print one of the following to ``stdout``: - Nothing: the next version number will be determined based on commit history. - ``x.y.z``: the next version number will be ``x.y.z``. - ``major|minor|patch``: the next version number will be the current version number with the indicated component bumped. This setting cannot be specified together with ``minMajorVersion``; the invoked script can be used to achieve the effects of ``minMajorVersion``. Default: - The next version will be determined based on the commit history and project settings.
|
379
|
+
:param npm_access: (experimental) Access level of the npm package. Default: - for scoped packages (e.g. ``foo@bar``), the default is ``NpmAccess.RESTRICTED``, for non-scoped packages, the default is ``NpmAccess.PUBLIC``.
|
380
|
+
:param npm_dist_tag: (experimental) The npmDistTag to use when publishing from the default branch. To set the npm dist-tag for release branches, set the ``npmDistTag`` property for each branch. Default: "latest"
|
381
|
+
:param npmignore: (deprecated) Additional entries to .npmignore.
|
382
|
+
:param npmignore_enabled: (experimental) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. Default: true
|
383
|
+
:param npm_ignore_options: (experimental) Configuration options for .npmignore file.
|
384
|
+
:param npm_provenance: (experimental) Should provenance statements be generated when the package is published. A supported package manager is required to publish a package with npm provenance statements and you will need to use a supported CI/CD provider. Note that the projen ``Release`` and ``Publisher`` components are using ``publib`` to publish packages, which is using npm internally and supports provenance statements independently of the package manager used. Default: - true for public packages, false otherwise
|
385
|
+
:param npm_registry: (deprecated) The host name of the npm registry to publish to. Cannot be set together with ``npmRegistryUrl``.
|
386
|
+
:param npm_registry_url: (experimental) The base URL of the npm package registry. Must be a URL (e.g. start with "https://" or "http://") Default: "https://registry.npmjs.org"
|
387
|
+
:param npm_token_secret: (experimental) GitHub secret which contains the NPM token to use when publishing packages. Default: "NPM_TOKEN"
|
388
|
+
:param outdir: (experimental) The root directory of the project. Relative to this directory, all files are synthesized. If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other subprojects. Default: "."
|
389
|
+
:param package: (experimental) Defines a ``package`` task that will produce an npm tarball under the artifacts directory (e.g. ``dist``). Default: true
|
390
|
+
:param package_manager: (experimental) The Node Package Manager used to execute scripts. Default: NodePackageManager.YARN_CLASSIC
|
391
|
+
:param package_name: (experimental) The "name" in package.json. Default: - defaults to project name
|
392
|
+
:param parent: (experimental) The parent project, if this project is part of a bigger project.
|
393
|
+
:param peer_dependency_options: (experimental) Options for ``peerDeps``.
|
394
|
+
:param peer_deps: (experimental) Peer dependencies for this module. Dependencies listed here are required to be installed (and satisfied) by the *consumer* of this library. Using peer dependencies allows you to ensure that only a single module of a certain library exists in the ``node_modules`` tree of your consumers. Note that prior to npm@7, peer dependencies are *not* automatically installed, which means that adding peer dependencies to a library will be a breaking change for your customers. Unless ``peerDependencyOptions.pinnedDevDependency`` is disabled (it is enabled by default), projen will automatically add a dev dependency with a pinned version for each peer dependency. This will ensure that you build & test your module against the lowest peer version required. Default: []
|
395
|
+
:param pnpm_version: (experimental) The version of PNPM to use if using PNPM as a package manager. Default: "9"
|
396
|
+
:param post_build_steps: (experimental) Steps to execute after build as part of the release workflow. Default: []
|
397
|
+
:param prerelease: (experimental) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). Default: - normal semantic versions
|
398
|
+
:param prettier: (experimental) Setup prettier. Default: false
|
399
|
+
:param prettier_options: (experimental) Prettier options. Default: - default options
|
400
|
+
:param project_type: (deprecated) Which type of project this is (library/app). Default: ProjectType.UNKNOWN
|
401
|
+
:param projen_command: (experimental) The shell command to use in order to run the projen CLI. Can be used to customize in special environments. Default: "npx projen"
|
402
|
+
:param projen_credentials: (experimental) Choose a method of providing GitHub API access for projen workflows. Default: - use a personal access token named PROJEN_GITHUB_TOKEN
|
403
|
+
:param projen_dev_dependency: (experimental) Indicates of "projen" should be installed as a devDependency. Default: - true if not a subproject
|
404
|
+
:param projenrc_js: (experimental) Generate (once) .projenrc.js (in JavaScript). Set to ``false`` in order to disable .projenrc.js generation. Default: - true if projenrcJson is false
|
405
|
+
:param projenrc_json: (experimental) Generate (once) .projenrc.json (in JSON). Set to ``false`` in order to disable .projenrc.json generation. Default: false
|
406
|
+
:param projenrc_json_options: (experimental) Options for .projenrc.json. Default: - default options
|
407
|
+
:param projenrc_js_options: (experimental) Options for .projenrc.js. Default: - default options
|
408
|
+
:param projenrc_ts: (experimental) Use TypeScript for your projenrc file (``.projenrc.ts``). Default: false
|
409
|
+
:param projenrc_ts_options: (experimental) Options for .projenrc.ts.
|
410
|
+
:param projen_token_secret: (deprecated) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the ``repo``, ``workflows`` and ``packages`` scope. Default: "PROJEN_GITHUB_TOKEN"
|
411
|
+
:param projen_version: (experimental) Version of projen to install. Default: - Defaults to the latest version.
|
412
|
+
:param publish_dry_run: (experimental) Instead of actually publishing to package managers, just print the publishing command. Default: false
|
413
|
+
:param publish_tasks: (experimental) Define publishing tasks that can be executed manually as well as workflows. Normally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity. Default: false
|
414
|
+
:param pull_request_template: (experimental) Include a GitHub pull request template. Default: true
|
415
|
+
:param pull_request_template_contents: (experimental) The contents of the pull request template. Default: - default content
|
416
|
+
:param readme: Configuration of the README.md file.
|
417
|
+
:param releasable_commits: (experimental) Find commits that should be considered releasable Used to decide if a release is required. Default: ReleasableCommits.everyCommit()
|
418
|
+
:param release: (experimental) Add release management to this project. Default: - true (false for subprojects)
|
419
|
+
:param release_branches: (experimental) Defines additional release branches. A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch *must* be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the ``majorVersion`` field must also be provided for the default branch. Default: - no additional branches are used for release. you can use ``addBranch()`` to add additional branches.
|
420
|
+
:param release_every_commit: (deprecated) Automatically release new versions every commit to one of branches in ``releaseBranches``. Default: true
|
421
|
+
:param release_failure_issue: (experimental) Create a github issue on every failed publishing task. Default: false
|
422
|
+
:param release_failure_issue_label: (experimental) The label to apply to issues indicating publish failures. Only applies if ``releaseFailureIssue`` is true. Default: "failed-release"
|
423
|
+
:param release_schedule: (deprecated) CRON schedule to trigger new releases. Default: - no scheduled releases
|
424
|
+
:param release_tag_prefix: (experimental) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. Note: this prefix is used to detect the latest tagged version when bumping, so if you change this on a project with an existing version history, you may need to manually tag your latest release with the new prefix. Default: "v"
|
425
|
+
:param release_to_npm: (experimental) Automatically release to npm when new versions are introduced. Default: false
|
426
|
+
:param release_trigger: (experimental) The release trigger to use. Default: - Continuous releases (``ReleaseTrigger.continuous()``)
|
427
|
+
:param release_workflow: (deprecated) DEPRECATED: renamed to ``release``. Default: - true if not a subproject
|
428
|
+
:param release_workflow_name: (experimental) The name of the default release workflow. Default: "release"
|
429
|
+
:param release_workflow_setup_steps: (experimental) A set of workflow steps to execute in order to setup the workflow container.
|
430
|
+
:param renovatebot: (experimental) Use renovatebot to handle dependency upgrades. Default: false
|
431
|
+
:param renovatebot_options: (experimental) Options for renovatebot. Default: - default options
|
432
|
+
:param repository: (experimental) The repository is the location where the actual code for your package lives. See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository
|
433
|
+
:param repository_directory: (experimental) 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.
|
434
|
+
:param require_approval: (experimental) To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. Default: ApprovalLevel.BROADENING
|
435
|
+
:param sample_code: (experimental) Generate one-time sample in ``src/`` and ``test/`` if there are no files there. Default: true
|
436
|
+
:param scoped_packages_options: (experimental) Options for privately hosted scoped packages. Default: - fetch all scoped packages from the public npm registry
|
437
|
+
:param scripts: (deprecated) npm scripts to include. If a script has the same name as a standard script, the standard script will be overwritten. Also adds the script as a task. Default: {}
|
438
|
+
:param srcdir: (experimental) Typescript sources directory. Default: "src"
|
439
|
+
:param stability: (experimental) Package's Stability.
|
440
|
+
:param stale: (experimental) Auto-close of stale issues and pull request. See ``staleOptions`` for options. Default: false
|
441
|
+
:param stale_options: (experimental) Auto-close stale issues and pull requests. To disable set ``stale`` to ``false``. Default: - see defaults in ``StaleOptions``
|
442
|
+
:param testdir: (experimental) Jest tests directory. Tests files should be named ``xxx.test.ts``. If this directory is under ``srcdir`` (e.g. ``src/test``, ``src/__tests__``), then tests are going to be compiled into ``lib/`` and executed as javascript. If the test directory is outside of ``src``, then we configure jest to compile the code in-memory. Default: "test"
|
443
|
+
:param tsconfig: (experimental) Custom TSConfig. Default: - default options
|
444
|
+
:param tsconfig_dev: (experimental) Custom tsconfig options for the development tsconfig.json file (used for testing). Default: - use the production tsconfig options
|
445
|
+
:param tsconfig_dev_file: (experimental) The name of the development tsconfig.json file. Default: "tsconfig.dev.json"
|
446
|
+
:param ts_jest_options: (experimental) Options for ts-jest.
|
447
|
+
:param typescript_version: (experimental) TypeScript version to use. NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a ``~`` dependency (e.g. ``~1.2.3``). Default: "latest"
|
448
|
+
:param versionrc_options: (experimental) Custom configuration used when creating changelog with commit-and-tag-version package. Given values either append to default configuration or overwrite values in it. Default: - standard configuration applicable for GitHub repositories
|
449
|
+
:param vscode: (experimental) Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. Default: true
|
450
|
+
:param watch_excludes: (experimental) Glob patterns to exclude from ``cdk watch``. Default: []
|
451
|
+
:param watch_includes: (experimental) Glob patterns to include in ``cdk watch``. Default: []
|
452
|
+
:param workflow_bootstrap_steps: (experimental) Workflow steps to use in order to bootstrap this repo. Default: "yarn install --frozen-lockfile && yarn projen"
|
453
|
+
:param workflow_container_image: (experimental) Container image to use for GitHub workflows. Default: - default image
|
454
|
+
:param workflow_git_identity: (experimental) The git identity to use in workflows. Default: - GitHub Actions
|
455
|
+
:param workflow_node_version: (experimental) The node version used in GitHub Actions workflows. Always use this option if your GitHub Actions workflows require a specific to run. Default: - ``minNodeVersion`` if set, otherwise ``lts/*``.
|
456
|
+
:param workflow_package_cache: (experimental) Enable Node.js package cache in GitHub workflows. Default: false
|
457
|
+
:param workflow_runs_on: (experimental) Github Runner selection labels. Default: ["ubuntu-latest"]
|
458
|
+
:param workflow_runs_on_group: (experimental) Github Runner Group selection options.
|
459
|
+
:param yarn_berry_options: (experimental) Options for Yarn Berry. Default: - Yarn Berry v4 with all default options
|
460
|
+
'''
|
461
|
+
options = CdkTypeScriptAppOptions(
|
462
|
+
cdk_version=cdk_version,
|
463
|
+
code_owners=code_owners,
|
464
|
+
name=name,
|
465
|
+
allow_library_dependencies=allow_library_dependencies,
|
466
|
+
app_entrypoint=app_entrypoint,
|
467
|
+
artifacts_directory=artifacts_directory,
|
468
|
+
author_email=author_email,
|
469
|
+
author_name=author_name,
|
470
|
+
author_organization=author_organization,
|
471
|
+
author_url=author_url,
|
472
|
+
auto_approve_options=auto_approve_options,
|
473
|
+
auto_approve_upgrades=auto_approve_upgrades,
|
474
|
+
auto_detect_bin=auto_detect_bin,
|
475
|
+
auto_merge=auto_merge,
|
476
|
+
auto_merge_options=auto_merge_options,
|
477
|
+
bin=bin,
|
478
|
+
bugs_email=bugs_email,
|
479
|
+
bugs_url=bugs_url,
|
480
|
+
build_command=build_command,
|
481
|
+
build_workflow=build_workflow,
|
482
|
+
build_workflow_options=build_workflow_options,
|
483
|
+
build_workflow_triggers=build_workflow_triggers,
|
484
|
+
bump_package=bump_package,
|
485
|
+
bundled_deps=bundled_deps,
|
486
|
+
bundler_options=bundler_options,
|
487
|
+
bun_version=bun_version,
|
488
|
+
cdk_assert=cdk_assert,
|
489
|
+
cdk_assertions=cdk_assertions,
|
490
|
+
cdk_cli_version=cdk_cli_version,
|
491
|
+
cdk_dependencies=cdk_dependencies,
|
492
|
+
cdk_dependencies_as_deps=cdk_dependencies_as_deps,
|
493
|
+
cdkout=cdkout,
|
494
|
+
cdk_test_dependencies=cdk_test_dependencies,
|
495
|
+
cdk_version_pinning=cdk_version_pinning,
|
496
|
+
check_licenses=check_licenses,
|
497
|
+
clobber=clobber,
|
498
|
+
code_artifact_options=code_artifact_options,
|
499
|
+
code_cov=code_cov,
|
500
|
+
code_cov_token_secret=code_cov_token_secret,
|
501
|
+
commit_generated=commit_generated,
|
502
|
+
constructs_version=constructs_version,
|
503
|
+
context=context,
|
504
|
+
copyright_owner=copyright_owner,
|
505
|
+
copyright_period=copyright_period,
|
506
|
+
default_release_branch=default_release_branch,
|
507
|
+
dependabot=dependabot,
|
508
|
+
dependabot_options=dependabot_options,
|
509
|
+
deps=deps,
|
510
|
+
deps_upgrade=deps_upgrade,
|
511
|
+
deps_upgrade_options=deps_upgrade_options,
|
512
|
+
description=description,
|
513
|
+
dev_container=dev_container,
|
514
|
+
dev_deps=dev_deps,
|
515
|
+
disable_tsconfig=disable_tsconfig,
|
516
|
+
disable_tsconfig_dev=disable_tsconfig_dev,
|
517
|
+
docgen=docgen,
|
518
|
+
docs_directory=docs_directory,
|
519
|
+
edge_lambda_auto_discover=edge_lambda_auto_discover,
|
520
|
+
entrypoint=entrypoint,
|
521
|
+
entrypoint_types=entrypoint_types,
|
522
|
+
eslint=eslint,
|
523
|
+
eslint_options=eslint_options,
|
524
|
+
experimental_integ_runner=experimental_integ_runner,
|
525
|
+
feature_flags=feature_flags,
|
526
|
+
github=github,
|
527
|
+
github_options=github_options,
|
528
|
+
gitignore=gitignore,
|
529
|
+
git_ignore_options=git_ignore_options,
|
530
|
+
git_options=git_options,
|
531
|
+
gitpod=gitpod,
|
532
|
+
homepage=homepage,
|
533
|
+
integration_test_auto_discover=integration_test_auto_discover,
|
534
|
+
jest=jest,
|
535
|
+
jest_options=jest_options,
|
536
|
+
jsii_release_version=jsii_release_version,
|
537
|
+
keywords=keywords,
|
538
|
+
lambda_auto_discover=lambda_auto_discover,
|
539
|
+
lambda_extension_auto_discover=lambda_extension_auto_discover,
|
540
|
+
lambda_options=lambda_options,
|
541
|
+
libdir=libdir,
|
542
|
+
license=license,
|
543
|
+
licensed=licensed,
|
544
|
+
logging=logging,
|
545
|
+
major_version=major_version,
|
546
|
+
max_node_version=max_node_version,
|
547
|
+
mergify=mergify,
|
548
|
+
mergify_options=mergify_options,
|
549
|
+
min_major_version=min_major_version,
|
550
|
+
min_node_version=min_node_version,
|
551
|
+
mutable_build=mutable_build,
|
552
|
+
next_version_command=next_version_command,
|
553
|
+
npm_access=npm_access,
|
554
|
+
npm_dist_tag=npm_dist_tag,
|
555
|
+
npmignore=npmignore,
|
556
|
+
npmignore_enabled=npmignore_enabled,
|
557
|
+
npm_ignore_options=npm_ignore_options,
|
558
|
+
npm_provenance=npm_provenance,
|
559
|
+
npm_registry=npm_registry,
|
560
|
+
npm_registry_url=npm_registry_url,
|
561
|
+
npm_token_secret=npm_token_secret,
|
562
|
+
outdir=outdir,
|
563
|
+
package=package,
|
564
|
+
package_manager=package_manager,
|
565
|
+
package_name=package_name,
|
566
|
+
parent=parent,
|
567
|
+
peer_dependency_options=peer_dependency_options,
|
568
|
+
peer_deps=peer_deps,
|
569
|
+
pnpm_version=pnpm_version,
|
570
|
+
post_build_steps=post_build_steps,
|
571
|
+
prerelease=prerelease,
|
572
|
+
prettier=prettier,
|
573
|
+
prettier_options=prettier_options,
|
574
|
+
project_type=project_type,
|
575
|
+
projen_command=projen_command,
|
576
|
+
projen_credentials=projen_credentials,
|
577
|
+
projen_dev_dependency=projen_dev_dependency,
|
578
|
+
projenrc_js=projenrc_js,
|
579
|
+
projenrc_json=projenrc_json,
|
580
|
+
projenrc_json_options=projenrc_json_options,
|
581
|
+
projenrc_js_options=projenrc_js_options,
|
582
|
+
projenrc_ts=projenrc_ts,
|
583
|
+
projenrc_ts_options=projenrc_ts_options,
|
584
|
+
projen_token_secret=projen_token_secret,
|
585
|
+
projen_version=projen_version,
|
586
|
+
publish_dry_run=publish_dry_run,
|
587
|
+
publish_tasks=publish_tasks,
|
588
|
+
pull_request_template=pull_request_template,
|
589
|
+
pull_request_template_contents=pull_request_template_contents,
|
590
|
+
readme=readme,
|
591
|
+
releasable_commits=releasable_commits,
|
592
|
+
release=release,
|
593
|
+
release_branches=release_branches,
|
594
|
+
release_every_commit=release_every_commit,
|
595
|
+
release_failure_issue=release_failure_issue,
|
596
|
+
release_failure_issue_label=release_failure_issue_label,
|
597
|
+
release_schedule=release_schedule,
|
598
|
+
release_tag_prefix=release_tag_prefix,
|
599
|
+
release_to_npm=release_to_npm,
|
600
|
+
release_trigger=release_trigger,
|
601
|
+
release_workflow=release_workflow,
|
602
|
+
release_workflow_name=release_workflow_name,
|
603
|
+
release_workflow_setup_steps=release_workflow_setup_steps,
|
604
|
+
renovatebot=renovatebot,
|
605
|
+
renovatebot_options=renovatebot_options,
|
606
|
+
repository=repository,
|
607
|
+
repository_directory=repository_directory,
|
608
|
+
require_approval=require_approval,
|
609
|
+
sample_code=sample_code,
|
610
|
+
scoped_packages_options=scoped_packages_options,
|
611
|
+
scripts=scripts,
|
612
|
+
srcdir=srcdir,
|
613
|
+
stability=stability,
|
614
|
+
stale=stale,
|
615
|
+
stale_options=stale_options,
|
616
|
+
testdir=testdir,
|
617
|
+
tsconfig=tsconfig,
|
618
|
+
tsconfig_dev=tsconfig_dev,
|
619
|
+
tsconfig_dev_file=tsconfig_dev_file,
|
620
|
+
ts_jest_options=ts_jest_options,
|
621
|
+
typescript_version=typescript_version,
|
622
|
+
versionrc_options=versionrc_options,
|
623
|
+
vscode=vscode,
|
624
|
+
watch_excludes=watch_excludes,
|
625
|
+
watch_includes=watch_includes,
|
626
|
+
workflow_bootstrap_steps=workflow_bootstrap_steps,
|
627
|
+
workflow_container_image=workflow_container_image,
|
628
|
+
workflow_git_identity=workflow_git_identity,
|
629
|
+
workflow_node_version=workflow_node_version,
|
630
|
+
workflow_package_cache=workflow_package_cache,
|
631
|
+
workflow_runs_on=workflow_runs_on,
|
632
|
+
workflow_runs_on_group=workflow_runs_on_group,
|
633
|
+
yarn_berry_options=yarn_berry_options,
|
634
|
+
)
|
635
|
+
|
636
|
+
jsii.create(self.__class__, self, [options])
|
637
|
+
|
638
|
+
@builtins.property
|
639
|
+
@jsii.member(jsii_name="readme")
|
640
|
+
def readme(self) -> "Readme":
|
641
|
+
return typing.cast("Readme", jsii.get(self, "readme"))
|
642
|
+
|
643
|
+
@readme.setter
|
644
|
+
def readme(self, value: "Readme") -> None:
|
645
|
+
if __debug__:
|
646
|
+
type_hints = typing.get_type_hints(_typecheckingstub__a544530c4e440f72065d416ace5f306da46147589bc70a0f44ccba0553de9c78)
|
647
|
+
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
648
|
+
jsii.set(self, "readme", value) # pyright: ignore[reportArgumentType]
|
649
|
+
|
650
|
+
|
651
|
+
@jsii.data_type(
|
652
|
+
jsii_type="projen-modules.CdkTypeScriptAppOptions",
|
653
|
+
jsii_struct_bases=[],
|
654
|
+
name_mapping={
|
655
|
+
"cdk_version": "cdkVersion",
|
656
|
+
"code_owners": "codeOwners",
|
657
|
+
"name": "name",
|
658
|
+
"allow_library_dependencies": "allowLibraryDependencies",
|
659
|
+
"app_entrypoint": "appEntrypoint",
|
660
|
+
"artifacts_directory": "artifactsDirectory",
|
661
|
+
"author_email": "authorEmail",
|
662
|
+
"author_name": "authorName",
|
663
|
+
"author_organization": "authorOrganization",
|
664
|
+
"author_url": "authorUrl",
|
665
|
+
"auto_approve_options": "autoApproveOptions",
|
666
|
+
"auto_approve_upgrades": "autoApproveUpgrades",
|
667
|
+
"auto_detect_bin": "autoDetectBin",
|
668
|
+
"auto_merge": "autoMerge",
|
669
|
+
"auto_merge_options": "autoMergeOptions",
|
670
|
+
"bin": "bin",
|
671
|
+
"bugs_email": "bugsEmail",
|
672
|
+
"bugs_url": "bugsUrl",
|
673
|
+
"build_command": "buildCommand",
|
674
|
+
"build_workflow": "buildWorkflow",
|
675
|
+
"build_workflow_options": "buildWorkflowOptions",
|
676
|
+
"build_workflow_triggers": "buildWorkflowTriggers",
|
677
|
+
"bump_package": "bumpPackage",
|
678
|
+
"bundled_deps": "bundledDeps",
|
679
|
+
"bundler_options": "bundlerOptions",
|
680
|
+
"bun_version": "bunVersion",
|
681
|
+
"cdk_assert": "cdkAssert",
|
682
|
+
"cdk_assertions": "cdkAssertions",
|
683
|
+
"cdk_cli_version": "cdkCliVersion",
|
684
|
+
"cdk_dependencies": "cdkDependencies",
|
685
|
+
"cdk_dependencies_as_deps": "cdkDependenciesAsDeps",
|
686
|
+
"cdkout": "cdkout",
|
687
|
+
"cdk_test_dependencies": "cdkTestDependencies",
|
688
|
+
"cdk_version_pinning": "cdkVersionPinning",
|
689
|
+
"check_licenses": "checkLicenses",
|
690
|
+
"clobber": "clobber",
|
691
|
+
"code_artifact_options": "codeArtifactOptions",
|
692
|
+
"code_cov": "codeCov",
|
693
|
+
"code_cov_token_secret": "codeCovTokenSecret",
|
694
|
+
"commit_generated": "commitGenerated",
|
695
|
+
"constructs_version": "constructsVersion",
|
696
|
+
"context": "context",
|
697
|
+
"copyright_owner": "copyrightOwner",
|
698
|
+
"copyright_period": "copyrightPeriod",
|
699
|
+
"default_release_branch": "defaultReleaseBranch",
|
700
|
+
"dependabot": "dependabot",
|
701
|
+
"dependabot_options": "dependabotOptions",
|
702
|
+
"deps": "deps",
|
703
|
+
"deps_upgrade": "depsUpgrade",
|
704
|
+
"deps_upgrade_options": "depsUpgradeOptions",
|
705
|
+
"description": "description",
|
706
|
+
"dev_container": "devContainer",
|
707
|
+
"dev_deps": "devDeps",
|
708
|
+
"disable_tsconfig": "disableTsconfig",
|
709
|
+
"disable_tsconfig_dev": "disableTsconfigDev",
|
710
|
+
"docgen": "docgen",
|
711
|
+
"docs_directory": "docsDirectory",
|
712
|
+
"edge_lambda_auto_discover": "edgeLambdaAutoDiscover",
|
713
|
+
"entrypoint": "entrypoint",
|
714
|
+
"entrypoint_types": "entrypointTypes",
|
715
|
+
"eslint": "eslint",
|
716
|
+
"eslint_options": "eslintOptions",
|
717
|
+
"experimental_integ_runner": "experimentalIntegRunner",
|
718
|
+
"feature_flags": "featureFlags",
|
719
|
+
"github": "github",
|
720
|
+
"github_options": "githubOptions",
|
721
|
+
"gitignore": "gitignore",
|
722
|
+
"git_ignore_options": "gitIgnoreOptions",
|
723
|
+
"git_options": "gitOptions",
|
724
|
+
"gitpod": "gitpod",
|
725
|
+
"homepage": "homepage",
|
726
|
+
"integration_test_auto_discover": "integrationTestAutoDiscover",
|
727
|
+
"jest": "jest",
|
728
|
+
"jest_options": "jestOptions",
|
729
|
+
"jsii_release_version": "jsiiReleaseVersion",
|
730
|
+
"keywords": "keywords",
|
731
|
+
"lambda_auto_discover": "lambdaAutoDiscover",
|
732
|
+
"lambda_extension_auto_discover": "lambdaExtensionAutoDiscover",
|
733
|
+
"lambda_options": "lambdaOptions",
|
734
|
+
"libdir": "libdir",
|
735
|
+
"license": "license",
|
736
|
+
"licensed": "licensed",
|
737
|
+
"logging": "logging",
|
738
|
+
"major_version": "majorVersion",
|
739
|
+
"max_node_version": "maxNodeVersion",
|
740
|
+
"mergify": "mergify",
|
741
|
+
"mergify_options": "mergifyOptions",
|
742
|
+
"min_major_version": "minMajorVersion",
|
743
|
+
"min_node_version": "minNodeVersion",
|
744
|
+
"mutable_build": "mutableBuild",
|
745
|
+
"next_version_command": "nextVersionCommand",
|
746
|
+
"npm_access": "npmAccess",
|
747
|
+
"npm_dist_tag": "npmDistTag",
|
748
|
+
"npmignore": "npmignore",
|
749
|
+
"npmignore_enabled": "npmignoreEnabled",
|
750
|
+
"npm_ignore_options": "npmIgnoreOptions",
|
751
|
+
"npm_provenance": "npmProvenance",
|
752
|
+
"npm_registry": "npmRegistry",
|
753
|
+
"npm_registry_url": "npmRegistryUrl",
|
754
|
+
"npm_token_secret": "npmTokenSecret",
|
755
|
+
"outdir": "outdir",
|
756
|
+
"package": "package",
|
757
|
+
"package_manager": "packageManager",
|
758
|
+
"package_name": "packageName",
|
759
|
+
"parent": "parent",
|
760
|
+
"peer_dependency_options": "peerDependencyOptions",
|
761
|
+
"peer_deps": "peerDeps",
|
762
|
+
"pnpm_version": "pnpmVersion",
|
763
|
+
"post_build_steps": "postBuildSteps",
|
764
|
+
"prerelease": "prerelease",
|
765
|
+
"prettier": "prettier",
|
766
|
+
"prettier_options": "prettierOptions",
|
767
|
+
"project_type": "projectType",
|
768
|
+
"projen_command": "projenCommand",
|
769
|
+
"projen_credentials": "projenCredentials",
|
770
|
+
"projen_dev_dependency": "projenDevDependency",
|
771
|
+
"projenrc_js": "projenrcJs",
|
772
|
+
"projenrc_json": "projenrcJson",
|
773
|
+
"projenrc_json_options": "projenrcJsonOptions",
|
774
|
+
"projenrc_js_options": "projenrcJsOptions",
|
775
|
+
"projenrc_ts": "projenrcTs",
|
776
|
+
"projenrc_ts_options": "projenrcTsOptions",
|
777
|
+
"projen_token_secret": "projenTokenSecret",
|
778
|
+
"projen_version": "projenVersion",
|
779
|
+
"publish_dry_run": "publishDryRun",
|
780
|
+
"publish_tasks": "publishTasks",
|
781
|
+
"pull_request_template": "pullRequestTemplate",
|
782
|
+
"pull_request_template_contents": "pullRequestTemplateContents",
|
783
|
+
"readme": "readme",
|
784
|
+
"releasable_commits": "releasableCommits",
|
785
|
+
"release": "release",
|
786
|
+
"release_branches": "releaseBranches",
|
787
|
+
"release_every_commit": "releaseEveryCommit",
|
788
|
+
"release_failure_issue": "releaseFailureIssue",
|
789
|
+
"release_failure_issue_label": "releaseFailureIssueLabel",
|
790
|
+
"release_schedule": "releaseSchedule",
|
791
|
+
"release_tag_prefix": "releaseTagPrefix",
|
792
|
+
"release_to_npm": "releaseToNpm",
|
793
|
+
"release_trigger": "releaseTrigger",
|
794
|
+
"release_workflow": "releaseWorkflow",
|
795
|
+
"release_workflow_name": "releaseWorkflowName",
|
796
|
+
"release_workflow_setup_steps": "releaseWorkflowSetupSteps",
|
797
|
+
"renovatebot": "renovatebot",
|
798
|
+
"renovatebot_options": "renovatebotOptions",
|
799
|
+
"repository": "repository",
|
800
|
+
"repository_directory": "repositoryDirectory",
|
801
|
+
"require_approval": "requireApproval",
|
802
|
+
"sample_code": "sampleCode",
|
803
|
+
"scoped_packages_options": "scopedPackagesOptions",
|
804
|
+
"scripts": "scripts",
|
805
|
+
"srcdir": "srcdir",
|
806
|
+
"stability": "stability",
|
807
|
+
"stale": "stale",
|
808
|
+
"stale_options": "staleOptions",
|
809
|
+
"testdir": "testdir",
|
810
|
+
"tsconfig": "tsconfig",
|
811
|
+
"tsconfig_dev": "tsconfigDev",
|
812
|
+
"tsconfig_dev_file": "tsconfigDevFile",
|
813
|
+
"ts_jest_options": "tsJestOptions",
|
814
|
+
"typescript_version": "typescriptVersion",
|
815
|
+
"versionrc_options": "versionrcOptions",
|
816
|
+
"vscode": "vscode",
|
817
|
+
"watch_excludes": "watchExcludes",
|
818
|
+
"watch_includes": "watchIncludes",
|
819
|
+
"workflow_bootstrap_steps": "workflowBootstrapSteps",
|
820
|
+
"workflow_container_image": "workflowContainerImage",
|
821
|
+
"workflow_git_identity": "workflowGitIdentity",
|
822
|
+
"workflow_node_version": "workflowNodeVersion",
|
823
|
+
"workflow_package_cache": "workflowPackageCache",
|
824
|
+
"workflow_runs_on": "workflowRunsOn",
|
825
|
+
"workflow_runs_on_group": "workflowRunsOnGroup",
|
826
|
+
"yarn_berry_options": "yarnBerryOptions",
|
827
|
+
},
|
828
|
+
)
|
829
|
+
class CdkTypeScriptAppOptions:
|
830
|
+
def __init__(
|
831
|
+
self,
|
832
|
+
*,
|
833
|
+
cdk_version: builtins.str,
|
834
|
+
code_owners: typing.Sequence[builtins.str],
|
835
|
+
name: builtins.str,
|
836
|
+
allow_library_dependencies: typing.Optional[builtins.bool] = None,
|
837
|
+
app_entrypoint: typing.Optional[builtins.str] = None,
|
838
|
+
artifacts_directory: typing.Optional[builtins.str] = None,
|
839
|
+
author_email: typing.Optional[builtins.str] = None,
|
840
|
+
author_name: typing.Optional[builtins.str] = None,
|
841
|
+
author_organization: typing.Optional[builtins.bool] = None,
|
842
|
+
author_url: typing.Optional[builtins.str] = None,
|
843
|
+
auto_approve_options: typing.Optional[typing.Union[_projen_github_04054675.AutoApproveOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
844
|
+
auto_approve_upgrades: typing.Optional[builtins.bool] = None,
|
845
|
+
auto_detect_bin: typing.Optional[builtins.bool] = None,
|
846
|
+
auto_merge: typing.Optional[builtins.bool] = None,
|
847
|
+
auto_merge_options: typing.Optional[typing.Union[_projen_github_04054675.AutoMergeOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
848
|
+
bin: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
849
|
+
bugs_email: typing.Optional[builtins.str] = None,
|
850
|
+
bugs_url: typing.Optional[builtins.str] = None,
|
851
|
+
build_command: typing.Optional[builtins.str] = None,
|
852
|
+
build_workflow: typing.Optional[builtins.bool] = None,
|
853
|
+
build_workflow_options: typing.Optional[typing.Union[_projen_javascript_04054675.BuildWorkflowOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
854
|
+
build_workflow_triggers: typing.Optional[typing.Union[_projen_github_workflows_04054675.Triggers, typing.Dict[builtins.str, typing.Any]]] = None,
|
855
|
+
bump_package: typing.Optional[builtins.str] = None,
|
856
|
+
bundled_deps: typing.Optional[typing.Sequence[builtins.str]] = None,
|
857
|
+
bundler_options: typing.Optional[typing.Union[_projen_javascript_04054675.BundlerOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
858
|
+
bun_version: typing.Optional[builtins.str] = None,
|
859
|
+
cdk_assert: typing.Optional[builtins.bool] = None,
|
860
|
+
cdk_assertions: typing.Optional[builtins.bool] = None,
|
861
|
+
cdk_cli_version: typing.Optional[builtins.str] = None,
|
862
|
+
cdk_dependencies: typing.Optional[typing.Sequence[builtins.str]] = None,
|
863
|
+
cdk_dependencies_as_deps: typing.Optional[builtins.bool] = None,
|
864
|
+
cdkout: typing.Optional[builtins.str] = None,
|
865
|
+
cdk_test_dependencies: typing.Optional[typing.Sequence[builtins.str]] = None,
|
866
|
+
cdk_version_pinning: typing.Optional[builtins.bool] = None,
|
867
|
+
check_licenses: typing.Optional[typing.Union[_projen_javascript_04054675.LicenseCheckerOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
868
|
+
clobber: typing.Optional[builtins.bool] = None,
|
869
|
+
code_artifact_options: typing.Optional[typing.Union[_projen_javascript_04054675.CodeArtifactOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
870
|
+
code_cov: typing.Optional[builtins.bool] = None,
|
871
|
+
code_cov_token_secret: typing.Optional[builtins.str] = None,
|
872
|
+
commit_generated: typing.Optional[builtins.bool] = None,
|
873
|
+
constructs_version: typing.Optional[builtins.str] = None,
|
874
|
+
context: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
|
875
|
+
copyright_owner: typing.Optional[builtins.str] = None,
|
876
|
+
copyright_period: typing.Optional[builtins.str] = None,
|
877
|
+
default_release_branch: typing.Optional[builtins.str] = None,
|
878
|
+
dependabot: typing.Optional[builtins.bool] = None,
|
879
|
+
dependabot_options: typing.Optional[typing.Union[_projen_github_04054675.DependabotOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
880
|
+
deps: typing.Optional[typing.Sequence[builtins.str]] = None,
|
881
|
+
deps_upgrade: typing.Optional[builtins.bool] = None,
|
882
|
+
deps_upgrade_options: typing.Optional[typing.Union[_projen_javascript_04054675.UpgradeDependenciesOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
883
|
+
description: typing.Optional[builtins.str] = None,
|
884
|
+
dev_container: typing.Optional[builtins.bool] = None,
|
885
|
+
dev_deps: typing.Optional[typing.Sequence[builtins.str]] = None,
|
886
|
+
disable_tsconfig: typing.Optional[builtins.bool] = None,
|
887
|
+
disable_tsconfig_dev: typing.Optional[builtins.bool] = None,
|
888
|
+
docgen: typing.Optional[builtins.bool] = None,
|
889
|
+
docs_directory: typing.Optional[builtins.str] = None,
|
890
|
+
edge_lambda_auto_discover: typing.Optional[builtins.bool] = None,
|
891
|
+
entrypoint: typing.Optional[builtins.str] = None,
|
892
|
+
entrypoint_types: typing.Optional[builtins.str] = None,
|
893
|
+
eslint: typing.Optional[builtins.bool] = None,
|
894
|
+
eslint_options: typing.Optional[typing.Union[_projen_javascript_04054675.EslintOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
895
|
+
experimental_integ_runner: typing.Optional[builtins.bool] = None,
|
896
|
+
feature_flags: typing.Optional[builtins.bool] = None,
|
897
|
+
github: typing.Optional[builtins.bool] = None,
|
898
|
+
github_options: typing.Optional[typing.Union[_projen_github_04054675.GitHubOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
899
|
+
gitignore: typing.Optional[typing.Sequence[builtins.str]] = None,
|
900
|
+
git_ignore_options: typing.Optional[typing.Union[_projen_04054675.IgnoreFileOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
901
|
+
git_options: typing.Optional[typing.Union[_projen_04054675.GitOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
902
|
+
gitpod: typing.Optional[builtins.bool] = None,
|
903
|
+
homepage: typing.Optional[builtins.str] = None,
|
904
|
+
integration_test_auto_discover: typing.Optional[builtins.bool] = None,
|
905
|
+
jest: typing.Optional[builtins.bool] = None,
|
906
|
+
jest_options: typing.Optional[typing.Union[_projen_javascript_04054675.JestOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
907
|
+
jsii_release_version: typing.Optional[builtins.str] = None,
|
908
|
+
keywords: typing.Optional[typing.Sequence[builtins.str]] = None,
|
909
|
+
lambda_auto_discover: typing.Optional[builtins.bool] = None,
|
910
|
+
lambda_extension_auto_discover: typing.Optional[builtins.bool] = None,
|
911
|
+
lambda_options: typing.Optional[typing.Union[_projen_awscdk_04054675.LambdaFunctionCommonOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
912
|
+
libdir: typing.Optional[builtins.str] = None,
|
913
|
+
license: typing.Optional[builtins.str] = None,
|
914
|
+
licensed: typing.Optional[builtins.bool] = None,
|
915
|
+
logging: typing.Optional[typing.Union[_projen_04054675.LoggerOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
916
|
+
major_version: typing.Optional[jsii.Number] = None,
|
917
|
+
max_node_version: typing.Optional[builtins.str] = None,
|
918
|
+
mergify: typing.Optional[builtins.bool] = None,
|
919
|
+
mergify_options: typing.Optional[typing.Union[_projen_github_04054675.MergifyOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
920
|
+
min_major_version: typing.Optional[jsii.Number] = None,
|
921
|
+
min_node_version: typing.Optional[builtins.str] = None,
|
922
|
+
mutable_build: typing.Optional[builtins.bool] = None,
|
923
|
+
next_version_command: typing.Optional[builtins.str] = None,
|
924
|
+
npm_access: typing.Optional[_projen_javascript_04054675.NpmAccess] = None,
|
925
|
+
npm_dist_tag: typing.Optional[builtins.str] = None,
|
926
|
+
npmignore: typing.Optional[typing.Sequence[builtins.str]] = None,
|
927
|
+
npmignore_enabled: typing.Optional[builtins.bool] = None,
|
928
|
+
npm_ignore_options: typing.Optional[typing.Union[_projen_04054675.IgnoreFileOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
929
|
+
npm_provenance: typing.Optional[builtins.bool] = None,
|
930
|
+
npm_registry: typing.Optional[builtins.str] = None,
|
931
|
+
npm_registry_url: typing.Optional[builtins.str] = None,
|
932
|
+
npm_token_secret: typing.Optional[builtins.str] = None,
|
933
|
+
outdir: typing.Optional[builtins.str] = None,
|
934
|
+
package: typing.Optional[builtins.bool] = None,
|
935
|
+
package_manager: typing.Optional[_projen_javascript_04054675.NodePackageManager] = None,
|
936
|
+
package_name: typing.Optional[builtins.str] = None,
|
937
|
+
parent: typing.Optional[_projen_04054675.Project] = None,
|
938
|
+
peer_dependency_options: typing.Optional[typing.Union[_projen_javascript_04054675.PeerDependencyOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
939
|
+
peer_deps: typing.Optional[typing.Sequence[builtins.str]] = None,
|
940
|
+
pnpm_version: typing.Optional[builtins.str] = None,
|
941
|
+
post_build_steps: typing.Optional[typing.Sequence[typing.Union[_projen_github_workflows_04054675.JobStep, typing.Dict[builtins.str, typing.Any]]]] = None,
|
942
|
+
prerelease: typing.Optional[builtins.str] = None,
|
943
|
+
prettier: typing.Optional[builtins.bool] = None,
|
944
|
+
prettier_options: typing.Optional[typing.Union[_projen_javascript_04054675.PrettierOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
945
|
+
project_type: typing.Optional[_projen_04054675.ProjectType] = None,
|
946
|
+
projen_command: typing.Optional[builtins.str] = None,
|
947
|
+
projen_credentials: typing.Optional[_projen_github_04054675.GithubCredentials] = None,
|
948
|
+
projen_dev_dependency: typing.Optional[builtins.bool] = None,
|
949
|
+
projenrc_js: typing.Optional[builtins.bool] = None,
|
950
|
+
projenrc_json: typing.Optional[builtins.bool] = None,
|
951
|
+
projenrc_json_options: typing.Optional[typing.Union[_projen_04054675.ProjenrcJsonOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
952
|
+
projenrc_js_options: typing.Optional[typing.Union[_projen_javascript_04054675.ProjenrcOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
953
|
+
projenrc_ts: typing.Optional[builtins.bool] = None,
|
954
|
+
projenrc_ts_options: typing.Optional[typing.Union[_projen_typescript_04054675.ProjenrcOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
955
|
+
projen_token_secret: typing.Optional[builtins.str] = None,
|
956
|
+
projen_version: typing.Optional[builtins.str] = None,
|
957
|
+
publish_dry_run: typing.Optional[builtins.bool] = None,
|
958
|
+
publish_tasks: typing.Optional[builtins.bool] = None,
|
959
|
+
pull_request_template: typing.Optional[builtins.bool] = None,
|
960
|
+
pull_request_template_contents: typing.Optional[typing.Sequence[builtins.str]] = None,
|
961
|
+
readme: typing.Optional[typing.Union["ReadmeOptions", typing.Dict[builtins.str, typing.Any]]] = None,
|
962
|
+
releasable_commits: typing.Optional[_projen_04054675.ReleasableCommits] = None,
|
963
|
+
release: typing.Optional[builtins.bool] = None,
|
964
|
+
release_branches: typing.Optional[typing.Mapping[builtins.str, typing.Union[_projen_release_04054675.BranchOptions, typing.Dict[builtins.str, typing.Any]]]] = None,
|
965
|
+
release_every_commit: typing.Optional[builtins.bool] = None,
|
966
|
+
release_failure_issue: typing.Optional[builtins.bool] = None,
|
967
|
+
release_failure_issue_label: typing.Optional[builtins.str] = None,
|
968
|
+
release_schedule: typing.Optional[builtins.str] = None,
|
969
|
+
release_tag_prefix: typing.Optional[builtins.str] = None,
|
970
|
+
release_to_npm: typing.Optional[builtins.bool] = None,
|
971
|
+
release_trigger: typing.Optional[_projen_release_04054675.ReleaseTrigger] = None,
|
972
|
+
release_workflow: typing.Optional[builtins.bool] = None,
|
973
|
+
release_workflow_name: typing.Optional[builtins.str] = None,
|
974
|
+
release_workflow_setup_steps: typing.Optional[typing.Sequence[typing.Union[_projen_github_workflows_04054675.JobStep, typing.Dict[builtins.str, typing.Any]]]] = None,
|
975
|
+
renovatebot: typing.Optional[builtins.bool] = None,
|
976
|
+
renovatebot_options: typing.Optional[typing.Union[_projen_04054675.RenovatebotOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
977
|
+
repository: typing.Optional[builtins.str] = None,
|
978
|
+
repository_directory: typing.Optional[builtins.str] = None,
|
979
|
+
require_approval: typing.Optional[_projen_awscdk_04054675.ApprovalLevel] = None,
|
980
|
+
sample_code: typing.Optional[builtins.bool] = None,
|
981
|
+
scoped_packages_options: typing.Optional[typing.Sequence[typing.Union[_projen_javascript_04054675.ScopedPackagesOptions, typing.Dict[builtins.str, typing.Any]]]] = None,
|
982
|
+
scripts: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
983
|
+
srcdir: typing.Optional[builtins.str] = None,
|
984
|
+
stability: typing.Optional[builtins.str] = None,
|
985
|
+
stale: typing.Optional[builtins.bool] = None,
|
986
|
+
stale_options: typing.Optional[typing.Union[_projen_github_04054675.StaleOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
987
|
+
testdir: typing.Optional[builtins.str] = None,
|
988
|
+
tsconfig: typing.Optional[typing.Union[_projen_javascript_04054675.TypescriptConfigOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
989
|
+
tsconfig_dev: typing.Optional[typing.Union[_projen_javascript_04054675.TypescriptConfigOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
990
|
+
tsconfig_dev_file: typing.Optional[builtins.str] = None,
|
991
|
+
ts_jest_options: typing.Optional[typing.Union[_projen_typescript_04054675.TsJestOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
992
|
+
typescript_version: typing.Optional[builtins.str] = None,
|
993
|
+
versionrc_options: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
|
994
|
+
vscode: typing.Optional[builtins.bool] = None,
|
995
|
+
watch_excludes: typing.Optional[typing.Sequence[builtins.str]] = None,
|
996
|
+
watch_includes: typing.Optional[typing.Sequence[builtins.str]] = None,
|
997
|
+
workflow_bootstrap_steps: typing.Optional[typing.Sequence[typing.Union[_projen_github_workflows_04054675.JobStep, typing.Dict[builtins.str, typing.Any]]]] = None,
|
998
|
+
workflow_container_image: typing.Optional[builtins.str] = None,
|
999
|
+
workflow_git_identity: typing.Optional[typing.Union[_projen_github_04054675.GitIdentity, typing.Dict[builtins.str, typing.Any]]] = None,
|
1000
|
+
workflow_node_version: typing.Optional[builtins.str] = None,
|
1001
|
+
workflow_package_cache: typing.Optional[builtins.bool] = None,
|
1002
|
+
workflow_runs_on: typing.Optional[typing.Sequence[builtins.str]] = None,
|
1003
|
+
workflow_runs_on_group: typing.Optional[typing.Union[_projen_04054675.GroupRunnerOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
1004
|
+
yarn_berry_options: typing.Optional[typing.Union[_projen_javascript_04054675.YarnBerryOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
1005
|
+
) -> None:
|
1006
|
+
'''CdkTypeScriptAppOptions.
|
1007
|
+
|
1008
|
+
:param cdk_version: (experimental) Minimum version of the AWS CDK to depend on. Default: "2.1.0"
|
1009
|
+
:param code_owners: List of teams used to generate the CODEOWNERS file.
|
1010
|
+
:param name: (experimental) This is the name of your project. Default: $BASEDIR
|
1011
|
+
:param allow_library_dependencies: (experimental) Allow the project to include ``peerDependencies`` and ``bundledDependencies``. This is normally only allowed for libraries. For apps, there's no meaning for specifying these. Default: true
|
1012
|
+
:param app_entrypoint: (experimental) The CDK app's entrypoint (relative to the source directory, which is "src" by default). Default: "main.ts"
|
1013
|
+
:param artifacts_directory: (experimental) A directory which will contain build artifacts. Default: "dist"
|
1014
|
+
:param author_email: (experimental) Author's e-mail.
|
1015
|
+
:param author_name: (experimental) Author's name.
|
1016
|
+
:param author_organization: (experimental) Is the author an organization.
|
1017
|
+
:param author_url: (experimental) Author's URL / Website.
|
1018
|
+
:param auto_approve_options: (experimental) Enable and configure the 'auto approve' workflow. Default: - auto approve is disabled
|
1019
|
+
:param auto_approve_upgrades: (experimental) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). Throw if set to true but ``autoApproveOptions`` are not defined. Default: - true
|
1020
|
+
:param auto_detect_bin: (experimental) Automatically add all executables under the ``bin`` directory to your ``package.json`` file under the ``bin`` section. Default: true
|
1021
|
+
:param auto_merge: (experimental) Enable automatic merging on GitHub. Has no effect if ``github.mergify`` is set to false. Default: true
|
1022
|
+
:param auto_merge_options: (experimental) Configure options for automatic merging on GitHub. Has no effect if ``github.mergify`` or ``autoMerge`` is set to false. Default: - see defaults in ``AutoMergeOptions``
|
1023
|
+
:param bin: (experimental) Binary programs vended with your module. You can use this option to add/customize how binaries are represented in your ``package.json``, but unless ``autoDetectBin`` is ``false``, every executable file under ``bin`` will automatically be added to this section.
|
1024
|
+
:param bugs_email: (experimental) The email address to which issues should be reported.
|
1025
|
+
:param bugs_url: (experimental) The url to your project's issue tracker.
|
1026
|
+
:param build_command: (experimental) A command to execute before synthesis. This command will be called when running ``cdk synth`` or when ``cdk watch`` identifies a change in your source code before redeployment. Default: - no build command
|
1027
|
+
:param build_workflow: (experimental) Define a GitHub workflow for building PRs. Default: - true if not a subproject
|
1028
|
+
:param build_workflow_options: (experimental) Options for PR build workflow.
|
1029
|
+
:param build_workflow_triggers: (deprecated) Build workflow triggers. Default: "{ pullRequest: {}, workflowDispatch: {} }"
|
1030
|
+
:param bump_package: (experimental) The ``commit-and-tag-version`` compatible package used to bump the package version, as a dependency string. This can be any compatible package version, including the deprecated ``standard-version@9``. Default: - A recent version of "commit-and-tag-version"
|
1031
|
+
:param bundled_deps: (experimental) List of dependencies to bundle into this module. These modules will be added both to the ``dependencies`` section and ``bundledDependencies`` section of your ``package.json``. The recommendation is to only specify the module name here (e.g. ``express``). This will behave similar to ``yarn add`` or ``npm install`` in the sense that it will add the module as a dependency to your ``package.json`` file with the latest version (``^``). You can specify semver requirements in the same syntax passed to ``npm i`` or ``yarn add`` (e.g. ``express@^2``) and this will be what you ``package.json`` will eventually include.
|
1032
|
+
:param bundler_options: (experimental) Options for ``Bundler``.
|
1033
|
+
:param bun_version: (experimental) The version of Bun to use if using Bun as a package manager. Default: "latest"
|
1034
|
+
:param cdk_assert: (deprecated) Warning: NodeJS only. Install the Default: - will be included by default for AWS CDK >= 1.0.0 < 2.0.0
|
1035
|
+
:param cdk_assertions: (experimental) Install the assertions library? Only needed for CDK 1.x. If using CDK 2.x then assertions is already included in 'aws-cdk-lib' Default: - will be included by default for AWS CDK >= 1.111.0 < 2.0.0
|
1036
|
+
:param cdk_cli_version: (experimental) Version range of the AWS CDK CLI to depend on. Can be either a specific version, or an NPM version range. By default, the latest 2.x version will be installed; you can use this option to restrict it to a specific version or version range. Default: "^2"
|
1037
|
+
:param cdk_dependencies: (deprecated) Which AWS CDKv1 modules this project requires.
|
1038
|
+
:param cdk_dependencies_as_deps: (deprecated) If this is enabled (default), all modules declared in ``cdkDependencies`` will be also added as normal ``dependencies`` (as well as ``peerDependencies``). This is to ensure that downstream consumers actually have your CDK dependencies installed when using npm < 7 or yarn, where peer dependencies are not automatically installed. If this is disabled, ``cdkDependencies`` will be added to ``devDependencies`` to ensure they are present during development. Note: this setting only applies to construct library projects Default: true
|
1039
|
+
:param cdkout: (experimental) cdk.out directory. Default: "cdk.out"
|
1040
|
+
:param cdk_test_dependencies: (deprecated) AWS CDK modules required for testing.
|
1041
|
+
:param cdk_version_pinning: (experimental) Use pinned version instead of caret version for CDK. You can use this to prevent mixed versions for your CDK dependencies and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.
|
1042
|
+
:param check_licenses: (experimental) Configure which licenses should be deemed acceptable for use by dependencies. This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered. Default: - no license checks are run during the build and all licenses will be accepted
|
1043
|
+
:param clobber: (experimental) Add a ``clobber`` task which resets the repo to origin. Default: - true, but false for subprojects
|
1044
|
+
:param code_artifact_options: (experimental) Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact Default: - undefined
|
1045
|
+
:param code_cov: (experimental) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with ``@codeCovTokenSecret``. Default: false
|
1046
|
+
:param code_cov_token_secret: (experimental) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. Default: - if this option is not specified, only public repositories are supported
|
1047
|
+
:param commit_generated: (experimental) Whether to commit the managed files by default. Default: true
|
1048
|
+
:param constructs_version: (experimental) Minimum version of the ``constructs`` library to depend on. Default: - for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
|
1049
|
+
:param context: (experimental) Additional context to include in ``cdk.json``. Default: - no additional context
|
1050
|
+
:param copyright_owner: (experimental) License copyright owner. Default: - defaults to the value of authorName or "" if ``authorName`` is undefined.
|
1051
|
+
:param copyright_period: (experimental) The copyright years to put in the LICENSE file. Default: - current year
|
1052
|
+
:param default_release_branch: (experimental) The name of the main release branch. Default: "main"
|
1053
|
+
:param dependabot: (experimental) Use dependabot to handle dependency upgrades. Cannot be used in conjunction with ``depsUpgrade``. Default: false
|
1054
|
+
:param dependabot_options: (experimental) Options for dependabot. Default: - default options
|
1055
|
+
:param deps: (experimental) Runtime dependencies of this module. The recommendation is to only specify the module name here (e.g. ``express``). This will behave similar to ``yarn add`` or ``npm install`` in the sense that it will add the module as a dependency to your ``package.json`` file with the latest version (``^``). You can specify semver requirements in the same syntax passed to ``npm i`` or ``yarn add`` (e.g. ``express@^2``) and this will be what you ``package.json`` will eventually include. Default: []
|
1056
|
+
:param deps_upgrade: (experimental) Use tasks and github workflows to handle dependency upgrades. Cannot be used in conjunction with ``dependabot``. Default: true
|
1057
|
+
:param deps_upgrade_options: (experimental) Options for ``UpgradeDependencies``. Default: - default options
|
1058
|
+
:param description: (experimental) The description is just a string that helps people understand the purpose of the package. It can be used when searching for packages in a package manager as well. See https://classic.yarnpkg.com/en/docs/package-json/#toc-description
|
1059
|
+
:param dev_container: (experimental) Add a VSCode development environment (used for GitHub Codespaces). Default: false
|
1060
|
+
:param dev_deps: (experimental) Build dependencies for this module. These dependencies will only be available in your build environment but will not be fetched when this module is consumed. The recommendation is to only specify the module name here (e.g. ``express``). This will behave similar to ``yarn add`` or ``npm install`` in the sense that it will add the module as a dependency to your ``package.json`` file with the latest version (``^``). You can specify semver requirements in the same syntax passed to ``npm i`` or ``yarn add`` (e.g. ``express@^2``) and this will be what you ``package.json`` will eventually include. Default: []
|
1061
|
+
:param disable_tsconfig: (experimental) Do not generate a ``tsconfig.json`` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). Default: false
|
1062
|
+
:param disable_tsconfig_dev: (experimental) Do not generate a ``tsconfig.dev.json`` file. Default: false
|
1063
|
+
:param docgen: (experimental) Docgen by Typedoc. Default: false
|
1064
|
+
:param docs_directory: (experimental) Docs directory. Default: "docs"
|
1065
|
+
:param edge_lambda_auto_discover: (experimental) Automatically adds an ``cloudfront.experimental.EdgeFunction`` for each ``.edge-lambda.ts`` handler in your source tree. If this is disabled, you can manually add an ``awscdk.AutoDiscover`` component to your project. Default: true
|
1066
|
+
:param entrypoint: (experimental) Module entrypoint (``main`` in ``package.json``). Set to an empty string to not include ``main`` in your package.json. Default: "lib/index.js"
|
1067
|
+
:param entrypoint_types: (experimental) The .d.ts file that includes the type declarations for this module. Default: - .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
|
1068
|
+
:param eslint: (experimental) Setup eslint. Default: true
|
1069
|
+
:param eslint_options: (experimental) Eslint options. Default: - opinionated default options
|
1070
|
+
:param experimental_integ_runner: (experimental) Enable experimental support for the AWS CDK integ-runner. Default: false
|
1071
|
+
:param feature_flags: (experimental) Include all feature flags in cdk.json. Default: true
|
1072
|
+
:param github: (experimental) Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. Default: true
|
1073
|
+
:param github_options: (experimental) Options for GitHub integration. Default: - see GitHubOptions
|
1074
|
+
:param gitignore: (experimental) Additional entries to .gitignore.
|
1075
|
+
:param git_ignore_options: (experimental) Configuration options for .gitignore file.
|
1076
|
+
:param git_options: (experimental) Configuration options for git.
|
1077
|
+
:param gitpod: (experimental) Add a Gitpod development environment. Default: false
|
1078
|
+
:param homepage: (experimental) Package's Homepage / Website.
|
1079
|
+
:param integration_test_auto_discover: (experimental) Automatically discovers and creates integration tests for each ``.integ.ts`` file in under your test directory. Default: true
|
1080
|
+
:param jest: (experimental) Setup jest unit tests. Default: true
|
1081
|
+
:param jest_options: (experimental) Jest options. Default: - default options
|
1082
|
+
:param jsii_release_version: (experimental) Version requirement of ``publib`` which is used to publish modules to npm. Default: "latest"
|
1083
|
+
:param keywords: (experimental) Keywords to include in ``package.json``.
|
1084
|
+
:param lambda_auto_discover: (experimental) Automatically adds an ``awscdk.LambdaFunction`` for each ``.lambda.ts`` handler in your source tree. If this is disabled, you can manually add an ``awscdk.AutoDiscover`` component to your project. Default: true
|
1085
|
+
:param lambda_extension_auto_discover: (experimental) Automatically adds an ``awscdk.LambdaExtension`` for each ``.lambda-extension.ts`` entrypoint in your source tree. If this is disabled, you can manually add an ``awscdk.AutoDiscover`` component to your project. Default: true
|
1086
|
+
:param lambda_options: (experimental) Common options for all AWS Lambda functions. Default: - default options
|
1087
|
+
:param libdir: (experimental) Typescript artifacts output directory. Default: "lib"
|
1088
|
+
:param license: (experimental) License's SPDX identifier. See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses. Use the ``licensed`` option if you want to no license to be specified. Default: "Apache-2.0"
|
1089
|
+
:param licensed: (experimental) Indicates if a license should be added. Default: true
|
1090
|
+
:param logging: (experimental) Configure logging options such as verbosity. Default: {}
|
1091
|
+
:param major_version: (experimental) Major version to release from the default branch. If this is specified, we bump the latest version of this major version line. If not specified, we bump the global latest version. Default: - Major version is not enforced.
|
1092
|
+
:param max_node_version: (experimental) The maximum node version supported by this package. Most projects should not use this option. The value indicates that the package is incompatible with any newer versions of node. This requirement is enforced via the engines field. You will normally not need to set this option. Consider this option only if your package is known to not function with newer versions of node. Default: - no maximum version is enforced
|
1093
|
+
:param mergify: (deprecated) Whether mergify should be enabled on this repository or not. Default: true
|
1094
|
+
:param mergify_options: (deprecated) Options for mergify. Default: - default options
|
1095
|
+
:param min_major_version: (experimental) Minimal Major version to release. This can be useful to set to 1, as breaking changes before the 1.x major release are not incrementing the major version number. Can not be set together with ``majorVersion``. Default: - No minimum version is being enforced
|
1096
|
+
:param min_node_version: (experimental) The minimum node version required by this package to function. Most projects should not use this option. The value indicates that the package is incompatible with any older versions of node. This requirement is enforced via the engines field. You will normally not need to set this option, even if your package is incompatible with EOL versions of node. Consider this option only if your package depends on a specific feature, that is not available in other LTS versions. Setting this option has very high impact on the consumers of your package, as package managers will actively prevent usage with node versions you have marked as incompatible. To change the node version of your CI/CD workflows, use ``workflowNodeVersion``. Default: - no minimum version is enforced
|
1097
|
+
:param mutable_build: (deprecated) Automatically update files modified during builds to pull-request branches. This means that any files synthesized by projen or e.g. test snapshots will always be up-to-date before a PR is merged. Implies that PR builds do not have anti-tamper checks. Default: true
|
1098
|
+
:param next_version_command: (experimental) A shell command to control the next version to release. If present, this shell command will be run before the bump is executed, and it determines what version to release. It will be executed in the following environment: - Working directory: the project directory. - ``$VERSION``: the current version. Looks like ``1.2.3``. - ``$LATEST_TAG``: the most recent tag. Looks like ``prefix-v1.2.3``, or may be unset. The command should print one of the following to ``stdout``: - Nothing: the next version number will be determined based on commit history. - ``x.y.z``: the next version number will be ``x.y.z``. - ``major|minor|patch``: the next version number will be the current version number with the indicated component bumped. This setting cannot be specified together with ``minMajorVersion``; the invoked script can be used to achieve the effects of ``minMajorVersion``. Default: - The next version will be determined based on the commit history and project settings.
|
1099
|
+
:param npm_access: (experimental) Access level of the npm package. Default: - for scoped packages (e.g. ``foo@bar``), the default is ``NpmAccess.RESTRICTED``, for non-scoped packages, the default is ``NpmAccess.PUBLIC``.
|
1100
|
+
:param npm_dist_tag: (experimental) The npmDistTag to use when publishing from the default branch. To set the npm dist-tag for release branches, set the ``npmDistTag`` property for each branch. Default: "latest"
|
1101
|
+
:param npmignore: (deprecated) Additional entries to .npmignore.
|
1102
|
+
:param npmignore_enabled: (experimental) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. Default: true
|
1103
|
+
:param npm_ignore_options: (experimental) Configuration options for .npmignore file.
|
1104
|
+
:param npm_provenance: (experimental) Should provenance statements be generated when the package is published. A supported package manager is required to publish a package with npm provenance statements and you will need to use a supported CI/CD provider. Note that the projen ``Release`` and ``Publisher`` components are using ``publib`` to publish packages, which is using npm internally and supports provenance statements independently of the package manager used. Default: - true for public packages, false otherwise
|
1105
|
+
:param npm_registry: (deprecated) The host name of the npm registry to publish to. Cannot be set together with ``npmRegistryUrl``.
|
1106
|
+
:param npm_registry_url: (experimental) The base URL of the npm package registry. Must be a URL (e.g. start with "https://" or "http://") Default: "https://registry.npmjs.org"
|
1107
|
+
:param npm_token_secret: (experimental) GitHub secret which contains the NPM token to use when publishing packages. Default: "NPM_TOKEN"
|
1108
|
+
:param outdir: (experimental) The root directory of the project. Relative to this directory, all files are synthesized. If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other subprojects. Default: "."
|
1109
|
+
:param package: (experimental) Defines a ``package`` task that will produce an npm tarball under the artifacts directory (e.g. ``dist``). Default: true
|
1110
|
+
:param package_manager: (experimental) The Node Package Manager used to execute scripts. Default: NodePackageManager.YARN_CLASSIC
|
1111
|
+
:param package_name: (experimental) The "name" in package.json. Default: - defaults to project name
|
1112
|
+
:param parent: (experimental) The parent project, if this project is part of a bigger project.
|
1113
|
+
:param peer_dependency_options: (experimental) Options for ``peerDeps``.
|
1114
|
+
:param peer_deps: (experimental) Peer dependencies for this module. Dependencies listed here are required to be installed (and satisfied) by the *consumer* of this library. Using peer dependencies allows you to ensure that only a single module of a certain library exists in the ``node_modules`` tree of your consumers. Note that prior to npm@7, peer dependencies are *not* automatically installed, which means that adding peer dependencies to a library will be a breaking change for your customers. Unless ``peerDependencyOptions.pinnedDevDependency`` is disabled (it is enabled by default), projen will automatically add a dev dependency with a pinned version for each peer dependency. This will ensure that you build & test your module against the lowest peer version required. Default: []
|
1115
|
+
:param pnpm_version: (experimental) The version of PNPM to use if using PNPM as a package manager. Default: "9"
|
1116
|
+
:param post_build_steps: (experimental) Steps to execute after build as part of the release workflow. Default: []
|
1117
|
+
:param prerelease: (experimental) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). Default: - normal semantic versions
|
1118
|
+
:param prettier: (experimental) Setup prettier. Default: false
|
1119
|
+
:param prettier_options: (experimental) Prettier options. Default: - default options
|
1120
|
+
:param project_type: (deprecated) Which type of project this is (library/app). Default: ProjectType.UNKNOWN
|
1121
|
+
:param projen_command: (experimental) The shell command to use in order to run the projen CLI. Can be used to customize in special environments. Default: "npx projen"
|
1122
|
+
:param projen_credentials: (experimental) Choose a method of providing GitHub API access for projen workflows. Default: - use a personal access token named PROJEN_GITHUB_TOKEN
|
1123
|
+
:param projen_dev_dependency: (experimental) Indicates of "projen" should be installed as a devDependency. Default: - true if not a subproject
|
1124
|
+
:param projenrc_js: (experimental) Generate (once) .projenrc.js (in JavaScript). Set to ``false`` in order to disable .projenrc.js generation. Default: - true if projenrcJson is false
|
1125
|
+
:param projenrc_json: (experimental) Generate (once) .projenrc.json (in JSON). Set to ``false`` in order to disable .projenrc.json generation. Default: false
|
1126
|
+
:param projenrc_json_options: (experimental) Options for .projenrc.json. Default: - default options
|
1127
|
+
:param projenrc_js_options: (experimental) Options for .projenrc.js. Default: - default options
|
1128
|
+
:param projenrc_ts: (experimental) Use TypeScript for your projenrc file (``.projenrc.ts``). Default: false
|
1129
|
+
:param projenrc_ts_options: (experimental) Options for .projenrc.ts.
|
1130
|
+
:param projen_token_secret: (deprecated) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the ``repo``, ``workflows`` and ``packages`` scope. Default: "PROJEN_GITHUB_TOKEN"
|
1131
|
+
:param projen_version: (experimental) Version of projen to install. Default: - Defaults to the latest version.
|
1132
|
+
:param publish_dry_run: (experimental) Instead of actually publishing to package managers, just print the publishing command. Default: false
|
1133
|
+
:param publish_tasks: (experimental) Define publishing tasks that can be executed manually as well as workflows. Normally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity. Default: false
|
1134
|
+
:param pull_request_template: (experimental) Include a GitHub pull request template. Default: true
|
1135
|
+
:param pull_request_template_contents: (experimental) The contents of the pull request template. Default: - default content
|
1136
|
+
:param readme: Configuration of the README.md file.
|
1137
|
+
:param releasable_commits: (experimental) Find commits that should be considered releasable Used to decide if a release is required. Default: ReleasableCommits.everyCommit()
|
1138
|
+
:param release: (experimental) Add release management to this project. Default: - true (false for subprojects)
|
1139
|
+
:param release_branches: (experimental) Defines additional release branches. A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch *must* be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the ``majorVersion`` field must also be provided for the default branch. Default: - no additional branches are used for release. you can use ``addBranch()`` to add additional branches.
|
1140
|
+
:param release_every_commit: (deprecated) Automatically release new versions every commit to one of branches in ``releaseBranches``. Default: true
|
1141
|
+
:param release_failure_issue: (experimental) Create a github issue on every failed publishing task. Default: false
|
1142
|
+
:param release_failure_issue_label: (experimental) The label to apply to issues indicating publish failures. Only applies if ``releaseFailureIssue`` is true. Default: "failed-release"
|
1143
|
+
:param release_schedule: (deprecated) CRON schedule to trigger new releases. Default: - no scheduled releases
|
1144
|
+
:param release_tag_prefix: (experimental) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. Note: this prefix is used to detect the latest tagged version when bumping, so if you change this on a project with an existing version history, you may need to manually tag your latest release with the new prefix. Default: "v"
|
1145
|
+
:param release_to_npm: (experimental) Automatically release to npm when new versions are introduced. Default: false
|
1146
|
+
:param release_trigger: (experimental) The release trigger to use. Default: - Continuous releases (``ReleaseTrigger.continuous()``)
|
1147
|
+
:param release_workflow: (deprecated) DEPRECATED: renamed to ``release``. Default: - true if not a subproject
|
1148
|
+
:param release_workflow_name: (experimental) The name of the default release workflow. Default: "release"
|
1149
|
+
:param release_workflow_setup_steps: (experimental) A set of workflow steps to execute in order to setup the workflow container.
|
1150
|
+
:param renovatebot: (experimental) Use renovatebot to handle dependency upgrades. Default: false
|
1151
|
+
:param renovatebot_options: (experimental) Options for renovatebot. Default: - default options
|
1152
|
+
:param repository: (experimental) The repository is the location where the actual code for your package lives. See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository
|
1153
|
+
:param repository_directory: (experimental) 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.
|
1154
|
+
:param require_approval: (experimental) To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. Default: ApprovalLevel.BROADENING
|
1155
|
+
:param sample_code: (experimental) Generate one-time sample in ``src/`` and ``test/`` if there are no files there. Default: true
|
1156
|
+
:param scoped_packages_options: (experimental) Options for privately hosted scoped packages. Default: - fetch all scoped packages from the public npm registry
|
1157
|
+
:param scripts: (deprecated) npm scripts to include. If a script has the same name as a standard script, the standard script will be overwritten. Also adds the script as a task. Default: {}
|
1158
|
+
:param srcdir: (experimental) Typescript sources directory. Default: "src"
|
1159
|
+
:param stability: (experimental) Package's Stability.
|
1160
|
+
:param stale: (experimental) Auto-close of stale issues and pull request. See ``staleOptions`` for options. Default: false
|
1161
|
+
:param stale_options: (experimental) Auto-close stale issues and pull requests. To disable set ``stale`` to ``false``. Default: - see defaults in ``StaleOptions``
|
1162
|
+
:param testdir: (experimental) Jest tests directory. Tests files should be named ``xxx.test.ts``. If this directory is under ``srcdir`` (e.g. ``src/test``, ``src/__tests__``), then tests are going to be compiled into ``lib/`` and executed as javascript. If the test directory is outside of ``src``, then we configure jest to compile the code in-memory. Default: "test"
|
1163
|
+
:param tsconfig: (experimental) Custom TSConfig. Default: - default options
|
1164
|
+
:param tsconfig_dev: (experimental) Custom tsconfig options for the development tsconfig.json file (used for testing). Default: - use the production tsconfig options
|
1165
|
+
:param tsconfig_dev_file: (experimental) The name of the development tsconfig.json file. Default: "tsconfig.dev.json"
|
1166
|
+
:param ts_jest_options: (experimental) Options for ts-jest.
|
1167
|
+
:param typescript_version: (experimental) TypeScript version to use. NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a ``~`` dependency (e.g. ``~1.2.3``). Default: "latest"
|
1168
|
+
:param versionrc_options: (experimental) Custom configuration used when creating changelog with commit-and-tag-version package. Given values either append to default configuration or overwrite values in it. Default: - standard configuration applicable for GitHub repositories
|
1169
|
+
:param vscode: (experimental) Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. Default: true
|
1170
|
+
:param watch_excludes: (experimental) Glob patterns to exclude from ``cdk watch``. Default: []
|
1171
|
+
:param watch_includes: (experimental) Glob patterns to include in ``cdk watch``. Default: []
|
1172
|
+
:param workflow_bootstrap_steps: (experimental) Workflow steps to use in order to bootstrap this repo. Default: "yarn install --frozen-lockfile && yarn projen"
|
1173
|
+
:param workflow_container_image: (experimental) Container image to use for GitHub workflows. Default: - default image
|
1174
|
+
:param workflow_git_identity: (experimental) The git identity to use in workflows. Default: - GitHub Actions
|
1175
|
+
:param workflow_node_version: (experimental) The node version used in GitHub Actions workflows. Always use this option if your GitHub Actions workflows require a specific to run. Default: - ``minNodeVersion`` if set, otherwise ``lts/*``.
|
1176
|
+
:param workflow_package_cache: (experimental) Enable Node.js package cache in GitHub workflows. Default: false
|
1177
|
+
:param workflow_runs_on: (experimental) Github Runner selection labels. Default: ["ubuntu-latest"]
|
1178
|
+
:param workflow_runs_on_group: (experimental) Github Runner Group selection options.
|
1179
|
+
:param yarn_berry_options: (experimental) Options for Yarn Berry. Default: - Yarn Berry v4 with all default options
|
1180
|
+
'''
|
1181
|
+
if isinstance(auto_approve_options, dict):
|
1182
|
+
auto_approve_options = _projen_github_04054675.AutoApproveOptions(**auto_approve_options)
|
1183
|
+
if isinstance(auto_merge_options, dict):
|
1184
|
+
auto_merge_options = _projen_github_04054675.AutoMergeOptions(**auto_merge_options)
|
1185
|
+
if isinstance(build_workflow_options, dict):
|
1186
|
+
build_workflow_options = _projen_javascript_04054675.BuildWorkflowOptions(**build_workflow_options)
|
1187
|
+
if isinstance(build_workflow_triggers, dict):
|
1188
|
+
build_workflow_triggers = _projen_github_workflows_04054675.Triggers(**build_workflow_triggers)
|
1189
|
+
if isinstance(bundler_options, dict):
|
1190
|
+
bundler_options = _projen_javascript_04054675.BundlerOptions(**bundler_options)
|
1191
|
+
if isinstance(check_licenses, dict):
|
1192
|
+
check_licenses = _projen_javascript_04054675.LicenseCheckerOptions(**check_licenses)
|
1193
|
+
if isinstance(code_artifact_options, dict):
|
1194
|
+
code_artifact_options = _projen_javascript_04054675.CodeArtifactOptions(**code_artifact_options)
|
1195
|
+
if isinstance(dependabot_options, dict):
|
1196
|
+
dependabot_options = _projen_github_04054675.DependabotOptions(**dependabot_options)
|
1197
|
+
if isinstance(deps_upgrade_options, dict):
|
1198
|
+
deps_upgrade_options = _projen_javascript_04054675.UpgradeDependenciesOptions(**deps_upgrade_options)
|
1199
|
+
if isinstance(eslint_options, dict):
|
1200
|
+
eslint_options = _projen_javascript_04054675.EslintOptions(**eslint_options)
|
1201
|
+
if isinstance(github_options, dict):
|
1202
|
+
github_options = _projen_github_04054675.GitHubOptions(**github_options)
|
1203
|
+
if isinstance(git_ignore_options, dict):
|
1204
|
+
git_ignore_options = _projen_04054675.IgnoreFileOptions(**git_ignore_options)
|
1205
|
+
if isinstance(git_options, dict):
|
1206
|
+
git_options = _projen_04054675.GitOptions(**git_options)
|
1207
|
+
if isinstance(jest_options, dict):
|
1208
|
+
jest_options = _projen_javascript_04054675.JestOptions(**jest_options)
|
1209
|
+
if isinstance(lambda_options, dict):
|
1210
|
+
lambda_options = _projen_awscdk_04054675.LambdaFunctionCommonOptions(**lambda_options)
|
1211
|
+
if isinstance(logging, dict):
|
1212
|
+
logging = _projen_04054675.LoggerOptions(**logging)
|
1213
|
+
if isinstance(mergify_options, dict):
|
1214
|
+
mergify_options = _projen_github_04054675.MergifyOptions(**mergify_options)
|
1215
|
+
if isinstance(npm_ignore_options, dict):
|
1216
|
+
npm_ignore_options = _projen_04054675.IgnoreFileOptions(**npm_ignore_options)
|
1217
|
+
if isinstance(peer_dependency_options, dict):
|
1218
|
+
peer_dependency_options = _projen_javascript_04054675.PeerDependencyOptions(**peer_dependency_options)
|
1219
|
+
if isinstance(prettier_options, dict):
|
1220
|
+
prettier_options = _projen_javascript_04054675.PrettierOptions(**prettier_options)
|
1221
|
+
if isinstance(projenrc_json_options, dict):
|
1222
|
+
projenrc_json_options = _projen_04054675.ProjenrcJsonOptions(**projenrc_json_options)
|
1223
|
+
if isinstance(projenrc_js_options, dict):
|
1224
|
+
projenrc_js_options = _projen_javascript_04054675.ProjenrcOptions(**projenrc_js_options)
|
1225
|
+
if isinstance(projenrc_ts_options, dict):
|
1226
|
+
projenrc_ts_options = _projen_typescript_04054675.ProjenrcOptions(**projenrc_ts_options)
|
1227
|
+
if isinstance(readme, dict):
|
1228
|
+
readme = ReadmeOptions(**readme)
|
1229
|
+
if isinstance(renovatebot_options, dict):
|
1230
|
+
renovatebot_options = _projen_04054675.RenovatebotOptions(**renovatebot_options)
|
1231
|
+
if isinstance(stale_options, dict):
|
1232
|
+
stale_options = _projen_github_04054675.StaleOptions(**stale_options)
|
1233
|
+
if isinstance(tsconfig, dict):
|
1234
|
+
tsconfig = _projen_javascript_04054675.TypescriptConfigOptions(**tsconfig)
|
1235
|
+
if isinstance(tsconfig_dev, dict):
|
1236
|
+
tsconfig_dev = _projen_javascript_04054675.TypescriptConfigOptions(**tsconfig_dev)
|
1237
|
+
if isinstance(ts_jest_options, dict):
|
1238
|
+
ts_jest_options = _projen_typescript_04054675.TsJestOptions(**ts_jest_options)
|
1239
|
+
if isinstance(workflow_git_identity, dict):
|
1240
|
+
workflow_git_identity = _projen_github_04054675.GitIdentity(**workflow_git_identity)
|
1241
|
+
if isinstance(workflow_runs_on_group, dict):
|
1242
|
+
workflow_runs_on_group = _projen_04054675.GroupRunnerOptions(**workflow_runs_on_group)
|
1243
|
+
if isinstance(yarn_berry_options, dict):
|
1244
|
+
yarn_berry_options = _projen_javascript_04054675.YarnBerryOptions(**yarn_berry_options)
|
1245
|
+
if __debug__:
|
1246
|
+
type_hints = typing.get_type_hints(_typecheckingstub__3a6354f4c0532263f309ca59025d89b070b95588f76bd5815340cc71a5341012)
|
1247
|
+
check_type(argname="argument cdk_version", value=cdk_version, expected_type=type_hints["cdk_version"])
|
1248
|
+
check_type(argname="argument code_owners", value=code_owners, expected_type=type_hints["code_owners"])
|
1249
|
+
check_type(argname="argument name", value=name, expected_type=type_hints["name"])
|
1250
|
+
check_type(argname="argument allow_library_dependencies", value=allow_library_dependencies, expected_type=type_hints["allow_library_dependencies"])
|
1251
|
+
check_type(argname="argument app_entrypoint", value=app_entrypoint, expected_type=type_hints["app_entrypoint"])
|
1252
|
+
check_type(argname="argument artifacts_directory", value=artifacts_directory, expected_type=type_hints["artifacts_directory"])
|
1253
|
+
check_type(argname="argument author_email", value=author_email, expected_type=type_hints["author_email"])
|
1254
|
+
check_type(argname="argument author_name", value=author_name, expected_type=type_hints["author_name"])
|
1255
|
+
check_type(argname="argument author_organization", value=author_organization, expected_type=type_hints["author_organization"])
|
1256
|
+
check_type(argname="argument author_url", value=author_url, expected_type=type_hints["author_url"])
|
1257
|
+
check_type(argname="argument auto_approve_options", value=auto_approve_options, expected_type=type_hints["auto_approve_options"])
|
1258
|
+
check_type(argname="argument auto_approve_upgrades", value=auto_approve_upgrades, expected_type=type_hints["auto_approve_upgrades"])
|
1259
|
+
check_type(argname="argument auto_detect_bin", value=auto_detect_bin, expected_type=type_hints["auto_detect_bin"])
|
1260
|
+
check_type(argname="argument auto_merge", value=auto_merge, expected_type=type_hints["auto_merge"])
|
1261
|
+
check_type(argname="argument auto_merge_options", value=auto_merge_options, expected_type=type_hints["auto_merge_options"])
|
1262
|
+
check_type(argname="argument bin", value=bin, expected_type=type_hints["bin"])
|
1263
|
+
check_type(argname="argument bugs_email", value=bugs_email, expected_type=type_hints["bugs_email"])
|
1264
|
+
check_type(argname="argument bugs_url", value=bugs_url, expected_type=type_hints["bugs_url"])
|
1265
|
+
check_type(argname="argument build_command", value=build_command, expected_type=type_hints["build_command"])
|
1266
|
+
check_type(argname="argument build_workflow", value=build_workflow, expected_type=type_hints["build_workflow"])
|
1267
|
+
check_type(argname="argument build_workflow_options", value=build_workflow_options, expected_type=type_hints["build_workflow_options"])
|
1268
|
+
check_type(argname="argument build_workflow_triggers", value=build_workflow_triggers, expected_type=type_hints["build_workflow_triggers"])
|
1269
|
+
check_type(argname="argument bump_package", value=bump_package, expected_type=type_hints["bump_package"])
|
1270
|
+
check_type(argname="argument bundled_deps", value=bundled_deps, expected_type=type_hints["bundled_deps"])
|
1271
|
+
check_type(argname="argument bundler_options", value=bundler_options, expected_type=type_hints["bundler_options"])
|
1272
|
+
check_type(argname="argument bun_version", value=bun_version, expected_type=type_hints["bun_version"])
|
1273
|
+
check_type(argname="argument cdk_assert", value=cdk_assert, expected_type=type_hints["cdk_assert"])
|
1274
|
+
check_type(argname="argument cdk_assertions", value=cdk_assertions, expected_type=type_hints["cdk_assertions"])
|
1275
|
+
check_type(argname="argument cdk_cli_version", value=cdk_cli_version, expected_type=type_hints["cdk_cli_version"])
|
1276
|
+
check_type(argname="argument cdk_dependencies", value=cdk_dependencies, expected_type=type_hints["cdk_dependencies"])
|
1277
|
+
check_type(argname="argument cdk_dependencies_as_deps", value=cdk_dependencies_as_deps, expected_type=type_hints["cdk_dependencies_as_deps"])
|
1278
|
+
check_type(argname="argument cdkout", value=cdkout, expected_type=type_hints["cdkout"])
|
1279
|
+
check_type(argname="argument cdk_test_dependencies", value=cdk_test_dependencies, expected_type=type_hints["cdk_test_dependencies"])
|
1280
|
+
check_type(argname="argument cdk_version_pinning", value=cdk_version_pinning, expected_type=type_hints["cdk_version_pinning"])
|
1281
|
+
check_type(argname="argument check_licenses", value=check_licenses, expected_type=type_hints["check_licenses"])
|
1282
|
+
check_type(argname="argument clobber", value=clobber, expected_type=type_hints["clobber"])
|
1283
|
+
check_type(argname="argument code_artifact_options", value=code_artifact_options, expected_type=type_hints["code_artifact_options"])
|
1284
|
+
check_type(argname="argument code_cov", value=code_cov, expected_type=type_hints["code_cov"])
|
1285
|
+
check_type(argname="argument code_cov_token_secret", value=code_cov_token_secret, expected_type=type_hints["code_cov_token_secret"])
|
1286
|
+
check_type(argname="argument commit_generated", value=commit_generated, expected_type=type_hints["commit_generated"])
|
1287
|
+
check_type(argname="argument constructs_version", value=constructs_version, expected_type=type_hints["constructs_version"])
|
1288
|
+
check_type(argname="argument context", value=context, expected_type=type_hints["context"])
|
1289
|
+
check_type(argname="argument copyright_owner", value=copyright_owner, expected_type=type_hints["copyright_owner"])
|
1290
|
+
check_type(argname="argument copyright_period", value=copyright_period, expected_type=type_hints["copyright_period"])
|
1291
|
+
check_type(argname="argument default_release_branch", value=default_release_branch, expected_type=type_hints["default_release_branch"])
|
1292
|
+
check_type(argname="argument dependabot", value=dependabot, expected_type=type_hints["dependabot"])
|
1293
|
+
check_type(argname="argument dependabot_options", value=dependabot_options, expected_type=type_hints["dependabot_options"])
|
1294
|
+
check_type(argname="argument deps", value=deps, expected_type=type_hints["deps"])
|
1295
|
+
check_type(argname="argument deps_upgrade", value=deps_upgrade, expected_type=type_hints["deps_upgrade"])
|
1296
|
+
check_type(argname="argument deps_upgrade_options", value=deps_upgrade_options, expected_type=type_hints["deps_upgrade_options"])
|
1297
|
+
check_type(argname="argument description", value=description, expected_type=type_hints["description"])
|
1298
|
+
check_type(argname="argument dev_container", value=dev_container, expected_type=type_hints["dev_container"])
|
1299
|
+
check_type(argname="argument dev_deps", value=dev_deps, expected_type=type_hints["dev_deps"])
|
1300
|
+
check_type(argname="argument disable_tsconfig", value=disable_tsconfig, expected_type=type_hints["disable_tsconfig"])
|
1301
|
+
check_type(argname="argument disable_tsconfig_dev", value=disable_tsconfig_dev, expected_type=type_hints["disable_tsconfig_dev"])
|
1302
|
+
check_type(argname="argument docgen", value=docgen, expected_type=type_hints["docgen"])
|
1303
|
+
check_type(argname="argument docs_directory", value=docs_directory, expected_type=type_hints["docs_directory"])
|
1304
|
+
check_type(argname="argument edge_lambda_auto_discover", value=edge_lambda_auto_discover, expected_type=type_hints["edge_lambda_auto_discover"])
|
1305
|
+
check_type(argname="argument entrypoint", value=entrypoint, expected_type=type_hints["entrypoint"])
|
1306
|
+
check_type(argname="argument entrypoint_types", value=entrypoint_types, expected_type=type_hints["entrypoint_types"])
|
1307
|
+
check_type(argname="argument eslint", value=eslint, expected_type=type_hints["eslint"])
|
1308
|
+
check_type(argname="argument eslint_options", value=eslint_options, expected_type=type_hints["eslint_options"])
|
1309
|
+
check_type(argname="argument experimental_integ_runner", value=experimental_integ_runner, expected_type=type_hints["experimental_integ_runner"])
|
1310
|
+
check_type(argname="argument feature_flags", value=feature_flags, expected_type=type_hints["feature_flags"])
|
1311
|
+
check_type(argname="argument github", value=github, expected_type=type_hints["github"])
|
1312
|
+
check_type(argname="argument github_options", value=github_options, expected_type=type_hints["github_options"])
|
1313
|
+
check_type(argname="argument gitignore", value=gitignore, expected_type=type_hints["gitignore"])
|
1314
|
+
check_type(argname="argument git_ignore_options", value=git_ignore_options, expected_type=type_hints["git_ignore_options"])
|
1315
|
+
check_type(argname="argument git_options", value=git_options, expected_type=type_hints["git_options"])
|
1316
|
+
check_type(argname="argument gitpod", value=gitpod, expected_type=type_hints["gitpod"])
|
1317
|
+
check_type(argname="argument homepage", value=homepage, expected_type=type_hints["homepage"])
|
1318
|
+
check_type(argname="argument integration_test_auto_discover", value=integration_test_auto_discover, expected_type=type_hints["integration_test_auto_discover"])
|
1319
|
+
check_type(argname="argument jest", value=jest, expected_type=type_hints["jest"])
|
1320
|
+
check_type(argname="argument jest_options", value=jest_options, expected_type=type_hints["jest_options"])
|
1321
|
+
check_type(argname="argument jsii_release_version", value=jsii_release_version, expected_type=type_hints["jsii_release_version"])
|
1322
|
+
check_type(argname="argument keywords", value=keywords, expected_type=type_hints["keywords"])
|
1323
|
+
check_type(argname="argument lambda_auto_discover", value=lambda_auto_discover, expected_type=type_hints["lambda_auto_discover"])
|
1324
|
+
check_type(argname="argument lambda_extension_auto_discover", value=lambda_extension_auto_discover, expected_type=type_hints["lambda_extension_auto_discover"])
|
1325
|
+
check_type(argname="argument lambda_options", value=lambda_options, expected_type=type_hints["lambda_options"])
|
1326
|
+
check_type(argname="argument libdir", value=libdir, expected_type=type_hints["libdir"])
|
1327
|
+
check_type(argname="argument license", value=license, expected_type=type_hints["license"])
|
1328
|
+
check_type(argname="argument licensed", value=licensed, expected_type=type_hints["licensed"])
|
1329
|
+
check_type(argname="argument logging", value=logging, expected_type=type_hints["logging"])
|
1330
|
+
check_type(argname="argument major_version", value=major_version, expected_type=type_hints["major_version"])
|
1331
|
+
check_type(argname="argument max_node_version", value=max_node_version, expected_type=type_hints["max_node_version"])
|
1332
|
+
check_type(argname="argument mergify", value=mergify, expected_type=type_hints["mergify"])
|
1333
|
+
check_type(argname="argument mergify_options", value=mergify_options, expected_type=type_hints["mergify_options"])
|
1334
|
+
check_type(argname="argument min_major_version", value=min_major_version, expected_type=type_hints["min_major_version"])
|
1335
|
+
check_type(argname="argument min_node_version", value=min_node_version, expected_type=type_hints["min_node_version"])
|
1336
|
+
check_type(argname="argument mutable_build", value=mutable_build, expected_type=type_hints["mutable_build"])
|
1337
|
+
check_type(argname="argument next_version_command", value=next_version_command, expected_type=type_hints["next_version_command"])
|
1338
|
+
check_type(argname="argument npm_access", value=npm_access, expected_type=type_hints["npm_access"])
|
1339
|
+
check_type(argname="argument npm_dist_tag", value=npm_dist_tag, expected_type=type_hints["npm_dist_tag"])
|
1340
|
+
check_type(argname="argument npmignore", value=npmignore, expected_type=type_hints["npmignore"])
|
1341
|
+
check_type(argname="argument npmignore_enabled", value=npmignore_enabled, expected_type=type_hints["npmignore_enabled"])
|
1342
|
+
check_type(argname="argument npm_ignore_options", value=npm_ignore_options, expected_type=type_hints["npm_ignore_options"])
|
1343
|
+
check_type(argname="argument npm_provenance", value=npm_provenance, expected_type=type_hints["npm_provenance"])
|
1344
|
+
check_type(argname="argument npm_registry", value=npm_registry, expected_type=type_hints["npm_registry"])
|
1345
|
+
check_type(argname="argument npm_registry_url", value=npm_registry_url, expected_type=type_hints["npm_registry_url"])
|
1346
|
+
check_type(argname="argument npm_token_secret", value=npm_token_secret, expected_type=type_hints["npm_token_secret"])
|
1347
|
+
check_type(argname="argument outdir", value=outdir, expected_type=type_hints["outdir"])
|
1348
|
+
check_type(argname="argument package", value=package, expected_type=type_hints["package"])
|
1349
|
+
check_type(argname="argument package_manager", value=package_manager, expected_type=type_hints["package_manager"])
|
1350
|
+
check_type(argname="argument package_name", value=package_name, expected_type=type_hints["package_name"])
|
1351
|
+
check_type(argname="argument parent", value=parent, expected_type=type_hints["parent"])
|
1352
|
+
check_type(argname="argument peer_dependency_options", value=peer_dependency_options, expected_type=type_hints["peer_dependency_options"])
|
1353
|
+
check_type(argname="argument peer_deps", value=peer_deps, expected_type=type_hints["peer_deps"])
|
1354
|
+
check_type(argname="argument pnpm_version", value=pnpm_version, expected_type=type_hints["pnpm_version"])
|
1355
|
+
check_type(argname="argument post_build_steps", value=post_build_steps, expected_type=type_hints["post_build_steps"])
|
1356
|
+
check_type(argname="argument prerelease", value=prerelease, expected_type=type_hints["prerelease"])
|
1357
|
+
check_type(argname="argument prettier", value=prettier, expected_type=type_hints["prettier"])
|
1358
|
+
check_type(argname="argument prettier_options", value=prettier_options, expected_type=type_hints["prettier_options"])
|
1359
|
+
check_type(argname="argument project_type", value=project_type, expected_type=type_hints["project_type"])
|
1360
|
+
check_type(argname="argument projen_command", value=projen_command, expected_type=type_hints["projen_command"])
|
1361
|
+
check_type(argname="argument projen_credentials", value=projen_credentials, expected_type=type_hints["projen_credentials"])
|
1362
|
+
check_type(argname="argument projen_dev_dependency", value=projen_dev_dependency, expected_type=type_hints["projen_dev_dependency"])
|
1363
|
+
check_type(argname="argument projenrc_js", value=projenrc_js, expected_type=type_hints["projenrc_js"])
|
1364
|
+
check_type(argname="argument projenrc_json", value=projenrc_json, expected_type=type_hints["projenrc_json"])
|
1365
|
+
check_type(argname="argument projenrc_json_options", value=projenrc_json_options, expected_type=type_hints["projenrc_json_options"])
|
1366
|
+
check_type(argname="argument projenrc_js_options", value=projenrc_js_options, expected_type=type_hints["projenrc_js_options"])
|
1367
|
+
check_type(argname="argument projenrc_ts", value=projenrc_ts, expected_type=type_hints["projenrc_ts"])
|
1368
|
+
check_type(argname="argument projenrc_ts_options", value=projenrc_ts_options, expected_type=type_hints["projenrc_ts_options"])
|
1369
|
+
check_type(argname="argument projen_token_secret", value=projen_token_secret, expected_type=type_hints["projen_token_secret"])
|
1370
|
+
check_type(argname="argument projen_version", value=projen_version, expected_type=type_hints["projen_version"])
|
1371
|
+
check_type(argname="argument publish_dry_run", value=publish_dry_run, expected_type=type_hints["publish_dry_run"])
|
1372
|
+
check_type(argname="argument publish_tasks", value=publish_tasks, expected_type=type_hints["publish_tasks"])
|
1373
|
+
check_type(argname="argument pull_request_template", value=pull_request_template, expected_type=type_hints["pull_request_template"])
|
1374
|
+
check_type(argname="argument pull_request_template_contents", value=pull_request_template_contents, expected_type=type_hints["pull_request_template_contents"])
|
1375
|
+
check_type(argname="argument readme", value=readme, expected_type=type_hints["readme"])
|
1376
|
+
check_type(argname="argument releasable_commits", value=releasable_commits, expected_type=type_hints["releasable_commits"])
|
1377
|
+
check_type(argname="argument release", value=release, expected_type=type_hints["release"])
|
1378
|
+
check_type(argname="argument release_branches", value=release_branches, expected_type=type_hints["release_branches"])
|
1379
|
+
check_type(argname="argument release_every_commit", value=release_every_commit, expected_type=type_hints["release_every_commit"])
|
1380
|
+
check_type(argname="argument release_failure_issue", value=release_failure_issue, expected_type=type_hints["release_failure_issue"])
|
1381
|
+
check_type(argname="argument release_failure_issue_label", value=release_failure_issue_label, expected_type=type_hints["release_failure_issue_label"])
|
1382
|
+
check_type(argname="argument release_schedule", value=release_schedule, expected_type=type_hints["release_schedule"])
|
1383
|
+
check_type(argname="argument release_tag_prefix", value=release_tag_prefix, expected_type=type_hints["release_tag_prefix"])
|
1384
|
+
check_type(argname="argument release_to_npm", value=release_to_npm, expected_type=type_hints["release_to_npm"])
|
1385
|
+
check_type(argname="argument release_trigger", value=release_trigger, expected_type=type_hints["release_trigger"])
|
1386
|
+
check_type(argname="argument release_workflow", value=release_workflow, expected_type=type_hints["release_workflow"])
|
1387
|
+
check_type(argname="argument release_workflow_name", value=release_workflow_name, expected_type=type_hints["release_workflow_name"])
|
1388
|
+
check_type(argname="argument release_workflow_setup_steps", value=release_workflow_setup_steps, expected_type=type_hints["release_workflow_setup_steps"])
|
1389
|
+
check_type(argname="argument renovatebot", value=renovatebot, expected_type=type_hints["renovatebot"])
|
1390
|
+
check_type(argname="argument renovatebot_options", value=renovatebot_options, expected_type=type_hints["renovatebot_options"])
|
1391
|
+
check_type(argname="argument repository", value=repository, expected_type=type_hints["repository"])
|
1392
|
+
check_type(argname="argument repository_directory", value=repository_directory, expected_type=type_hints["repository_directory"])
|
1393
|
+
check_type(argname="argument require_approval", value=require_approval, expected_type=type_hints["require_approval"])
|
1394
|
+
check_type(argname="argument sample_code", value=sample_code, expected_type=type_hints["sample_code"])
|
1395
|
+
check_type(argname="argument scoped_packages_options", value=scoped_packages_options, expected_type=type_hints["scoped_packages_options"])
|
1396
|
+
check_type(argname="argument scripts", value=scripts, expected_type=type_hints["scripts"])
|
1397
|
+
check_type(argname="argument srcdir", value=srcdir, expected_type=type_hints["srcdir"])
|
1398
|
+
check_type(argname="argument stability", value=stability, expected_type=type_hints["stability"])
|
1399
|
+
check_type(argname="argument stale", value=stale, expected_type=type_hints["stale"])
|
1400
|
+
check_type(argname="argument stale_options", value=stale_options, expected_type=type_hints["stale_options"])
|
1401
|
+
check_type(argname="argument testdir", value=testdir, expected_type=type_hints["testdir"])
|
1402
|
+
check_type(argname="argument tsconfig", value=tsconfig, expected_type=type_hints["tsconfig"])
|
1403
|
+
check_type(argname="argument tsconfig_dev", value=tsconfig_dev, expected_type=type_hints["tsconfig_dev"])
|
1404
|
+
check_type(argname="argument tsconfig_dev_file", value=tsconfig_dev_file, expected_type=type_hints["tsconfig_dev_file"])
|
1405
|
+
check_type(argname="argument ts_jest_options", value=ts_jest_options, expected_type=type_hints["ts_jest_options"])
|
1406
|
+
check_type(argname="argument typescript_version", value=typescript_version, expected_type=type_hints["typescript_version"])
|
1407
|
+
check_type(argname="argument versionrc_options", value=versionrc_options, expected_type=type_hints["versionrc_options"])
|
1408
|
+
check_type(argname="argument vscode", value=vscode, expected_type=type_hints["vscode"])
|
1409
|
+
check_type(argname="argument watch_excludes", value=watch_excludes, expected_type=type_hints["watch_excludes"])
|
1410
|
+
check_type(argname="argument watch_includes", value=watch_includes, expected_type=type_hints["watch_includes"])
|
1411
|
+
check_type(argname="argument workflow_bootstrap_steps", value=workflow_bootstrap_steps, expected_type=type_hints["workflow_bootstrap_steps"])
|
1412
|
+
check_type(argname="argument workflow_container_image", value=workflow_container_image, expected_type=type_hints["workflow_container_image"])
|
1413
|
+
check_type(argname="argument workflow_git_identity", value=workflow_git_identity, expected_type=type_hints["workflow_git_identity"])
|
1414
|
+
check_type(argname="argument workflow_node_version", value=workflow_node_version, expected_type=type_hints["workflow_node_version"])
|
1415
|
+
check_type(argname="argument workflow_package_cache", value=workflow_package_cache, expected_type=type_hints["workflow_package_cache"])
|
1416
|
+
check_type(argname="argument workflow_runs_on", value=workflow_runs_on, expected_type=type_hints["workflow_runs_on"])
|
1417
|
+
check_type(argname="argument workflow_runs_on_group", value=workflow_runs_on_group, expected_type=type_hints["workflow_runs_on_group"])
|
1418
|
+
check_type(argname="argument yarn_berry_options", value=yarn_berry_options, expected_type=type_hints["yarn_berry_options"])
|
1419
|
+
self._values: typing.Dict[builtins.str, typing.Any] = {
|
1420
|
+
"cdk_version": cdk_version,
|
1421
|
+
"code_owners": code_owners,
|
1422
|
+
"name": name,
|
1423
|
+
}
|
1424
|
+
if allow_library_dependencies is not None:
|
1425
|
+
self._values["allow_library_dependencies"] = allow_library_dependencies
|
1426
|
+
if app_entrypoint is not None:
|
1427
|
+
self._values["app_entrypoint"] = app_entrypoint
|
1428
|
+
if artifacts_directory is not None:
|
1429
|
+
self._values["artifacts_directory"] = artifacts_directory
|
1430
|
+
if author_email is not None:
|
1431
|
+
self._values["author_email"] = author_email
|
1432
|
+
if author_name is not None:
|
1433
|
+
self._values["author_name"] = author_name
|
1434
|
+
if author_organization is not None:
|
1435
|
+
self._values["author_organization"] = author_organization
|
1436
|
+
if author_url is not None:
|
1437
|
+
self._values["author_url"] = author_url
|
1438
|
+
if auto_approve_options is not None:
|
1439
|
+
self._values["auto_approve_options"] = auto_approve_options
|
1440
|
+
if auto_approve_upgrades is not None:
|
1441
|
+
self._values["auto_approve_upgrades"] = auto_approve_upgrades
|
1442
|
+
if auto_detect_bin is not None:
|
1443
|
+
self._values["auto_detect_bin"] = auto_detect_bin
|
1444
|
+
if auto_merge is not None:
|
1445
|
+
self._values["auto_merge"] = auto_merge
|
1446
|
+
if auto_merge_options is not None:
|
1447
|
+
self._values["auto_merge_options"] = auto_merge_options
|
1448
|
+
if bin is not None:
|
1449
|
+
self._values["bin"] = bin
|
1450
|
+
if bugs_email is not None:
|
1451
|
+
self._values["bugs_email"] = bugs_email
|
1452
|
+
if bugs_url is not None:
|
1453
|
+
self._values["bugs_url"] = bugs_url
|
1454
|
+
if build_command is not None:
|
1455
|
+
self._values["build_command"] = build_command
|
1456
|
+
if build_workflow is not None:
|
1457
|
+
self._values["build_workflow"] = build_workflow
|
1458
|
+
if build_workflow_options is not None:
|
1459
|
+
self._values["build_workflow_options"] = build_workflow_options
|
1460
|
+
if build_workflow_triggers is not None:
|
1461
|
+
self._values["build_workflow_triggers"] = build_workflow_triggers
|
1462
|
+
if bump_package is not None:
|
1463
|
+
self._values["bump_package"] = bump_package
|
1464
|
+
if bundled_deps is not None:
|
1465
|
+
self._values["bundled_deps"] = bundled_deps
|
1466
|
+
if bundler_options is not None:
|
1467
|
+
self._values["bundler_options"] = bundler_options
|
1468
|
+
if bun_version is not None:
|
1469
|
+
self._values["bun_version"] = bun_version
|
1470
|
+
if cdk_assert is not None:
|
1471
|
+
self._values["cdk_assert"] = cdk_assert
|
1472
|
+
if cdk_assertions is not None:
|
1473
|
+
self._values["cdk_assertions"] = cdk_assertions
|
1474
|
+
if cdk_cli_version is not None:
|
1475
|
+
self._values["cdk_cli_version"] = cdk_cli_version
|
1476
|
+
if cdk_dependencies is not None:
|
1477
|
+
self._values["cdk_dependencies"] = cdk_dependencies
|
1478
|
+
if cdk_dependencies_as_deps is not None:
|
1479
|
+
self._values["cdk_dependencies_as_deps"] = cdk_dependencies_as_deps
|
1480
|
+
if cdkout is not None:
|
1481
|
+
self._values["cdkout"] = cdkout
|
1482
|
+
if cdk_test_dependencies is not None:
|
1483
|
+
self._values["cdk_test_dependencies"] = cdk_test_dependencies
|
1484
|
+
if cdk_version_pinning is not None:
|
1485
|
+
self._values["cdk_version_pinning"] = cdk_version_pinning
|
1486
|
+
if check_licenses is not None:
|
1487
|
+
self._values["check_licenses"] = check_licenses
|
1488
|
+
if clobber is not None:
|
1489
|
+
self._values["clobber"] = clobber
|
1490
|
+
if code_artifact_options is not None:
|
1491
|
+
self._values["code_artifact_options"] = code_artifact_options
|
1492
|
+
if code_cov is not None:
|
1493
|
+
self._values["code_cov"] = code_cov
|
1494
|
+
if code_cov_token_secret is not None:
|
1495
|
+
self._values["code_cov_token_secret"] = code_cov_token_secret
|
1496
|
+
if commit_generated is not None:
|
1497
|
+
self._values["commit_generated"] = commit_generated
|
1498
|
+
if constructs_version is not None:
|
1499
|
+
self._values["constructs_version"] = constructs_version
|
1500
|
+
if context is not None:
|
1501
|
+
self._values["context"] = context
|
1502
|
+
if copyright_owner is not None:
|
1503
|
+
self._values["copyright_owner"] = copyright_owner
|
1504
|
+
if copyright_period is not None:
|
1505
|
+
self._values["copyright_period"] = copyright_period
|
1506
|
+
if default_release_branch is not None:
|
1507
|
+
self._values["default_release_branch"] = default_release_branch
|
1508
|
+
if dependabot is not None:
|
1509
|
+
self._values["dependabot"] = dependabot
|
1510
|
+
if dependabot_options is not None:
|
1511
|
+
self._values["dependabot_options"] = dependabot_options
|
1512
|
+
if deps is not None:
|
1513
|
+
self._values["deps"] = deps
|
1514
|
+
if deps_upgrade is not None:
|
1515
|
+
self._values["deps_upgrade"] = deps_upgrade
|
1516
|
+
if deps_upgrade_options is not None:
|
1517
|
+
self._values["deps_upgrade_options"] = deps_upgrade_options
|
1518
|
+
if description is not None:
|
1519
|
+
self._values["description"] = description
|
1520
|
+
if dev_container is not None:
|
1521
|
+
self._values["dev_container"] = dev_container
|
1522
|
+
if dev_deps is not None:
|
1523
|
+
self._values["dev_deps"] = dev_deps
|
1524
|
+
if disable_tsconfig is not None:
|
1525
|
+
self._values["disable_tsconfig"] = disable_tsconfig
|
1526
|
+
if disable_tsconfig_dev is not None:
|
1527
|
+
self._values["disable_tsconfig_dev"] = disable_tsconfig_dev
|
1528
|
+
if docgen is not None:
|
1529
|
+
self._values["docgen"] = docgen
|
1530
|
+
if docs_directory is not None:
|
1531
|
+
self._values["docs_directory"] = docs_directory
|
1532
|
+
if edge_lambda_auto_discover is not None:
|
1533
|
+
self._values["edge_lambda_auto_discover"] = edge_lambda_auto_discover
|
1534
|
+
if entrypoint is not None:
|
1535
|
+
self._values["entrypoint"] = entrypoint
|
1536
|
+
if entrypoint_types is not None:
|
1537
|
+
self._values["entrypoint_types"] = entrypoint_types
|
1538
|
+
if eslint is not None:
|
1539
|
+
self._values["eslint"] = eslint
|
1540
|
+
if eslint_options is not None:
|
1541
|
+
self._values["eslint_options"] = eslint_options
|
1542
|
+
if experimental_integ_runner is not None:
|
1543
|
+
self._values["experimental_integ_runner"] = experimental_integ_runner
|
1544
|
+
if feature_flags is not None:
|
1545
|
+
self._values["feature_flags"] = feature_flags
|
1546
|
+
if github is not None:
|
1547
|
+
self._values["github"] = github
|
1548
|
+
if github_options is not None:
|
1549
|
+
self._values["github_options"] = github_options
|
1550
|
+
if gitignore is not None:
|
1551
|
+
self._values["gitignore"] = gitignore
|
1552
|
+
if git_ignore_options is not None:
|
1553
|
+
self._values["git_ignore_options"] = git_ignore_options
|
1554
|
+
if git_options is not None:
|
1555
|
+
self._values["git_options"] = git_options
|
1556
|
+
if gitpod is not None:
|
1557
|
+
self._values["gitpod"] = gitpod
|
1558
|
+
if homepage is not None:
|
1559
|
+
self._values["homepage"] = homepage
|
1560
|
+
if integration_test_auto_discover is not None:
|
1561
|
+
self._values["integration_test_auto_discover"] = integration_test_auto_discover
|
1562
|
+
if jest is not None:
|
1563
|
+
self._values["jest"] = jest
|
1564
|
+
if jest_options is not None:
|
1565
|
+
self._values["jest_options"] = jest_options
|
1566
|
+
if jsii_release_version is not None:
|
1567
|
+
self._values["jsii_release_version"] = jsii_release_version
|
1568
|
+
if keywords is not None:
|
1569
|
+
self._values["keywords"] = keywords
|
1570
|
+
if lambda_auto_discover is not None:
|
1571
|
+
self._values["lambda_auto_discover"] = lambda_auto_discover
|
1572
|
+
if lambda_extension_auto_discover is not None:
|
1573
|
+
self._values["lambda_extension_auto_discover"] = lambda_extension_auto_discover
|
1574
|
+
if lambda_options is not None:
|
1575
|
+
self._values["lambda_options"] = lambda_options
|
1576
|
+
if libdir is not None:
|
1577
|
+
self._values["libdir"] = libdir
|
1578
|
+
if license is not None:
|
1579
|
+
self._values["license"] = license
|
1580
|
+
if licensed is not None:
|
1581
|
+
self._values["licensed"] = licensed
|
1582
|
+
if logging is not None:
|
1583
|
+
self._values["logging"] = logging
|
1584
|
+
if major_version is not None:
|
1585
|
+
self._values["major_version"] = major_version
|
1586
|
+
if max_node_version is not None:
|
1587
|
+
self._values["max_node_version"] = max_node_version
|
1588
|
+
if mergify is not None:
|
1589
|
+
self._values["mergify"] = mergify
|
1590
|
+
if mergify_options is not None:
|
1591
|
+
self._values["mergify_options"] = mergify_options
|
1592
|
+
if min_major_version is not None:
|
1593
|
+
self._values["min_major_version"] = min_major_version
|
1594
|
+
if min_node_version is not None:
|
1595
|
+
self._values["min_node_version"] = min_node_version
|
1596
|
+
if mutable_build is not None:
|
1597
|
+
self._values["mutable_build"] = mutable_build
|
1598
|
+
if next_version_command is not None:
|
1599
|
+
self._values["next_version_command"] = next_version_command
|
1600
|
+
if npm_access is not None:
|
1601
|
+
self._values["npm_access"] = npm_access
|
1602
|
+
if npm_dist_tag is not None:
|
1603
|
+
self._values["npm_dist_tag"] = npm_dist_tag
|
1604
|
+
if npmignore is not None:
|
1605
|
+
self._values["npmignore"] = npmignore
|
1606
|
+
if npmignore_enabled is not None:
|
1607
|
+
self._values["npmignore_enabled"] = npmignore_enabled
|
1608
|
+
if npm_ignore_options is not None:
|
1609
|
+
self._values["npm_ignore_options"] = npm_ignore_options
|
1610
|
+
if npm_provenance is not None:
|
1611
|
+
self._values["npm_provenance"] = npm_provenance
|
1612
|
+
if npm_registry is not None:
|
1613
|
+
self._values["npm_registry"] = npm_registry
|
1614
|
+
if npm_registry_url is not None:
|
1615
|
+
self._values["npm_registry_url"] = npm_registry_url
|
1616
|
+
if npm_token_secret is not None:
|
1617
|
+
self._values["npm_token_secret"] = npm_token_secret
|
1618
|
+
if outdir is not None:
|
1619
|
+
self._values["outdir"] = outdir
|
1620
|
+
if package is not None:
|
1621
|
+
self._values["package"] = package
|
1622
|
+
if package_manager is not None:
|
1623
|
+
self._values["package_manager"] = package_manager
|
1624
|
+
if package_name is not None:
|
1625
|
+
self._values["package_name"] = package_name
|
1626
|
+
if parent is not None:
|
1627
|
+
self._values["parent"] = parent
|
1628
|
+
if peer_dependency_options is not None:
|
1629
|
+
self._values["peer_dependency_options"] = peer_dependency_options
|
1630
|
+
if peer_deps is not None:
|
1631
|
+
self._values["peer_deps"] = peer_deps
|
1632
|
+
if pnpm_version is not None:
|
1633
|
+
self._values["pnpm_version"] = pnpm_version
|
1634
|
+
if post_build_steps is not None:
|
1635
|
+
self._values["post_build_steps"] = post_build_steps
|
1636
|
+
if prerelease is not None:
|
1637
|
+
self._values["prerelease"] = prerelease
|
1638
|
+
if prettier is not None:
|
1639
|
+
self._values["prettier"] = prettier
|
1640
|
+
if prettier_options is not None:
|
1641
|
+
self._values["prettier_options"] = prettier_options
|
1642
|
+
if project_type is not None:
|
1643
|
+
self._values["project_type"] = project_type
|
1644
|
+
if projen_command is not None:
|
1645
|
+
self._values["projen_command"] = projen_command
|
1646
|
+
if projen_credentials is not None:
|
1647
|
+
self._values["projen_credentials"] = projen_credentials
|
1648
|
+
if projen_dev_dependency is not None:
|
1649
|
+
self._values["projen_dev_dependency"] = projen_dev_dependency
|
1650
|
+
if projenrc_js is not None:
|
1651
|
+
self._values["projenrc_js"] = projenrc_js
|
1652
|
+
if projenrc_json is not None:
|
1653
|
+
self._values["projenrc_json"] = projenrc_json
|
1654
|
+
if projenrc_json_options is not None:
|
1655
|
+
self._values["projenrc_json_options"] = projenrc_json_options
|
1656
|
+
if projenrc_js_options is not None:
|
1657
|
+
self._values["projenrc_js_options"] = projenrc_js_options
|
1658
|
+
if projenrc_ts is not None:
|
1659
|
+
self._values["projenrc_ts"] = projenrc_ts
|
1660
|
+
if projenrc_ts_options is not None:
|
1661
|
+
self._values["projenrc_ts_options"] = projenrc_ts_options
|
1662
|
+
if projen_token_secret is not None:
|
1663
|
+
self._values["projen_token_secret"] = projen_token_secret
|
1664
|
+
if projen_version is not None:
|
1665
|
+
self._values["projen_version"] = projen_version
|
1666
|
+
if publish_dry_run is not None:
|
1667
|
+
self._values["publish_dry_run"] = publish_dry_run
|
1668
|
+
if publish_tasks is not None:
|
1669
|
+
self._values["publish_tasks"] = publish_tasks
|
1670
|
+
if pull_request_template is not None:
|
1671
|
+
self._values["pull_request_template"] = pull_request_template
|
1672
|
+
if pull_request_template_contents is not None:
|
1673
|
+
self._values["pull_request_template_contents"] = pull_request_template_contents
|
1674
|
+
if readme is not None:
|
1675
|
+
self._values["readme"] = readme
|
1676
|
+
if releasable_commits is not None:
|
1677
|
+
self._values["releasable_commits"] = releasable_commits
|
1678
|
+
if release is not None:
|
1679
|
+
self._values["release"] = release
|
1680
|
+
if release_branches is not None:
|
1681
|
+
self._values["release_branches"] = release_branches
|
1682
|
+
if release_every_commit is not None:
|
1683
|
+
self._values["release_every_commit"] = release_every_commit
|
1684
|
+
if release_failure_issue is not None:
|
1685
|
+
self._values["release_failure_issue"] = release_failure_issue
|
1686
|
+
if release_failure_issue_label is not None:
|
1687
|
+
self._values["release_failure_issue_label"] = release_failure_issue_label
|
1688
|
+
if release_schedule is not None:
|
1689
|
+
self._values["release_schedule"] = release_schedule
|
1690
|
+
if release_tag_prefix is not None:
|
1691
|
+
self._values["release_tag_prefix"] = release_tag_prefix
|
1692
|
+
if release_to_npm is not None:
|
1693
|
+
self._values["release_to_npm"] = release_to_npm
|
1694
|
+
if release_trigger is not None:
|
1695
|
+
self._values["release_trigger"] = release_trigger
|
1696
|
+
if release_workflow is not None:
|
1697
|
+
self._values["release_workflow"] = release_workflow
|
1698
|
+
if release_workflow_name is not None:
|
1699
|
+
self._values["release_workflow_name"] = release_workflow_name
|
1700
|
+
if release_workflow_setup_steps is not None:
|
1701
|
+
self._values["release_workflow_setup_steps"] = release_workflow_setup_steps
|
1702
|
+
if renovatebot is not None:
|
1703
|
+
self._values["renovatebot"] = renovatebot
|
1704
|
+
if renovatebot_options is not None:
|
1705
|
+
self._values["renovatebot_options"] = renovatebot_options
|
1706
|
+
if repository is not None:
|
1707
|
+
self._values["repository"] = repository
|
1708
|
+
if repository_directory is not None:
|
1709
|
+
self._values["repository_directory"] = repository_directory
|
1710
|
+
if require_approval is not None:
|
1711
|
+
self._values["require_approval"] = require_approval
|
1712
|
+
if sample_code is not None:
|
1713
|
+
self._values["sample_code"] = sample_code
|
1714
|
+
if scoped_packages_options is not None:
|
1715
|
+
self._values["scoped_packages_options"] = scoped_packages_options
|
1716
|
+
if scripts is not None:
|
1717
|
+
self._values["scripts"] = scripts
|
1718
|
+
if srcdir is not None:
|
1719
|
+
self._values["srcdir"] = srcdir
|
1720
|
+
if stability is not None:
|
1721
|
+
self._values["stability"] = stability
|
1722
|
+
if stale is not None:
|
1723
|
+
self._values["stale"] = stale
|
1724
|
+
if stale_options is not None:
|
1725
|
+
self._values["stale_options"] = stale_options
|
1726
|
+
if testdir is not None:
|
1727
|
+
self._values["testdir"] = testdir
|
1728
|
+
if tsconfig is not None:
|
1729
|
+
self._values["tsconfig"] = tsconfig
|
1730
|
+
if tsconfig_dev is not None:
|
1731
|
+
self._values["tsconfig_dev"] = tsconfig_dev
|
1732
|
+
if tsconfig_dev_file is not None:
|
1733
|
+
self._values["tsconfig_dev_file"] = tsconfig_dev_file
|
1734
|
+
if ts_jest_options is not None:
|
1735
|
+
self._values["ts_jest_options"] = ts_jest_options
|
1736
|
+
if typescript_version is not None:
|
1737
|
+
self._values["typescript_version"] = typescript_version
|
1738
|
+
if versionrc_options is not None:
|
1739
|
+
self._values["versionrc_options"] = versionrc_options
|
1740
|
+
if vscode is not None:
|
1741
|
+
self._values["vscode"] = vscode
|
1742
|
+
if watch_excludes is not None:
|
1743
|
+
self._values["watch_excludes"] = watch_excludes
|
1744
|
+
if watch_includes is not None:
|
1745
|
+
self._values["watch_includes"] = watch_includes
|
1746
|
+
if workflow_bootstrap_steps is not None:
|
1747
|
+
self._values["workflow_bootstrap_steps"] = workflow_bootstrap_steps
|
1748
|
+
if workflow_container_image is not None:
|
1749
|
+
self._values["workflow_container_image"] = workflow_container_image
|
1750
|
+
if workflow_git_identity is not None:
|
1751
|
+
self._values["workflow_git_identity"] = workflow_git_identity
|
1752
|
+
if workflow_node_version is not None:
|
1753
|
+
self._values["workflow_node_version"] = workflow_node_version
|
1754
|
+
if workflow_package_cache is not None:
|
1755
|
+
self._values["workflow_package_cache"] = workflow_package_cache
|
1756
|
+
if workflow_runs_on is not None:
|
1757
|
+
self._values["workflow_runs_on"] = workflow_runs_on
|
1758
|
+
if workflow_runs_on_group is not None:
|
1759
|
+
self._values["workflow_runs_on_group"] = workflow_runs_on_group
|
1760
|
+
if yarn_berry_options is not None:
|
1761
|
+
self._values["yarn_berry_options"] = yarn_berry_options
|
1762
|
+
|
1763
|
+
@builtins.property
|
1764
|
+
def cdk_version(self) -> builtins.str:
|
1765
|
+
'''(experimental) Minimum version of the AWS CDK to depend on.
|
1766
|
+
|
1767
|
+
:default: "2.1.0"
|
1768
|
+
|
1769
|
+
:stability: experimental
|
1770
|
+
'''
|
1771
|
+
result = self._values.get("cdk_version")
|
1772
|
+
assert result is not None, "Required property 'cdk_version' is missing"
|
1773
|
+
return typing.cast(builtins.str, result)
|
1774
|
+
|
1775
|
+
@builtins.property
|
1776
|
+
def code_owners(self) -> typing.List[builtins.str]:
|
1777
|
+
'''List of teams used to generate the CODEOWNERS file.'''
|
1778
|
+
result = self._values.get("code_owners")
|
1779
|
+
assert result is not None, "Required property 'code_owners' is missing"
|
1780
|
+
return typing.cast(typing.List[builtins.str], result)
|
1781
|
+
|
1782
|
+
@builtins.property
|
1783
|
+
def name(self) -> builtins.str:
|
1784
|
+
'''(experimental) This is the name of your project.
|
1785
|
+
|
1786
|
+
:default: $BASEDIR
|
1787
|
+
|
1788
|
+
:stability: experimental
|
1789
|
+
:featured: true
|
1790
|
+
'''
|
1791
|
+
result = self._values.get("name")
|
1792
|
+
assert result is not None, "Required property 'name' is missing"
|
1793
|
+
return typing.cast(builtins.str, result)
|
1794
|
+
|
1795
|
+
@builtins.property
|
1796
|
+
def allow_library_dependencies(self) -> typing.Optional[builtins.bool]:
|
1797
|
+
'''(experimental) Allow the project to include ``peerDependencies`` and ``bundledDependencies``.
|
1798
|
+
|
1799
|
+
This is normally only allowed for libraries. For apps, there's no meaning
|
1800
|
+
for specifying these.
|
1801
|
+
|
1802
|
+
:default: true
|
1803
|
+
|
1804
|
+
:stability: experimental
|
1805
|
+
'''
|
1806
|
+
result = self._values.get("allow_library_dependencies")
|
1807
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
1808
|
+
|
1809
|
+
@builtins.property
|
1810
|
+
def app_entrypoint(self) -> typing.Optional[builtins.str]:
|
1811
|
+
'''(experimental) The CDK app's entrypoint (relative to the source directory, which is "src" by default).
|
1812
|
+
|
1813
|
+
:default: "main.ts"
|
1814
|
+
|
1815
|
+
:stability: experimental
|
1816
|
+
'''
|
1817
|
+
result = self._values.get("app_entrypoint")
|
1818
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
1819
|
+
|
1820
|
+
@builtins.property
|
1821
|
+
def artifacts_directory(self) -> typing.Optional[builtins.str]:
|
1822
|
+
'''(experimental) A directory which will contain build artifacts.
|
1823
|
+
|
1824
|
+
:default: "dist"
|
1825
|
+
|
1826
|
+
:stability: experimental
|
1827
|
+
'''
|
1828
|
+
result = self._values.get("artifacts_directory")
|
1829
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
1830
|
+
|
1831
|
+
@builtins.property
|
1832
|
+
def author_email(self) -> typing.Optional[builtins.str]:
|
1833
|
+
'''(experimental) Author's e-mail.
|
1834
|
+
|
1835
|
+
:stability: experimental
|
1836
|
+
'''
|
1837
|
+
result = self._values.get("author_email")
|
1838
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
1839
|
+
|
1840
|
+
@builtins.property
|
1841
|
+
def author_name(self) -> typing.Optional[builtins.str]:
|
1842
|
+
'''(experimental) Author's name.
|
1843
|
+
|
1844
|
+
:stability: experimental
|
1845
|
+
'''
|
1846
|
+
result = self._values.get("author_name")
|
1847
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
1848
|
+
|
1849
|
+
@builtins.property
|
1850
|
+
def author_organization(self) -> typing.Optional[builtins.bool]:
|
1851
|
+
'''(experimental) Is the author an organization.
|
1852
|
+
|
1853
|
+
:stability: experimental
|
1854
|
+
'''
|
1855
|
+
result = self._values.get("author_organization")
|
1856
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
1857
|
+
|
1858
|
+
@builtins.property
|
1859
|
+
def author_url(self) -> typing.Optional[builtins.str]:
|
1860
|
+
'''(experimental) Author's URL / Website.
|
1861
|
+
|
1862
|
+
:stability: experimental
|
1863
|
+
'''
|
1864
|
+
result = self._values.get("author_url")
|
1865
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
1866
|
+
|
1867
|
+
@builtins.property
|
1868
|
+
def auto_approve_options(
|
1869
|
+
self,
|
1870
|
+
) -> typing.Optional[_projen_github_04054675.AutoApproveOptions]:
|
1871
|
+
'''(experimental) Enable and configure the 'auto approve' workflow.
|
1872
|
+
|
1873
|
+
:default: - auto approve is disabled
|
1874
|
+
|
1875
|
+
:stability: experimental
|
1876
|
+
'''
|
1877
|
+
result = self._values.get("auto_approve_options")
|
1878
|
+
return typing.cast(typing.Optional[_projen_github_04054675.AutoApproveOptions], result)
|
1879
|
+
|
1880
|
+
@builtins.property
|
1881
|
+
def auto_approve_upgrades(self) -> typing.Optional[builtins.bool]:
|
1882
|
+
'''(experimental) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
|
1883
|
+
|
1884
|
+
Throw if set to true but ``autoApproveOptions`` are not defined.
|
1885
|
+
|
1886
|
+
:default: - true
|
1887
|
+
|
1888
|
+
:stability: experimental
|
1889
|
+
'''
|
1890
|
+
result = self._values.get("auto_approve_upgrades")
|
1891
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
1892
|
+
|
1893
|
+
@builtins.property
|
1894
|
+
def auto_detect_bin(self) -> typing.Optional[builtins.bool]:
|
1895
|
+
'''(experimental) Automatically add all executables under the ``bin`` directory to your ``package.json`` file under the ``bin`` section.
|
1896
|
+
|
1897
|
+
:default: true
|
1898
|
+
|
1899
|
+
:stability: experimental
|
1900
|
+
'''
|
1901
|
+
result = self._values.get("auto_detect_bin")
|
1902
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
1903
|
+
|
1904
|
+
@builtins.property
|
1905
|
+
def auto_merge(self) -> typing.Optional[builtins.bool]:
|
1906
|
+
'''(experimental) Enable automatic merging on GitHub.
|
1907
|
+
|
1908
|
+
Has no effect if ``github.mergify``
|
1909
|
+
is set to false.
|
1910
|
+
|
1911
|
+
:default: true
|
1912
|
+
|
1913
|
+
:stability: experimental
|
1914
|
+
'''
|
1915
|
+
result = self._values.get("auto_merge")
|
1916
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
1917
|
+
|
1918
|
+
@builtins.property
|
1919
|
+
def auto_merge_options(
|
1920
|
+
self,
|
1921
|
+
) -> typing.Optional[_projen_github_04054675.AutoMergeOptions]:
|
1922
|
+
'''(experimental) Configure options for automatic merging on GitHub.
|
1923
|
+
|
1924
|
+
Has no effect if
|
1925
|
+
``github.mergify`` or ``autoMerge`` is set to false.
|
1926
|
+
|
1927
|
+
:default: - see defaults in ``AutoMergeOptions``
|
1928
|
+
|
1929
|
+
:stability: experimental
|
1930
|
+
'''
|
1931
|
+
result = self._values.get("auto_merge_options")
|
1932
|
+
return typing.cast(typing.Optional[_projen_github_04054675.AutoMergeOptions], result)
|
1933
|
+
|
1934
|
+
@builtins.property
|
1935
|
+
def bin(self) -> typing.Optional[typing.Mapping[builtins.str, builtins.str]]:
|
1936
|
+
'''(experimental) Binary programs vended with your module.
|
1937
|
+
|
1938
|
+
You can use this option to add/customize how binaries are represented in
|
1939
|
+
your ``package.json``, but unless ``autoDetectBin`` is ``false``, every
|
1940
|
+
executable file under ``bin`` will automatically be added to this section.
|
1941
|
+
|
1942
|
+
:stability: experimental
|
1943
|
+
'''
|
1944
|
+
result = self._values.get("bin")
|
1945
|
+
return typing.cast(typing.Optional[typing.Mapping[builtins.str, builtins.str]], result)
|
1946
|
+
|
1947
|
+
@builtins.property
|
1948
|
+
def bugs_email(self) -> typing.Optional[builtins.str]:
|
1949
|
+
'''(experimental) The email address to which issues should be reported.
|
1950
|
+
|
1951
|
+
:stability: experimental
|
1952
|
+
'''
|
1953
|
+
result = self._values.get("bugs_email")
|
1954
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
1955
|
+
|
1956
|
+
@builtins.property
|
1957
|
+
def bugs_url(self) -> typing.Optional[builtins.str]:
|
1958
|
+
'''(experimental) The url to your project's issue tracker.
|
1959
|
+
|
1960
|
+
:stability: experimental
|
1961
|
+
'''
|
1962
|
+
result = self._values.get("bugs_url")
|
1963
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
1964
|
+
|
1965
|
+
@builtins.property
|
1966
|
+
def build_command(self) -> typing.Optional[builtins.str]:
|
1967
|
+
'''(experimental) A command to execute before synthesis.
|
1968
|
+
|
1969
|
+
This command will be called when
|
1970
|
+
running ``cdk synth`` or when ``cdk watch`` identifies a change in your source
|
1971
|
+
code before redeployment.
|
1972
|
+
|
1973
|
+
:default: - no build command
|
1974
|
+
|
1975
|
+
:stability: experimental
|
1976
|
+
'''
|
1977
|
+
result = self._values.get("build_command")
|
1978
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
1979
|
+
|
1980
|
+
@builtins.property
|
1981
|
+
def build_workflow(self) -> typing.Optional[builtins.bool]:
|
1982
|
+
'''(experimental) Define a GitHub workflow for building PRs.
|
1983
|
+
|
1984
|
+
:default: - true if not a subproject
|
1985
|
+
|
1986
|
+
:stability: experimental
|
1987
|
+
'''
|
1988
|
+
result = self._values.get("build_workflow")
|
1989
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
1990
|
+
|
1991
|
+
@builtins.property
|
1992
|
+
def build_workflow_options(
|
1993
|
+
self,
|
1994
|
+
) -> typing.Optional[_projen_javascript_04054675.BuildWorkflowOptions]:
|
1995
|
+
'''(experimental) Options for PR build workflow.
|
1996
|
+
|
1997
|
+
:stability: experimental
|
1998
|
+
'''
|
1999
|
+
result = self._values.get("build_workflow_options")
|
2000
|
+
return typing.cast(typing.Optional[_projen_javascript_04054675.BuildWorkflowOptions], result)
|
2001
|
+
|
2002
|
+
@builtins.property
|
2003
|
+
def build_workflow_triggers(
|
2004
|
+
self,
|
2005
|
+
) -> typing.Optional[_projen_github_workflows_04054675.Triggers]:
|
2006
|
+
'''(deprecated) Build workflow triggers.
|
2007
|
+
|
2008
|
+
:default: "{ pullRequest: {}, workflowDispatch: {} }"
|
2009
|
+
|
2010
|
+
:deprecated: - Use ``buildWorkflowOptions.workflowTriggers``
|
2011
|
+
|
2012
|
+
:stability: deprecated
|
2013
|
+
'''
|
2014
|
+
result = self._values.get("build_workflow_triggers")
|
2015
|
+
return typing.cast(typing.Optional[_projen_github_workflows_04054675.Triggers], result)
|
2016
|
+
|
2017
|
+
@builtins.property
|
2018
|
+
def bump_package(self) -> typing.Optional[builtins.str]:
|
2019
|
+
'''(experimental) The ``commit-and-tag-version`` compatible package used to bump the package version, as a dependency string.
|
2020
|
+
|
2021
|
+
This can be any compatible package version, including the deprecated ``standard-version@9``.
|
2022
|
+
|
2023
|
+
:default: - A recent version of "commit-and-tag-version"
|
2024
|
+
|
2025
|
+
:stability: experimental
|
2026
|
+
'''
|
2027
|
+
result = self._values.get("bump_package")
|
2028
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
2029
|
+
|
2030
|
+
@builtins.property
|
2031
|
+
def bundled_deps(self) -> typing.Optional[typing.List[builtins.str]]:
|
2032
|
+
'''(experimental) List of dependencies to bundle into this module.
|
2033
|
+
|
2034
|
+
These modules will be
|
2035
|
+
added both to the ``dependencies`` section and ``bundledDependencies`` section of
|
2036
|
+
your ``package.json``.
|
2037
|
+
|
2038
|
+
The recommendation is to only specify the module name here (e.g.
|
2039
|
+
``express``). This will behave similar to ``yarn add`` or ``npm install`` in the
|
2040
|
+
sense that it will add the module as a dependency to your ``package.json``
|
2041
|
+
file with the latest version (``^``). You can specify semver requirements in
|
2042
|
+
the same syntax passed to ``npm i`` or ``yarn add`` (e.g. ``express@^2``) and
|
2043
|
+
this will be what you ``package.json`` will eventually include.
|
2044
|
+
|
2045
|
+
:stability: experimental
|
2046
|
+
'''
|
2047
|
+
result = self._values.get("bundled_deps")
|
2048
|
+
return typing.cast(typing.Optional[typing.List[builtins.str]], result)
|
2049
|
+
|
2050
|
+
@builtins.property
|
2051
|
+
def bundler_options(
|
2052
|
+
self,
|
2053
|
+
) -> typing.Optional[_projen_javascript_04054675.BundlerOptions]:
|
2054
|
+
'''(experimental) Options for ``Bundler``.
|
2055
|
+
|
2056
|
+
:stability: experimental
|
2057
|
+
'''
|
2058
|
+
result = self._values.get("bundler_options")
|
2059
|
+
return typing.cast(typing.Optional[_projen_javascript_04054675.BundlerOptions], result)
|
2060
|
+
|
2061
|
+
@builtins.property
|
2062
|
+
def bun_version(self) -> typing.Optional[builtins.str]:
|
2063
|
+
'''(experimental) The version of Bun to use if using Bun as a package manager.
|
2064
|
+
|
2065
|
+
:default: "latest"
|
2066
|
+
|
2067
|
+
:stability: experimental
|
2068
|
+
'''
|
2069
|
+
result = self._values.get("bun_version")
|
2070
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
2071
|
+
|
2072
|
+
@builtins.property
|
2073
|
+
def cdk_assert(self) -> typing.Optional[builtins.bool]:
|
2074
|
+
'''(deprecated) Warning: NodeJS only.
|
2075
|
+
|
2076
|
+
Install the
|
2077
|
+
|
2078
|
+
:default: - will be included by default for AWS CDK >= 1.0.0 < 2.0.0
|
2079
|
+
|
2080
|
+
:deprecated: The
|
2081
|
+
|
2082
|
+
:stability: deprecated
|
2083
|
+
:aws-cdk: /assertions (in V1) and included in ``aws-cdk-lib`` for V2.
|
2084
|
+
'''
|
2085
|
+
result = self._values.get("cdk_assert")
|
2086
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2087
|
+
|
2088
|
+
@builtins.property
|
2089
|
+
def cdk_assertions(self) -> typing.Optional[builtins.bool]:
|
2090
|
+
'''(experimental) Install the assertions library?
|
2091
|
+
|
2092
|
+
Only needed for CDK 1.x. If using CDK 2.x then
|
2093
|
+
assertions is already included in 'aws-cdk-lib'
|
2094
|
+
|
2095
|
+
:default: - will be included by default for AWS CDK >= 1.111.0 < 2.0.0
|
2096
|
+
|
2097
|
+
:stability: experimental
|
2098
|
+
'''
|
2099
|
+
result = self._values.get("cdk_assertions")
|
2100
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2101
|
+
|
2102
|
+
@builtins.property
|
2103
|
+
def cdk_cli_version(self) -> typing.Optional[builtins.str]:
|
2104
|
+
'''(experimental) Version range of the AWS CDK CLI to depend on.
|
2105
|
+
|
2106
|
+
Can be either a specific version, or an NPM version range.
|
2107
|
+
|
2108
|
+
By default, the latest 2.x version will be installed; you can use this
|
2109
|
+
option to restrict it to a specific version or version range.
|
2110
|
+
|
2111
|
+
:default: "^2"
|
2112
|
+
|
2113
|
+
:stability: experimental
|
2114
|
+
'''
|
2115
|
+
result = self._values.get("cdk_cli_version")
|
2116
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
2117
|
+
|
2118
|
+
@builtins.property
|
2119
|
+
def cdk_dependencies(self) -> typing.Optional[typing.List[builtins.str]]:
|
2120
|
+
'''(deprecated) Which AWS CDKv1 modules this project requires.
|
2121
|
+
|
2122
|
+
:deprecated: For CDK 2.x use "deps" instead. (or "peerDeps" if you're building a library)
|
2123
|
+
|
2124
|
+
:stability: deprecated
|
2125
|
+
'''
|
2126
|
+
result = self._values.get("cdk_dependencies")
|
2127
|
+
return typing.cast(typing.Optional[typing.List[builtins.str]], result)
|
2128
|
+
|
2129
|
+
@builtins.property
|
2130
|
+
def cdk_dependencies_as_deps(self) -> typing.Optional[builtins.bool]:
|
2131
|
+
'''(deprecated) If this is enabled (default), all modules declared in ``cdkDependencies`` will be also added as normal ``dependencies`` (as well as ``peerDependencies``).
|
2132
|
+
|
2133
|
+
This is to ensure that downstream consumers actually have your CDK dependencies installed
|
2134
|
+
when using npm < 7 or yarn, where peer dependencies are not automatically installed.
|
2135
|
+
If this is disabled, ``cdkDependencies`` will be added to ``devDependencies`` to ensure
|
2136
|
+
they are present during development.
|
2137
|
+
|
2138
|
+
Note: this setting only applies to construct library projects
|
2139
|
+
|
2140
|
+
:default: true
|
2141
|
+
|
2142
|
+
:deprecated: Not supported in CDK v2.
|
2143
|
+
|
2144
|
+
:stability: deprecated
|
2145
|
+
'''
|
2146
|
+
result = self._values.get("cdk_dependencies_as_deps")
|
2147
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2148
|
+
|
2149
|
+
@builtins.property
|
2150
|
+
def cdkout(self) -> typing.Optional[builtins.str]:
|
2151
|
+
'''(experimental) cdk.out directory.
|
2152
|
+
|
2153
|
+
:default: "cdk.out"
|
2154
|
+
|
2155
|
+
:stability: experimental
|
2156
|
+
'''
|
2157
|
+
result = self._values.get("cdkout")
|
2158
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
2159
|
+
|
2160
|
+
@builtins.property
|
2161
|
+
def cdk_test_dependencies(self) -> typing.Optional[typing.List[builtins.str]]:
|
2162
|
+
'''(deprecated) AWS CDK modules required for testing.
|
2163
|
+
|
2164
|
+
:deprecated: For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead
|
2165
|
+
|
2166
|
+
:stability: deprecated
|
2167
|
+
'''
|
2168
|
+
result = self._values.get("cdk_test_dependencies")
|
2169
|
+
return typing.cast(typing.Optional[typing.List[builtins.str]], result)
|
2170
|
+
|
2171
|
+
@builtins.property
|
2172
|
+
def cdk_version_pinning(self) -> typing.Optional[builtins.bool]:
|
2173
|
+
'''(experimental) Use pinned version instead of caret version for CDK.
|
2174
|
+
|
2175
|
+
You can use this to prevent mixed versions for your CDK dependencies and to prevent auto-updates.
|
2176
|
+
If you use experimental features this will let you define the moment you include breaking changes.
|
2177
|
+
|
2178
|
+
:stability: experimental
|
2179
|
+
'''
|
2180
|
+
result = self._values.get("cdk_version_pinning")
|
2181
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2182
|
+
|
2183
|
+
@builtins.property
|
2184
|
+
def check_licenses(
|
2185
|
+
self,
|
2186
|
+
) -> typing.Optional[_projen_javascript_04054675.LicenseCheckerOptions]:
|
2187
|
+
'''(experimental) Configure which licenses should be deemed acceptable for use by dependencies.
|
2188
|
+
|
2189
|
+
This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.
|
2190
|
+
|
2191
|
+
:default: - no license checks are run during the build and all licenses will be accepted
|
2192
|
+
|
2193
|
+
:stability: experimental
|
2194
|
+
'''
|
2195
|
+
result = self._values.get("check_licenses")
|
2196
|
+
return typing.cast(typing.Optional[_projen_javascript_04054675.LicenseCheckerOptions], result)
|
2197
|
+
|
2198
|
+
@builtins.property
|
2199
|
+
def clobber(self) -> typing.Optional[builtins.bool]:
|
2200
|
+
'''(experimental) Add a ``clobber`` task which resets the repo to origin.
|
2201
|
+
|
2202
|
+
:default: - true, but false for subprojects
|
2203
|
+
|
2204
|
+
:stability: experimental
|
2205
|
+
'''
|
2206
|
+
result = self._values.get("clobber")
|
2207
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2208
|
+
|
2209
|
+
@builtins.property
|
2210
|
+
def code_artifact_options(
|
2211
|
+
self,
|
2212
|
+
) -> typing.Optional[_projen_javascript_04054675.CodeArtifactOptions]:
|
2213
|
+
'''(experimental) Options for npm packages using AWS CodeArtifact.
|
2214
|
+
|
2215
|
+
This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact
|
2216
|
+
|
2217
|
+
:default: - undefined
|
2218
|
+
|
2219
|
+
:stability: experimental
|
2220
|
+
'''
|
2221
|
+
result = self._values.get("code_artifact_options")
|
2222
|
+
return typing.cast(typing.Optional[_projen_javascript_04054675.CodeArtifactOptions], result)
|
2223
|
+
|
2224
|
+
@builtins.property
|
2225
|
+
def code_cov(self) -> typing.Optional[builtins.bool]:
|
2226
|
+
'''(experimental) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with ``@codeCovTokenSecret``.
|
2227
|
+
|
2228
|
+
:default: false
|
2229
|
+
|
2230
|
+
:stability: experimental
|
2231
|
+
'''
|
2232
|
+
result = self._values.get("code_cov")
|
2233
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2234
|
+
|
2235
|
+
@builtins.property
|
2236
|
+
def code_cov_token_secret(self) -> typing.Optional[builtins.str]:
|
2237
|
+
'''(experimental) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
|
2238
|
+
|
2239
|
+
:default: - if this option is not specified, only public repositories are supported
|
2240
|
+
|
2241
|
+
:stability: experimental
|
2242
|
+
'''
|
2243
|
+
result = self._values.get("code_cov_token_secret")
|
2244
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
2245
|
+
|
2246
|
+
@builtins.property
|
2247
|
+
def commit_generated(self) -> typing.Optional[builtins.bool]:
|
2248
|
+
'''(experimental) Whether to commit the managed files by default.
|
2249
|
+
|
2250
|
+
:default: true
|
2251
|
+
|
2252
|
+
:stability: experimental
|
2253
|
+
'''
|
2254
|
+
result = self._values.get("commit_generated")
|
2255
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2256
|
+
|
2257
|
+
@builtins.property
|
2258
|
+
def constructs_version(self) -> typing.Optional[builtins.str]:
|
2259
|
+
'''(experimental) Minimum version of the ``constructs`` library to depend on.
|
2260
|
+
|
2261
|
+
:default:
|
2262
|
+
|
2263
|
+
- for CDK 1.x the default is "3.2.27", for CDK 2.x the default is
|
2264
|
+
"10.0.5".
|
2265
|
+
|
2266
|
+
:stability: experimental
|
2267
|
+
'''
|
2268
|
+
result = self._values.get("constructs_version")
|
2269
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
2270
|
+
|
2271
|
+
@builtins.property
|
2272
|
+
def context(self) -> typing.Optional[typing.Mapping[builtins.str, typing.Any]]:
|
2273
|
+
'''(experimental) Additional context to include in ``cdk.json``.
|
2274
|
+
|
2275
|
+
:default: - no additional context
|
2276
|
+
|
2277
|
+
:stability: experimental
|
2278
|
+
'''
|
2279
|
+
result = self._values.get("context")
|
2280
|
+
return typing.cast(typing.Optional[typing.Mapping[builtins.str, typing.Any]], result)
|
2281
|
+
|
2282
|
+
@builtins.property
|
2283
|
+
def copyright_owner(self) -> typing.Optional[builtins.str]:
|
2284
|
+
'''(experimental) License copyright owner.
|
2285
|
+
|
2286
|
+
:default: - defaults to the value of authorName or "" if ``authorName`` is undefined.
|
2287
|
+
|
2288
|
+
:stability: experimental
|
2289
|
+
'''
|
2290
|
+
result = self._values.get("copyright_owner")
|
2291
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
2292
|
+
|
2293
|
+
@builtins.property
|
2294
|
+
def copyright_period(self) -> typing.Optional[builtins.str]:
|
2295
|
+
'''(experimental) The copyright years to put in the LICENSE file.
|
2296
|
+
|
2297
|
+
:default: - current year
|
2298
|
+
|
2299
|
+
:stability: experimental
|
2300
|
+
'''
|
2301
|
+
result = self._values.get("copyright_period")
|
2302
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
2303
|
+
|
2304
|
+
@builtins.property
|
2305
|
+
def default_release_branch(self) -> typing.Optional[builtins.str]:
|
2306
|
+
'''(experimental) The name of the main release branch.
|
2307
|
+
|
2308
|
+
:default: "main"
|
2309
|
+
|
2310
|
+
:stability: experimental
|
2311
|
+
'''
|
2312
|
+
result = self._values.get("default_release_branch")
|
2313
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
2314
|
+
|
2315
|
+
@builtins.property
|
2316
|
+
def dependabot(self) -> typing.Optional[builtins.bool]:
|
2317
|
+
'''(experimental) Use dependabot to handle dependency upgrades.
|
2318
|
+
|
2319
|
+
Cannot be used in conjunction with ``depsUpgrade``.
|
2320
|
+
|
2321
|
+
:default: false
|
2322
|
+
|
2323
|
+
:stability: experimental
|
2324
|
+
'''
|
2325
|
+
result = self._values.get("dependabot")
|
2326
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2327
|
+
|
2328
|
+
@builtins.property
|
2329
|
+
def dependabot_options(
|
2330
|
+
self,
|
2331
|
+
) -> typing.Optional[_projen_github_04054675.DependabotOptions]:
|
2332
|
+
'''(experimental) Options for dependabot.
|
2333
|
+
|
2334
|
+
:default: - default options
|
2335
|
+
|
2336
|
+
:stability: experimental
|
2337
|
+
'''
|
2338
|
+
result = self._values.get("dependabot_options")
|
2339
|
+
return typing.cast(typing.Optional[_projen_github_04054675.DependabotOptions], result)
|
2340
|
+
|
2341
|
+
@builtins.property
|
2342
|
+
def deps(self) -> typing.Optional[typing.List[builtins.str]]:
|
2343
|
+
'''(experimental) Runtime dependencies of this module.
|
2344
|
+
|
2345
|
+
The recommendation is to only specify the module name here (e.g.
|
2346
|
+
``express``). This will behave similar to ``yarn add`` or ``npm install`` in the
|
2347
|
+
sense that it will add the module as a dependency to your ``package.json``
|
2348
|
+
file with the latest version (``^``). You can specify semver requirements in
|
2349
|
+
the same syntax passed to ``npm i`` or ``yarn add`` (e.g. ``express@^2``) and
|
2350
|
+
this will be what you ``package.json`` will eventually include.
|
2351
|
+
|
2352
|
+
:default: []
|
2353
|
+
|
2354
|
+
:stability: experimental
|
2355
|
+
:featured: true
|
2356
|
+
'''
|
2357
|
+
result = self._values.get("deps")
|
2358
|
+
return typing.cast(typing.Optional[typing.List[builtins.str]], result)
|
2359
|
+
|
2360
|
+
@builtins.property
|
2361
|
+
def deps_upgrade(self) -> typing.Optional[builtins.bool]:
|
2362
|
+
'''(experimental) Use tasks and github workflows to handle dependency upgrades.
|
2363
|
+
|
2364
|
+
Cannot be used in conjunction with ``dependabot``.
|
2365
|
+
|
2366
|
+
:default: true
|
2367
|
+
|
2368
|
+
:stability: experimental
|
2369
|
+
'''
|
2370
|
+
result = self._values.get("deps_upgrade")
|
2371
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2372
|
+
|
2373
|
+
@builtins.property
|
2374
|
+
def deps_upgrade_options(
|
2375
|
+
self,
|
2376
|
+
) -> typing.Optional[_projen_javascript_04054675.UpgradeDependenciesOptions]:
|
2377
|
+
'''(experimental) Options for ``UpgradeDependencies``.
|
2378
|
+
|
2379
|
+
:default: - default options
|
2380
|
+
|
2381
|
+
:stability: experimental
|
2382
|
+
'''
|
2383
|
+
result = self._values.get("deps_upgrade_options")
|
2384
|
+
return typing.cast(typing.Optional[_projen_javascript_04054675.UpgradeDependenciesOptions], result)
|
2385
|
+
|
2386
|
+
@builtins.property
|
2387
|
+
def description(self) -> typing.Optional[builtins.str]:
|
2388
|
+
'''(experimental) The description is just a string that helps people understand the purpose of the package.
|
2389
|
+
|
2390
|
+
It can be used when searching for packages in a package manager as well.
|
2391
|
+
See https://classic.yarnpkg.com/en/docs/package-json/#toc-description
|
2392
|
+
|
2393
|
+
:stability: experimental
|
2394
|
+
:featured: true
|
2395
|
+
'''
|
2396
|
+
result = self._values.get("description")
|
2397
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
2398
|
+
|
2399
|
+
@builtins.property
|
2400
|
+
def dev_container(self) -> typing.Optional[builtins.bool]:
|
2401
|
+
'''(experimental) Add a VSCode development environment (used for GitHub Codespaces).
|
2402
|
+
|
2403
|
+
:default: false
|
2404
|
+
|
2405
|
+
:stability: experimental
|
2406
|
+
'''
|
2407
|
+
result = self._values.get("dev_container")
|
2408
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2409
|
+
|
2410
|
+
@builtins.property
|
2411
|
+
def dev_deps(self) -> typing.Optional[typing.List[builtins.str]]:
|
2412
|
+
'''(experimental) Build dependencies for this module.
|
2413
|
+
|
2414
|
+
These dependencies will only be
|
2415
|
+
available in your build environment but will not be fetched when this
|
2416
|
+
module is consumed.
|
2417
|
+
|
2418
|
+
The recommendation is to only specify the module name here (e.g.
|
2419
|
+
``express``). This will behave similar to ``yarn add`` or ``npm install`` in the
|
2420
|
+
sense that it will add the module as a dependency to your ``package.json``
|
2421
|
+
file with the latest version (``^``). You can specify semver requirements in
|
2422
|
+
the same syntax passed to ``npm i`` or ``yarn add`` (e.g. ``express@^2``) and
|
2423
|
+
this will be what you ``package.json`` will eventually include.
|
2424
|
+
|
2425
|
+
:default: []
|
2426
|
+
|
2427
|
+
:stability: experimental
|
2428
|
+
:featured: true
|
2429
|
+
'''
|
2430
|
+
result = self._values.get("dev_deps")
|
2431
|
+
return typing.cast(typing.Optional[typing.List[builtins.str]], result)
|
2432
|
+
|
2433
|
+
@builtins.property
|
2434
|
+
def disable_tsconfig(self) -> typing.Optional[builtins.bool]:
|
2435
|
+
'''(experimental) Do not generate a ``tsconfig.json`` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
|
2436
|
+
|
2437
|
+
:default: false
|
2438
|
+
|
2439
|
+
:stability: experimental
|
2440
|
+
'''
|
2441
|
+
result = self._values.get("disable_tsconfig")
|
2442
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2443
|
+
|
2444
|
+
@builtins.property
|
2445
|
+
def disable_tsconfig_dev(self) -> typing.Optional[builtins.bool]:
|
2446
|
+
'''(experimental) Do not generate a ``tsconfig.dev.json`` file.
|
2447
|
+
|
2448
|
+
:default: false
|
2449
|
+
|
2450
|
+
:stability: experimental
|
2451
|
+
'''
|
2452
|
+
result = self._values.get("disable_tsconfig_dev")
|
2453
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2454
|
+
|
2455
|
+
@builtins.property
|
2456
|
+
def docgen(self) -> typing.Optional[builtins.bool]:
|
2457
|
+
'''(experimental) Docgen by Typedoc.
|
2458
|
+
|
2459
|
+
:default: false
|
2460
|
+
|
2461
|
+
:stability: experimental
|
2462
|
+
'''
|
2463
|
+
result = self._values.get("docgen")
|
2464
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2465
|
+
|
2466
|
+
@builtins.property
|
2467
|
+
def docs_directory(self) -> typing.Optional[builtins.str]:
|
2468
|
+
'''(experimental) Docs directory.
|
2469
|
+
|
2470
|
+
:default: "docs"
|
2471
|
+
|
2472
|
+
:stability: experimental
|
2473
|
+
'''
|
2474
|
+
result = self._values.get("docs_directory")
|
2475
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
2476
|
+
|
2477
|
+
@builtins.property
|
2478
|
+
def edge_lambda_auto_discover(self) -> typing.Optional[builtins.bool]:
|
2479
|
+
'''(experimental) Automatically adds an ``cloudfront.experimental.EdgeFunction`` for each ``.edge-lambda.ts`` handler in your source tree. If this is disabled, you can manually add an ``awscdk.AutoDiscover`` component to your project.
|
2480
|
+
|
2481
|
+
:default: true
|
2482
|
+
|
2483
|
+
:stability: experimental
|
2484
|
+
'''
|
2485
|
+
result = self._values.get("edge_lambda_auto_discover")
|
2486
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2487
|
+
|
2488
|
+
@builtins.property
|
2489
|
+
def entrypoint(self) -> typing.Optional[builtins.str]:
|
2490
|
+
'''(experimental) Module entrypoint (``main`` in ``package.json``). Set to an empty string to not include ``main`` in your package.json.
|
2491
|
+
|
2492
|
+
:default: "lib/index.js"
|
2493
|
+
|
2494
|
+
:stability: experimental
|
2495
|
+
'''
|
2496
|
+
result = self._values.get("entrypoint")
|
2497
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
2498
|
+
|
2499
|
+
@builtins.property
|
2500
|
+
def entrypoint_types(self) -> typing.Optional[builtins.str]:
|
2501
|
+
'''(experimental) The .d.ts file that includes the type declarations for this module.
|
2502
|
+
|
2503
|
+
:default: - .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
|
2504
|
+
|
2505
|
+
:stability: experimental
|
2506
|
+
'''
|
2507
|
+
result = self._values.get("entrypoint_types")
|
2508
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
2509
|
+
|
2510
|
+
@builtins.property
|
2511
|
+
def eslint(self) -> typing.Optional[builtins.bool]:
|
2512
|
+
'''(experimental) Setup eslint.
|
2513
|
+
|
2514
|
+
:default: true
|
2515
|
+
|
2516
|
+
:stability: experimental
|
2517
|
+
'''
|
2518
|
+
result = self._values.get("eslint")
|
2519
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2520
|
+
|
2521
|
+
@builtins.property
|
2522
|
+
def eslint_options(
|
2523
|
+
self,
|
2524
|
+
) -> typing.Optional[_projen_javascript_04054675.EslintOptions]:
|
2525
|
+
'''(experimental) Eslint options.
|
2526
|
+
|
2527
|
+
:default: - opinionated default options
|
2528
|
+
|
2529
|
+
:stability: experimental
|
2530
|
+
'''
|
2531
|
+
result = self._values.get("eslint_options")
|
2532
|
+
return typing.cast(typing.Optional[_projen_javascript_04054675.EslintOptions], result)
|
2533
|
+
|
2534
|
+
@builtins.property
|
2535
|
+
def experimental_integ_runner(self) -> typing.Optional[builtins.bool]:
|
2536
|
+
'''(experimental) Enable experimental support for the AWS CDK integ-runner.
|
2537
|
+
|
2538
|
+
:default: false
|
2539
|
+
|
2540
|
+
:stability: experimental
|
2541
|
+
'''
|
2542
|
+
result = self._values.get("experimental_integ_runner")
|
2543
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2544
|
+
|
2545
|
+
@builtins.property
|
2546
|
+
def feature_flags(self) -> typing.Optional[builtins.bool]:
|
2547
|
+
'''(experimental) Include all feature flags in cdk.json.
|
2548
|
+
|
2549
|
+
:default: true
|
2550
|
+
|
2551
|
+
:stability: experimental
|
2552
|
+
'''
|
2553
|
+
result = self._values.get("feature_flags")
|
2554
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2555
|
+
|
2556
|
+
@builtins.property
|
2557
|
+
def github(self) -> typing.Optional[builtins.bool]:
|
2558
|
+
'''(experimental) Enable GitHub integration.
|
2559
|
+
|
2560
|
+
Enabled by default for root projects. Disabled for non-root projects.
|
2561
|
+
|
2562
|
+
:default: true
|
2563
|
+
|
2564
|
+
:stability: experimental
|
2565
|
+
'''
|
2566
|
+
result = self._values.get("github")
|
2567
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2568
|
+
|
2569
|
+
@builtins.property
|
2570
|
+
def github_options(self) -> typing.Optional[_projen_github_04054675.GitHubOptions]:
|
2571
|
+
'''(experimental) Options for GitHub integration.
|
2572
|
+
|
2573
|
+
:default: - see GitHubOptions
|
2574
|
+
|
2575
|
+
:stability: experimental
|
2576
|
+
'''
|
2577
|
+
result = self._values.get("github_options")
|
2578
|
+
return typing.cast(typing.Optional[_projen_github_04054675.GitHubOptions], result)
|
2579
|
+
|
2580
|
+
@builtins.property
|
2581
|
+
def gitignore(self) -> typing.Optional[typing.List[builtins.str]]:
|
2582
|
+
'''(experimental) Additional entries to .gitignore.
|
2583
|
+
|
2584
|
+
:stability: experimental
|
2585
|
+
'''
|
2586
|
+
result = self._values.get("gitignore")
|
2587
|
+
return typing.cast(typing.Optional[typing.List[builtins.str]], result)
|
2588
|
+
|
2589
|
+
@builtins.property
|
2590
|
+
def git_ignore_options(self) -> typing.Optional[_projen_04054675.IgnoreFileOptions]:
|
2591
|
+
'''(experimental) Configuration options for .gitignore file.
|
2592
|
+
|
2593
|
+
:stability: experimental
|
2594
|
+
'''
|
2595
|
+
result = self._values.get("git_ignore_options")
|
2596
|
+
return typing.cast(typing.Optional[_projen_04054675.IgnoreFileOptions], result)
|
2597
|
+
|
2598
|
+
@builtins.property
|
2599
|
+
def git_options(self) -> typing.Optional[_projen_04054675.GitOptions]:
|
2600
|
+
'''(experimental) Configuration options for git.
|
2601
|
+
|
2602
|
+
:stability: experimental
|
2603
|
+
'''
|
2604
|
+
result = self._values.get("git_options")
|
2605
|
+
return typing.cast(typing.Optional[_projen_04054675.GitOptions], result)
|
2606
|
+
|
2607
|
+
@builtins.property
|
2608
|
+
def gitpod(self) -> typing.Optional[builtins.bool]:
|
2609
|
+
'''(experimental) Add a Gitpod development environment.
|
2610
|
+
|
2611
|
+
:default: false
|
2612
|
+
|
2613
|
+
:stability: experimental
|
2614
|
+
'''
|
2615
|
+
result = self._values.get("gitpod")
|
2616
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2617
|
+
|
2618
|
+
@builtins.property
|
2619
|
+
def homepage(self) -> typing.Optional[builtins.str]:
|
2620
|
+
'''(experimental) Package's Homepage / Website.
|
2621
|
+
|
2622
|
+
:stability: experimental
|
2623
|
+
'''
|
2624
|
+
result = self._values.get("homepage")
|
2625
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
2626
|
+
|
2627
|
+
@builtins.property
|
2628
|
+
def integration_test_auto_discover(self) -> typing.Optional[builtins.bool]:
|
2629
|
+
'''(experimental) Automatically discovers and creates integration tests for each ``.integ.ts`` file in under your test directory.
|
2630
|
+
|
2631
|
+
:default: true
|
2632
|
+
|
2633
|
+
:stability: experimental
|
2634
|
+
'''
|
2635
|
+
result = self._values.get("integration_test_auto_discover")
|
2636
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2637
|
+
|
2638
|
+
@builtins.property
|
2639
|
+
def jest(self) -> typing.Optional[builtins.bool]:
|
2640
|
+
'''(experimental) Setup jest unit tests.
|
2641
|
+
|
2642
|
+
:default: true
|
2643
|
+
|
2644
|
+
:stability: experimental
|
2645
|
+
'''
|
2646
|
+
result = self._values.get("jest")
|
2647
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2648
|
+
|
2649
|
+
@builtins.property
|
2650
|
+
def jest_options(self) -> typing.Optional[_projen_javascript_04054675.JestOptions]:
|
2651
|
+
'''(experimental) Jest options.
|
2652
|
+
|
2653
|
+
:default: - default options
|
2654
|
+
|
2655
|
+
:stability: experimental
|
2656
|
+
'''
|
2657
|
+
result = self._values.get("jest_options")
|
2658
|
+
return typing.cast(typing.Optional[_projen_javascript_04054675.JestOptions], result)
|
2659
|
+
|
2660
|
+
@builtins.property
|
2661
|
+
def jsii_release_version(self) -> typing.Optional[builtins.str]:
|
2662
|
+
'''(experimental) Version requirement of ``publib`` which is used to publish modules to npm.
|
2663
|
+
|
2664
|
+
:default: "latest"
|
2665
|
+
|
2666
|
+
:stability: experimental
|
2667
|
+
'''
|
2668
|
+
result = self._values.get("jsii_release_version")
|
2669
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
2670
|
+
|
2671
|
+
@builtins.property
|
2672
|
+
def keywords(self) -> typing.Optional[typing.List[builtins.str]]:
|
2673
|
+
'''(experimental) Keywords to include in ``package.json``.
|
2674
|
+
|
2675
|
+
:stability: experimental
|
2676
|
+
'''
|
2677
|
+
result = self._values.get("keywords")
|
2678
|
+
return typing.cast(typing.Optional[typing.List[builtins.str]], result)
|
2679
|
+
|
2680
|
+
@builtins.property
|
2681
|
+
def lambda_auto_discover(self) -> typing.Optional[builtins.bool]:
|
2682
|
+
'''(experimental) Automatically adds an ``awscdk.LambdaFunction`` for each ``.lambda.ts`` handler in your source tree. If this is disabled, you can manually add an ``awscdk.AutoDiscover`` component to your project.
|
2683
|
+
|
2684
|
+
:default: true
|
2685
|
+
|
2686
|
+
:stability: experimental
|
2687
|
+
'''
|
2688
|
+
result = self._values.get("lambda_auto_discover")
|
2689
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2690
|
+
|
2691
|
+
@builtins.property
|
2692
|
+
def lambda_extension_auto_discover(self) -> typing.Optional[builtins.bool]:
|
2693
|
+
'''(experimental) Automatically adds an ``awscdk.LambdaExtension`` for each ``.lambda-extension.ts`` entrypoint in your source tree. If this is disabled, you can manually add an ``awscdk.AutoDiscover`` component to your project.
|
2694
|
+
|
2695
|
+
:default: true
|
2696
|
+
|
2697
|
+
:stability: experimental
|
2698
|
+
'''
|
2699
|
+
result = self._values.get("lambda_extension_auto_discover")
|
2700
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2701
|
+
|
2702
|
+
@builtins.property
|
2703
|
+
def lambda_options(
|
2704
|
+
self,
|
2705
|
+
) -> typing.Optional[_projen_awscdk_04054675.LambdaFunctionCommonOptions]:
|
2706
|
+
'''(experimental) Common options for all AWS Lambda functions.
|
2707
|
+
|
2708
|
+
:default: - default options
|
2709
|
+
|
2710
|
+
:stability: experimental
|
2711
|
+
'''
|
2712
|
+
result = self._values.get("lambda_options")
|
2713
|
+
return typing.cast(typing.Optional[_projen_awscdk_04054675.LambdaFunctionCommonOptions], result)
|
2714
|
+
|
2715
|
+
@builtins.property
|
2716
|
+
def libdir(self) -> typing.Optional[builtins.str]:
|
2717
|
+
'''(experimental) Typescript artifacts output directory.
|
2718
|
+
|
2719
|
+
:default: "lib"
|
2720
|
+
|
2721
|
+
:stability: experimental
|
2722
|
+
'''
|
2723
|
+
result = self._values.get("libdir")
|
2724
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
2725
|
+
|
2726
|
+
@builtins.property
|
2727
|
+
def license(self) -> typing.Optional[builtins.str]:
|
2728
|
+
'''(experimental) License's SPDX identifier.
|
2729
|
+
|
2730
|
+
See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses.
|
2731
|
+
Use the ``licensed`` option if you want to no license to be specified.
|
2732
|
+
|
2733
|
+
:default: "Apache-2.0"
|
2734
|
+
|
2735
|
+
:stability: experimental
|
2736
|
+
'''
|
2737
|
+
result = self._values.get("license")
|
2738
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
2739
|
+
|
2740
|
+
@builtins.property
|
2741
|
+
def licensed(self) -> typing.Optional[builtins.bool]:
|
2742
|
+
'''(experimental) Indicates if a license should be added.
|
2743
|
+
|
2744
|
+
:default: true
|
2745
|
+
|
2746
|
+
:stability: experimental
|
2747
|
+
'''
|
2748
|
+
result = self._values.get("licensed")
|
2749
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2750
|
+
|
2751
|
+
@builtins.property
|
2752
|
+
def logging(self) -> typing.Optional[_projen_04054675.LoggerOptions]:
|
2753
|
+
'''(experimental) Configure logging options such as verbosity.
|
2754
|
+
|
2755
|
+
:default: {}
|
2756
|
+
|
2757
|
+
:stability: experimental
|
2758
|
+
'''
|
2759
|
+
result = self._values.get("logging")
|
2760
|
+
return typing.cast(typing.Optional[_projen_04054675.LoggerOptions], result)
|
2761
|
+
|
2762
|
+
@builtins.property
|
2763
|
+
def major_version(self) -> typing.Optional[jsii.Number]:
|
2764
|
+
'''(experimental) Major version to release from the default branch.
|
2765
|
+
|
2766
|
+
If this is specified, we bump the latest version of this major version line.
|
2767
|
+
If not specified, we bump the global latest version.
|
2768
|
+
|
2769
|
+
:default: - Major version is not enforced.
|
2770
|
+
|
2771
|
+
:stability: experimental
|
2772
|
+
'''
|
2773
|
+
result = self._values.get("major_version")
|
2774
|
+
return typing.cast(typing.Optional[jsii.Number], result)
|
2775
|
+
|
2776
|
+
@builtins.property
|
2777
|
+
def max_node_version(self) -> typing.Optional[builtins.str]:
|
2778
|
+
'''(experimental) The maximum node version supported by this package.
|
2779
|
+
|
2780
|
+
Most projects should not use this option.
|
2781
|
+
The value indicates that the package is incompatible with any newer versions of node.
|
2782
|
+
This requirement is enforced via the engines field.
|
2783
|
+
|
2784
|
+
You will normally not need to set this option.
|
2785
|
+
Consider this option only if your package is known to not function with newer versions of node.
|
2786
|
+
|
2787
|
+
:default: - no maximum version is enforced
|
2788
|
+
|
2789
|
+
:stability: experimental
|
2790
|
+
'''
|
2791
|
+
result = self._values.get("max_node_version")
|
2792
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
2793
|
+
|
2794
|
+
@builtins.property
|
2795
|
+
def mergify(self) -> typing.Optional[builtins.bool]:
|
2796
|
+
'''(deprecated) Whether mergify should be enabled on this repository or not.
|
2797
|
+
|
2798
|
+
:default: true
|
2799
|
+
|
2800
|
+
:deprecated: use ``githubOptions.mergify`` instead
|
2801
|
+
|
2802
|
+
:stability: deprecated
|
2803
|
+
'''
|
2804
|
+
result = self._values.get("mergify")
|
2805
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2806
|
+
|
2807
|
+
@builtins.property
|
2808
|
+
def mergify_options(
|
2809
|
+
self,
|
2810
|
+
) -> typing.Optional[_projen_github_04054675.MergifyOptions]:
|
2811
|
+
'''(deprecated) Options for mergify.
|
2812
|
+
|
2813
|
+
:default: - default options
|
2814
|
+
|
2815
|
+
:deprecated: use ``githubOptions.mergifyOptions`` instead
|
2816
|
+
|
2817
|
+
:stability: deprecated
|
2818
|
+
'''
|
2819
|
+
result = self._values.get("mergify_options")
|
2820
|
+
return typing.cast(typing.Optional[_projen_github_04054675.MergifyOptions], result)
|
2821
|
+
|
2822
|
+
@builtins.property
|
2823
|
+
def min_major_version(self) -> typing.Optional[jsii.Number]:
|
2824
|
+
'''(experimental) Minimal Major version to release.
|
2825
|
+
|
2826
|
+
This can be useful to set to 1, as breaking changes before the 1.x major
|
2827
|
+
release are not incrementing the major version number.
|
2828
|
+
|
2829
|
+
Can not be set together with ``majorVersion``.
|
2830
|
+
|
2831
|
+
:default: - No minimum version is being enforced
|
2832
|
+
|
2833
|
+
:stability: experimental
|
2834
|
+
'''
|
2835
|
+
result = self._values.get("min_major_version")
|
2836
|
+
return typing.cast(typing.Optional[jsii.Number], result)
|
2837
|
+
|
2838
|
+
@builtins.property
|
2839
|
+
def min_node_version(self) -> typing.Optional[builtins.str]:
|
2840
|
+
'''(experimental) The minimum node version required by this package to function.
|
2841
|
+
|
2842
|
+
Most projects should not use this option.
|
2843
|
+
The value indicates that the package is incompatible with any older versions of node.
|
2844
|
+
This requirement is enforced via the engines field.
|
2845
|
+
|
2846
|
+
You will normally not need to set this option, even if your package is incompatible with EOL versions of node.
|
2847
|
+
Consider this option only if your package depends on a specific feature, that is not available in other LTS versions.
|
2848
|
+
Setting this option has very high impact on the consumers of your package,
|
2849
|
+
as package managers will actively prevent usage with node versions you have marked as incompatible.
|
2850
|
+
|
2851
|
+
To change the node version of your CI/CD workflows, use ``workflowNodeVersion``.
|
2852
|
+
|
2853
|
+
:default: - no minimum version is enforced
|
2854
|
+
|
2855
|
+
:stability: experimental
|
2856
|
+
'''
|
2857
|
+
result = self._values.get("min_node_version")
|
2858
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
2859
|
+
|
2860
|
+
@builtins.property
|
2861
|
+
def mutable_build(self) -> typing.Optional[builtins.bool]:
|
2862
|
+
'''(deprecated) Automatically update files modified during builds to pull-request branches.
|
2863
|
+
|
2864
|
+
This means
|
2865
|
+
that any files synthesized by projen or e.g. test snapshots will always be up-to-date
|
2866
|
+
before a PR is merged.
|
2867
|
+
|
2868
|
+
Implies that PR builds do not have anti-tamper checks.
|
2869
|
+
|
2870
|
+
:default: true
|
2871
|
+
|
2872
|
+
:deprecated: - Use ``buildWorkflowOptions.mutableBuild``
|
2873
|
+
|
2874
|
+
:stability: deprecated
|
2875
|
+
'''
|
2876
|
+
result = self._values.get("mutable_build")
|
2877
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2878
|
+
|
2879
|
+
@builtins.property
|
2880
|
+
def next_version_command(self) -> typing.Optional[builtins.str]:
|
2881
|
+
'''(experimental) A shell command to control the next version to release.
|
2882
|
+
|
2883
|
+
If present, this shell command will be run before the bump is executed, and
|
2884
|
+
it determines what version to release. It will be executed in the following
|
2885
|
+
environment:
|
2886
|
+
|
2887
|
+
- Working directory: the project directory.
|
2888
|
+
- ``$VERSION``: the current version. Looks like ``1.2.3``.
|
2889
|
+
- ``$LATEST_TAG``: the most recent tag. Looks like ``prefix-v1.2.3``, or may be unset.
|
2890
|
+
|
2891
|
+
The command should print one of the following to ``stdout``:
|
2892
|
+
|
2893
|
+
- Nothing: the next version number will be determined based on commit history.
|
2894
|
+
- ``x.y.z``: the next version number will be ``x.y.z``.
|
2895
|
+
- ``major|minor|patch``: the next version number will be the current version number
|
2896
|
+
with the indicated component bumped.
|
2897
|
+
|
2898
|
+
This setting cannot be specified together with ``minMajorVersion``; the invoked
|
2899
|
+
script can be used to achieve the effects of ``minMajorVersion``.
|
2900
|
+
|
2901
|
+
:default: - The next version will be determined based on the commit history and project settings.
|
2902
|
+
|
2903
|
+
:stability: experimental
|
2904
|
+
'''
|
2905
|
+
result = self._values.get("next_version_command")
|
2906
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
2907
|
+
|
2908
|
+
@builtins.property
|
2909
|
+
def npm_access(self) -> typing.Optional[_projen_javascript_04054675.NpmAccess]:
|
2910
|
+
'''(experimental) Access level of the npm package.
|
2911
|
+
|
2912
|
+
:default:
|
2913
|
+
|
2914
|
+
- for scoped packages (e.g. ``foo@bar``), the default is
|
2915
|
+
``NpmAccess.RESTRICTED``, for non-scoped packages, the default is
|
2916
|
+
``NpmAccess.PUBLIC``.
|
2917
|
+
|
2918
|
+
:stability: experimental
|
2919
|
+
'''
|
2920
|
+
result = self._values.get("npm_access")
|
2921
|
+
return typing.cast(typing.Optional[_projen_javascript_04054675.NpmAccess], result)
|
2922
|
+
|
2923
|
+
@builtins.property
|
2924
|
+
def npm_dist_tag(self) -> typing.Optional[builtins.str]:
|
2925
|
+
'''(experimental) The npmDistTag to use when publishing from the default branch.
|
2926
|
+
|
2927
|
+
To set the npm dist-tag for release branches, set the ``npmDistTag`` property
|
2928
|
+
for each branch.
|
2929
|
+
|
2930
|
+
:default: "latest"
|
2931
|
+
|
2932
|
+
:stability: experimental
|
2933
|
+
'''
|
2934
|
+
result = self._values.get("npm_dist_tag")
|
2935
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
2936
|
+
|
2937
|
+
@builtins.property
|
2938
|
+
def npmignore(self) -> typing.Optional[typing.List[builtins.str]]:
|
2939
|
+
'''(deprecated) Additional entries to .npmignore.
|
2940
|
+
|
2941
|
+
:deprecated: - use ``project.addPackageIgnore``
|
2942
|
+
|
2943
|
+
:stability: deprecated
|
2944
|
+
'''
|
2945
|
+
result = self._values.get("npmignore")
|
2946
|
+
return typing.cast(typing.Optional[typing.List[builtins.str]], result)
|
2947
|
+
|
2948
|
+
@builtins.property
|
2949
|
+
def npmignore_enabled(self) -> typing.Optional[builtins.bool]:
|
2950
|
+
'''(experimental) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
|
2951
|
+
|
2952
|
+
:default: true
|
2953
|
+
|
2954
|
+
:stability: experimental
|
2955
|
+
'''
|
2956
|
+
result = self._values.get("npmignore_enabled")
|
2957
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2958
|
+
|
2959
|
+
@builtins.property
|
2960
|
+
def npm_ignore_options(self) -> typing.Optional[_projen_04054675.IgnoreFileOptions]:
|
2961
|
+
'''(experimental) Configuration options for .npmignore file.
|
2962
|
+
|
2963
|
+
:stability: experimental
|
2964
|
+
'''
|
2965
|
+
result = self._values.get("npm_ignore_options")
|
2966
|
+
return typing.cast(typing.Optional[_projen_04054675.IgnoreFileOptions], result)
|
2967
|
+
|
2968
|
+
@builtins.property
|
2969
|
+
def npm_provenance(self) -> typing.Optional[builtins.bool]:
|
2970
|
+
'''(experimental) Should provenance statements be generated when the package is published.
|
2971
|
+
|
2972
|
+
A supported package manager is required to publish a package with npm provenance statements and
|
2973
|
+
you will need to use a supported CI/CD provider.
|
2974
|
+
|
2975
|
+
Note that the projen ``Release`` and ``Publisher`` components are using ``publib`` to publish packages,
|
2976
|
+
which is using npm internally and supports provenance statements independently of the package manager used.
|
2977
|
+
|
2978
|
+
:default: - true for public packages, false otherwise
|
2979
|
+
|
2980
|
+
:stability: experimental
|
2981
|
+
'''
|
2982
|
+
result = self._values.get("npm_provenance")
|
2983
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
2984
|
+
|
2985
|
+
@builtins.property
|
2986
|
+
def npm_registry(self) -> typing.Optional[builtins.str]:
|
2987
|
+
'''(deprecated) The host name of the npm registry to publish to.
|
2988
|
+
|
2989
|
+
Cannot be set together with ``npmRegistryUrl``.
|
2990
|
+
|
2991
|
+
:deprecated: use ``npmRegistryUrl`` instead
|
2992
|
+
|
2993
|
+
:stability: deprecated
|
2994
|
+
'''
|
2995
|
+
result = self._values.get("npm_registry")
|
2996
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
2997
|
+
|
2998
|
+
@builtins.property
|
2999
|
+
def npm_registry_url(self) -> typing.Optional[builtins.str]:
|
3000
|
+
'''(experimental) The base URL of the npm package registry.
|
3001
|
+
|
3002
|
+
Must be a URL (e.g. start with "https://" or "http://")
|
3003
|
+
|
3004
|
+
:default: "https://registry.npmjs.org"
|
3005
|
+
|
3006
|
+
:stability: experimental
|
3007
|
+
'''
|
3008
|
+
result = self._values.get("npm_registry_url")
|
3009
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
3010
|
+
|
3011
|
+
@builtins.property
|
3012
|
+
def npm_token_secret(self) -> typing.Optional[builtins.str]:
|
3013
|
+
'''(experimental) GitHub secret which contains the NPM token to use when publishing packages.
|
3014
|
+
|
3015
|
+
:default: "NPM_TOKEN"
|
3016
|
+
|
3017
|
+
:stability: experimental
|
3018
|
+
'''
|
3019
|
+
result = self._values.get("npm_token_secret")
|
3020
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
3021
|
+
|
3022
|
+
@builtins.property
|
3023
|
+
def outdir(self) -> typing.Optional[builtins.str]:
|
3024
|
+
'''(experimental) The root directory of the project. Relative to this directory, all files are synthesized.
|
3025
|
+
|
3026
|
+
If this project has a parent, this directory is relative to the parent
|
3027
|
+
directory and it cannot be the same as the parent or any of it's other
|
3028
|
+
subprojects.
|
3029
|
+
|
3030
|
+
:default: "."
|
3031
|
+
|
3032
|
+
:stability: experimental
|
3033
|
+
'''
|
3034
|
+
result = self._values.get("outdir")
|
3035
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
3036
|
+
|
3037
|
+
@builtins.property
|
3038
|
+
def package(self) -> typing.Optional[builtins.bool]:
|
3039
|
+
'''(experimental) Defines a ``package`` task that will produce an npm tarball under the artifacts directory (e.g. ``dist``).
|
3040
|
+
|
3041
|
+
:default: true
|
3042
|
+
|
3043
|
+
:stability: experimental
|
3044
|
+
'''
|
3045
|
+
result = self._values.get("package")
|
3046
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
3047
|
+
|
3048
|
+
@builtins.property
|
3049
|
+
def package_manager(
|
3050
|
+
self,
|
3051
|
+
) -> typing.Optional[_projen_javascript_04054675.NodePackageManager]:
|
3052
|
+
'''(experimental) The Node Package Manager used to execute scripts.
|
3053
|
+
|
3054
|
+
:default: NodePackageManager.YARN_CLASSIC
|
3055
|
+
|
3056
|
+
:stability: experimental
|
3057
|
+
'''
|
3058
|
+
result = self._values.get("package_manager")
|
3059
|
+
return typing.cast(typing.Optional[_projen_javascript_04054675.NodePackageManager], result)
|
3060
|
+
|
3061
|
+
@builtins.property
|
3062
|
+
def package_name(self) -> typing.Optional[builtins.str]:
|
3063
|
+
'''(experimental) The "name" in package.json.
|
3064
|
+
|
3065
|
+
:default: - defaults to project name
|
3066
|
+
|
3067
|
+
:stability: experimental
|
3068
|
+
:featured: true
|
3069
|
+
'''
|
3070
|
+
result = self._values.get("package_name")
|
3071
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
3072
|
+
|
3073
|
+
@builtins.property
|
3074
|
+
def parent(self) -> typing.Optional[_projen_04054675.Project]:
|
3075
|
+
'''(experimental) The parent project, if this project is part of a bigger project.
|
3076
|
+
|
3077
|
+
:stability: experimental
|
3078
|
+
'''
|
3079
|
+
result = self._values.get("parent")
|
3080
|
+
return typing.cast(typing.Optional[_projen_04054675.Project], result)
|
3081
|
+
|
3082
|
+
@builtins.property
|
3083
|
+
def peer_dependency_options(
|
3084
|
+
self,
|
3085
|
+
) -> typing.Optional[_projen_javascript_04054675.PeerDependencyOptions]:
|
3086
|
+
'''(experimental) Options for ``peerDeps``.
|
3087
|
+
|
3088
|
+
:stability: experimental
|
3089
|
+
'''
|
3090
|
+
result = self._values.get("peer_dependency_options")
|
3091
|
+
return typing.cast(typing.Optional[_projen_javascript_04054675.PeerDependencyOptions], result)
|
3092
|
+
|
3093
|
+
@builtins.property
|
3094
|
+
def peer_deps(self) -> typing.Optional[typing.List[builtins.str]]:
|
3095
|
+
'''(experimental) Peer dependencies for this module.
|
3096
|
+
|
3097
|
+
Dependencies listed here are required to
|
3098
|
+
be installed (and satisfied) by the *consumer* of this library. Using peer
|
3099
|
+
dependencies allows you to ensure that only a single module of a certain
|
3100
|
+
library exists in the ``node_modules`` tree of your consumers.
|
3101
|
+
|
3102
|
+
Note that prior to npm@7, peer dependencies are *not* automatically
|
3103
|
+
installed, which means that adding peer dependencies to a library will be a
|
3104
|
+
breaking change for your customers.
|
3105
|
+
|
3106
|
+
Unless ``peerDependencyOptions.pinnedDevDependency`` is disabled (it is
|
3107
|
+
enabled by default), projen will automatically add a dev dependency with a
|
3108
|
+
pinned version for each peer dependency. This will ensure that you build &
|
3109
|
+
test your module against the lowest peer version required.
|
3110
|
+
|
3111
|
+
:default: []
|
3112
|
+
|
3113
|
+
:stability: experimental
|
3114
|
+
'''
|
3115
|
+
result = self._values.get("peer_deps")
|
3116
|
+
return typing.cast(typing.Optional[typing.List[builtins.str]], result)
|
3117
|
+
|
3118
|
+
@builtins.property
|
3119
|
+
def pnpm_version(self) -> typing.Optional[builtins.str]:
|
3120
|
+
'''(experimental) The version of PNPM to use if using PNPM as a package manager.
|
3121
|
+
|
3122
|
+
:default: "9"
|
3123
|
+
|
3124
|
+
:stability: experimental
|
3125
|
+
'''
|
3126
|
+
result = self._values.get("pnpm_version")
|
3127
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
3128
|
+
|
3129
|
+
@builtins.property
|
3130
|
+
def post_build_steps(
|
3131
|
+
self,
|
3132
|
+
) -> typing.Optional[typing.List[_projen_github_workflows_04054675.JobStep]]:
|
3133
|
+
'''(experimental) Steps to execute after build as part of the release workflow.
|
3134
|
+
|
3135
|
+
:default: []
|
3136
|
+
|
3137
|
+
:stability: experimental
|
3138
|
+
'''
|
3139
|
+
result = self._values.get("post_build_steps")
|
3140
|
+
return typing.cast(typing.Optional[typing.List[_projen_github_workflows_04054675.JobStep]], result)
|
3141
|
+
|
3142
|
+
@builtins.property
|
3143
|
+
def prerelease(self) -> typing.Optional[builtins.str]:
|
3144
|
+
'''(experimental) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
|
3145
|
+
|
3146
|
+
:default: - normal semantic versions
|
3147
|
+
|
3148
|
+
:stability: experimental
|
3149
|
+
'''
|
3150
|
+
result = self._values.get("prerelease")
|
3151
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
3152
|
+
|
3153
|
+
@builtins.property
|
3154
|
+
def prettier(self) -> typing.Optional[builtins.bool]:
|
3155
|
+
'''(experimental) Setup prettier.
|
3156
|
+
|
3157
|
+
:default: false
|
3158
|
+
|
3159
|
+
:stability: experimental
|
3160
|
+
'''
|
3161
|
+
result = self._values.get("prettier")
|
3162
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
3163
|
+
|
3164
|
+
@builtins.property
|
3165
|
+
def prettier_options(
|
3166
|
+
self,
|
3167
|
+
) -> typing.Optional[_projen_javascript_04054675.PrettierOptions]:
|
3168
|
+
'''(experimental) Prettier options.
|
3169
|
+
|
3170
|
+
:default: - default options
|
3171
|
+
|
3172
|
+
:stability: experimental
|
3173
|
+
'''
|
3174
|
+
result = self._values.get("prettier_options")
|
3175
|
+
return typing.cast(typing.Optional[_projen_javascript_04054675.PrettierOptions], result)
|
3176
|
+
|
3177
|
+
@builtins.property
|
3178
|
+
def project_type(self) -> typing.Optional[_projen_04054675.ProjectType]:
|
3179
|
+
'''(deprecated) Which type of project this is (library/app).
|
3180
|
+
|
3181
|
+
:default: ProjectType.UNKNOWN
|
3182
|
+
|
3183
|
+
:deprecated: no longer supported at the base project level
|
3184
|
+
|
3185
|
+
:stability: deprecated
|
3186
|
+
'''
|
3187
|
+
result = self._values.get("project_type")
|
3188
|
+
return typing.cast(typing.Optional[_projen_04054675.ProjectType], result)
|
3189
|
+
|
3190
|
+
@builtins.property
|
3191
|
+
def projen_command(self) -> typing.Optional[builtins.str]:
|
3192
|
+
'''(experimental) The shell command to use in order to run the projen CLI.
|
3193
|
+
|
3194
|
+
Can be used to customize in special environments.
|
3195
|
+
|
3196
|
+
:default: "npx projen"
|
3197
|
+
|
3198
|
+
:stability: experimental
|
3199
|
+
'''
|
3200
|
+
result = self._values.get("projen_command")
|
3201
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
3202
|
+
|
3203
|
+
@builtins.property
|
3204
|
+
def projen_credentials(
|
3205
|
+
self,
|
3206
|
+
) -> typing.Optional[_projen_github_04054675.GithubCredentials]:
|
3207
|
+
'''(experimental) Choose a method of providing GitHub API access for projen workflows.
|
3208
|
+
|
3209
|
+
:default: - use a personal access token named PROJEN_GITHUB_TOKEN
|
3210
|
+
|
3211
|
+
:stability: experimental
|
3212
|
+
'''
|
3213
|
+
result = self._values.get("projen_credentials")
|
3214
|
+
return typing.cast(typing.Optional[_projen_github_04054675.GithubCredentials], result)
|
3215
|
+
|
3216
|
+
@builtins.property
|
3217
|
+
def projen_dev_dependency(self) -> typing.Optional[builtins.bool]:
|
3218
|
+
'''(experimental) Indicates of "projen" should be installed as a devDependency.
|
3219
|
+
|
3220
|
+
:default: - true if not a subproject
|
3221
|
+
|
3222
|
+
:stability: experimental
|
3223
|
+
'''
|
3224
|
+
result = self._values.get("projen_dev_dependency")
|
3225
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
3226
|
+
|
3227
|
+
@builtins.property
|
3228
|
+
def projenrc_js(self) -> typing.Optional[builtins.bool]:
|
3229
|
+
'''(experimental) Generate (once) .projenrc.js (in JavaScript). Set to ``false`` in order to disable .projenrc.js generation.
|
3230
|
+
|
3231
|
+
:default: - true if projenrcJson is false
|
3232
|
+
|
3233
|
+
:stability: experimental
|
3234
|
+
'''
|
3235
|
+
result = self._values.get("projenrc_js")
|
3236
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
3237
|
+
|
3238
|
+
@builtins.property
|
3239
|
+
def projenrc_json(self) -> typing.Optional[builtins.bool]:
|
3240
|
+
'''(experimental) Generate (once) .projenrc.json (in JSON). Set to ``false`` in order to disable .projenrc.json generation.
|
3241
|
+
|
3242
|
+
:default: false
|
3243
|
+
|
3244
|
+
:stability: experimental
|
3245
|
+
'''
|
3246
|
+
result = self._values.get("projenrc_json")
|
3247
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
3248
|
+
|
3249
|
+
@builtins.property
|
3250
|
+
def projenrc_json_options(
|
3251
|
+
self,
|
3252
|
+
) -> typing.Optional[_projen_04054675.ProjenrcJsonOptions]:
|
3253
|
+
'''(experimental) Options for .projenrc.json.
|
3254
|
+
|
3255
|
+
:default: - default options
|
3256
|
+
|
3257
|
+
:stability: experimental
|
3258
|
+
'''
|
3259
|
+
result = self._values.get("projenrc_json_options")
|
3260
|
+
return typing.cast(typing.Optional[_projen_04054675.ProjenrcJsonOptions], result)
|
3261
|
+
|
3262
|
+
@builtins.property
|
3263
|
+
def projenrc_js_options(
|
3264
|
+
self,
|
3265
|
+
) -> typing.Optional[_projen_javascript_04054675.ProjenrcOptions]:
|
3266
|
+
'''(experimental) Options for .projenrc.js.
|
3267
|
+
|
3268
|
+
:default: - default options
|
3269
|
+
|
3270
|
+
:stability: experimental
|
3271
|
+
'''
|
3272
|
+
result = self._values.get("projenrc_js_options")
|
3273
|
+
return typing.cast(typing.Optional[_projen_javascript_04054675.ProjenrcOptions], result)
|
3274
|
+
|
3275
|
+
@builtins.property
|
3276
|
+
def projenrc_ts(self) -> typing.Optional[builtins.bool]:
|
3277
|
+
'''(experimental) Use TypeScript for your projenrc file (``.projenrc.ts``).
|
3278
|
+
|
3279
|
+
:default: false
|
3280
|
+
|
3281
|
+
:stability: experimental
|
3282
|
+
:pjnew: true
|
3283
|
+
'''
|
3284
|
+
result = self._values.get("projenrc_ts")
|
3285
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
3286
|
+
|
3287
|
+
@builtins.property
|
3288
|
+
def projenrc_ts_options(
|
3289
|
+
self,
|
3290
|
+
) -> typing.Optional[_projen_typescript_04054675.ProjenrcOptions]:
|
3291
|
+
'''(experimental) Options for .projenrc.ts.
|
3292
|
+
|
3293
|
+
:stability: experimental
|
3294
|
+
'''
|
3295
|
+
result = self._values.get("projenrc_ts_options")
|
3296
|
+
return typing.cast(typing.Optional[_projen_typescript_04054675.ProjenrcOptions], result)
|
3297
|
+
|
3298
|
+
@builtins.property
|
3299
|
+
def projen_token_secret(self) -> typing.Optional[builtins.str]:
|
3300
|
+
'''(deprecated) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
|
3301
|
+
|
3302
|
+
This token needs to have the ``repo``, ``workflows``
|
3303
|
+
and ``packages`` scope.
|
3304
|
+
|
3305
|
+
:default: "PROJEN_GITHUB_TOKEN"
|
3306
|
+
|
3307
|
+
:deprecated: use ``projenCredentials``
|
3308
|
+
|
3309
|
+
:stability: deprecated
|
3310
|
+
'''
|
3311
|
+
result = self._values.get("projen_token_secret")
|
3312
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
3313
|
+
|
3314
|
+
@builtins.property
|
3315
|
+
def projen_version(self) -> typing.Optional[builtins.str]:
|
3316
|
+
'''(experimental) Version of projen to install.
|
3317
|
+
|
3318
|
+
:default: - Defaults to the latest version.
|
3319
|
+
|
3320
|
+
:stability: experimental
|
3321
|
+
'''
|
3322
|
+
result = self._values.get("projen_version")
|
3323
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
3324
|
+
|
3325
|
+
@builtins.property
|
3326
|
+
def publish_dry_run(self) -> typing.Optional[builtins.bool]:
|
3327
|
+
'''(experimental) Instead of actually publishing to package managers, just print the publishing command.
|
3328
|
+
|
3329
|
+
:default: false
|
3330
|
+
|
3331
|
+
:stability: experimental
|
3332
|
+
'''
|
3333
|
+
result = self._values.get("publish_dry_run")
|
3334
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
3335
|
+
|
3336
|
+
@builtins.property
|
3337
|
+
def publish_tasks(self) -> typing.Optional[builtins.bool]:
|
3338
|
+
'''(experimental) Define publishing tasks that can be executed manually as well as workflows.
|
3339
|
+
|
3340
|
+
Normally, publishing only happens within automated workflows. Enable this
|
3341
|
+
in order to create a publishing task for each publishing activity.
|
3342
|
+
|
3343
|
+
:default: false
|
3344
|
+
|
3345
|
+
:stability: experimental
|
3346
|
+
'''
|
3347
|
+
result = self._values.get("publish_tasks")
|
3348
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
3349
|
+
|
3350
|
+
@builtins.property
|
3351
|
+
def pull_request_template(self) -> typing.Optional[builtins.bool]:
|
3352
|
+
'''(experimental) Include a GitHub pull request template.
|
3353
|
+
|
3354
|
+
:default: true
|
3355
|
+
|
3356
|
+
:stability: experimental
|
3357
|
+
'''
|
3358
|
+
result = self._values.get("pull_request_template")
|
3359
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
3360
|
+
|
3361
|
+
@builtins.property
|
3362
|
+
def pull_request_template_contents(
|
3363
|
+
self,
|
3364
|
+
) -> typing.Optional[typing.List[builtins.str]]:
|
3365
|
+
'''(experimental) The contents of the pull request template.
|
3366
|
+
|
3367
|
+
:default: - default content
|
3368
|
+
|
3369
|
+
:stability: experimental
|
3370
|
+
'''
|
3371
|
+
result = self._values.get("pull_request_template_contents")
|
3372
|
+
return typing.cast(typing.Optional[typing.List[builtins.str]], result)
|
3373
|
+
|
3374
|
+
@builtins.property
|
3375
|
+
def readme(self) -> typing.Optional["ReadmeOptions"]:
|
3376
|
+
'''Configuration of the README.md file.'''
|
3377
|
+
result = self._values.get("readme")
|
3378
|
+
return typing.cast(typing.Optional["ReadmeOptions"], result)
|
3379
|
+
|
3380
|
+
@builtins.property
|
3381
|
+
def releasable_commits(self) -> typing.Optional[_projen_04054675.ReleasableCommits]:
|
3382
|
+
'''(experimental) Find commits that should be considered releasable Used to decide if a release is required.
|
3383
|
+
|
3384
|
+
:default: ReleasableCommits.everyCommit()
|
3385
|
+
|
3386
|
+
:stability: experimental
|
3387
|
+
'''
|
3388
|
+
result = self._values.get("releasable_commits")
|
3389
|
+
return typing.cast(typing.Optional[_projen_04054675.ReleasableCommits], result)
|
3390
|
+
|
3391
|
+
@builtins.property
|
3392
|
+
def release(self) -> typing.Optional[builtins.bool]:
|
3393
|
+
'''(experimental) Add release management to this project.
|
3394
|
+
|
3395
|
+
:default: - true (false for subprojects)
|
3396
|
+
|
3397
|
+
:stability: experimental
|
3398
|
+
'''
|
3399
|
+
result = self._values.get("release")
|
3400
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
3401
|
+
|
3402
|
+
@builtins.property
|
3403
|
+
def release_branches(
|
3404
|
+
self,
|
3405
|
+
) -> typing.Optional[typing.Mapping[builtins.str, _projen_release_04054675.BranchOptions]]:
|
3406
|
+
'''(experimental) Defines additional release branches.
|
3407
|
+
|
3408
|
+
A workflow will be created for each
|
3409
|
+
release branch which will publish releases from commits in this branch.
|
3410
|
+
Each release branch *must* be assigned a major version number which is used
|
3411
|
+
to enforce that versions published from that branch always use that major
|
3412
|
+
version. If multiple branches are used, the ``majorVersion`` field must also
|
3413
|
+
be provided for the default branch.
|
3414
|
+
|
3415
|
+
:default:
|
3416
|
+
|
3417
|
+
- no additional branches are used for release. you can use
|
3418
|
+
``addBranch()`` to add additional branches.
|
3419
|
+
|
3420
|
+
:stability: experimental
|
3421
|
+
'''
|
3422
|
+
result = self._values.get("release_branches")
|
3423
|
+
return typing.cast(typing.Optional[typing.Mapping[builtins.str, _projen_release_04054675.BranchOptions]], result)
|
3424
|
+
|
3425
|
+
@builtins.property
|
3426
|
+
def release_every_commit(self) -> typing.Optional[builtins.bool]:
|
3427
|
+
'''(deprecated) Automatically release new versions every commit to one of branches in ``releaseBranches``.
|
3428
|
+
|
3429
|
+
:default: true
|
3430
|
+
|
3431
|
+
:deprecated: Use ``releaseTrigger: ReleaseTrigger.continuous()`` instead
|
3432
|
+
|
3433
|
+
:stability: deprecated
|
3434
|
+
'''
|
3435
|
+
result = self._values.get("release_every_commit")
|
3436
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
3437
|
+
|
3438
|
+
@builtins.property
|
3439
|
+
def release_failure_issue(self) -> typing.Optional[builtins.bool]:
|
3440
|
+
'''(experimental) Create a github issue on every failed publishing task.
|
3441
|
+
|
3442
|
+
:default: false
|
3443
|
+
|
3444
|
+
:stability: experimental
|
3445
|
+
'''
|
3446
|
+
result = self._values.get("release_failure_issue")
|
3447
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
3448
|
+
|
3449
|
+
@builtins.property
|
3450
|
+
def release_failure_issue_label(self) -> typing.Optional[builtins.str]:
|
3451
|
+
'''(experimental) The label to apply to issues indicating publish failures.
|
3452
|
+
|
3453
|
+
Only applies if ``releaseFailureIssue`` is true.
|
3454
|
+
|
3455
|
+
:default: "failed-release"
|
3456
|
+
|
3457
|
+
:stability: experimental
|
3458
|
+
'''
|
3459
|
+
result = self._values.get("release_failure_issue_label")
|
3460
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
3461
|
+
|
3462
|
+
@builtins.property
|
3463
|
+
def release_schedule(self) -> typing.Optional[builtins.str]:
|
3464
|
+
'''(deprecated) CRON schedule to trigger new releases.
|
3465
|
+
|
3466
|
+
:default: - no scheduled releases
|
3467
|
+
|
3468
|
+
:deprecated: Use ``releaseTrigger: ReleaseTrigger.scheduled()`` instead
|
3469
|
+
|
3470
|
+
:stability: deprecated
|
3471
|
+
'''
|
3472
|
+
result = self._values.get("release_schedule")
|
3473
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
3474
|
+
|
3475
|
+
@builtins.property
|
3476
|
+
def release_tag_prefix(self) -> typing.Optional[builtins.str]:
|
3477
|
+
'''(experimental) Automatically add the given prefix to release tags.
|
3478
|
+
|
3479
|
+
Useful if you are releasing on multiple branches with overlapping version numbers.
|
3480
|
+
Note: this prefix is used to detect the latest tagged version
|
3481
|
+
when bumping, so if you change this on a project with an existing version
|
3482
|
+
history, you may need to manually tag your latest release
|
3483
|
+
with the new prefix.
|
3484
|
+
|
3485
|
+
:default: "v"
|
3486
|
+
|
3487
|
+
:stability: experimental
|
3488
|
+
'''
|
3489
|
+
result = self._values.get("release_tag_prefix")
|
3490
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
3491
|
+
|
3492
|
+
@builtins.property
|
3493
|
+
def release_to_npm(self) -> typing.Optional[builtins.bool]:
|
3494
|
+
'''(experimental) Automatically release to npm when new versions are introduced.
|
3495
|
+
|
3496
|
+
:default: false
|
3497
|
+
|
3498
|
+
:stability: experimental
|
3499
|
+
'''
|
3500
|
+
result = self._values.get("release_to_npm")
|
3501
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
3502
|
+
|
3503
|
+
@builtins.property
|
3504
|
+
def release_trigger(
|
3505
|
+
self,
|
3506
|
+
) -> typing.Optional[_projen_release_04054675.ReleaseTrigger]:
|
3507
|
+
'''(experimental) The release trigger to use.
|
3508
|
+
|
3509
|
+
:default: - Continuous releases (``ReleaseTrigger.continuous()``)
|
3510
|
+
|
3511
|
+
:stability: experimental
|
3512
|
+
'''
|
3513
|
+
result = self._values.get("release_trigger")
|
3514
|
+
return typing.cast(typing.Optional[_projen_release_04054675.ReleaseTrigger], result)
|
3515
|
+
|
3516
|
+
@builtins.property
|
3517
|
+
def release_workflow(self) -> typing.Optional[builtins.bool]:
|
3518
|
+
'''(deprecated) DEPRECATED: renamed to ``release``.
|
3519
|
+
|
3520
|
+
:default: - true if not a subproject
|
3521
|
+
|
3522
|
+
:deprecated: see ``release``.
|
3523
|
+
|
3524
|
+
:stability: deprecated
|
3525
|
+
'''
|
3526
|
+
result = self._values.get("release_workflow")
|
3527
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
3528
|
+
|
3529
|
+
@builtins.property
|
3530
|
+
def release_workflow_name(self) -> typing.Optional[builtins.str]:
|
3531
|
+
'''(experimental) The name of the default release workflow.
|
3532
|
+
|
3533
|
+
:default: "release"
|
3534
|
+
|
3535
|
+
:stability: experimental
|
3536
|
+
'''
|
3537
|
+
result = self._values.get("release_workflow_name")
|
3538
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
3539
|
+
|
3540
|
+
@builtins.property
|
3541
|
+
def release_workflow_setup_steps(
|
3542
|
+
self,
|
3543
|
+
) -> typing.Optional[typing.List[_projen_github_workflows_04054675.JobStep]]:
|
3544
|
+
'''(experimental) A set of workflow steps to execute in order to setup the workflow container.
|
3545
|
+
|
3546
|
+
:stability: experimental
|
3547
|
+
'''
|
3548
|
+
result = self._values.get("release_workflow_setup_steps")
|
3549
|
+
return typing.cast(typing.Optional[typing.List[_projen_github_workflows_04054675.JobStep]], result)
|
3550
|
+
|
3551
|
+
@builtins.property
|
3552
|
+
def renovatebot(self) -> typing.Optional[builtins.bool]:
|
3553
|
+
'''(experimental) Use renovatebot to handle dependency upgrades.
|
3554
|
+
|
3555
|
+
:default: false
|
3556
|
+
|
3557
|
+
:stability: experimental
|
3558
|
+
'''
|
3559
|
+
result = self._values.get("renovatebot")
|
3560
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
3561
|
+
|
3562
|
+
@builtins.property
|
3563
|
+
def renovatebot_options(
|
3564
|
+
self,
|
3565
|
+
) -> typing.Optional[_projen_04054675.RenovatebotOptions]:
|
3566
|
+
'''(experimental) Options for renovatebot.
|
3567
|
+
|
3568
|
+
:default: - default options
|
3569
|
+
|
3570
|
+
:stability: experimental
|
3571
|
+
'''
|
3572
|
+
result = self._values.get("renovatebot_options")
|
3573
|
+
return typing.cast(typing.Optional[_projen_04054675.RenovatebotOptions], result)
|
3574
|
+
|
3575
|
+
@builtins.property
|
3576
|
+
def repository(self) -> typing.Optional[builtins.str]:
|
3577
|
+
'''(experimental) The repository is the location where the actual code for your package lives.
|
3578
|
+
|
3579
|
+
See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository
|
3580
|
+
|
3581
|
+
:stability: experimental
|
3582
|
+
'''
|
3583
|
+
result = self._values.get("repository")
|
3584
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
3585
|
+
|
3586
|
+
@builtins.property
|
3587
|
+
def repository_directory(self) -> typing.Optional[builtins.str]:
|
3588
|
+
'''(experimental) 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.
|
3589
|
+
|
3590
|
+
:stability: experimental
|
3591
|
+
'''
|
3592
|
+
result = self._values.get("repository_directory")
|
3593
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
3594
|
+
|
3595
|
+
@builtins.property
|
3596
|
+
def require_approval(
|
3597
|
+
self,
|
3598
|
+
) -> typing.Optional[_projen_awscdk_04054675.ApprovalLevel]:
|
3599
|
+
'''(experimental) To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them.
|
3600
|
+
|
3601
|
+
:default: ApprovalLevel.BROADENING
|
3602
|
+
|
3603
|
+
:stability: experimental
|
3604
|
+
'''
|
3605
|
+
result = self._values.get("require_approval")
|
3606
|
+
return typing.cast(typing.Optional[_projen_awscdk_04054675.ApprovalLevel], result)
|
3607
|
+
|
3608
|
+
@builtins.property
|
3609
|
+
def sample_code(self) -> typing.Optional[builtins.bool]:
|
3610
|
+
'''(experimental) Generate one-time sample in ``src/`` and ``test/`` if there are no files there.
|
3611
|
+
|
3612
|
+
:default: true
|
3613
|
+
|
3614
|
+
:stability: experimental
|
3615
|
+
'''
|
3616
|
+
result = self._values.get("sample_code")
|
3617
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
3618
|
+
|
3619
|
+
@builtins.property
|
3620
|
+
def scoped_packages_options(
|
3621
|
+
self,
|
3622
|
+
) -> typing.Optional[typing.List[_projen_javascript_04054675.ScopedPackagesOptions]]:
|
3623
|
+
'''(experimental) Options for privately hosted scoped packages.
|
3624
|
+
|
3625
|
+
:default: - fetch all scoped packages from the public npm registry
|
3626
|
+
|
3627
|
+
:stability: experimental
|
3628
|
+
'''
|
3629
|
+
result = self._values.get("scoped_packages_options")
|
3630
|
+
return typing.cast(typing.Optional[typing.List[_projen_javascript_04054675.ScopedPackagesOptions]], result)
|
3631
|
+
|
3632
|
+
@builtins.property
|
3633
|
+
def scripts(self) -> typing.Optional[typing.Mapping[builtins.str, builtins.str]]:
|
3634
|
+
'''(deprecated) npm scripts to include.
|
3635
|
+
|
3636
|
+
If a script has the same name as a standard script,
|
3637
|
+
the standard script will be overwritten.
|
3638
|
+
Also adds the script as a task.
|
3639
|
+
|
3640
|
+
:default: {}
|
3641
|
+
|
3642
|
+
:deprecated: use ``project.addTask()`` or ``package.setScript()``
|
3643
|
+
|
3644
|
+
:stability: deprecated
|
3645
|
+
'''
|
3646
|
+
result = self._values.get("scripts")
|
3647
|
+
return typing.cast(typing.Optional[typing.Mapping[builtins.str, builtins.str]], result)
|
3648
|
+
|
3649
|
+
@builtins.property
|
3650
|
+
def srcdir(self) -> typing.Optional[builtins.str]:
|
3651
|
+
'''(experimental) Typescript sources directory.
|
3652
|
+
|
3653
|
+
:default: "src"
|
3654
|
+
|
3655
|
+
:stability: experimental
|
3656
|
+
'''
|
3657
|
+
result = self._values.get("srcdir")
|
3658
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
3659
|
+
|
3660
|
+
@builtins.property
|
3661
|
+
def stability(self) -> typing.Optional[builtins.str]:
|
3662
|
+
'''(experimental) Package's Stability.
|
3663
|
+
|
3664
|
+
:stability: experimental
|
3665
|
+
'''
|
3666
|
+
result = self._values.get("stability")
|
3667
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
3668
|
+
|
3669
|
+
@builtins.property
|
3670
|
+
def stale(self) -> typing.Optional[builtins.bool]:
|
3671
|
+
'''(experimental) Auto-close of stale issues and pull request.
|
3672
|
+
|
3673
|
+
See ``staleOptions`` for options.
|
3674
|
+
|
3675
|
+
:default: false
|
3676
|
+
|
3677
|
+
:stability: experimental
|
3678
|
+
'''
|
3679
|
+
result = self._values.get("stale")
|
3680
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
3681
|
+
|
3682
|
+
@builtins.property
|
3683
|
+
def stale_options(self) -> typing.Optional[_projen_github_04054675.StaleOptions]:
|
3684
|
+
'''(experimental) Auto-close stale issues and pull requests.
|
3685
|
+
|
3686
|
+
To disable set ``stale`` to ``false``.
|
3687
|
+
|
3688
|
+
:default: - see defaults in ``StaleOptions``
|
3689
|
+
|
3690
|
+
:stability: experimental
|
3691
|
+
'''
|
3692
|
+
result = self._values.get("stale_options")
|
3693
|
+
return typing.cast(typing.Optional[_projen_github_04054675.StaleOptions], result)
|
3694
|
+
|
3695
|
+
@builtins.property
|
3696
|
+
def testdir(self) -> typing.Optional[builtins.str]:
|
3697
|
+
'''(experimental) Jest tests directory.
|
3698
|
+
|
3699
|
+
Tests files should be named ``xxx.test.ts``.
|
3700
|
+
If this directory is under ``srcdir`` (e.g. ``src/test``, ``src/__tests__``),
|
3701
|
+
then tests are going to be compiled into ``lib/`` and executed as javascript.
|
3702
|
+
If the test directory is outside of ``src``, then we configure jest to
|
3703
|
+
compile the code in-memory.
|
3704
|
+
|
3705
|
+
:default: "test"
|
3706
|
+
|
3707
|
+
:stability: experimental
|
3708
|
+
'''
|
3709
|
+
result = self._values.get("testdir")
|
3710
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
3711
|
+
|
3712
|
+
@builtins.property
|
3713
|
+
def tsconfig(
|
3714
|
+
self,
|
3715
|
+
) -> typing.Optional[_projen_javascript_04054675.TypescriptConfigOptions]:
|
3716
|
+
'''(experimental) Custom TSConfig.
|
3717
|
+
|
3718
|
+
:default: - default options
|
3719
|
+
|
3720
|
+
:stability: experimental
|
3721
|
+
'''
|
3722
|
+
result = self._values.get("tsconfig")
|
3723
|
+
return typing.cast(typing.Optional[_projen_javascript_04054675.TypescriptConfigOptions], result)
|
3724
|
+
|
3725
|
+
@builtins.property
|
3726
|
+
def tsconfig_dev(
|
3727
|
+
self,
|
3728
|
+
) -> typing.Optional[_projen_javascript_04054675.TypescriptConfigOptions]:
|
3729
|
+
'''(experimental) Custom tsconfig options for the development tsconfig.json file (used for testing).
|
3730
|
+
|
3731
|
+
:default: - use the production tsconfig options
|
3732
|
+
|
3733
|
+
:stability: experimental
|
3734
|
+
'''
|
3735
|
+
result = self._values.get("tsconfig_dev")
|
3736
|
+
return typing.cast(typing.Optional[_projen_javascript_04054675.TypescriptConfigOptions], result)
|
3737
|
+
|
3738
|
+
@builtins.property
|
3739
|
+
def tsconfig_dev_file(self) -> typing.Optional[builtins.str]:
|
3740
|
+
'''(experimental) The name of the development tsconfig.json file.
|
3741
|
+
|
3742
|
+
:default: "tsconfig.dev.json"
|
3743
|
+
|
3744
|
+
:stability: experimental
|
3745
|
+
'''
|
3746
|
+
result = self._values.get("tsconfig_dev_file")
|
3747
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
3748
|
+
|
3749
|
+
@builtins.property
|
3750
|
+
def ts_jest_options(
|
3751
|
+
self,
|
3752
|
+
) -> typing.Optional[_projen_typescript_04054675.TsJestOptions]:
|
3753
|
+
'''(experimental) Options for ts-jest.
|
3754
|
+
|
3755
|
+
:stability: experimental
|
3756
|
+
'''
|
3757
|
+
result = self._values.get("ts_jest_options")
|
3758
|
+
return typing.cast(typing.Optional[_projen_typescript_04054675.TsJestOptions], result)
|
3759
|
+
|
3760
|
+
@builtins.property
|
3761
|
+
def typescript_version(self) -> typing.Optional[builtins.str]:
|
3762
|
+
'''(experimental) TypeScript version to use.
|
3763
|
+
|
3764
|
+
NOTE: Typescript is not semantically versioned and should remain on the
|
3765
|
+
same minor, so we recommend using a ``~`` dependency (e.g. ``~1.2.3``).
|
3766
|
+
|
3767
|
+
:default: "latest"
|
3768
|
+
|
3769
|
+
:stability: experimental
|
3770
|
+
'''
|
3771
|
+
result = self._values.get("typescript_version")
|
3772
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
3773
|
+
|
3774
|
+
@builtins.property
|
3775
|
+
def versionrc_options(
|
3776
|
+
self,
|
3777
|
+
) -> typing.Optional[typing.Mapping[builtins.str, typing.Any]]:
|
3778
|
+
'''(experimental) Custom configuration used when creating changelog with commit-and-tag-version package.
|
3779
|
+
|
3780
|
+
Given values either append to default configuration or overwrite values in it.
|
3781
|
+
|
3782
|
+
:default: - standard configuration applicable for GitHub repositories
|
3783
|
+
|
3784
|
+
:stability: experimental
|
3785
|
+
'''
|
3786
|
+
result = self._values.get("versionrc_options")
|
3787
|
+
return typing.cast(typing.Optional[typing.Mapping[builtins.str, typing.Any]], result)
|
3788
|
+
|
3789
|
+
@builtins.property
|
3790
|
+
def vscode(self) -> typing.Optional[builtins.bool]:
|
3791
|
+
'''(experimental) Enable VSCode integration.
|
3792
|
+
|
3793
|
+
Enabled by default for root projects. Disabled for non-root projects.
|
3794
|
+
|
3795
|
+
:default: true
|
3796
|
+
|
3797
|
+
:stability: experimental
|
3798
|
+
'''
|
3799
|
+
result = self._values.get("vscode")
|
3800
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
3801
|
+
|
3802
|
+
@builtins.property
|
3803
|
+
def watch_excludes(self) -> typing.Optional[typing.List[builtins.str]]:
|
3804
|
+
'''(experimental) Glob patterns to exclude from ``cdk watch``.
|
3805
|
+
|
3806
|
+
:default: []
|
3807
|
+
|
3808
|
+
:stability: experimental
|
3809
|
+
'''
|
3810
|
+
result = self._values.get("watch_excludes")
|
3811
|
+
return typing.cast(typing.Optional[typing.List[builtins.str]], result)
|
3812
|
+
|
3813
|
+
@builtins.property
|
3814
|
+
def watch_includes(self) -> typing.Optional[typing.List[builtins.str]]:
|
3815
|
+
'''(experimental) Glob patterns to include in ``cdk watch``.
|
3816
|
+
|
3817
|
+
:default: []
|
3818
|
+
|
3819
|
+
:stability: experimental
|
3820
|
+
'''
|
3821
|
+
result = self._values.get("watch_includes")
|
3822
|
+
return typing.cast(typing.Optional[typing.List[builtins.str]], result)
|
3823
|
+
|
3824
|
+
@builtins.property
|
3825
|
+
def workflow_bootstrap_steps(
|
3826
|
+
self,
|
3827
|
+
) -> typing.Optional[typing.List[_projen_github_workflows_04054675.JobStep]]:
|
3828
|
+
'''(experimental) Workflow steps to use in order to bootstrap this repo.
|
3829
|
+
|
3830
|
+
:default: "yarn install --frozen-lockfile && yarn projen"
|
3831
|
+
|
3832
|
+
:stability: experimental
|
3833
|
+
'''
|
3834
|
+
result = self._values.get("workflow_bootstrap_steps")
|
3835
|
+
return typing.cast(typing.Optional[typing.List[_projen_github_workflows_04054675.JobStep]], result)
|
3836
|
+
|
3837
|
+
@builtins.property
|
3838
|
+
def workflow_container_image(self) -> typing.Optional[builtins.str]:
|
3839
|
+
'''(experimental) Container image to use for GitHub workflows.
|
3840
|
+
|
3841
|
+
:default: - default image
|
3842
|
+
|
3843
|
+
:stability: experimental
|
3844
|
+
'''
|
3845
|
+
result = self._values.get("workflow_container_image")
|
3846
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
3847
|
+
|
3848
|
+
@builtins.property
|
3849
|
+
def workflow_git_identity(
|
3850
|
+
self,
|
3851
|
+
) -> typing.Optional[_projen_github_04054675.GitIdentity]:
|
3852
|
+
'''(experimental) The git identity to use in workflows.
|
3853
|
+
|
3854
|
+
:default: - GitHub Actions
|
3855
|
+
|
3856
|
+
:stability: experimental
|
3857
|
+
'''
|
3858
|
+
result = self._values.get("workflow_git_identity")
|
3859
|
+
return typing.cast(typing.Optional[_projen_github_04054675.GitIdentity], result)
|
3860
|
+
|
3861
|
+
@builtins.property
|
3862
|
+
def workflow_node_version(self) -> typing.Optional[builtins.str]:
|
3863
|
+
'''(experimental) The node version used in GitHub Actions workflows.
|
3864
|
+
|
3865
|
+
Always use this option if your GitHub Actions workflows require a specific to run.
|
3866
|
+
|
3867
|
+
:default: - ``minNodeVersion`` if set, otherwise ``lts/*``.
|
3868
|
+
|
3869
|
+
:stability: experimental
|
3870
|
+
'''
|
3871
|
+
result = self._values.get("workflow_node_version")
|
3872
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
3873
|
+
|
3874
|
+
@builtins.property
|
3875
|
+
def workflow_package_cache(self) -> typing.Optional[builtins.bool]:
|
3876
|
+
'''(experimental) Enable Node.js package cache in GitHub workflows.
|
3877
|
+
|
3878
|
+
:default: false
|
3879
|
+
|
3880
|
+
:stability: experimental
|
3881
|
+
'''
|
3882
|
+
result = self._values.get("workflow_package_cache")
|
3883
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
3884
|
+
|
3885
|
+
@builtins.property
|
3886
|
+
def workflow_runs_on(self) -> typing.Optional[typing.List[builtins.str]]:
|
3887
|
+
'''(experimental) Github Runner selection labels.
|
3888
|
+
|
3889
|
+
:default: ["ubuntu-latest"]
|
3890
|
+
|
3891
|
+
:stability: experimental
|
3892
|
+
:description: Defines a target Runner by labels
|
3893
|
+
:throws: {Error} if both ``runsOn`` and ``runsOnGroup`` are specified
|
3894
|
+
'''
|
3895
|
+
result = self._values.get("workflow_runs_on")
|
3896
|
+
return typing.cast(typing.Optional[typing.List[builtins.str]], result)
|
3897
|
+
|
3898
|
+
@builtins.property
|
3899
|
+
def workflow_runs_on_group(
|
3900
|
+
self,
|
3901
|
+
) -> typing.Optional[_projen_04054675.GroupRunnerOptions]:
|
3902
|
+
'''(experimental) Github Runner Group selection options.
|
3903
|
+
|
3904
|
+
:stability: experimental
|
3905
|
+
:description: Defines a target Runner Group by name and/or labels
|
3906
|
+
:throws: {Error} if both ``runsOn`` and ``runsOnGroup`` are specified
|
3907
|
+
'''
|
3908
|
+
result = self._values.get("workflow_runs_on_group")
|
3909
|
+
return typing.cast(typing.Optional[_projen_04054675.GroupRunnerOptions], result)
|
3910
|
+
|
3911
|
+
@builtins.property
|
3912
|
+
def yarn_berry_options(
|
3913
|
+
self,
|
3914
|
+
) -> typing.Optional[_projen_javascript_04054675.YarnBerryOptions]:
|
3915
|
+
'''(experimental) Options for Yarn Berry.
|
3916
|
+
|
3917
|
+
:default: - Yarn Berry v4 with all default options
|
3918
|
+
|
3919
|
+
:stability: experimental
|
3920
|
+
'''
|
3921
|
+
result = self._values.get("yarn_berry_options")
|
3922
|
+
return typing.cast(typing.Optional[_projen_javascript_04054675.YarnBerryOptions], result)
|
3923
|
+
|
3924
|
+
def __eq__(self, rhs: typing.Any) -> builtins.bool:
|
3925
|
+
return isinstance(rhs, self.__class__) and rhs._values == self._values
|
3926
|
+
|
3927
|
+
def __ne__(self, rhs: typing.Any) -> builtins.bool:
|
3928
|
+
return not (rhs == self)
|
3929
|
+
|
3930
|
+
def __repr__(self) -> str:
|
3931
|
+
return "CdkTypeScriptAppOptions(%s)" % ", ".join(
|
3932
|
+
k + "=" + repr(v) for k, v in self._values.items()
|
3933
|
+
)
|
3934
|
+
|
3935
|
+
|
99
3936
|
@jsii.interface(jsii_type="projen-modules.ISectionOptions")
|
100
3937
|
class ISectionOptions(typing_extensions.Protocol):
|
101
3938
|
@builtins.property
|
@@ -8667,6 +12504,8 @@ class Section(metaclass=jsii.JSIIMeta, jsii_type="projen-modules.Section"):
|
|
8667
12504
|
|
8668
12505
|
|
8669
12506
|
__all__ = [
|
12507
|
+
"CdkTypeScriptApp",
|
12508
|
+
"CdkTypeScriptAppOptions",
|
8670
12509
|
"ISectionOptions",
|
8671
12510
|
"JsiiProject",
|
8672
12511
|
"JsiiProjectOptions",
|
@@ -8681,6 +12520,190 @@ __all__ = [
|
|
8681
12520
|
|
8682
12521
|
publication.publish()
|
8683
12522
|
|
12523
|
+
def _typecheckingstub__a544530c4e440f72065d416ace5f306da46147589bc70a0f44ccba0553de9c78(
|
12524
|
+
value: Readme,
|
12525
|
+
) -> None:
|
12526
|
+
"""Type checking stubs"""
|
12527
|
+
pass
|
12528
|
+
|
12529
|
+
def _typecheckingstub__3a6354f4c0532263f309ca59025d89b070b95588f76bd5815340cc71a5341012(
|
12530
|
+
*,
|
12531
|
+
cdk_version: builtins.str,
|
12532
|
+
code_owners: typing.Sequence[builtins.str],
|
12533
|
+
name: builtins.str,
|
12534
|
+
allow_library_dependencies: typing.Optional[builtins.bool] = None,
|
12535
|
+
app_entrypoint: typing.Optional[builtins.str] = None,
|
12536
|
+
artifacts_directory: typing.Optional[builtins.str] = None,
|
12537
|
+
author_email: typing.Optional[builtins.str] = None,
|
12538
|
+
author_name: typing.Optional[builtins.str] = None,
|
12539
|
+
author_organization: typing.Optional[builtins.bool] = None,
|
12540
|
+
author_url: typing.Optional[builtins.str] = None,
|
12541
|
+
auto_approve_options: typing.Optional[typing.Union[_projen_github_04054675.AutoApproveOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12542
|
+
auto_approve_upgrades: typing.Optional[builtins.bool] = None,
|
12543
|
+
auto_detect_bin: typing.Optional[builtins.bool] = None,
|
12544
|
+
auto_merge: typing.Optional[builtins.bool] = None,
|
12545
|
+
auto_merge_options: typing.Optional[typing.Union[_projen_github_04054675.AutoMergeOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12546
|
+
bin: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
12547
|
+
bugs_email: typing.Optional[builtins.str] = None,
|
12548
|
+
bugs_url: typing.Optional[builtins.str] = None,
|
12549
|
+
build_command: typing.Optional[builtins.str] = None,
|
12550
|
+
build_workflow: typing.Optional[builtins.bool] = None,
|
12551
|
+
build_workflow_options: typing.Optional[typing.Union[_projen_javascript_04054675.BuildWorkflowOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12552
|
+
build_workflow_triggers: typing.Optional[typing.Union[_projen_github_workflows_04054675.Triggers, typing.Dict[builtins.str, typing.Any]]] = None,
|
12553
|
+
bump_package: typing.Optional[builtins.str] = None,
|
12554
|
+
bundled_deps: typing.Optional[typing.Sequence[builtins.str]] = None,
|
12555
|
+
bundler_options: typing.Optional[typing.Union[_projen_javascript_04054675.BundlerOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12556
|
+
bun_version: typing.Optional[builtins.str] = None,
|
12557
|
+
cdk_assert: typing.Optional[builtins.bool] = None,
|
12558
|
+
cdk_assertions: typing.Optional[builtins.bool] = None,
|
12559
|
+
cdk_cli_version: typing.Optional[builtins.str] = None,
|
12560
|
+
cdk_dependencies: typing.Optional[typing.Sequence[builtins.str]] = None,
|
12561
|
+
cdk_dependencies_as_deps: typing.Optional[builtins.bool] = None,
|
12562
|
+
cdkout: typing.Optional[builtins.str] = None,
|
12563
|
+
cdk_test_dependencies: typing.Optional[typing.Sequence[builtins.str]] = None,
|
12564
|
+
cdk_version_pinning: typing.Optional[builtins.bool] = None,
|
12565
|
+
check_licenses: typing.Optional[typing.Union[_projen_javascript_04054675.LicenseCheckerOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12566
|
+
clobber: typing.Optional[builtins.bool] = None,
|
12567
|
+
code_artifact_options: typing.Optional[typing.Union[_projen_javascript_04054675.CodeArtifactOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12568
|
+
code_cov: typing.Optional[builtins.bool] = None,
|
12569
|
+
code_cov_token_secret: typing.Optional[builtins.str] = None,
|
12570
|
+
commit_generated: typing.Optional[builtins.bool] = None,
|
12571
|
+
constructs_version: typing.Optional[builtins.str] = None,
|
12572
|
+
context: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
|
12573
|
+
copyright_owner: typing.Optional[builtins.str] = None,
|
12574
|
+
copyright_period: typing.Optional[builtins.str] = None,
|
12575
|
+
default_release_branch: typing.Optional[builtins.str] = None,
|
12576
|
+
dependabot: typing.Optional[builtins.bool] = None,
|
12577
|
+
dependabot_options: typing.Optional[typing.Union[_projen_github_04054675.DependabotOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12578
|
+
deps: typing.Optional[typing.Sequence[builtins.str]] = None,
|
12579
|
+
deps_upgrade: typing.Optional[builtins.bool] = None,
|
12580
|
+
deps_upgrade_options: typing.Optional[typing.Union[_projen_javascript_04054675.UpgradeDependenciesOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12581
|
+
description: typing.Optional[builtins.str] = None,
|
12582
|
+
dev_container: typing.Optional[builtins.bool] = None,
|
12583
|
+
dev_deps: typing.Optional[typing.Sequence[builtins.str]] = None,
|
12584
|
+
disable_tsconfig: typing.Optional[builtins.bool] = None,
|
12585
|
+
disable_tsconfig_dev: typing.Optional[builtins.bool] = None,
|
12586
|
+
docgen: typing.Optional[builtins.bool] = None,
|
12587
|
+
docs_directory: typing.Optional[builtins.str] = None,
|
12588
|
+
edge_lambda_auto_discover: typing.Optional[builtins.bool] = None,
|
12589
|
+
entrypoint: typing.Optional[builtins.str] = None,
|
12590
|
+
entrypoint_types: typing.Optional[builtins.str] = None,
|
12591
|
+
eslint: typing.Optional[builtins.bool] = None,
|
12592
|
+
eslint_options: typing.Optional[typing.Union[_projen_javascript_04054675.EslintOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12593
|
+
experimental_integ_runner: typing.Optional[builtins.bool] = None,
|
12594
|
+
feature_flags: typing.Optional[builtins.bool] = None,
|
12595
|
+
github: typing.Optional[builtins.bool] = None,
|
12596
|
+
github_options: typing.Optional[typing.Union[_projen_github_04054675.GitHubOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12597
|
+
gitignore: typing.Optional[typing.Sequence[builtins.str]] = None,
|
12598
|
+
git_ignore_options: typing.Optional[typing.Union[_projen_04054675.IgnoreFileOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12599
|
+
git_options: typing.Optional[typing.Union[_projen_04054675.GitOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12600
|
+
gitpod: typing.Optional[builtins.bool] = None,
|
12601
|
+
homepage: typing.Optional[builtins.str] = None,
|
12602
|
+
integration_test_auto_discover: typing.Optional[builtins.bool] = None,
|
12603
|
+
jest: typing.Optional[builtins.bool] = None,
|
12604
|
+
jest_options: typing.Optional[typing.Union[_projen_javascript_04054675.JestOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12605
|
+
jsii_release_version: typing.Optional[builtins.str] = None,
|
12606
|
+
keywords: typing.Optional[typing.Sequence[builtins.str]] = None,
|
12607
|
+
lambda_auto_discover: typing.Optional[builtins.bool] = None,
|
12608
|
+
lambda_extension_auto_discover: typing.Optional[builtins.bool] = None,
|
12609
|
+
lambda_options: typing.Optional[typing.Union[_projen_awscdk_04054675.LambdaFunctionCommonOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12610
|
+
libdir: typing.Optional[builtins.str] = None,
|
12611
|
+
license: typing.Optional[builtins.str] = None,
|
12612
|
+
licensed: typing.Optional[builtins.bool] = None,
|
12613
|
+
logging: typing.Optional[typing.Union[_projen_04054675.LoggerOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12614
|
+
major_version: typing.Optional[jsii.Number] = None,
|
12615
|
+
max_node_version: typing.Optional[builtins.str] = None,
|
12616
|
+
mergify: typing.Optional[builtins.bool] = None,
|
12617
|
+
mergify_options: typing.Optional[typing.Union[_projen_github_04054675.MergifyOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12618
|
+
min_major_version: typing.Optional[jsii.Number] = None,
|
12619
|
+
min_node_version: typing.Optional[builtins.str] = None,
|
12620
|
+
mutable_build: typing.Optional[builtins.bool] = None,
|
12621
|
+
next_version_command: typing.Optional[builtins.str] = None,
|
12622
|
+
npm_access: typing.Optional[_projen_javascript_04054675.NpmAccess] = None,
|
12623
|
+
npm_dist_tag: typing.Optional[builtins.str] = None,
|
12624
|
+
npmignore: typing.Optional[typing.Sequence[builtins.str]] = None,
|
12625
|
+
npmignore_enabled: typing.Optional[builtins.bool] = None,
|
12626
|
+
npm_ignore_options: typing.Optional[typing.Union[_projen_04054675.IgnoreFileOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12627
|
+
npm_provenance: typing.Optional[builtins.bool] = None,
|
12628
|
+
npm_registry: typing.Optional[builtins.str] = None,
|
12629
|
+
npm_registry_url: typing.Optional[builtins.str] = None,
|
12630
|
+
npm_token_secret: typing.Optional[builtins.str] = None,
|
12631
|
+
outdir: typing.Optional[builtins.str] = None,
|
12632
|
+
package: typing.Optional[builtins.bool] = None,
|
12633
|
+
package_manager: typing.Optional[_projen_javascript_04054675.NodePackageManager] = None,
|
12634
|
+
package_name: typing.Optional[builtins.str] = None,
|
12635
|
+
parent: typing.Optional[_projen_04054675.Project] = None,
|
12636
|
+
peer_dependency_options: typing.Optional[typing.Union[_projen_javascript_04054675.PeerDependencyOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12637
|
+
peer_deps: typing.Optional[typing.Sequence[builtins.str]] = None,
|
12638
|
+
pnpm_version: typing.Optional[builtins.str] = None,
|
12639
|
+
post_build_steps: typing.Optional[typing.Sequence[typing.Union[_projen_github_workflows_04054675.JobStep, typing.Dict[builtins.str, typing.Any]]]] = None,
|
12640
|
+
prerelease: typing.Optional[builtins.str] = None,
|
12641
|
+
prettier: typing.Optional[builtins.bool] = None,
|
12642
|
+
prettier_options: typing.Optional[typing.Union[_projen_javascript_04054675.PrettierOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12643
|
+
project_type: typing.Optional[_projen_04054675.ProjectType] = None,
|
12644
|
+
projen_command: typing.Optional[builtins.str] = None,
|
12645
|
+
projen_credentials: typing.Optional[_projen_github_04054675.GithubCredentials] = None,
|
12646
|
+
projen_dev_dependency: typing.Optional[builtins.bool] = None,
|
12647
|
+
projenrc_js: typing.Optional[builtins.bool] = None,
|
12648
|
+
projenrc_json: typing.Optional[builtins.bool] = None,
|
12649
|
+
projenrc_json_options: typing.Optional[typing.Union[_projen_04054675.ProjenrcJsonOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12650
|
+
projenrc_js_options: typing.Optional[typing.Union[_projen_javascript_04054675.ProjenrcOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12651
|
+
projenrc_ts: typing.Optional[builtins.bool] = None,
|
12652
|
+
projenrc_ts_options: typing.Optional[typing.Union[_projen_typescript_04054675.ProjenrcOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12653
|
+
projen_token_secret: typing.Optional[builtins.str] = None,
|
12654
|
+
projen_version: typing.Optional[builtins.str] = None,
|
12655
|
+
publish_dry_run: typing.Optional[builtins.bool] = None,
|
12656
|
+
publish_tasks: typing.Optional[builtins.bool] = None,
|
12657
|
+
pull_request_template: typing.Optional[builtins.bool] = None,
|
12658
|
+
pull_request_template_contents: typing.Optional[typing.Sequence[builtins.str]] = None,
|
12659
|
+
readme: typing.Optional[typing.Union[ReadmeOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12660
|
+
releasable_commits: typing.Optional[_projen_04054675.ReleasableCommits] = None,
|
12661
|
+
release: typing.Optional[builtins.bool] = None,
|
12662
|
+
release_branches: typing.Optional[typing.Mapping[builtins.str, typing.Union[_projen_release_04054675.BranchOptions, typing.Dict[builtins.str, typing.Any]]]] = None,
|
12663
|
+
release_every_commit: typing.Optional[builtins.bool] = None,
|
12664
|
+
release_failure_issue: typing.Optional[builtins.bool] = None,
|
12665
|
+
release_failure_issue_label: typing.Optional[builtins.str] = None,
|
12666
|
+
release_schedule: typing.Optional[builtins.str] = None,
|
12667
|
+
release_tag_prefix: typing.Optional[builtins.str] = None,
|
12668
|
+
release_to_npm: typing.Optional[builtins.bool] = None,
|
12669
|
+
release_trigger: typing.Optional[_projen_release_04054675.ReleaseTrigger] = None,
|
12670
|
+
release_workflow: typing.Optional[builtins.bool] = None,
|
12671
|
+
release_workflow_name: typing.Optional[builtins.str] = None,
|
12672
|
+
release_workflow_setup_steps: typing.Optional[typing.Sequence[typing.Union[_projen_github_workflows_04054675.JobStep, typing.Dict[builtins.str, typing.Any]]]] = None,
|
12673
|
+
renovatebot: typing.Optional[builtins.bool] = None,
|
12674
|
+
renovatebot_options: typing.Optional[typing.Union[_projen_04054675.RenovatebotOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12675
|
+
repository: typing.Optional[builtins.str] = None,
|
12676
|
+
repository_directory: typing.Optional[builtins.str] = None,
|
12677
|
+
require_approval: typing.Optional[_projen_awscdk_04054675.ApprovalLevel] = None,
|
12678
|
+
sample_code: typing.Optional[builtins.bool] = None,
|
12679
|
+
scoped_packages_options: typing.Optional[typing.Sequence[typing.Union[_projen_javascript_04054675.ScopedPackagesOptions, typing.Dict[builtins.str, typing.Any]]]] = None,
|
12680
|
+
scripts: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
12681
|
+
srcdir: typing.Optional[builtins.str] = None,
|
12682
|
+
stability: typing.Optional[builtins.str] = None,
|
12683
|
+
stale: typing.Optional[builtins.bool] = None,
|
12684
|
+
stale_options: typing.Optional[typing.Union[_projen_github_04054675.StaleOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12685
|
+
testdir: typing.Optional[builtins.str] = None,
|
12686
|
+
tsconfig: typing.Optional[typing.Union[_projen_javascript_04054675.TypescriptConfigOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12687
|
+
tsconfig_dev: typing.Optional[typing.Union[_projen_javascript_04054675.TypescriptConfigOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12688
|
+
tsconfig_dev_file: typing.Optional[builtins.str] = None,
|
12689
|
+
ts_jest_options: typing.Optional[typing.Union[_projen_typescript_04054675.TsJestOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12690
|
+
typescript_version: typing.Optional[builtins.str] = None,
|
12691
|
+
versionrc_options: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
|
12692
|
+
vscode: typing.Optional[builtins.bool] = None,
|
12693
|
+
watch_excludes: typing.Optional[typing.Sequence[builtins.str]] = None,
|
12694
|
+
watch_includes: typing.Optional[typing.Sequence[builtins.str]] = None,
|
12695
|
+
workflow_bootstrap_steps: typing.Optional[typing.Sequence[typing.Union[_projen_github_workflows_04054675.JobStep, typing.Dict[builtins.str, typing.Any]]]] = None,
|
12696
|
+
workflow_container_image: typing.Optional[builtins.str] = None,
|
12697
|
+
workflow_git_identity: typing.Optional[typing.Union[_projen_github_04054675.GitIdentity, typing.Dict[builtins.str, typing.Any]]] = None,
|
12698
|
+
workflow_node_version: typing.Optional[builtins.str] = None,
|
12699
|
+
workflow_package_cache: typing.Optional[builtins.bool] = None,
|
12700
|
+
workflow_runs_on: typing.Optional[typing.Sequence[builtins.str]] = None,
|
12701
|
+
workflow_runs_on_group: typing.Optional[typing.Union[_projen_04054675.GroupRunnerOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12702
|
+
yarn_berry_options: typing.Optional[typing.Union[_projen_javascript_04054675.YarnBerryOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
12703
|
+
) -> None:
|
12704
|
+
"""Type checking stubs"""
|
12705
|
+
pass
|
12706
|
+
|
8684
12707
|
def _typecheckingstub__23029d204b6d2d942365c98cdf1ae37497306087c242e282bc4760de997efd13(
|
8685
12708
|
value: builtins.str,
|
8686
12709
|
) -> None:
|