@taimos/projen 0.0.130 → 0.0.133
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.gitattributes +1 -1
- package/.jsii +4 -4
- package/API.md +79 -85
- package/changelog.md +6 -1
- package/lib/aspects/cdk-pipeline.d.ts +0 -6
- package/lib/aspects/cdk-pipeline.js +2 -8
- package/lib/aspects/sops.d.ts +1 -15
- package/lib/aspects/sops.js +3 -9
- package/lib/projects/cdk-app.d.ts +3 -12
- package/lib/projects/cdk-app.js +9 -8
- package/lib/projects/cdk-construct.d.ts +1 -8
- package/lib/projects/cdk-construct.js +33 -7
- package/lib/projects/private-cdk-app.d.ts +1 -11
- package/lib/projects/private-cdk-app.js +3 -7
- package/lib/projects/private-ts-lib.d.ts +1 -11
- package/lib/projects/private-ts-lib.js +3 -7
- package/lib/projects/ts-lib.d.ts +1 -8
- package/lib/projects/ts-lib.js +33 -7
- package/package.json +11 -8
- package/releasetag.txt +1 -1
- package/version.txt +1 -1
package/API.md
CHANGED
|
@@ -79,9 +79,10 @@ new PrivateTaimosCdkApp(options: PrivateTaimosCdkAppOptions)
|
|
|
79
79
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
80
80
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
81
81
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
82
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
82
83
|
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
83
84
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
84
|
-
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__:
|
|
85
|
+
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
85
86
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
86
87
|
* **vscode** (<code>boolean</code>) Enable VSCode integration. __*Default*__: true
|
|
87
88
|
* **allowLibraryDependencies** (<code>boolean</code>) Allow the project to include `peerDependencies` and `bundledDependencies`. __*Default*__: true
|
|
@@ -117,7 +118,7 @@ new PrivateTaimosCdkApp(options: PrivateTaimosCdkAppOptions)
|
|
|
117
118
|
* **repositoryDirectory** (<code>string</code>) 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. __*Optional*__
|
|
118
119
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
119
120
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
120
|
-
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `
|
|
121
|
+
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `publib` which is used to publish modules to npm. __*Default*__: "latest"
|
|
121
122
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
122
123
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
123
124
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
@@ -138,9 +139,9 @@ new PrivateTaimosCdkApp(options: PrivateTaimosCdkAppOptions)
|
|
|
138
139
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
139
140
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
140
141
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
141
|
-
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
142
142
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
143
143
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
144
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
144
145
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
145
146
|
* **codeCov** (<code>boolean</code>) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. __*Default*__: false
|
|
146
147
|
* **codeCovTokenSecret** (<code>string</code>) 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
|
|
@@ -149,7 +150,7 @@ new PrivateTaimosCdkApp(options: PrivateTaimosCdkAppOptions)
|
|
|
149
150
|
* **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
|
|
150
151
|
* **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
|
|
151
152
|
* **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
|
|
152
|
-
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for
|
|
153
|
+
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for `UpgradeDependencies`. __*Default*__: default options
|
|
153
154
|
* **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
|
|
154
155
|
* **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
|
|
155
156
|
* **jestOptions** (<code>[javascript.JestOptions](#projen-javascript-jestoptions)</code>) Jest options. __*Default*__: default options
|
|
@@ -162,16 +163,13 @@ new PrivateTaimosCdkApp(options: PrivateTaimosCdkAppOptions)
|
|
|
162
163
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
163
164
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
164
165
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
165
|
-
* **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
166
|
-
* **projenUpgradeSchedule** (<code>Array<string></code>) Customize the projenUpgrade schedule in cron expression. __*Default*__: [ "0 6 * * *" ]
|
|
167
|
-
* **projenUpgradeSecret** (<code>string</code>) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`). __*Default*__: no automatic projen upgrade pull requests
|
|
168
166
|
* **projenVersion** (<code>string</code>) Version of projen to install. __*Default*__: Defaults to the latest version.
|
|
169
167
|
* **pullRequestTemplate** (<code>boolean</code>) Include a GitHub pull request template. __*Default*__: true
|
|
170
168
|
* **pullRequestTemplateContents** (<code>Array<string></code>) The contents of the pull request template. __*Default*__: default content
|
|
171
169
|
* **release** (<code>boolean</code>) Add release management to this project. __*Default*__: true (false for subprojects)
|
|
172
170
|
* **releaseToNpm** (<code>boolean</code>) Automatically release to npm when new versions are introduced. __*Default*__: false
|
|
173
171
|
* **releaseWorkflow** (<code>boolean</code>) DEPRECATED: renamed to `release`. __*Default*__: true if not a subproject
|
|
174
|
-
* **workflowBootstrapSteps** (<code>Array<
|
|
172
|
+
* **workflowBootstrapSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
|
|
175
173
|
* **workflowGitIdentity** (<code>[github.GitIdentity](#projen-github-gitidentity)</code>) The git identity to use in workflows. __*Default*__: GitHub Actions
|
|
176
174
|
* **workflowNodeVersion** (<code>string</code>) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
|
|
177
175
|
* **disableTsconfig** (<code>boolean</code>) Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). __*Default*__: false
|
|
@@ -206,7 +204,9 @@ new PrivateTaimosCdkApp(options: PrivateTaimosCdkAppOptions)
|
|
|
206
204
|
* **cdkVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for CDK. __*Optional*__
|
|
207
205
|
* **constructsVersion** (<code>string</code>) 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".
|
|
208
206
|
* **appEntrypoint** (<code>string</code>) The CDK app's entrypoint (relative to the source directory, which is "src" by default). __*Default*__: "main.ts"
|
|
207
|
+
* **integrationTestAutoDiscover** (<code>boolean</code>) Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory. __*Default*__: true
|
|
209
208
|
* **lambdaAutoDiscover** (<code>boolean</code>) 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
|
|
209
|
+
* **lambdaExtensionAutoDiscover** (<code>boolean</code>) 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
|
|
210
210
|
* **lambdaOptions** (<code>[awscdk.LambdaFunctionCommonOptions](#projen-awscdk-lambdafunctioncommonoptions)</code>) Common options for all AWS Lambda functions. __*Default*__: default options
|
|
211
211
|
* **cdkPipelines** (<code>boolean</code>) Enable CDK pipelines. __*Default*__: false
|
|
212
212
|
* **sops** (<code>[SopsAspectOptions](#taimos-projen-sopsaspectoptions)</code>) Enable storing secrets using Mozilla SOPS. __*Default*__: no SOPS config
|
|
@@ -285,9 +285,10 @@ new TaimosCdkApp(options: TaimosCdkAppOptions)
|
|
|
285
285
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
286
286
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
287
287
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
288
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
288
289
|
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
289
290
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
290
|
-
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__:
|
|
291
|
+
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
291
292
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
292
293
|
* **vscode** (<code>boolean</code>) Enable VSCode integration. __*Default*__: true
|
|
293
294
|
* **allowLibraryDependencies** (<code>boolean</code>) Allow the project to include `peerDependencies` and `bundledDependencies`. __*Default*__: true
|
|
@@ -323,7 +324,7 @@ new TaimosCdkApp(options: TaimosCdkAppOptions)
|
|
|
323
324
|
* **repositoryDirectory** (<code>string</code>) 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. __*Optional*__
|
|
324
325
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
325
326
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
326
|
-
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `
|
|
327
|
+
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `publib` which is used to publish modules to npm. __*Default*__: "latest"
|
|
327
328
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
328
329
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
329
330
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
@@ -344,9 +345,9 @@ new TaimosCdkApp(options: TaimosCdkAppOptions)
|
|
|
344
345
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
345
346
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
346
347
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
347
|
-
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
348
348
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
349
349
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
350
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
350
351
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
351
352
|
* **codeCov** (<code>boolean</code>) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. __*Default*__: false
|
|
352
353
|
* **codeCovTokenSecret** (<code>string</code>) 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
|
|
@@ -355,7 +356,7 @@ new TaimosCdkApp(options: TaimosCdkAppOptions)
|
|
|
355
356
|
* **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
|
|
356
357
|
* **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
|
|
357
358
|
* **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
|
|
358
|
-
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for
|
|
359
|
+
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for `UpgradeDependencies`. __*Default*__: default options
|
|
359
360
|
* **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
|
|
360
361
|
* **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
|
|
361
362
|
* **jestOptions** (<code>[javascript.JestOptions](#projen-javascript-jestoptions)</code>) Jest options. __*Default*__: default options
|
|
@@ -368,16 +369,13 @@ new TaimosCdkApp(options: TaimosCdkAppOptions)
|
|
|
368
369
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
369
370
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
370
371
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
371
|
-
* **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
372
|
-
* **projenUpgradeSchedule** (<code>Array<string></code>) Customize the projenUpgrade schedule in cron expression. __*Default*__: [ "0 6 * * *" ]
|
|
373
|
-
* **projenUpgradeSecret** (<code>string</code>) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`). __*Default*__: no automatic projen upgrade pull requests
|
|
374
372
|
* **projenVersion** (<code>string</code>) Version of projen to install. __*Default*__: Defaults to the latest version.
|
|
375
373
|
* **pullRequestTemplate** (<code>boolean</code>) Include a GitHub pull request template. __*Default*__: true
|
|
376
374
|
* **pullRequestTemplateContents** (<code>Array<string></code>) The contents of the pull request template. __*Default*__: default content
|
|
377
375
|
* **release** (<code>boolean</code>) Add release management to this project. __*Default*__: true (false for subprojects)
|
|
378
376
|
* **releaseToNpm** (<code>boolean</code>) Automatically release to npm when new versions are introduced. __*Default*__: false
|
|
379
377
|
* **releaseWorkflow** (<code>boolean</code>) DEPRECATED: renamed to `release`. __*Default*__: true if not a subproject
|
|
380
|
-
* **workflowBootstrapSteps** (<code>Array<
|
|
378
|
+
* **workflowBootstrapSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
|
|
381
379
|
* **workflowGitIdentity** (<code>[github.GitIdentity](#projen-github-gitidentity)</code>) The git identity to use in workflows. __*Default*__: GitHub Actions
|
|
382
380
|
* **workflowNodeVersion** (<code>string</code>) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
|
|
383
381
|
* **disableTsconfig** (<code>boolean</code>) Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). __*Default*__: false
|
|
@@ -412,7 +410,9 @@ new TaimosCdkApp(options: TaimosCdkAppOptions)
|
|
|
412
410
|
* **cdkVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for CDK. __*Optional*__
|
|
413
411
|
* **constructsVersion** (<code>string</code>) 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".
|
|
414
412
|
* **appEntrypoint** (<code>string</code>) The CDK app's entrypoint (relative to the source directory, which is "src" by default). __*Default*__: "main.ts"
|
|
413
|
+
* **integrationTestAutoDiscover** (<code>boolean</code>) Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory. __*Default*__: true
|
|
415
414
|
* **lambdaAutoDiscover** (<code>boolean</code>) 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
|
|
415
|
+
* **lambdaExtensionAutoDiscover** (<code>boolean</code>) 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
|
|
416
416
|
* **lambdaOptions** (<code>[awscdk.LambdaFunctionCommonOptions](#projen-awscdk-lambdafunctioncommonoptions)</code>) Common options for all AWS Lambda functions. __*Default*__: default options
|
|
417
417
|
* **cdkPipelines** (<code>boolean</code>) Enable CDK pipelines. __*Default*__: false
|
|
418
418
|
* **sops** (<code>[SopsAspectOptions](#taimos-projen-sopsaspectoptions)</code>) Enable storing secrets using Mozilla SOPS. __*Default*__: no SOPS config
|
|
@@ -453,9 +453,10 @@ new TaimosCdkConstructLibrary(options: TaimosCdkConstructLibraryOptions)
|
|
|
453
453
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
454
454
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
455
455
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
456
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
456
457
|
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
457
458
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
458
|
-
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__:
|
|
459
|
+
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
459
460
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
460
461
|
* **vscode** (<code>boolean</code>) Enable VSCode integration. __*Default*__: true
|
|
461
462
|
* **allowLibraryDependencies** (<code>boolean</code>) Allow the project to include `peerDependencies` and `bundledDependencies`. __*Default*__: true
|
|
@@ -491,7 +492,7 @@ new TaimosCdkConstructLibrary(options: TaimosCdkConstructLibraryOptions)
|
|
|
491
492
|
* **repositoryDirectory** (<code>string</code>) 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. __*Optional*__
|
|
492
493
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
493
494
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
494
|
-
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `
|
|
495
|
+
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `publib` which is used to publish modules to npm. __*Default*__: "latest"
|
|
495
496
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
496
497
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
497
498
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
@@ -512,9 +513,9 @@ new TaimosCdkConstructLibrary(options: TaimosCdkConstructLibraryOptions)
|
|
|
512
513
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
513
514
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
514
515
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
515
|
-
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
516
516
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
517
517
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
518
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
518
519
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
519
520
|
* **codeCov** (<code>boolean</code>) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. __*Default*__: false
|
|
520
521
|
* **codeCovTokenSecret** (<code>string</code>) 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
|
|
@@ -523,7 +524,7 @@ new TaimosCdkConstructLibrary(options: TaimosCdkConstructLibraryOptions)
|
|
|
523
524
|
* **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
|
|
524
525
|
* **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
|
|
525
526
|
* **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
|
|
526
|
-
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for
|
|
527
|
+
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for `UpgradeDependencies`. __*Default*__: default options
|
|
527
528
|
* **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
|
|
528
529
|
* **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
|
|
529
530
|
* **jestOptions** (<code>[javascript.JestOptions](#projen-javascript-jestoptions)</code>) Jest options. __*Default*__: default options
|
|
@@ -536,16 +537,13 @@ new TaimosCdkConstructLibrary(options: TaimosCdkConstructLibraryOptions)
|
|
|
536
537
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
537
538
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
538
539
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
539
|
-
* **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
540
|
-
* **projenUpgradeSchedule** (<code>Array<string></code>) Customize the projenUpgrade schedule in cron expression. __*Default*__: [ "0 6 * * *" ]
|
|
541
|
-
* **projenUpgradeSecret** (<code>string</code>) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`). __*Default*__: no automatic projen upgrade pull requests
|
|
542
540
|
* **projenVersion** (<code>string</code>) Version of projen to install. __*Default*__: Defaults to the latest version.
|
|
543
541
|
* **pullRequestTemplate** (<code>boolean</code>) Include a GitHub pull request template. __*Default*__: true
|
|
544
542
|
* **pullRequestTemplateContents** (<code>Array<string></code>) The contents of the pull request template. __*Default*__: default content
|
|
545
543
|
* **release** (<code>boolean</code>) Add release management to this project. __*Default*__: true (false for subprojects)
|
|
546
544
|
* **releaseToNpm** (<code>boolean</code>) Automatically release to npm when new versions are introduced. __*Default*__: false
|
|
547
545
|
* **releaseWorkflow** (<code>boolean</code>) DEPRECATED: renamed to `release`. __*Default*__: true if not a subproject
|
|
548
|
-
* **workflowBootstrapSteps** (<code>Array<
|
|
546
|
+
* **workflowBootstrapSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
|
|
549
547
|
* **workflowGitIdentity** (<code>[github.GitIdentity](#projen-github-gitidentity)</code>) The git identity to use in workflows. __*Default*__: GitHub Actions
|
|
550
548
|
* **workflowNodeVersion** (<code>string</code>) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
|
|
551
549
|
* **disableTsconfig** (<code>boolean</code>) Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). __*Default*__: false
|
|
@@ -569,6 +567,7 @@ new TaimosCdkConstructLibrary(options: TaimosCdkConstructLibraryOptions)
|
|
|
569
567
|
* **repositoryUrl** (<code>string</code>) Git repository URL.
|
|
570
568
|
* **compat** (<code>boolean</code>) Automatically run API compatibility test against the latest version published to npm after compilation. __*Default*__: false
|
|
571
569
|
* **compatIgnore** (<code>string</code>) Name of the ignore file for API compatibility tests. __*Default*__: ".compatignore"
|
|
570
|
+
* **docgenFilePath** (<code>string</code>) File path for generated docs. __*Default*__: "API.md"
|
|
572
571
|
* **dotnet** (<code>[cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)</code>) *No description* __*Optional*__
|
|
573
572
|
* **excludeTypescript** (<code>Array<string></code>) Accepts a list of glob patterns. __*Optional*__
|
|
574
573
|
* **publishToGo** (<code>[cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)</code>) Publish Go bindings to a git repository. __*Default*__: no publishing
|
|
@@ -586,7 +585,9 @@ new TaimosCdkConstructLibrary(options: TaimosCdkConstructLibraryOptions)
|
|
|
586
585
|
* **cdkTestDependencies** (<code>Array<string></code>) AWS CDK modules required for testing. __*Optional*__
|
|
587
586
|
* **cdkVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for CDK. __*Optional*__
|
|
588
587
|
* **constructsVersion** (<code>string</code>) 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".
|
|
588
|
+
* **integrationTestAutoDiscover** (<code>boolean</code>) Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory. __*Default*__: true
|
|
589
589
|
* **lambdaAutoDiscover** (<code>boolean</code>) Automatically adds an `aws_lambda.Function` for each `.lambda.ts` handler in your source tree. If this is disabled, you either need to explicitly call `aws_lambda.Function.autoDiscover()` or define a `new aws_lambda.Function()` for each handler. __*Default*__: true
|
|
590
|
+
* **lambdaExtensionAutoDiscover** (<code>boolean</code>) 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
|
|
590
591
|
* **lambdaOptions** (<code>[awscdk.LambdaFunctionCommonOptions](#projen-awscdk-lambdafunctioncommonoptions)</code>) Common options for all AWS Lambda functions. __*Default*__: default options
|
|
591
592
|
|
|
592
593
|
|
|
@@ -625,9 +626,10 @@ new TaimosPrivateTypescriptLibrary(options: TaimosPrivateTypescriptLibraryOption
|
|
|
625
626
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
626
627
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
627
628
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
629
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
628
630
|
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
629
631
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
630
|
-
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__:
|
|
632
|
+
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
631
633
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
632
634
|
* **vscode** (<code>boolean</code>) Enable VSCode integration. __*Default*__: true
|
|
633
635
|
* **allowLibraryDependencies** (<code>boolean</code>) Allow the project to include `peerDependencies` and `bundledDependencies`. __*Default*__: true
|
|
@@ -663,7 +665,7 @@ new TaimosPrivateTypescriptLibrary(options: TaimosPrivateTypescriptLibraryOption
|
|
|
663
665
|
* **repositoryDirectory** (<code>string</code>) 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. __*Optional*__
|
|
664
666
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
665
667
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
666
|
-
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `
|
|
668
|
+
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `publib` which is used to publish modules to npm. __*Default*__: "latest"
|
|
667
669
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
668
670
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
669
671
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
@@ -684,9 +686,9 @@ new TaimosPrivateTypescriptLibrary(options: TaimosPrivateTypescriptLibraryOption
|
|
|
684
686
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
685
687
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
686
688
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
687
|
-
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
688
689
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
689
690
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
691
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
690
692
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
691
693
|
* **codeCov** (<code>boolean</code>) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. __*Default*__: false
|
|
692
694
|
* **codeCovTokenSecret** (<code>string</code>) 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
|
|
@@ -695,7 +697,7 @@ new TaimosPrivateTypescriptLibrary(options: TaimosPrivateTypescriptLibraryOption
|
|
|
695
697
|
* **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
|
|
696
698
|
* **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
|
|
697
699
|
* **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
|
|
698
|
-
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for
|
|
700
|
+
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for `UpgradeDependencies`. __*Default*__: default options
|
|
699
701
|
* **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
|
|
700
702
|
* **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
|
|
701
703
|
* **jestOptions** (<code>[javascript.JestOptions](#projen-javascript-jestoptions)</code>) Jest options. __*Default*__: default options
|
|
@@ -708,16 +710,13 @@ new TaimosPrivateTypescriptLibrary(options: TaimosPrivateTypescriptLibraryOption
|
|
|
708
710
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
709
711
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
710
712
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
711
|
-
* **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
712
|
-
* **projenUpgradeSchedule** (<code>Array<string></code>) Customize the projenUpgrade schedule in cron expression. __*Default*__: [ "0 6 * * *" ]
|
|
713
|
-
* **projenUpgradeSecret** (<code>string</code>) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`). __*Default*__: no automatic projen upgrade pull requests
|
|
714
713
|
* **projenVersion** (<code>string</code>) Version of projen to install. __*Default*__: Defaults to the latest version.
|
|
715
714
|
* **pullRequestTemplate** (<code>boolean</code>) Include a GitHub pull request template. __*Default*__: true
|
|
716
715
|
* **pullRequestTemplateContents** (<code>Array<string></code>) The contents of the pull request template. __*Default*__: default content
|
|
717
716
|
* **release** (<code>boolean</code>) Add release management to this project. __*Default*__: true (false for subprojects)
|
|
718
717
|
* **releaseToNpm** (<code>boolean</code>) Automatically release to npm when new versions are introduced. __*Default*__: false
|
|
719
718
|
* **releaseWorkflow** (<code>boolean</code>) DEPRECATED: renamed to `release`. __*Default*__: true if not a subproject
|
|
720
|
-
* **workflowBootstrapSteps** (<code>Array<
|
|
719
|
+
* **workflowBootstrapSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
|
|
721
720
|
* **workflowGitIdentity** (<code>[github.GitIdentity](#projen-github-gitidentity)</code>) The git identity to use in workflows. __*Default*__: GitHub Actions
|
|
722
721
|
* **workflowNodeVersion** (<code>string</code>) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
|
|
723
722
|
* **disableTsconfig** (<code>boolean</code>) Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). __*Default*__: false
|
|
@@ -781,9 +780,10 @@ new TaimosTypescriptLibrary(options: TaimosTypescriptLibraryOptions)
|
|
|
781
780
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
782
781
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
783
782
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
783
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
784
784
|
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
785
785
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
786
|
-
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__:
|
|
786
|
+
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
787
787
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
788
788
|
* **vscode** (<code>boolean</code>) Enable VSCode integration. __*Default*__: true
|
|
789
789
|
* **allowLibraryDependencies** (<code>boolean</code>) Allow the project to include `peerDependencies` and `bundledDependencies`. __*Default*__: true
|
|
@@ -819,7 +819,7 @@ new TaimosTypescriptLibrary(options: TaimosTypescriptLibraryOptions)
|
|
|
819
819
|
* **repositoryDirectory** (<code>string</code>) 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. __*Optional*__
|
|
820
820
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
821
821
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
822
|
-
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `
|
|
822
|
+
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `publib` which is used to publish modules to npm. __*Default*__: "latest"
|
|
823
823
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
824
824
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
825
825
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
@@ -840,9 +840,9 @@ new TaimosTypescriptLibrary(options: TaimosTypescriptLibraryOptions)
|
|
|
840
840
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
841
841
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
842
842
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
843
|
-
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
844
843
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
845
844
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
845
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
846
846
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
847
847
|
* **codeCov** (<code>boolean</code>) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. __*Default*__: false
|
|
848
848
|
* **codeCovTokenSecret** (<code>string</code>) 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
|
|
@@ -851,7 +851,7 @@ new TaimosTypescriptLibrary(options: TaimosTypescriptLibraryOptions)
|
|
|
851
851
|
* **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
|
|
852
852
|
* **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
|
|
853
853
|
* **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
|
|
854
|
-
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for
|
|
854
|
+
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for `UpgradeDependencies`. __*Default*__: default options
|
|
855
855
|
* **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
|
|
856
856
|
* **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
|
|
857
857
|
* **jestOptions** (<code>[javascript.JestOptions](#projen-javascript-jestoptions)</code>) Jest options. __*Default*__: default options
|
|
@@ -864,16 +864,13 @@ new TaimosTypescriptLibrary(options: TaimosTypescriptLibraryOptions)
|
|
|
864
864
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
865
865
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
866
866
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
867
|
-
* **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
868
|
-
* **projenUpgradeSchedule** (<code>Array<string></code>) Customize the projenUpgrade schedule in cron expression. __*Default*__: [ "0 6 * * *" ]
|
|
869
|
-
* **projenUpgradeSecret** (<code>string</code>) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`). __*Default*__: no automatic projen upgrade pull requests
|
|
870
867
|
* **projenVersion** (<code>string</code>) Version of projen to install. __*Default*__: Defaults to the latest version.
|
|
871
868
|
* **pullRequestTemplate** (<code>boolean</code>) Include a GitHub pull request template. __*Default*__: true
|
|
872
869
|
* **pullRequestTemplateContents** (<code>Array<string></code>) The contents of the pull request template. __*Default*__: default content
|
|
873
870
|
* **release** (<code>boolean</code>) Add release management to this project. __*Default*__: true (false for subprojects)
|
|
874
871
|
* **releaseToNpm** (<code>boolean</code>) Automatically release to npm when new versions are introduced. __*Default*__: false
|
|
875
872
|
* **releaseWorkflow** (<code>boolean</code>) DEPRECATED: renamed to `release`. __*Default*__: true if not a subproject
|
|
876
|
-
* **workflowBootstrapSteps** (<code>Array<
|
|
873
|
+
* **workflowBootstrapSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
|
|
877
874
|
* **workflowGitIdentity** (<code>[github.GitIdentity](#projen-github-gitidentity)</code>) The git identity to use in workflows. __*Default*__: GitHub Actions
|
|
878
875
|
* **workflowNodeVersion** (<code>string</code>) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
|
|
879
876
|
* **disableTsconfig** (<code>boolean</code>) Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). __*Default*__: false
|
|
@@ -916,7 +913,6 @@ Name | Type | Description
|
|
|
916
913
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
917
914
|
**authorUrl**?🔹 | <code>string</code> | Author's URL / Website.<br/>__*Optional*__
|
|
918
915
|
**autoApproveOptions**?🔹 | <code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code> | Enable and configure the 'auto approve' workflow.<br/>__*Default*__: auto approve is disabled
|
|
919
|
-
**autoApproveProjenUpgrades**?🔹 | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
920
916
|
**autoApproveUpgrades**?🔹 | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: true
|
|
921
917
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
922
918
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
@@ -925,6 +921,7 @@ Name | Type | Description
|
|
|
925
921
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
926
922
|
**buildCommand**?🔹 | <code>string</code> | A command to execute before synthesis.<br/>__*Default*__: no build command
|
|
927
923
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
924
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
928
925
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
929
926
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
930
927
|
**cdkAssert**?⚠️ | <code>boolean</code> | Warning: NodeJS only.<br/>__*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
|
|
@@ -947,7 +944,7 @@ Name | Type | Description
|
|
|
947
944
|
**dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
|
|
948
945
|
**deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
|
|
949
946
|
**depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
|
|
950
|
-
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for
|
|
947
|
+
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for `UpgradeDependencies`.<br/>__*Default*__: default options
|
|
951
948
|
**description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
|
|
952
949
|
**devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
|
|
953
950
|
**devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
|
|
@@ -964,11 +961,13 @@ Name | Type | Description
|
|
|
964
961
|
**gitignore**?🔹 | <code>Array<string></code> | Additional entries to .gitignore.<br/>__*Optional*__
|
|
965
962
|
**gitpod**?🔹 | <code>boolean</code> | Add a Gitpod development environment.<br/>__*Default*__: false
|
|
966
963
|
**homepage**?🔹 | <code>string</code> | Package's Homepage / Website.<br/>__*Optional*__
|
|
964
|
+
**integrationTestAutoDiscover**?🔹 | <code>boolean</code> | Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory.<br/>__*Default*__: true
|
|
967
965
|
**jest**?🔹 | <code>boolean</code> | Setup jest unit tests.<br/>__*Default*__: true
|
|
968
966
|
**jestOptions**?🔹 | <code>[javascript.JestOptions](#projen-javascript-jestoptions)</code> | Jest options.<br/>__*Default*__: default options
|
|
969
|
-
**jsiiReleaseVersion**?🔹 | <code>string</code> | Version requirement of `
|
|
967
|
+
**jsiiReleaseVersion**?🔹 | <code>string</code> | Version requirement of `publib` which is used to publish modules to npm.<br/>__*Default*__: "latest"
|
|
970
968
|
**keywords**?🔹 | <code>Array<string></code> | Keywords to include in `package.json`.<br/>__*Optional*__
|
|
971
969
|
**lambdaAutoDiscover**?🔹 | <code>boolean</code> | 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.<br/>__*Default*__: true
|
|
970
|
+
**lambdaExtensionAutoDiscover**?🔹 | <code>boolean</code> | 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.<br/>__*Default*__: true
|
|
972
971
|
**lambdaOptions**?🔹 | <code>[awscdk.LambdaFunctionCommonOptions](#projen-awscdk-lambdafunctioncommonoptions)</code> | Common options for all AWS Lambda functions.<br/>__*Default*__: default options
|
|
973
972
|
**libdir**?🔹 | <code>string</code> | Typescript artifacts output directory.<br/>__*Default*__: "lib"
|
|
974
973
|
**license**?🔹 | <code>string</code> | License's SPDX identifier.<br/>__*Default*__: "Apache-2.0"
|
|
@@ -1000,11 +999,9 @@ Name | Type | Description
|
|
|
1000
999
|
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
1001
1000
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
1002
1001
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
1002
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
1003
1003
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
1004
|
-
**projenTokenSecret
|
|
1005
|
-
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
1006
|
-
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
1007
|
-
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
1004
|
+
**projenTokenSecret**?⚠️ | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
1008
1005
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
1009
1006
|
**projenrcJs**?🔹 | <code>boolean</code> | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.<br/>__*Default*__: true if projenrcJson is false
|
|
1010
1007
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -1037,7 +1034,7 @@ Name | Type | Description
|
|
|
1037
1034
|
**sops**? | <code>[SopsAspectOptions](#taimos-projen-sopsaspectoptions)</code> | Enable storing secrets using Mozilla SOPS.<br/>__*Default*__: no SOPS config
|
|
1038
1035
|
**srcdir**?🔹 | <code>string</code> | Typescript sources directory.<br/>__*Default*__: "src"
|
|
1039
1036
|
**stability**?🔹 | <code>string</code> | Package's Stability.<br/>__*Optional*__
|
|
1040
|
-
**stale**?🔹 | <code>boolean</code> | Auto-close of stale issues and pull request.<br/>__*Default*__:
|
|
1037
|
+
**stale**?🔹 | <code>boolean</code> | Auto-close of stale issues and pull request.<br/>__*Default*__: false
|
|
1041
1038
|
**staleOptions**?🔹 | <code>[github.StaleOptions](#projen-github-staleoptions)</code> | Auto-close stale issues and pull requests.<br/>__*Default*__: see defaults in `StaleOptions`
|
|
1042
1039
|
**testdir**?🔹 | <code>string</code> | Jest tests directory. Tests files should be named `xxx.test.ts`.<br/>__*Default*__: "test"
|
|
1043
1040
|
**tsconfig**?🔹 | <code>[javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)</code> | Custom TSConfig.<br/>__*Default*__: default options
|
|
@@ -1048,7 +1045,7 @@ Name | Type | Description
|
|
|
1048
1045
|
**vscode**?🔹 | <code>boolean</code> | Enable VSCode integration.<br/>__*Default*__: true
|
|
1049
1046
|
**watchExcludes**?🔹 | <code>Array<string></code> | Glob patterns to exclude from `cdk watch`.<br/>__*Default*__: []
|
|
1050
1047
|
**watchIncludes**?🔹 | <code>Array<string></code> | Glob patterns to include in `cdk watch`.<br/>__*Default*__: []
|
|
1051
|
-
**workflowBootstrapSteps**?🔹 | <code>Array<
|
|
1048
|
+
**workflowBootstrapSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Workflow steps to use in order to bootstrap this repo.<br/>__*Default*__: "yarn install --frozen-lockfile && yarn projen"
|
|
1052
1049
|
**workflowContainerImage**?🔹 | <code>string</code> | Container image to use for GitHub workflows.<br/>__*Default*__: default image
|
|
1053
1050
|
**workflowGitIdentity**?🔹 | <code>[github.GitIdentity](#projen-github-gitidentity)</code> | The git identity to use in workflows.<br/>__*Default*__: GitHub Actions
|
|
1054
1051
|
**workflowNodeVersion**?🔹 | <code>string</code> | The node version to use in GitHub workflows.<br/>__*Default*__: same as `minNodeVersion`
|
|
@@ -1089,7 +1086,6 @@ Name | Type | Description
|
|
|
1089
1086
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
1090
1087
|
**authorUrl**?🔹 | <code>string</code> | Author's URL / Website.<br/>__*Optional*__
|
|
1091
1088
|
**autoApproveOptions**?🔹 | <code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code> | Enable and configure the 'auto approve' workflow.<br/>__*Default*__: auto approve is disabled
|
|
1092
|
-
**autoApproveProjenUpgrades**?🔹 | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
1093
1089
|
**autoApproveUpgrades**?🔹 | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: true
|
|
1094
1090
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
1095
1091
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
@@ -1098,6 +1094,7 @@ Name | Type | Description
|
|
|
1098
1094
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
1099
1095
|
**buildCommand**?🔹 | <code>string</code> | A command to execute before synthesis.<br/>__*Default*__: no build command
|
|
1100
1096
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
1097
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
1101
1098
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
1102
1099
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
1103
1100
|
**cdkAssert**?⚠️ | <code>boolean</code> | Warning: NodeJS only.<br/>__*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
|
|
@@ -1120,7 +1117,7 @@ Name | Type | Description
|
|
|
1120
1117
|
**dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
|
|
1121
1118
|
**deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
|
|
1122
1119
|
**depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
|
|
1123
|
-
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for
|
|
1120
|
+
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for `UpgradeDependencies`.<br/>__*Default*__: default options
|
|
1124
1121
|
**description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
|
|
1125
1122
|
**devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
|
|
1126
1123
|
**devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
|
|
@@ -1137,11 +1134,13 @@ Name | Type | Description
|
|
|
1137
1134
|
**gitignore**?🔹 | <code>Array<string></code> | Additional entries to .gitignore.<br/>__*Optional*__
|
|
1138
1135
|
**gitpod**?🔹 | <code>boolean</code> | Add a Gitpod development environment.<br/>__*Default*__: false
|
|
1139
1136
|
**homepage**?🔹 | <code>string</code> | Package's Homepage / Website.<br/>__*Optional*__
|
|
1137
|
+
**integrationTestAutoDiscover**?🔹 | <code>boolean</code> | Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory.<br/>__*Default*__: true
|
|
1140
1138
|
**jest**?🔹 | <code>boolean</code> | Setup jest unit tests.<br/>__*Default*__: true
|
|
1141
1139
|
**jestOptions**?🔹 | <code>[javascript.JestOptions](#projen-javascript-jestoptions)</code> | Jest options.<br/>__*Default*__: default options
|
|
1142
|
-
**jsiiReleaseVersion**?🔹 | <code>string</code> | Version requirement of `
|
|
1140
|
+
**jsiiReleaseVersion**?🔹 | <code>string</code> | Version requirement of `publib` which is used to publish modules to npm.<br/>__*Default*__: "latest"
|
|
1143
1141
|
**keywords**?🔹 | <code>Array<string></code> | Keywords to include in `package.json`.<br/>__*Optional*__
|
|
1144
1142
|
**lambdaAutoDiscover**?🔹 | <code>boolean</code> | 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.<br/>__*Default*__: true
|
|
1143
|
+
**lambdaExtensionAutoDiscover**?🔹 | <code>boolean</code> | 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.<br/>__*Default*__: true
|
|
1145
1144
|
**lambdaOptions**?🔹 | <code>[awscdk.LambdaFunctionCommonOptions](#projen-awscdk-lambdafunctioncommonoptions)</code> | Common options for all AWS Lambda functions.<br/>__*Default*__: default options
|
|
1146
1145
|
**libdir**?🔹 | <code>string</code> | Typescript artifacts output directory.<br/>__*Default*__: "lib"
|
|
1147
1146
|
**license**?🔹 | <code>string</code> | License's SPDX identifier.<br/>__*Default*__: "Apache-2.0"
|
|
@@ -1173,11 +1172,9 @@ Name | Type | Description
|
|
|
1173
1172
|
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
1174
1173
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
1175
1174
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
1175
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
1176
1176
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
1177
|
-
**projenTokenSecret
|
|
1178
|
-
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
1179
|
-
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
1180
|
-
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
1177
|
+
**projenTokenSecret**?⚠️ | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
1181
1178
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
1182
1179
|
**projenrcJs**?🔹 | <code>boolean</code> | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.<br/>__*Default*__: true if projenrcJson is false
|
|
1183
1180
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -1210,7 +1207,7 @@ Name | Type | Description
|
|
|
1210
1207
|
**sops**? | <code>[SopsAspectOptions](#taimos-projen-sopsaspectoptions)</code> | Enable storing secrets using Mozilla SOPS.<br/>__*Default*__: no SOPS config
|
|
1211
1208
|
**srcdir**?🔹 | <code>string</code> | Typescript sources directory.<br/>__*Default*__: "src"
|
|
1212
1209
|
**stability**?🔹 | <code>string</code> | Package's Stability.<br/>__*Optional*__
|
|
1213
|
-
**stale**?🔹 | <code>boolean</code> | Auto-close of stale issues and pull request.<br/>__*Default*__:
|
|
1210
|
+
**stale**?🔹 | <code>boolean</code> | Auto-close of stale issues and pull request.<br/>__*Default*__: false
|
|
1214
1211
|
**staleOptions**?🔹 | <code>[github.StaleOptions](#projen-github-staleoptions)</code> | Auto-close stale issues and pull requests.<br/>__*Default*__: see defaults in `StaleOptions`
|
|
1215
1212
|
**testdir**?🔹 | <code>string</code> | Jest tests directory. Tests files should be named `xxx.test.ts`.<br/>__*Default*__: "test"
|
|
1216
1213
|
**tsconfig**?🔹 | <code>[javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)</code> | Custom TSConfig.<br/>__*Default*__: default options
|
|
@@ -1221,7 +1218,7 @@ Name | Type | Description
|
|
|
1221
1218
|
**vscode**?🔹 | <code>boolean</code> | Enable VSCode integration.<br/>__*Default*__: true
|
|
1222
1219
|
**watchExcludes**?🔹 | <code>Array<string></code> | Glob patterns to exclude from `cdk watch`.<br/>__*Default*__: []
|
|
1223
1220
|
**watchIncludes**?🔹 | <code>Array<string></code> | Glob patterns to include in `cdk watch`.<br/>__*Default*__: []
|
|
1224
|
-
**workflowBootstrapSteps**?🔹 | <code>Array<
|
|
1221
|
+
**workflowBootstrapSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Workflow steps to use in order to bootstrap this repo.<br/>__*Default*__: "yarn install --frozen-lockfile && yarn projen"
|
|
1225
1222
|
**workflowContainerImage**?🔹 | <code>string</code> | Container image to use for GitHub workflows.<br/>__*Default*__: default image
|
|
1226
1223
|
**workflowGitIdentity**?🔹 | <code>[github.GitIdentity](#projen-github-gitidentity)</code> | The git identity to use in workflows.<br/>__*Default*__: GitHub Actions
|
|
1227
1224
|
**workflowNodeVersion**?🔹 | <code>string</code> | The node version to use in GitHub workflows.<br/>__*Default*__: same as `minNodeVersion`
|
|
@@ -1251,7 +1248,6 @@ Name | Type | Description
|
|
|
1251
1248
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
1252
1249
|
**authorUrl**?🔹 | <code>string</code> | Author's URL / Website.<br/>__*Optional*__
|
|
1253
1250
|
**autoApproveOptions**?🔹 | <code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code> | Enable and configure the 'auto approve' workflow.<br/>__*Default*__: auto approve is disabled
|
|
1254
|
-
**autoApproveProjenUpgrades**?🔹 | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
1255
1251
|
**autoApproveUpgrades**?🔹 | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: true
|
|
1256
1252
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
1257
1253
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
@@ -1259,6 +1255,7 @@ Name | Type | Description
|
|
|
1259
1255
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
1260
1256
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
1261
1257
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
1258
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
1262
1259
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
1263
1260
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
1264
1261
|
**catalog**?🔹 | <code>[cdk.Catalog](#projen-cdk-catalog)</code> | Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:.<br/>__*Default*__: new version will be announced
|
|
@@ -1281,12 +1278,13 @@ Name | Type | Description
|
|
|
1281
1278
|
**dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
|
|
1282
1279
|
**deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
|
|
1283
1280
|
**depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
|
|
1284
|
-
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for
|
|
1281
|
+
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for `UpgradeDependencies`.<br/>__*Default*__: default options
|
|
1285
1282
|
**description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
|
|
1286
1283
|
**devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
|
|
1287
1284
|
**devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
|
|
1288
1285
|
**disableTsconfig**?🔹 | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).<br/>__*Default*__: false
|
|
1289
1286
|
**docgen**?🔹 | <code>boolean</code> | Docgen by Typedoc.<br/>__*Default*__: false
|
|
1287
|
+
**docgenFilePath**?🔹 | <code>string</code> | File path for generated docs.<br/>__*Default*__: "API.md"
|
|
1290
1288
|
**docsDirectory**?🔹 | <code>string</code> | Docs directory.<br/>__*Default*__: "docs"
|
|
1291
1289
|
**dotnet**?⚠️ | <code>[cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)</code> | __*Optional*__
|
|
1292
1290
|
**entrypoint**?🔹 | <code>string</code> | Module entrypoint (`main` in `package.json`).<br/>__*Default*__: "lib/index.js"
|
|
@@ -1299,11 +1297,13 @@ Name | Type | Description
|
|
|
1299
1297
|
**gitignore**?🔹 | <code>Array<string></code> | Additional entries to .gitignore.<br/>__*Optional*__
|
|
1300
1298
|
**gitpod**?🔹 | <code>boolean</code> | Add a Gitpod development environment.<br/>__*Default*__: false
|
|
1301
1299
|
**homepage**?🔹 | <code>string</code> | Package's Homepage / Website.<br/>__*Optional*__
|
|
1300
|
+
**integrationTestAutoDiscover**?🔹 | <code>boolean</code> | Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory.<br/>__*Default*__: true
|
|
1302
1301
|
**jest**?🔹 | <code>boolean</code> | Setup jest unit tests.<br/>__*Default*__: true
|
|
1303
1302
|
**jestOptions**?🔹 | <code>[javascript.JestOptions](#projen-javascript-jestoptions)</code> | Jest options.<br/>__*Default*__: default options
|
|
1304
|
-
**jsiiReleaseVersion**?🔹 | <code>string</code> | Version requirement of `
|
|
1303
|
+
**jsiiReleaseVersion**?🔹 | <code>string</code> | Version requirement of `publib` which is used to publish modules to npm.<br/>__*Default*__: "latest"
|
|
1305
1304
|
**keywords**?🔹 | <code>Array<string></code> | Keywords to include in `package.json`.<br/>__*Optional*__
|
|
1306
1305
|
**lambdaAutoDiscover**?🔹 | <code>boolean</code> | Automatically adds an `aws_lambda.Function` for each `.lambda.ts` handler in your source tree. If this is disabled, you either need to explicitly call `aws_lambda.Function.autoDiscover()` or define a `new aws_lambda.Function()` for each handler.<br/>__*Default*__: true
|
|
1306
|
+
**lambdaExtensionAutoDiscover**?🔹 | <code>boolean</code> | 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.<br/>__*Default*__: true
|
|
1307
1307
|
**lambdaOptions**?🔹 | <code>[awscdk.LambdaFunctionCommonOptions](#projen-awscdk-lambdafunctioncommonoptions)</code> | Common options for all AWS Lambda functions.<br/>__*Default*__: default options
|
|
1308
1308
|
**libdir**?🔹 | <code>string</code> | Typescript artifacts output directory.<br/>__*Default*__: "lib"
|
|
1309
1309
|
**license**?🔹 | <code>string</code> | License's SPDX identifier.<br/>__*Default*__: "Apache-2.0"
|
|
@@ -1335,11 +1335,9 @@ Name | Type | Description
|
|
|
1335
1335
|
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
1336
1336
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
1337
1337
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
1338
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
1338
1339
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
1339
|
-
**projenTokenSecret
|
|
1340
|
-
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
1341
|
-
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
1342
|
-
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
1340
|
+
**projenTokenSecret**?⚠️ | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
1343
1341
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
1344
1342
|
**projenrcJs**?🔹 | <code>boolean</code> | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.<br/>__*Default*__: true if projenrcJson is false
|
|
1345
1343
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -1376,7 +1374,7 @@ Name | Type | Description
|
|
|
1376
1374
|
**scripts**?🔹 | <code>Map<string, string></code> | npm scripts to include.<br/>__*Default*__: {}
|
|
1377
1375
|
**srcdir**?🔹 | <code>string</code> | Typescript sources directory.<br/>__*Default*__: "src"
|
|
1378
1376
|
**stability**?🔹 | <code>string</code> | Package's Stability.<br/>__*Optional*__
|
|
1379
|
-
**stale**?🔹 | <code>boolean</code> | Auto-close of stale issues and pull request.<br/>__*Default*__:
|
|
1377
|
+
**stale**?🔹 | <code>boolean</code> | Auto-close of stale issues and pull request.<br/>__*Default*__: false
|
|
1380
1378
|
**staleOptions**?🔹 | <code>[github.StaleOptions](#projen-github-staleoptions)</code> | Auto-close stale issues and pull requests.<br/>__*Default*__: see defaults in `StaleOptions`
|
|
1381
1379
|
**testdir**?🔹 | <code>string</code> | Jest tests directory. Tests files should be named `xxx.test.ts`.<br/>__*Default*__: "test"
|
|
1382
1380
|
**tsconfig**?🔹 | <code>[javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)</code> | Custom TSConfig.<br/>__*Default*__: default options
|
|
@@ -1385,7 +1383,7 @@ Name | Type | Description
|
|
|
1385
1383
|
**typescriptVersion**?🔹 | <code>string</code> | TypeScript version to use.<br/>__*Default*__: "latest"
|
|
1386
1384
|
**versionrcOptions**?🔹 | <code>Map<string, any></code> | Custom configuration used when creating changelog with standard-version package.<br/>__*Default*__: standard configuration applicable for GitHub repositories
|
|
1387
1385
|
**vscode**?🔹 | <code>boolean</code> | Enable VSCode integration.<br/>__*Default*__: true
|
|
1388
|
-
**workflowBootstrapSteps**?🔹 | <code>Array<
|
|
1386
|
+
**workflowBootstrapSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Workflow steps to use in order to bootstrap this repo.<br/>__*Default*__: "yarn install --frozen-lockfile && yarn projen"
|
|
1389
1387
|
**workflowContainerImage**?🔹 | <code>string</code> | Container image to use for GitHub workflows.<br/>__*Default*__: default image
|
|
1390
1388
|
**workflowGitIdentity**?🔹 | <code>[github.GitIdentity](#projen-github-gitidentity)</code> | The git identity to use in workflows.<br/>__*Default*__: GitHub Actions
|
|
1391
1389
|
**workflowNodeVersion**?🔹 | <code>string</code> | The node version to use in GitHub workflows.<br/>__*Default*__: same as `minNodeVersion`
|
|
@@ -1411,7 +1409,6 @@ Name | Type | Description
|
|
|
1411
1409
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
1412
1410
|
**authorUrl**?🔹 | <code>string</code> | Author's URL / Website.<br/>__*Optional*__
|
|
1413
1411
|
**autoApproveOptions**?🔹 | <code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code> | Enable and configure the 'auto approve' workflow.<br/>__*Default*__: auto approve is disabled
|
|
1414
|
-
**autoApproveProjenUpgrades**?🔹 | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
1415
1412
|
**autoApproveUpgrades**?🔹 | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: true
|
|
1416
1413
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
1417
1414
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
@@ -1419,6 +1416,7 @@ Name | Type | Description
|
|
|
1419
1416
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
1420
1417
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
1421
1418
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
1419
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
1422
1420
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
1423
1421
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
1424
1422
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
@@ -1431,7 +1429,7 @@ Name | Type | Description
|
|
|
1431
1429
|
**dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
|
|
1432
1430
|
**deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
|
|
1433
1431
|
**depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
|
|
1434
|
-
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for
|
|
1432
|
+
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for `UpgradeDependencies`.<br/>__*Default*__: default options
|
|
1435
1433
|
**description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
|
|
1436
1434
|
**devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
|
|
1437
1435
|
**devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
|
|
@@ -1449,7 +1447,7 @@ Name | Type | Description
|
|
|
1449
1447
|
**homepage**?🔹 | <code>string</code> | Package's Homepage / Website.<br/>__*Optional*__
|
|
1450
1448
|
**jest**?🔹 | <code>boolean</code> | Setup jest unit tests.<br/>__*Default*__: true
|
|
1451
1449
|
**jestOptions**?🔹 | <code>[javascript.JestOptions](#projen-javascript-jestoptions)</code> | Jest options.<br/>__*Default*__: default options
|
|
1452
|
-
**jsiiReleaseVersion**?🔹 | <code>string</code> | Version requirement of `
|
|
1450
|
+
**jsiiReleaseVersion**?🔹 | <code>string</code> | Version requirement of `publib` which is used to publish modules to npm.<br/>__*Default*__: "latest"
|
|
1453
1451
|
**keywords**?🔹 | <code>Array<string></code> | Keywords to include in `package.json`.<br/>__*Optional*__
|
|
1454
1452
|
**libdir**?🔹 | <code>string</code> | Typescript artifacts output directory.<br/>__*Default*__: "lib"
|
|
1455
1453
|
**license**?🔹 | <code>string</code> | License's SPDX identifier.<br/>__*Default*__: "Apache-2.0"
|
|
@@ -1481,11 +1479,9 @@ Name | Type | Description
|
|
|
1481
1479
|
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
1482
1480
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
1483
1481
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
1482
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
1484
1483
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
1485
|
-
**projenTokenSecret
|
|
1486
|
-
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
1487
|
-
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
1488
|
-
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
1484
|
+
**projenTokenSecret**?⚠️ | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
1489
1485
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
1490
1486
|
**projenrcJs**?🔹 | <code>boolean</code> | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.<br/>__*Default*__: true if projenrcJson is false
|
|
1491
1487
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -1516,7 +1512,7 @@ Name | Type | Description
|
|
|
1516
1512
|
**scripts**?🔹 | <code>Map<string, string></code> | npm scripts to include.<br/>__*Default*__: {}
|
|
1517
1513
|
**srcdir**?🔹 | <code>string</code> | Typescript sources directory.<br/>__*Default*__: "src"
|
|
1518
1514
|
**stability**?🔹 | <code>string</code> | Package's Stability.<br/>__*Optional*__
|
|
1519
|
-
**stale**?🔹 | <code>boolean</code> | Auto-close of stale issues and pull request.<br/>__*Default*__:
|
|
1515
|
+
**stale**?🔹 | <code>boolean</code> | Auto-close of stale issues and pull request.<br/>__*Default*__: false
|
|
1520
1516
|
**staleOptions**?🔹 | <code>[github.StaleOptions](#projen-github-staleoptions)</code> | Auto-close stale issues and pull requests.<br/>__*Default*__: see defaults in `StaleOptions`
|
|
1521
1517
|
**testdir**?🔹 | <code>string</code> | Jest tests directory. Tests files should be named `xxx.test.ts`.<br/>__*Default*__: "test"
|
|
1522
1518
|
**tsconfig**?🔹 | <code>[javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)</code> | Custom TSConfig.<br/>__*Default*__: default options
|
|
@@ -1525,7 +1521,7 @@ Name | Type | Description
|
|
|
1525
1521
|
**typescriptVersion**?🔹 | <code>string</code> | TypeScript version to use.<br/>__*Default*__: "latest"
|
|
1526
1522
|
**versionrcOptions**?🔹 | <code>Map<string, any></code> | Custom configuration used when creating changelog with standard-version package.<br/>__*Default*__: standard configuration applicable for GitHub repositories
|
|
1527
1523
|
**vscode**?🔹 | <code>boolean</code> | Enable VSCode integration.<br/>__*Default*__: true
|
|
1528
|
-
**workflowBootstrapSteps**?🔹 | <code>Array<
|
|
1524
|
+
**workflowBootstrapSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Workflow steps to use in order to bootstrap this repo.<br/>__*Default*__: "yarn install --frozen-lockfile && yarn projen"
|
|
1529
1525
|
**workflowContainerImage**?🔹 | <code>string</code> | Container image to use for GitHub workflows.<br/>__*Default*__: default image
|
|
1530
1526
|
**workflowGitIdentity**?🔹 | <code>[github.GitIdentity](#projen-github-gitidentity)</code> | The git identity to use in workflows.<br/>__*Default*__: GitHub Actions
|
|
1531
1527
|
**workflowNodeVersion**?🔹 | <code>string</code> | The node version to use in GitHub workflows.<br/>__*Default*__: same as `minNodeVersion`
|
|
@@ -1551,7 +1547,6 @@ Name | Type | Description
|
|
|
1551
1547
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
1552
1548
|
**authorUrl**?🔹 | <code>string</code> | Author's URL / Website.<br/>__*Optional*__
|
|
1553
1549
|
**autoApproveOptions**?🔹 | <code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code> | Enable and configure the 'auto approve' workflow.<br/>__*Default*__: auto approve is disabled
|
|
1554
|
-
**autoApproveProjenUpgrades**?🔹 | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
1555
1550
|
**autoApproveUpgrades**?🔹 | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: true
|
|
1556
1551
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
1557
1552
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
@@ -1559,6 +1554,7 @@ Name | Type | Description
|
|
|
1559
1554
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
1560
1555
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
1561
1556
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
1557
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
1562
1558
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
1563
1559
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
1564
1560
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
@@ -1571,7 +1567,7 @@ Name | Type | Description
|
|
|
1571
1567
|
**dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
|
|
1572
1568
|
**deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
|
|
1573
1569
|
**depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
|
|
1574
|
-
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for
|
|
1570
|
+
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for `UpgradeDependencies`.<br/>__*Default*__: default options
|
|
1575
1571
|
**description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
|
|
1576
1572
|
**devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
|
|
1577
1573
|
**devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
|
|
@@ -1589,7 +1585,7 @@ Name | Type | Description
|
|
|
1589
1585
|
**homepage**?🔹 | <code>string</code> | Package's Homepage / Website.<br/>__*Optional*__
|
|
1590
1586
|
**jest**?🔹 | <code>boolean</code> | Setup jest unit tests.<br/>__*Default*__: true
|
|
1591
1587
|
**jestOptions**?🔹 | <code>[javascript.JestOptions](#projen-javascript-jestoptions)</code> | Jest options.<br/>__*Default*__: default options
|
|
1592
|
-
**jsiiReleaseVersion**?🔹 | <code>string</code> | Version requirement of `
|
|
1588
|
+
**jsiiReleaseVersion**?🔹 | <code>string</code> | Version requirement of `publib` which is used to publish modules to npm.<br/>__*Default*__: "latest"
|
|
1593
1589
|
**keywords**?🔹 | <code>Array<string></code> | Keywords to include in `package.json`.<br/>__*Optional*__
|
|
1594
1590
|
**libdir**?🔹 | <code>string</code> | Typescript artifacts output directory.<br/>__*Default*__: "lib"
|
|
1595
1591
|
**license**?🔹 | <code>string</code> | License's SPDX identifier.<br/>__*Default*__: "Apache-2.0"
|
|
@@ -1621,11 +1617,9 @@ Name | Type | Description
|
|
|
1621
1617
|
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
1622
1618
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
1623
1619
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
1620
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
1624
1621
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
1625
|
-
**projenTokenSecret
|
|
1626
|
-
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
1627
|
-
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
1628
|
-
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
1622
|
+
**projenTokenSecret**?⚠️ | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
1629
1623
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
1630
1624
|
**projenrcJs**?🔹 | <code>boolean</code> | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.<br/>__*Default*__: true if projenrcJson is false
|
|
1631
1625
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -1656,7 +1650,7 @@ Name | Type | Description
|
|
|
1656
1650
|
**scripts**?🔹 | <code>Map<string, string></code> | npm scripts to include.<br/>__*Default*__: {}
|
|
1657
1651
|
**srcdir**?🔹 | <code>string</code> | Typescript sources directory.<br/>__*Default*__: "src"
|
|
1658
1652
|
**stability**?🔹 | <code>string</code> | Package's Stability.<br/>__*Optional*__
|
|
1659
|
-
**stale**?🔹 | <code>boolean</code> | Auto-close of stale issues and pull request.<br/>__*Default*__:
|
|
1653
|
+
**stale**?🔹 | <code>boolean</code> | Auto-close of stale issues and pull request.<br/>__*Default*__: false
|
|
1660
1654
|
**staleOptions**?🔹 | <code>[github.StaleOptions](#projen-github-staleoptions)</code> | Auto-close stale issues and pull requests.<br/>__*Default*__: see defaults in `StaleOptions`
|
|
1661
1655
|
**testdir**?🔹 | <code>string</code> | Jest tests directory. Tests files should be named `xxx.test.ts`.<br/>__*Default*__: "test"
|
|
1662
1656
|
**tsconfig**?🔹 | <code>[javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)</code> | Custom TSConfig.<br/>__*Default*__: default options
|
|
@@ -1665,7 +1659,7 @@ Name | Type | Description
|
|
|
1665
1659
|
**typescriptVersion**?🔹 | <code>string</code> | TypeScript version to use.<br/>__*Default*__: "latest"
|
|
1666
1660
|
**versionrcOptions**?🔹 | <code>Map<string, any></code> | Custom configuration used when creating changelog with standard-version package.<br/>__*Default*__: standard configuration applicable for GitHub repositories
|
|
1667
1661
|
**vscode**?🔹 | <code>boolean</code> | Enable VSCode integration.<br/>__*Default*__: true
|
|
1668
|
-
**workflowBootstrapSteps**?🔹 | <code>Array<
|
|
1662
|
+
**workflowBootstrapSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Workflow steps to use in order to bootstrap this repo.<br/>__*Default*__: "yarn install --frozen-lockfile && yarn projen"
|
|
1669
1663
|
**workflowContainerImage**?🔹 | <code>string</code> | Container image to use for GitHub workflows.<br/>__*Default*__: default image
|
|
1670
1664
|
**workflowGitIdentity**?🔹 | <code>[github.GitIdentity](#projen-github-gitidentity)</code> | The git identity to use in workflows.<br/>__*Default*__: GitHub Actions
|
|
1671
1665
|
**workflowNodeVersion**?🔹 | <code>string</code> | The node version to use in GitHub workflows.<br/>__*Default*__: same as `minNodeVersion`
|