projen 0.51.16 → 0.52.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +415 -288
- package/README.md +0 -1
- package/changelog.md +1 -1
- package/docs/README.md +25 -0
- package/{API.md → docs/api/API.md} +101 -19
- package/docs/eject.md +30 -0
- package/lib/awscdk/auto-discover.js +1 -1
- package/lib/awscdk/awscdk-app-java.js +1 -1
- package/lib/awscdk/awscdk-app-ts.js +1 -1
- package/lib/awscdk/awscdk-construct.js +2 -2
- package/lib/awscdk/awscdk-deps-java.js +1 -1
- package/lib/awscdk/awscdk-deps-js.js +1 -1
- package/lib/awscdk/awscdk-deps.js +1 -1
- package/lib/awscdk/cdk-config.js +1 -1
- package/lib/awscdk/cdk-tasks.js +1 -1
- package/lib/awscdk/integration-test.js +1 -1
- package/lib/awscdk/lambda-function.js +6 -5
- package/lib/build/build-workflow.d.ts +8 -1
- package/lib/build/build-workflow.js +4 -4
- package/lib/cdk/construct-lib.js +1 -1
- package/lib/cdk/jsii-docgen.d.ts +16 -2
- package/lib/cdk/jsii-docgen.js +8 -6
- package/lib/cdk/jsii-project.d.ts +7 -0
- package/lib/cdk/jsii-project.js +3 -3
- package/lib/cdk8s/cdk8s-app-ts.js +1 -1
- package/lib/cdk8s/cdk8s-construct.js +1 -1
- package/lib/cdktf/cdktf-construct.js +1 -1
- package/lib/component.js +1 -1
- package/lib/dependencies.js +8 -6
- package/lib/dev-env.js +1 -1
- package/lib/docker-compose.js +2 -2
- package/lib/file.d.ts +22 -8
- package/lib/file.js +32 -12
- package/lib/gitattributes.js +3 -3
- package/lib/github/auto-approve.js +1 -1
- package/lib/github/auto-merge.js +1 -1
- package/lib/github/dependabot.js +1 -1
- package/lib/github/github-project.js +1 -1
- package/lib/github/github.js +1 -1
- package/lib/github/mergify.js +1 -1
- package/lib/github/pr-template.js +3 -2
- package/lib/github/pull-request-lint.js +1 -1
- package/lib/github/stale.js +1 -1
- package/lib/github/task-workflow.js +1 -1
- package/lib/github/workflows.js +1 -1
- package/lib/gitlab/configuration.js +1 -1
- package/lib/gitlab/gitlab-configuration.js +1 -1
- package/lib/gitlab/nested-configuration.js +1 -1
- package/lib/gitpod.js +1 -1
- package/lib/ignore-file.js +6 -3
- package/lib/ini.js +3 -3
- package/lib/java/java-project.js +1 -1
- package/lib/java/junit.js +1 -1
- package/lib/java/maven-compile.js +1 -1
- package/lib/java/maven-packaging.js +1 -1
- package/lib/java/maven-sample.js +1 -1
- package/lib/java/pom.js +1 -1
- package/lib/java/projenrc.js +5 -5
- package/lib/javascript/bundler.js +1 -1
- package/lib/javascript/eslint.js +1 -1
- package/lib/javascript/jest.js +1 -1
- package/lib/javascript/node-package.js +1 -1
- package/lib/javascript/node-project.d.ts +8 -1
- package/lib/javascript/node-project.js +7 -4
- package/lib/javascript/npm-config.js +1 -1
- package/lib/javascript/prettier.js +1 -1
- package/lib/javascript/projenrc.js +4 -4
- package/lib/javascript/typescript-config.js +1 -1
- package/lib/javascript/upgrade-dependencies.js +2 -2
- package/lib/json.js +3 -3
- package/lib/license.js +3 -3
- package/lib/logger.js +1 -1
- package/lib/makefile.js +1 -1
- package/lib/object-file.d.ts +0 -13
- package/lib/object-file.js +4 -5
- package/lib/project-build.js +3 -3
- package/lib/project.d.ts +18 -1
- package/lib/project.js +54 -15
- package/lib/projects.js +1 -1
- package/lib/projenrc-json.js +5 -5
- package/lib/python/pip.js +1 -1
- package/lib/python/poetry.js +2 -2
- package/lib/python/projenrc.js +4 -4
- package/lib/python/pytest.js +1 -1
- package/lib/python/python-project.js +1 -1
- package/lib/python/python-sample.js +1 -1
- package/lib/python/requirements-file.js +3 -3
- package/lib/python/setuppy.js +3 -3
- package/lib/python/setuptools.js +1 -1
- package/lib/python/venv.js +1 -1
- package/lib/readme.js +1 -1
- package/lib/release/bump-version.task.js +2 -2
- package/lib/release/publisher.js +1 -1
- package/lib/release/release-trigger.js +1 -1
- package/lib/release/release.js +1 -1
- package/lib/run-task.js +3 -0
- package/lib/sample-file.js +2 -2
- package/lib/semver.js +1 -1
- package/lib/source-code.d.ts +4 -0
- package/lib/source-code.js +8 -2
- package/lib/task-runtime.d.ts +6 -0
- package/lib/task-runtime.js +13 -6
- package/lib/task.js +1 -1
- package/lib/tasks.d.ts +6 -6
- package/lib/tasks.js +18 -11
- package/lib/testing.js +1 -1
- package/lib/textfile.js +1 -1
- package/lib/toml.js +3 -3
- package/lib/typescript/projenrc.js +4 -4
- package/lib/typescript/typescript-typedoc.js +1 -1
- package/lib/typescript/typescript.js +7 -5
- package/lib/util.d.ts +2 -0
- package/lib/util.js +22 -2
- package/lib/version.js +1 -1
- package/lib/vscode/devcontainer.js +1 -1
- package/lib/vscode/launch-config.js +1 -1
- package/lib/vscode/vscode.js +1 -1
- package/lib/web/next.js +3 -3
- package/lib/web/postcss.js +1 -1
- package/lib/web/react.js +8 -11
- package/lib/web/tailwind.js +1 -1
- package/lib/xmlfile.js +3 -3
- package/lib/yaml.js +3 -3
- package/node_modules/xmlbuilder2/node_modules/@types/node/README.md +1 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/events.d.ts +31 -3
- package/node_modules/xmlbuilder2/node_modules/@types/node/package.json +2 -2
- package/node_modules/xmlbuilder2/node_modules/@types/node/util.d.ts +1 -1
- package/package.json +4 -1
- package/releasetag.txt +1 -1
- package/version.txt +1 -1
- package/docs/mutable-builds.md +0 -0
|
@@ -52,7 +52,7 @@ Name|Description
|
|
|
52
52
|
[awscdk.LambdaRuntime](#projen-awscdk-lambdaruntime)|The runtime for the AWS Lambda function.
|
|
53
53
|
[build.BuildWorkflow](#projen-build-buildworkflow)|*No description*
|
|
54
54
|
[cdk.ConstructLibrary](#projen-cdk-constructlibrary)|A multi-language library for CDK constructs.
|
|
55
|
-
[cdk.JsiiDocgen](#projen-cdk-jsiidocgen)|Creates
|
|
55
|
+
[cdk.JsiiDocgen](#projen-cdk-jsiidocgen)|Creates a markdown file based on the jsii manifest: - Adds a `docgen` script to package.json - Runs `jsii-docgen` after compilation - Enforces that markdown file is checked in.
|
|
56
56
|
[cdk.JsiiProject](#projen-cdk-jsiiproject)|Multi-language jsii library project.
|
|
57
57
|
[cdk8s.Cdk8sTypeScriptApp](#projen-cdk8s-cdk8stypescriptapp)|CDK8s app in TypeScript.
|
|
58
58
|
[cdk8s.ConstructLibraryCdk8s](#projen-cdk8s-constructlibrarycdk8s)|CDK8s construct library project.
|
|
@@ -188,6 +188,7 @@ Name|Description
|
|
|
188
188
|
[build.BuildWorkflowOptions](#projen-build-buildworkflowoptions)|*No description*
|
|
189
189
|
[cdk.Catalog](#projen-cdk-catalog)|*No description*
|
|
190
190
|
[cdk.ConstructLibraryOptions](#projen-cdk-constructlibraryoptions)|*No description*
|
|
191
|
+
[cdk.JsiiDocgenOptions](#projen-cdk-jsiidocgenoptions)|Options for `JsiiDocgen`.
|
|
191
192
|
[cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)|*No description*
|
|
192
193
|
[cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)|Go target configuration.
|
|
193
194
|
[cdk.JsiiJavaTarget](#projen-cdk-jsiijavatarget)|*No description*
|
|
@@ -856,6 +857,7 @@ new FileBase(project: Project, filePath: string, options?: FileBaseOptions)
|
|
|
856
857
|
* **committed** (<code>boolean</code>) Indicates whether this file should be committed to git or ignored. __*Default*__: true
|
|
857
858
|
* **editGitignore** (<code>boolean</code>) Update the project's .gitignore file. __*Default*__: true
|
|
858
859
|
* **executable** (<code>boolean</code>) Whether the generated file should be marked as executable. __*Default*__: false
|
|
860
|
+
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
|
|
859
861
|
* **readonly** (<code>boolean</code>) Whether the generated file should be readonly. __*Default*__: true
|
|
860
862
|
|
|
861
863
|
|
|
@@ -870,7 +872,7 @@ Name | Type | Description
|
|
|
870
872
|
**path**🔹 | <code>string</code> | The file path, relative to the project root.
|
|
871
873
|
**readonly**🔹 | <code>boolean</code> | Indicates if the file should be read-only or read-write.
|
|
872
874
|
**changed**?🔹 | <code>boolean</code> | Indicates if the file has been changed during synthesis.<br/>__*Optional*__
|
|
873
|
-
|
|
875
|
+
**marker**?🔹 | <code>string</code> | The projen marker, used to identify files as projen-generated.<br/>__*Optional*__
|
|
874
876
|
|
|
875
877
|
### Methods
|
|
876
878
|
|
|
@@ -1209,8 +1211,8 @@ new IniFile(project: Project, filePath: string, options: IniFileOptions)
|
|
|
1209
1211
|
* **committed** (<code>boolean</code>) Indicates whether this file should be committed to git or ignored. __*Default*__: true
|
|
1210
1212
|
* **editGitignore** (<code>boolean</code>) Update the project's .gitignore file. __*Default*__: true
|
|
1211
1213
|
* **executable** (<code>boolean</code>) Whether the generated file should be marked as executable. __*Default*__: false
|
|
1214
|
+
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
|
|
1212
1215
|
* **readonly** (<code>boolean</code>) Whether the generated file should be readonly. __*Default*__: true
|
|
1213
|
-
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: true
|
|
1214
1216
|
* **obj** (<code>any</code>) The object that will be serialized. __*Default*__: {} an empty object (use `file.obj` to mutate).
|
|
1215
1217
|
* **omitEmpty** (<code>boolean</code>) Omits empty objects and arrays. __*Default*__: false
|
|
1216
1218
|
|
|
@@ -1254,8 +1256,8 @@ new JsonFile(project: Project, filePath: string, options: JsonFileOptions)
|
|
|
1254
1256
|
* **committed** (<code>boolean</code>) Indicates whether this file should be committed to git or ignored. __*Default*__: true
|
|
1255
1257
|
* **editGitignore** (<code>boolean</code>) Update the project's .gitignore file. __*Default*__: true
|
|
1256
1258
|
* **executable** (<code>boolean</code>) Whether the generated file should be marked as executable. __*Default*__: false
|
|
1259
|
+
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
|
|
1257
1260
|
* **readonly** (<code>boolean</code>) Whether the generated file should be readonly. __*Default*__: true
|
|
1258
|
-
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: true
|
|
1259
1261
|
* **obj** (<code>any</code>) The object that will be serialized. __*Default*__: {} an empty object (use `file.obj` to mutate).
|
|
1260
1262
|
* **omitEmpty** (<code>boolean</code>) Omits empty objects and arrays. __*Default*__: false
|
|
1261
1263
|
* **newline** (<code>boolean</code>) Adds a newline at the end of the file. __*Default*__: true
|
|
@@ -1448,6 +1450,7 @@ new Makefile(project: Project, filePath: string, options?: MakefileOptions)
|
|
|
1448
1450
|
* **committed** (<code>boolean</code>) Indicates whether this file should be committed to git or ignored. __*Default*__: true
|
|
1449
1451
|
* **editGitignore** (<code>boolean</code>) Update the project's .gitignore file. __*Default*__: true
|
|
1450
1452
|
* **executable** (<code>boolean</code>) Whether the generated file should be marked as executable. __*Default*__: false
|
|
1453
|
+
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
|
|
1451
1454
|
* **readonly** (<code>boolean</code>) Whether the generated file should be readonly. __*Default*__: true
|
|
1452
1455
|
* **all** (<code>Array<string></code>) List of targets to build when Make is invoked without specifying any targets. __*Default*__: []
|
|
1453
1456
|
* **rules** (<code>Array<[Rule](#projen-rule)></code>) Rules to include in the Makefile. __*Default*__: []
|
|
@@ -1562,8 +1565,8 @@ new ObjectFile(project: Project, filePath: string, options: ObjectFileOptions)
|
|
|
1562
1565
|
* **committed** (<code>boolean</code>) Indicates whether this file should be committed to git or ignored. __*Default*__: true
|
|
1563
1566
|
* **editGitignore** (<code>boolean</code>) Update the project's .gitignore file. __*Default*__: true
|
|
1564
1567
|
* **executable** (<code>boolean</code>) Whether the generated file should be marked as executable. __*Default*__: false
|
|
1568
|
+
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
|
|
1565
1569
|
* **readonly** (<code>boolean</code>) Whether the generated file should be readonly. __*Default*__: true
|
|
1566
|
-
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: true
|
|
1567
1570
|
* **obj** (<code>any</code>) The object that will be serialized. __*Default*__: {} an empty object (use `file.obj` to mutate).
|
|
1568
1571
|
* **omitEmpty** (<code>boolean</code>) Omits empty objects and arrays. __*Default*__: false
|
|
1569
1572
|
|
|
@@ -1574,7 +1577,6 @@ new ObjectFile(project: Project, filePath: string, options: ObjectFileOptions)
|
|
|
1574
1577
|
|
|
1575
1578
|
Name | Type | Description
|
|
1576
1579
|
-----|------|-------------
|
|
1577
|
-
**marker**🔹 | <code>boolean</code> | Indicates if the projen marker JSON-comment will be added to the output object.
|
|
1578
1580
|
**omitEmpty**🔹 | <code>boolean</code> | Indicates if empty objects and arrays are omitted from the output object.
|
|
1579
1581
|
|
|
1580
1582
|
### Methods
|
|
@@ -1681,8 +1683,8 @@ Name | Type | Description
|
|
|
1681
1683
|
**buildTask**🔹 | <code>[Task](#projen-task)</code> | <span></span>
|
|
1682
1684
|
**compileTask**🔹 | <code>[Task](#projen-task)</code> | <span></span>
|
|
1683
1685
|
**components**🔹 | <code>Array<[Component](#projen-component)></code> | Returns all the components within this project.
|
|
1684
|
-
**defaultTask**🔹 | <code>[Task](#projen-task)</code> | This is the "default" task, the one that executes "projen".
|
|
1685
1686
|
**deps**🔹 | <code>[Dependencies](#projen-dependencies)</code> | Project dependencies.
|
|
1687
|
+
**ejected**🔹 | <code>boolean</code> | Whether or not the project is being ejected.
|
|
1686
1688
|
**files**🔹 | <code>Array<[FileBase](#projen-filebase)></code> | All files in this project.
|
|
1687
1689
|
**gitattributes**🔹 | <code>[GitAttributesFile](#projen-gitattributesfile)</code> | The .gitattributes file for this repository.
|
|
1688
1690
|
**gitignore**🔹 | <code>[IgnoreFile](#projen-ignorefile)</code> | .gitignore.
|
|
@@ -1697,6 +1699,7 @@ Name | Type | Description
|
|
|
1697
1699
|
**root**🔹 | <code>[Project](#projen-project)</code> | The root project.
|
|
1698
1700
|
**tasks**🔹 | <code>[Tasks](#projen-tasks)</code> | Project tasks.
|
|
1699
1701
|
**testTask**🔹 | <code>[Task](#projen-task)</code> | <span></span>
|
|
1702
|
+
**defaultTask**?🔹 | <code>[Task](#projen-task)</code> | This is the "default" task, the one that executes "projen".<br/>__*Optional*__
|
|
1700
1703
|
**initProject**?🔹 | <code>[InitProject](#projen-initproject)</code> | The options used when this project is bootstrapped via `projen new`.<br/>__*Optional*__
|
|
1701
1704
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | A parent project.<br/>__*Optional*__
|
|
1702
1705
|
*static* **DEFAULT_TASK**🔹 | <code>string</code> | The name of the default task (the task executed when `projen` is run without arguments).
|
|
@@ -2238,6 +2241,7 @@ new SourceCode(project: Project, filePath: string, options?: SourceCodeOptions)
|
|
|
2238
2241
|
Name | Type | Description
|
|
2239
2242
|
-----|------|-------------
|
|
2240
2243
|
**filePath**🔹 | <code>string</code> | <span></span>
|
|
2244
|
+
**marker**?🔹 | <code>string</code> | __*Optional*__
|
|
2241
2245
|
|
|
2242
2246
|
### Methods
|
|
2243
2247
|
|
|
@@ -2524,6 +2528,7 @@ Name | Type | Description
|
|
|
2524
2528
|
**manifest**🔹 | <code>[TasksManifest](#projen-tasksmanifest)</code> | The contents of tasks.json.
|
|
2525
2529
|
**tasks**🔹 | <code>Array<[TaskSpec](#projen-taskspec)></code> | The tasks in this project.
|
|
2526
2530
|
**workdir**🔹 | <code>string</code> | The root directory of the project and the cwd for executing tasks.
|
|
2531
|
+
*static* **MANIFEST_FILE**🔹 | <code>string</code> | The project-relative path of the tasks manifest file.
|
|
2527
2532
|
|
|
2528
2533
|
### Methods
|
|
2529
2534
|
|
|
@@ -2586,7 +2591,6 @@ Name | Type | Description
|
|
|
2586
2591
|
-----|------|-------------
|
|
2587
2592
|
**all**🔹 | <code>Array<[Task](#projen-task)></code> | All tasks.
|
|
2588
2593
|
**env**🔹 | <code>Map<string, string></code> | Returns a copy of the currently global environment for this project.
|
|
2589
|
-
*static* **MANIFEST_FILE**🔹 | <code>string</code> | The project-relative path of the tasks manifest file.
|
|
2590
2594
|
|
|
2591
2595
|
### Methods
|
|
2592
2596
|
|
|
@@ -2638,6 +2642,18 @@ removeTask(name: string): Task
|
|
|
2638
2642
|
__Returns__:
|
|
2639
2643
|
* <code>[Task](#projen-task)</code>
|
|
2640
2644
|
|
|
2645
|
+
#### synthesize()🔹 <a id="projen-tasks-synthesize"></a>
|
|
2646
|
+
|
|
2647
|
+
Synthesizes files to the project output directory.
|
|
2648
|
+
|
|
2649
|
+
```ts
|
|
2650
|
+
synthesize(): void
|
|
2651
|
+
```
|
|
2652
|
+
|
|
2653
|
+
|
|
2654
|
+
|
|
2655
|
+
|
|
2656
|
+
|
|
2641
2657
|
#### tryFind(name)🔹 <a id="projen-tasks-tryfind"></a>
|
|
2642
2658
|
|
|
2643
2659
|
Finds a task by name.
|
|
@@ -2699,6 +2715,7 @@ new TextFile(project: Project, filePath: string, options?: TextFileOptions)
|
|
|
2699
2715
|
* **committed** (<code>boolean</code>) Indicates whether this file should be committed to git or ignored. __*Default*__: true
|
|
2700
2716
|
* **editGitignore** (<code>boolean</code>) Update the project's .gitignore file. __*Default*__: true
|
|
2701
2717
|
* **executable** (<code>boolean</code>) Whether the generated file should be marked as executable. __*Default*__: false
|
|
2718
|
+
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
|
|
2702
2719
|
* **readonly** (<code>boolean</code>) Whether the generated file should be readonly. __*Default*__: true
|
|
2703
2720
|
* **lines** (<code>Array<string></code>) The contents of the text file. __*Default*__: [] empty file
|
|
2704
2721
|
|
|
@@ -2755,8 +2772,8 @@ new TomlFile(project: Project, filePath: string, options: TomlFileOptions)
|
|
|
2755
2772
|
* **committed** (<code>boolean</code>) Indicates whether this file should be committed to git or ignored. __*Default*__: true
|
|
2756
2773
|
* **editGitignore** (<code>boolean</code>) Update the project's .gitignore file. __*Default*__: true
|
|
2757
2774
|
* **executable** (<code>boolean</code>) Whether the generated file should be marked as executable. __*Default*__: false
|
|
2775
|
+
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
|
|
2758
2776
|
* **readonly** (<code>boolean</code>) Whether the generated file should be readonly. __*Default*__: true
|
|
2759
|
-
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: true
|
|
2760
2777
|
* **obj** (<code>any</code>) The object that will be serialized. __*Default*__: {} an empty object (use `file.obj` to mutate).
|
|
2761
2778
|
* **omitEmpty** (<code>boolean</code>) Omits empty objects and arrays. __*Default*__: false
|
|
2762
2779
|
|
|
@@ -2839,8 +2856,8 @@ new XmlFile(project: Project, filePath: string, options?: XmlFileOptions)
|
|
|
2839
2856
|
* **committed** (<code>boolean</code>) Indicates whether this file should be committed to git or ignored. __*Default*__: true
|
|
2840
2857
|
* **editGitignore** (<code>boolean</code>) Update the project's .gitignore file. __*Default*__: true
|
|
2841
2858
|
* **executable** (<code>boolean</code>) Whether the generated file should be marked as executable. __*Default*__: false
|
|
2859
|
+
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
|
|
2842
2860
|
* **readonly** (<code>boolean</code>) Whether the generated file should be readonly. __*Default*__: true
|
|
2843
|
-
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: true
|
|
2844
2861
|
* **obj** (<code>any</code>) The object that will be serialized. __*Default*__: {} an empty object (use `file.obj` to mutate).
|
|
2845
2862
|
* **omitEmpty** (<code>boolean</code>) Omits empty objects and arrays. __*Default*__: false
|
|
2846
2863
|
|
|
@@ -2884,8 +2901,8 @@ new YamlFile(project: Project, filePath: string, options: YamlFileOptions)
|
|
|
2884
2901
|
* **committed** (<code>boolean</code>) Indicates whether this file should be committed to git or ignored. __*Default*__: true
|
|
2885
2902
|
* **editGitignore** (<code>boolean</code>) Update the project's .gitignore file. __*Default*__: true
|
|
2886
2903
|
* **executable** (<code>boolean</code>) Whether the generated file should be marked as executable. __*Default*__: false
|
|
2904
|
+
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
|
|
2887
2905
|
* **readonly** (<code>boolean</code>) Whether the generated file should be readonly. __*Default*__: true
|
|
2888
|
-
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: true
|
|
2889
2906
|
* **obj** (<code>any</code>) The object that will be serialized. __*Default*__: {} an empty object (use `file.obj` to mutate).
|
|
2890
2907
|
* **omitEmpty** (<code>boolean</code>) Omits empty objects and arrays. __*Default*__: false
|
|
2891
2908
|
* **lineWidth** (<code>number</code>) Maximum line width (set to 0 to disable folding). __*Default*__: 0
|
|
@@ -3046,6 +3063,7 @@ new awscdk.AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
|
|
|
3046
3063
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
3047
3064
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
3048
3065
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
3066
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
3049
3067
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
3050
3068
|
* **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
|
|
3051
3069
|
* **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
|
|
@@ -3100,6 +3118,7 @@ new awscdk.AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
|
|
|
3100
3118
|
* **repositoryUrl** (<code>string</code>) Git repository URL.
|
|
3101
3119
|
* **compat** (<code>boolean</code>) Automatically run API compatibility test against the latest version published to npm after compilation. __*Default*__: false
|
|
3102
3120
|
* **compatIgnore** (<code>string</code>) Name of the ignore file for API compatibility tests. __*Default*__: ".compatignore"
|
|
3121
|
+
* **docgenFilePath** (<code>string</code>) File path for generated docs. __*Default*__: "API.md"
|
|
3103
3122
|
* **dotnet** (<code>[cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)</code>) *No description* __*Optional*__
|
|
3104
3123
|
* **excludeTypescript** (<code>Array<string></code>) Accepts a list of glob patterns. __*Optional*__
|
|
3105
3124
|
* **publishToGo** (<code>[cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)</code>) Publish Go bindings to a git repository. __*Default*__: no publishing
|
|
@@ -3554,6 +3573,7 @@ new awscdk.AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
|
|
|
3554
3573
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
3555
3574
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
3556
3575
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
3576
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
3557
3577
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
3558
3578
|
* **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
|
|
3559
3579
|
* **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
|
|
@@ -3825,6 +3845,7 @@ new awscdk.ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
|
|
|
3825
3845
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
3826
3846
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
3827
3847
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
3848
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
3828
3849
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
3829
3850
|
* **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
|
|
3830
3851
|
* **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
|
|
@@ -3879,6 +3900,7 @@ new awscdk.ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
|
|
|
3879
3900
|
* **repositoryUrl** (<code>string</code>) Git repository URL.
|
|
3880
3901
|
* **compat** (<code>boolean</code>) Automatically run API compatibility test against the latest version published to npm after compilation. __*Default*__: false
|
|
3881
3902
|
* **compatIgnore** (<code>string</code>) Name of the ignore file for API compatibility tests. __*Default*__: ".compatignore"
|
|
3903
|
+
* **docgenFilePath** (<code>string</code>) File path for generated docs. __*Default*__: "API.md"
|
|
3882
3904
|
* **dotnet** (<code>[cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)</code>) *No description* __*Optional*__
|
|
3883
3905
|
* **excludeTypescript** (<code>Array<string></code>) Accepts a list of glob patterns. __*Optional*__
|
|
3884
3906
|
* **publishToGo** (<code>[cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)</code>) Publish Go bindings to a git repository. __*Default*__: no publishing
|
|
@@ -4032,6 +4054,7 @@ new build.BuildWorkflow(project: Project, options: BuildWorkflowOptions)
|
|
|
4032
4054
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build. __*Default*__: []
|
|
4033
4055
|
* **preBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute before the build. __*Default*__: []
|
|
4034
4056
|
* **runsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
4057
|
+
* **workflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
4035
4058
|
|
|
4036
4059
|
|
|
4037
4060
|
|
|
@@ -4248,6 +4271,7 @@ new cdk.ConstructLibrary(options: ConstructLibraryOptions)
|
|
|
4248
4271
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
4249
4272
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
4250
4273
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
4274
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
4251
4275
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
4252
4276
|
* **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
|
|
4253
4277
|
* **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
|
|
@@ -4302,6 +4326,7 @@ new cdk.ConstructLibrary(options: ConstructLibraryOptions)
|
|
|
4302
4326
|
* **repositoryUrl** (<code>string</code>) Git repository URL.
|
|
4303
4327
|
* **compat** (<code>boolean</code>) Automatically run API compatibility test against the latest version published to npm after compilation. __*Default*__: false
|
|
4304
4328
|
* **compatIgnore** (<code>string</code>) Name of the ignore file for API compatibility tests. __*Default*__: ".compatignore"
|
|
4329
|
+
* **docgenFilePath** (<code>string</code>) File path for generated docs. __*Default*__: "API.md"
|
|
4305
4330
|
* **dotnet** (<code>[cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)</code>) *No description* __*Optional*__
|
|
4306
4331
|
* **excludeTypescript** (<code>Array<string></code>) Accepts a list of glob patterns. __*Optional*__
|
|
4307
4332
|
* **publishToGo** (<code>[cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)</code>) Publish Go bindings to a git repository. __*Default*__: no publishing
|
|
@@ -4317,7 +4342,7 @@ new cdk.ConstructLibrary(options: ConstructLibraryOptions)
|
|
|
4317
4342
|
|
|
4318
4343
|
## class JsiiDocgen 🔹 <a id="projen-cdk-jsiidocgen"></a>
|
|
4319
4344
|
|
|
4320
|
-
Creates
|
|
4345
|
+
Creates a markdown file based on the jsii manifest: - Adds a `docgen` script to package.json - Runs `jsii-docgen` after compilation - Enforces that markdown file is checked in.
|
|
4321
4346
|
|
|
4322
4347
|
__Submodule__: cdk
|
|
4323
4348
|
|
|
@@ -4328,10 +4353,12 @@ __Submodule__: cdk
|
|
|
4328
4353
|
|
|
4329
4354
|
|
|
4330
4355
|
```ts
|
|
4331
|
-
new cdk.JsiiDocgen(project: JsiiProject)
|
|
4356
|
+
new cdk.JsiiDocgen(project: JsiiProject, options?: JsiiDocgenOptions)
|
|
4332
4357
|
```
|
|
4333
4358
|
|
|
4334
4359
|
* **project** (<code>[cdk.JsiiProject](#projen-cdk-jsiiproject)</code>) *No description*
|
|
4360
|
+
* **options** (<code>[cdk.JsiiDocgenOptions](#projen-cdk-jsiidocgenoptions)</code>) *No description*
|
|
4361
|
+
* **filePath** (<code>string</code>) File path for generated docs. __*Default*__: "API.md"
|
|
4335
4362
|
|
|
4336
4363
|
|
|
4337
4364
|
|
|
@@ -4433,6 +4460,7 @@ new cdk.JsiiProject(options: JsiiProjectOptions)
|
|
|
4433
4460
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
4434
4461
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
4435
4462
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
4463
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
4436
4464
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
4437
4465
|
* **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
|
|
4438
4466
|
* **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
|
|
@@ -4487,6 +4515,7 @@ new cdk.JsiiProject(options: JsiiProjectOptions)
|
|
|
4487
4515
|
* **repositoryUrl** (<code>string</code>) Git repository URL.
|
|
4488
4516
|
* **compat** (<code>boolean</code>) Automatically run API compatibility test against the latest version published to npm after compilation. __*Default*__: false
|
|
4489
4517
|
* **compatIgnore** (<code>string</code>) Name of the ignore file for API compatibility tests. __*Default*__: ".compatignore"
|
|
4518
|
+
* **docgenFilePath** (<code>string</code>) File path for generated docs. __*Default*__: "API.md"
|
|
4490
4519
|
* **dotnet** (<code>[cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)</code>) *No description* __*Optional*__
|
|
4491
4520
|
* **excludeTypescript** (<code>Array<string></code>) Accepts a list of glob patterns. __*Optional*__
|
|
4492
4521
|
* **publishToGo** (<code>[cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)</code>) Publish Go bindings to a git repository. __*Default*__: no publishing
|
|
@@ -4604,6 +4633,7 @@ new cdk8s.Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
|
|
|
4604
4633
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
4605
4634
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
4606
4635
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
4636
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
4607
4637
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
4608
4638
|
* **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
|
|
4609
4639
|
* **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
|
|
@@ -4779,6 +4809,7 @@ new cdk8s.ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
|
|
|
4779
4809
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
4780
4810
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
4781
4811
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
4812
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
4782
4813
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
4783
4814
|
* **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
|
|
4784
4815
|
* **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
|
|
@@ -4833,6 +4864,7 @@ new cdk8s.ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
|
|
|
4833
4864
|
* **repositoryUrl** (<code>string</code>) Git repository URL.
|
|
4834
4865
|
* **compat** (<code>boolean</code>) Automatically run API compatibility test against the latest version published to npm after compilation. __*Default*__: false
|
|
4835
4866
|
* **compatIgnore** (<code>string</code>) Name of the ignore file for API compatibility tests. __*Default*__: ".compatignore"
|
|
4867
|
+
* **docgenFilePath** (<code>string</code>) File path for generated docs. __*Default*__: "API.md"
|
|
4836
4868
|
* **dotnet** (<code>[cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)</code>) *No description* __*Optional*__
|
|
4837
4869
|
* **excludeTypescript** (<code>Array<string></code>) Accepts a list of glob patterns. __*Optional*__
|
|
4838
4870
|
* **publishToGo** (<code>[cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)</code>) Publish Go bindings to a git repository. __*Default*__: no publishing
|
|
@@ -4961,6 +4993,7 @@ new cdktf.ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
|
|
|
4961
4993
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
4962
4994
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
4963
4995
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
4996
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
4964
4997
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
4965
4998
|
* **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
|
|
4966
4999
|
* **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
|
|
@@ -5015,6 +5048,7 @@ new cdktf.ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
|
|
|
5015
5048
|
* **repositoryUrl** (<code>string</code>) Git repository URL.
|
|
5016
5049
|
* **compat** (<code>boolean</code>) Automatically run API compatibility test against the latest version published to npm after compilation. __*Default*__: false
|
|
5017
5050
|
* **compatIgnore** (<code>string</code>) Name of the ignore file for API compatibility tests. __*Default*__: ".compatignore"
|
|
5051
|
+
* **docgenFilePath** (<code>string</code>) File path for generated docs. __*Default*__: "API.md"
|
|
5018
5052
|
* **dotnet** (<code>[cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)</code>) *No description* __*Optional*__
|
|
5019
5053
|
* **excludeTypescript** (<code>Array<string></code>) Accepts a list of glob patterns. __*Optional*__
|
|
5020
5054
|
* **publishToGo** (<code>[cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)</code>) Publish Go bindings to a git repository. __*Default*__: no publishing
|
|
@@ -7016,6 +7050,7 @@ new javascript.NodeProject(options: NodeProjectOptions)
|
|
|
7016
7050
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
7017
7051
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
7018
7052
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
7053
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
7019
7054
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
7020
7055
|
* **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
|
|
7021
7056
|
* **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
|
|
@@ -8779,6 +8814,7 @@ new typescript.TypeScriptAppProject(options: TypeScriptProjectOptions)
|
|
|
8779
8814
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
8780
8815
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
8781
8816
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
8817
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
8782
8818
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
8783
8819
|
* **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
|
|
8784
8820
|
* **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
|
|
@@ -8929,6 +8965,7 @@ new typescript.TypeScriptLibraryProject(options: TypeScriptProjectOptions)
|
|
|
8929
8965
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
8930
8966
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
8931
8967
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
8968
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
8932
8969
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
8933
8970
|
* **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
|
|
8934
8971
|
* **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
|
|
@@ -9079,6 +9116,7 @@ new typescript.TypeScriptProject(options: TypeScriptProjectOptions)
|
|
|
9079
9116
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
9080
9117
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
9081
9118
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
9119
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
9082
9120
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
9083
9121
|
* **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
|
|
9084
9122
|
* **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
|
|
@@ -9474,6 +9512,7 @@ new web.NextJsProject(options: NextJsProjectOptions)
|
|
|
9474
9512
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
9475
9513
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
9476
9514
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
9515
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
9477
9516
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
9478
9517
|
* **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
|
|
9479
9518
|
* **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
|
|
@@ -9622,6 +9661,7 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
|
|
|
9622
9661
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
9623
9662
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
9624
9663
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
9664
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
9625
9665
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
9626
9666
|
* **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
|
|
9627
9667
|
* **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
|
|
@@ -9842,6 +9882,7 @@ new web.ReactProject(options: ReactProjectOptions)
|
|
|
9842
9882
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
9843
9883
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
9844
9884
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
9885
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
9845
9886
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
9846
9887
|
* **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
|
|
9847
9888
|
* **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
|
|
@@ -9913,6 +9954,7 @@ new web.ReactTypeDef(project: ReactTypeScriptProject, filePath: string, options?
|
|
|
9913
9954
|
* **committed** (<code>boolean</code>) Indicates whether this file should be committed to git or ignored. __*Default*__: true
|
|
9914
9955
|
* **editGitignore** (<code>boolean</code>) Update the project's .gitignore file. __*Default*__: true
|
|
9915
9956
|
* **executable** (<code>boolean</code>) Whether the generated file should be marked as executable. __*Default*__: false
|
|
9957
|
+
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
|
|
9916
9958
|
* **readonly** (<code>boolean</code>) Whether the generated file should be readonly. __*Default*__: true
|
|
9917
9959
|
|
|
9918
9960
|
|
|
@@ -10031,6 +10073,7 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
|
|
|
10031
10073
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
10032
10074
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
10033
10075
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
10076
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
10034
10077
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
10035
10078
|
* **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
|
|
10036
10079
|
* **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
|
|
@@ -10330,6 +10373,7 @@ Name | Type | Description
|
|
|
10330
10373
|
**committed**?🔹 | <code>boolean</code> | Indicates whether this file should be committed to git or ignored.<br/>__*Default*__: true
|
|
10331
10374
|
**editGitignore**?🔹 | <code>boolean</code> | Update the project's .gitignore file.<br/>__*Default*__: true
|
|
10332
10375
|
**executable**?🔹 | <code>boolean</code> | Whether the generated file should be marked as executable.<br/>__*Default*__: false
|
|
10376
|
+
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__: marker will be included as long as the project is not ejected
|
|
10333
10377
|
**readonly**?🔹 | <code>boolean</code> | Whether the generated file should be readonly.<br/>__*Default*__: true
|
|
10334
10378
|
|
|
10335
10379
|
|
|
@@ -10601,7 +10645,7 @@ Name | Type | Description
|
|
|
10601
10645
|
**committed**?🔹 | <code>boolean</code> | Indicates whether this file should be committed to git or ignored.<br/>__*Default*__: true
|
|
10602
10646
|
**editGitignore**?🔹 | <code>boolean</code> | Update the project's .gitignore file.<br/>__*Default*__: true
|
|
10603
10647
|
**executable**?🔹 | <code>boolean</code> | Whether the generated file should be marked as executable.<br/>__*Default*__: false
|
|
10604
|
-
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__:
|
|
10648
|
+
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__: marker will be included as long as the project is not ejected
|
|
10605
10649
|
**obj**?🔹 | <code>any</code> | The object that will be serialized.<br/>__*Default*__: {} an empty object (use `file.obj` to mutate).
|
|
10606
10650
|
**omitEmpty**?🔹 | <code>boolean</code> | Omits empty objects and arrays.<br/>__*Default*__: false
|
|
10607
10651
|
**readonly**?🔹 | <code>boolean</code> | Whether the generated file should be readonly.<br/>__*Default*__: true
|
|
@@ -10638,7 +10682,7 @@ Name | Type | Description
|
|
|
10638
10682
|
**committed**?🔹 | <code>boolean</code> | Indicates whether this file should be committed to git or ignored.<br/>__*Default*__: true
|
|
10639
10683
|
**editGitignore**?🔹 | <code>boolean</code> | Update the project's .gitignore file.<br/>__*Default*__: true
|
|
10640
10684
|
**executable**?🔹 | <code>boolean</code> | Whether the generated file should be marked as executable.<br/>__*Default*__: false
|
|
10641
|
-
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__:
|
|
10685
|
+
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__: marker will be included as long as the project is not ejected
|
|
10642
10686
|
**newline**?🔹 | <code>boolean</code> | Adds a newline at the end of the file.<br/>__*Default*__: true
|
|
10643
10687
|
**obj**?🔹 | <code>any</code> | The object that will be serialized.<br/>__*Default*__: {} an empty object (use `file.obj` to mutate).
|
|
10644
10688
|
**omitEmpty**?🔹 | <code>boolean</code> | Omits empty objects and arrays.<br/>__*Default*__: false
|
|
@@ -10688,6 +10732,7 @@ Name | Type | Description
|
|
|
10688
10732
|
**committed**?🔹 | <code>boolean</code> | Indicates whether this file should be committed to git or ignored.<br/>__*Default*__: true
|
|
10689
10733
|
**editGitignore**?🔹 | <code>boolean</code> | Update the project's .gitignore file.<br/>__*Default*__: true
|
|
10690
10734
|
**executable**?🔹 | <code>boolean</code> | Whether the generated file should be marked as executable.<br/>__*Default*__: false
|
|
10735
|
+
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__: marker will be included as long as the project is not ejected
|
|
10691
10736
|
**readonly**?🔹 | <code>boolean</code> | Whether the generated file should be readonly.<br/>__*Default*__: true
|
|
10692
10737
|
**rules**?🔹 | <code>Array<[Rule](#projen-rule)></code> | Rules to include in the Makefile.<br/>__*Default*__: []
|
|
10693
10738
|
|
|
@@ -10705,7 +10750,7 @@ Name | Type | Description
|
|
|
10705
10750
|
**committed**?🔹 | <code>boolean</code> | Indicates whether this file should be committed to git or ignored.<br/>__*Default*__: true
|
|
10706
10751
|
**editGitignore**?🔹 | <code>boolean</code> | Update the project's .gitignore file.<br/>__*Default*__: true
|
|
10707
10752
|
**executable**?🔹 | <code>boolean</code> | Whether the generated file should be marked as executable.<br/>__*Default*__: false
|
|
10708
|
-
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__:
|
|
10753
|
+
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__: marker will be included as long as the project is not ejected
|
|
10709
10754
|
**obj**?🔹 | <code>any</code> | The object that will be serialized.<br/>__*Default*__: {} an empty object (use `file.obj` to mutate).
|
|
10710
10755
|
**omitEmpty**?🔹 | <code>boolean</code> | Omits empty objects and arrays.<br/>__*Default*__: false
|
|
10711
10756
|
**readonly**?🔹 | <code>boolean</code> | Whether the generated file should be readonly.<br/>__*Default*__: true
|
|
@@ -10946,6 +10991,7 @@ Name | Type | Description
|
|
|
10946
10991
|
**editGitignore**?🔹 | <code>boolean</code> | Update the project's .gitignore file.<br/>__*Default*__: true
|
|
10947
10992
|
**executable**?🔹 | <code>boolean</code> | Whether the generated file should be marked as executable.<br/>__*Default*__: false
|
|
10948
10993
|
**lines**?🔹 | <code>Array<string></code> | The contents of the text file.<br/>__*Default*__: [] empty file
|
|
10994
|
+
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__: marker will be included as long as the project is not ejected
|
|
10949
10995
|
**readonly**?🔹 | <code>boolean</code> | Whether the generated file should be readonly.<br/>__*Default*__: true
|
|
10950
10996
|
|
|
10951
10997
|
|
|
@@ -10962,7 +11008,7 @@ Name | Type | Description
|
|
|
10962
11008
|
**committed**?🔹 | <code>boolean</code> | Indicates whether this file should be committed to git or ignored.<br/>__*Default*__: true
|
|
10963
11009
|
**editGitignore**?🔹 | <code>boolean</code> | Update the project's .gitignore file.<br/>__*Default*__: true
|
|
10964
11010
|
**executable**?🔹 | <code>boolean</code> | Whether the generated file should be marked as executable.<br/>__*Default*__: false
|
|
10965
|
-
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__:
|
|
11011
|
+
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__: marker will be included as long as the project is not ejected
|
|
10966
11012
|
**obj**?🔹 | <code>any</code> | The object that will be serialized.<br/>__*Default*__: {} an empty object (use `file.obj` to mutate).
|
|
10967
11013
|
**omitEmpty**?🔹 | <code>boolean</code> | Omits empty objects and arrays.<br/>__*Default*__: false
|
|
10968
11014
|
**readonly**?🔹 | <code>boolean</code> | Whether the generated file should be readonly.<br/>__*Default*__: true
|
|
@@ -10996,7 +11042,7 @@ Name | Type | Description
|
|
|
10996
11042
|
**committed**?🔹 | <code>boolean</code> | Indicates whether this file should be committed to git or ignored.<br/>__*Default*__: true
|
|
10997
11043
|
**editGitignore**?🔹 | <code>boolean</code> | Update the project's .gitignore file.<br/>__*Default*__: true
|
|
10998
11044
|
**executable**?🔹 | <code>boolean</code> | Whether the generated file should be marked as executable.<br/>__*Default*__: false
|
|
10999
|
-
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__:
|
|
11045
|
+
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__: marker will be included as long as the project is not ejected
|
|
11000
11046
|
**obj**?🔹 | <code>any</code> | The object that will be serialized.<br/>__*Default*__: {} an empty object (use `file.obj` to mutate).
|
|
11001
11047
|
**omitEmpty**?🔹 | <code>boolean</code> | Omits empty objects and arrays.<br/>__*Default*__: false
|
|
11002
11048
|
**readonly**?🔹 | <code>boolean</code> | Whether the generated file should be readonly.<br/>__*Default*__: true
|
|
@@ -11016,7 +11062,7 @@ Name | Type | Description
|
|
|
11016
11062
|
**editGitignore**?🔹 | <code>boolean</code> | Update the project's .gitignore file.<br/>__*Default*__: true
|
|
11017
11063
|
**executable**?🔹 | <code>boolean</code> | Whether the generated file should be marked as executable.<br/>__*Default*__: false
|
|
11018
11064
|
**lineWidth**?🔹 | <code>number</code> | Maximum line width (set to 0 to disable folding).<br/>__*Default*__: 0
|
|
11019
|
-
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__:
|
|
11065
|
+
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__: marker will be included as long as the project is not ejected
|
|
11020
11066
|
**obj**?🔹 | <code>any</code> | The object that will be serialized.<br/>__*Default*__: {} an empty object (use `file.obj` to mutate).
|
|
11021
11067
|
**omitEmpty**?🔹 | <code>boolean</code> | Omits empty objects and arrays.<br/>__*Default*__: false
|
|
11022
11068
|
**readonly**?🔹 | <code>boolean</code> | Whether the generated file should be readonly.<br/>__*Default*__: true
|
|
@@ -11070,6 +11116,7 @@ Name | Type | Description
|
|
|
11070
11116
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
11071
11117
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
11072
11118
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
11119
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
11073
11120
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
11074
11121
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
11075
11122
|
**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
|
|
@@ -11098,6 +11145,7 @@ Name | Type | Description
|
|
|
11098
11145
|
**devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
|
|
11099
11146
|
**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
|
|
11100
11147
|
**docgen**?🔹 | <code>boolean</code> | Docgen by Typedoc.<br/>__*Default*__: false
|
|
11148
|
+
**docgenFilePath**?🔹 | <code>string</code> | File path for generated docs.<br/>__*Default*__: "API.md"
|
|
11101
11149
|
**docsDirectory**?🔹 | <code>string</code> | Docs directory.<br/>__*Default*__: "docs"
|
|
11102
11150
|
**dotnet**?⚠️ | <code>[cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)</code> | __*Optional*__
|
|
11103
11151
|
**entrypoint**?🔹 | <code>string</code> | Module entrypoint (`main` in `package.json`).<br/>__*Default*__: "lib/index.js"
|
|
@@ -11359,6 +11407,7 @@ Name | Type | Description
|
|
|
11359
11407
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
11360
11408
|
**buildCommand**?🔹 | <code>string</code> | A command to execute before synthesis.<br/>__*Default*__: no build command
|
|
11361
11409
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
11410
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
11362
11411
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
11363
11412
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
11364
11413
|
**cdkAssert**?⚠️ | <code>boolean</code> | Warning: NodeJS only.<br/>__*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
|
|
@@ -11557,6 +11606,7 @@ Name | Type | Description
|
|
|
11557
11606
|
**bugsEmail**?⚠️ | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
11558
11607
|
**bugsUrl**?⚠️ | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
11559
11608
|
**buildWorkflow**?⚠️ | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
11609
|
+
**buildWorkflowTriggers**?⚠️ | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
11560
11610
|
**bundledDeps**?⚠️ | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
11561
11611
|
**bundlerOptions**?⚠️ | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
11562
11612
|
**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
|
|
@@ -11585,6 +11635,7 @@ Name | Type | Description
|
|
|
11585
11635
|
**devDeps**?⚠️ | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
|
|
11586
11636
|
**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
|
|
11587
11637
|
**docgen**?⚠️ | <code>boolean</code> | Docgen by Typedoc.<br/>__*Default*__: false
|
|
11638
|
+
**docgenFilePath**?⚠️ | <code>string</code> | File path for generated docs.<br/>__*Default*__: "API.md"
|
|
11588
11639
|
**docsDirectory**?⚠️ | <code>string</code> | Docs directory.<br/>__*Default*__: "docs"
|
|
11589
11640
|
**dotnet**?⚠️ | <code>[cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)</code> | __*Optional*__
|
|
11590
11641
|
**entrypoint**?⚠️ | <code>string</code> | Module entrypoint (`main` in `package.json`).<br/>__*Default*__: "lib/index.js"
|
|
@@ -11805,6 +11856,7 @@ Name | Type | Description
|
|
|
11805
11856
|
**postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build.<br/>__*Default*__: []
|
|
11806
11857
|
**preBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute before the build.<br/>__*Default*__: []
|
|
11807
11858
|
**runsOn**?🔹 | <code>Array<string></code> | Github Runner selection labels.<br/>__*Default*__: ["ubuntu-latest"]
|
|
11859
|
+
**workflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
11808
11860
|
|
|
11809
11861
|
|
|
11810
11862
|
|
|
@@ -11851,6 +11903,7 @@ Name | Type | Description
|
|
|
11851
11903
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
11852
11904
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
11853
11905
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
11906
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
11854
11907
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
11855
11908
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
11856
11909
|
**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
|
|
@@ -11872,6 +11925,7 @@ Name | Type | Description
|
|
|
11872
11925
|
**devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
|
|
11873
11926
|
**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
|
|
11874
11927
|
**docgen**?🔹 | <code>boolean</code> | Docgen by Typedoc.<br/>__*Default*__: false
|
|
11928
|
+
**docgenFilePath**?🔹 | <code>string</code> | File path for generated docs.<br/>__*Default*__: "API.md"
|
|
11875
11929
|
**docsDirectory**?🔹 | <code>string</code> | Docs directory.<br/>__*Default*__: "docs"
|
|
11876
11930
|
**dotnet**?⚠️ | <code>[cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)</code> | __*Optional*__
|
|
11877
11931
|
**entrypoint**?🔹 | <code>string</code> | Module entrypoint (`main` in `package.json`).<br/>__*Default*__: "lib/index.js"
|
|
@@ -11976,6 +12030,19 @@ Name | Type | Description
|
|
|
11976
12030
|
|
|
11977
12031
|
|
|
11978
12032
|
|
|
12033
|
+
## struct JsiiDocgenOptions 🔹 <a id="projen-cdk-jsiidocgenoptions"></a>
|
|
12034
|
+
|
|
12035
|
+
|
|
12036
|
+
Options for `JsiiDocgen`.
|
|
12037
|
+
|
|
12038
|
+
|
|
12039
|
+
|
|
12040
|
+
Name | Type | Description
|
|
12041
|
+
-----|------|-------------
|
|
12042
|
+
**filePath**?🔹 | <code>string</code> | File path for generated docs.<br/>__*Default*__: "API.md"
|
|
12043
|
+
|
|
12044
|
+
|
|
12045
|
+
|
|
11979
12046
|
## struct JsiiDotNetTarget 🔹 <a id="projen-cdk-jsiidotnettarget"></a>
|
|
11980
12047
|
|
|
11981
12048
|
|
|
@@ -12068,6 +12135,7 @@ Name | Type | Description
|
|
|
12068
12135
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
12069
12136
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
12070
12137
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
12138
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
12071
12139
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
12072
12140
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
12073
12141
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
@@ -12088,6 +12156,7 @@ Name | Type | Description
|
|
|
12088
12156
|
**devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
|
|
12089
12157
|
**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
|
|
12090
12158
|
**docgen**?🔹 | <code>boolean</code> | Docgen by Typedoc.<br/>__*Default*__: false
|
|
12159
|
+
**docgenFilePath**?🔹 | <code>string</code> | File path for generated docs.<br/>__*Default*__: "API.md"
|
|
12091
12160
|
**docsDirectory**?🔹 | <code>string</code> | Docs directory.<br/>__*Default*__: "docs"
|
|
12092
12161
|
**dotnet**?⚠️ | <code>[cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)</code> | __*Optional*__
|
|
12093
12162
|
**entrypoint**?🔹 | <code>string</code> | Module entrypoint (`main` in `package.json`).<br/>__*Default*__: "lib/index.js"
|
|
@@ -12239,6 +12308,7 @@ Name | Type | Description
|
|
|
12239
12308
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
12240
12309
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
12241
12310
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
12311
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
12242
12312
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
12243
12313
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
12244
12314
|
**cdk8sCliVersion**?🔹 | <code>string</code> | cdk8s-cli version.<br/>__*Default*__: "cdk8sVersion"
|
|
@@ -12391,6 +12461,7 @@ Name | Type | Description
|
|
|
12391
12461
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
12392
12462
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
12393
12463
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
12464
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
12394
12465
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
12395
12466
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
12396
12467
|
**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
|
|
@@ -12416,6 +12487,7 @@ Name | Type | Description
|
|
|
12416
12487
|
**devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
|
|
12417
12488
|
**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
|
|
12418
12489
|
**docgen**?🔹 | <code>boolean</code> | Docgen by Typedoc.<br/>__*Default*__: false
|
|
12490
|
+
**docgenFilePath**?🔹 | <code>string</code> | File path for generated docs.<br/>__*Default*__: "API.md"
|
|
12419
12491
|
**docsDirectory**?🔹 | <code>string</code> | Docs directory.<br/>__*Default*__: "docs"
|
|
12420
12492
|
**dotnet**?⚠️ | <code>[cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)</code> | __*Optional*__
|
|
12421
12493
|
**entrypoint**?🔹 | <code>string</code> | Module entrypoint (`main` in `package.json`).<br/>__*Default*__: "lib/index.js"
|
|
@@ -12550,6 +12622,7 @@ Name | Type | Description
|
|
|
12550
12622
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
12551
12623
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
12552
12624
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
12625
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
12553
12626
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
12554
12627
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
12555
12628
|
**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
|
|
@@ -12571,6 +12644,7 @@ Name | Type | Description
|
|
|
12571
12644
|
**devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
|
|
12572
12645
|
**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
|
|
12573
12646
|
**docgen**?🔹 | <code>boolean</code> | Docgen by Typedoc.<br/>__*Default*__: false
|
|
12647
|
+
**docgenFilePath**?🔹 | <code>string</code> | File path for generated docs.<br/>__*Default*__: "API.md"
|
|
12574
12648
|
**docsDirectory**?🔹 | <code>string</code> | Docs directory.<br/>__*Default*__: "docs"
|
|
12575
12649
|
**dotnet**?⚠️ | <code>[cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)</code> | __*Optional*__
|
|
12576
12650
|
**entrypoint**?🔹 | <code>string</code> | Module entrypoint (`main` in `package.json`).<br/>__*Default*__: "lib/index.js"
|
|
@@ -14103,6 +14177,7 @@ Name | Type | Description
|
|
|
14103
14177
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
14104
14178
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
14105
14179
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
14180
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
14106
14181
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
14107
14182
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
14108
14183
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
@@ -15163,6 +15238,7 @@ Name | Type | Description
|
|
|
15163
15238
|
**bugsEmail**?⚠️ | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
15164
15239
|
**bugsUrl**?⚠️ | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
15165
15240
|
**buildWorkflow**?⚠️ | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
15241
|
+
**buildWorkflowTriggers**?⚠️ | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
15166
15242
|
**bundledDeps**?⚠️ | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
15167
15243
|
**bundlerOptions**?⚠️ | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
15168
15244
|
**clobber**?⚠️ | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
@@ -15303,6 +15379,7 @@ Name | Type | Description
|
|
|
15303
15379
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
15304
15380
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
15305
15381
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
15382
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
15306
15383
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
15307
15384
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
15308
15385
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
@@ -15548,6 +15625,7 @@ Name | Type | Description
|
|
|
15548
15625
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
15549
15626
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
15550
15627
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
15628
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
15551
15629
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
15552
15630
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
15553
15631
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
@@ -15676,6 +15754,7 @@ Name | Type | Description
|
|
|
15676
15754
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
15677
15755
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
15678
15756
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
15757
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
15679
15758
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
15680
15759
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
15681
15760
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
@@ -15846,6 +15925,7 @@ Name | Type | Description
|
|
|
15846
15925
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
15847
15926
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
15848
15927
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
15928
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
15849
15929
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
15850
15930
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
15851
15931
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
@@ -15972,6 +16052,7 @@ Name | Type | Description
|
|
|
15972
16052
|
**committed**?🔹 | <code>boolean</code> | Indicates whether this file should be committed to git or ignored.<br/>__*Default*__: true
|
|
15973
16053
|
**editGitignore**?🔹 | <code>boolean</code> | Update the project's .gitignore file.<br/>__*Default*__: true
|
|
15974
16054
|
**executable**?🔹 | <code>boolean</code> | Whether the generated file should be marked as executable.<br/>__*Default*__: false
|
|
16055
|
+
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__: marker will be included as long as the project is not ejected
|
|
15975
16056
|
**readonly**?🔹 | <code>boolean</code> | Whether the generated file should be readonly.<br/>__*Default*__: true
|
|
15976
16057
|
|
|
15977
16058
|
|
|
@@ -16002,6 +16083,7 @@ Name | Type | Description
|
|
|
16002
16083
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
16003
16084
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
16004
16085
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
16086
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
16005
16087
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
16006
16088
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
16007
16089
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|