projen 0.32.7 → 0.33.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (119) hide show
  1. package/.jsii +694 -674
  2. package/API.md +132 -153
  3. package/docs/project.md +30 -0
  4. package/lib/awscdk/auto-discover.js +1 -1
  5. package/lib/awscdk/cdk-config.js +1 -1
  6. package/lib/awscdk/cdk-tasks.js +1 -1
  7. package/lib/awscdk/java-app.js +3 -3
  8. package/lib/awscdk/lambda-function.js +5 -5
  9. package/lib/awscdk-app-ts.js +3 -3
  10. package/lib/awscdk-construct.js +2 -2
  11. package/lib/cdk8s-app-ts.js +3 -3
  12. package/lib/cdk8s-construct.js +1 -1
  13. package/lib/cdktf-construct.js +1 -1
  14. package/lib/cli/synth.js +5 -2
  15. package/lib/common.d.ts +1 -0
  16. package/lib/common.js +4 -3
  17. package/lib/component.js +1 -1
  18. package/lib/construct-lib.js +1 -1
  19. package/lib/deps/dependencies.js +1 -1
  20. package/lib/dev-env.js +1 -1
  21. package/lib/docker-compose.js +2 -2
  22. package/lib/eslint.js +1 -1
  23. package/lib/file.js +1 -1
  24. package/lib/git/gitattributes.js +1 -1
  25. package/lib/github/auto-approve.js +1 -1
  26. package/lib/github/auto-merge.js +1 -1
  27. package/lib/github/dependabot.js +1 -1
  28. package/lib/github/github.d.ts +8 -1
  29. package/lib/github/github.js +3 -3
  30. package/lib/github/mergify.js +1 -1
  31. package/lib/github/pr-template.js +1 -1
  32. package/lib/github/stale.js +1 -1
  33. package/lib/github/task-workflow.js +1 -1
  34. package/lib/github/workflows.js +1 -1
  35. package/lib/gitpod.js +1 -1
  36. package/lib/ignore-file.js +1 -1
  37. package/lib/index.d.ts +1 -0
  38. package/lib/index.js +2 -1
  39. package/lib/ini.js +1 -1
  40. package/lib/java/java-project.d.ts +0 -7
  41. package/lib/java/java-project.js +2 -5
  42. package/lib/java/junit.js +3 -6
  43. package/lib/java/maven-compile.d.ts +0 -5
  44. package/lib/java/maven-compile.js +3 -6
  45. package/lib/java/maven-packaging.d.ts +0 -7
  46. package/lib/java/maven-packaging.js +7 -8
  47. package/lib/java/maven-sample.js +1 -1
  48. package/lib/java/pom.js +1 -1
  49. package/lib/java/projenrc.js +4 -6
  50. package/lib/javascript/bundler.d.ts +1 -8
  51. package/lib/javascript/bundler.js +4 -5
  52. package/lib/javascript/npm-config.js +1 -1
  53. package/lib/javascript/projenrc.js +3 -4
  54. package/lib/jest.js +1 -1
  55. package/lib/jsii-docgen.js +3 -2
  56. package/lib/jsii-project.js +1 -1
  57. package/lib/json/projenrc.js +4 -9
  58. package/lib/json.js +1 -1
  59. package/lib/license.js +1 -1
  60. package/lib/logger.js +6 -5
  61. package/lib/logging.d.ts +1 -0
  62. package/lib/logging.js +6 -4
  63. package/lib/makefile.js +1 -1
  64. package/lib/node-package.d.ts +6 -15
  65. package/lib/node-package.js +22 -15
  66. package/lib/node-project.d.ts +0 -54
  67. package/lib/node-project.js +34 -70
  68. package/lib/object-file.js +1 -1
  69. package/lib/project-build.d.ts +60 -0
  70. package/lib/project-build.js +61 -0
  71. package/lib/project.d.ts +60 -1
  72. package/lib/project.js +40 -9
  73. package/lib/projects.js +1 -1
  74. package/lib/python/pip.js +1 -1
  75. package/lib/python/poetry.d.ts +0 -6
  76. package/lib/python/poetry.js +4 -7
  77. package/lib/python/projenrc.js +3 -5
  78. package/lib/python/pytest.d.ts +0 -5
  79. package/lib/python/pytest.js +6 -9
  80. package/lib/python/python-packaging.d.ts +0 -6
  81. package/lib/python/python-packaging.js +1 -1
  82. package/lib/python/python-project.js +1 -1
  83. package/lib/python/python-sample.js +1 -1
  84. package/lib/python/requirements-file.js +1 -1
  85. package/lib/python/setuppy.js +1 -1
  86. package/lib/python/setuptools.d.ts +0 -6
  87. package/lib/python/setuptools.js +3 -6
  88. package/lib/python/venv.js +1 -1
  89. package/lib/readme.js +1 -1
  90. package/lib/release/publisher.js +1 -1
  91. package/lib/release/release-trigger.js +1 -1
  92. package/lib/release/release.js +1 -1
  93. package/lib/sample-file.js +2 -2
  94. package/lib/semver.js +1 -1
  95. package/lib/source-code.js +1 -1
  96. package/lib/tasks/runtime.js +10 -7
  97. package/lib/tasks/task.d.ts +8 -0
  98. package/lib/tasks/task.js +26 -2
  99. package/lib/tasks/tasks.js +1 -1
  100. package/lib/textfile.js +1 -1
  101. package/lib/toml.js +1 -1
  102. package/lib/typescript/projenrc.js +3 -6
  103. package/lib/typescript-config.js +1 -1
  104. package/lib/typescript-typedoc.js +3 -2
  105. package/lib/typescript.d.ts +0 -13
  106. package/lib/typescript.js +24 -45
  107. package/lib/upgrade-dependencies.js +2 -2
  108. package/lib/util.js +3 -3
  109. package/lib/version.js +1 -1
  110. package/lib/vscode/devcontainer.js +1 -1
  111. package/lib/vscode/launch-config.js +1 -1
  112. package/lib/vscode/vscode.js +1 -1
  113. package/lib/web/next.js +5 -5
  114. package/lib/web/postcss.js +1 -1
  115. package/lib/web/react.js +6 -6
  116. package/lib/web/tailwind.js +1 -1
  117. package/lib/xmlfile.js +1 -1
  118. package/lib/yaml.js +1 -1
  119. package/package.json +4 -2
package/API.md CHANGED
@@ -31,6 +31,7 @@ Name|Description
31
31
  [NodeProject](#projen-nodeproject)|Node.js project.
32
32
  [ObjectFile](#projen-objectfile)|Represents an Object file.
33
33
  [Project](#projen-project)|Base project.
34
+ [ProjectBuild](#projen-projectbuild)|Manages a standard build process for all projects.
34
35
  [Projects](#projen-projects)|Programmatic API for projen.
35
36
  [SampleDir](#projen-sampledir)|Renders the given files into the directory if the directory does not exist.
36
37
  [SampleFile](#projen-samplefile)|Produces a file with the given contents but only once, if the file doesn't already exist.
@@ -336,6 +337,7 @@ new AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
336
337
  * **logging** (<code>[LoggerOptions](#projen-loggeroptions)</code>) Configure logging options such as verbosity. __*Default*__: {}
337
338
  * **outdir** (<code>string</code>) The root directory of the project. __*Default*__: "."
338
339
  * **parent** (<code>[Project](#projen-project)</code>) The parent project, if this project is part of a bigger project. __*Optional*__
340
+ * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
339
341
  * **projenrcJson** (<code>boolean</code>) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
340
342
  * **projenrcJsonOptions** (<code>[json.ProjenrcOptions](#projen-json-projenrcoptions)</code>) Options for .projenrc.json. __*Default*__: default options
341
343
  * **autoApproveOptions** (<code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code>) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
@@ -346,6 +348,7 @@ new AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
346
348
  * **githubOptions** (<code>[github.GitHubOptions](#projen-github-githuboptions)</code>) Options for GitHub integration. __*Default*__: see GitHubOptions
347
349
  * **gitpod** (<code>boolean</code>) Add a Gitpod development environment. __*Default*__: false
348
350
  * **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
351
+ * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
349
352
  * **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
350
353
  * **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
351
354
  * **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
@@ -379,7 +382,6 @@ new AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
379
382
  * **packageName** (<code>string</code>) The "name" in package.json. __*Default*__: defaults to project name
380
383
  * **peerDependencyOptions** (<code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code>) Options for `peerDeps`. __*Optional*__
381
384
  * **peerDeps** (<code>Array<string></code>) Peer dependencies for this module. __*Default*__: []
382
- * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
383
385
  * **repository** (<code>string</code>) The repository is the location where the actual code for your package lives. __*Optional*__
384
386
  * **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*__
385
387
  * **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
@@ -416,12 +418,10 @@ new AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
416
418
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
417
419
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
418
420
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
419
- * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
420
421
  * **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
421
422
  * **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
422
423
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
423
424
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
424
- * **projenDuringBuild** (<code>boolean</code>) Execute `projen` as the first step of the `build` task to synthesize project files. __*Default*__: true
425
425
  * **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
426
426
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
427
427
  * **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
@@ -436,7 +436,6 @@ new AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
436
436
  * **workflowBootstrapSteps** (<code>Array<any></code>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
437
437
  * **workflowGitIdentity** (<code>[github.GitIdentity](#projen-github-gitidentity)</code>) The git identity to use in workflows. __*Default*__: GitHub Actions
438
438
  * **workflowNodeVersion** (<code>string</code>) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
439
- * **compileBeforeTest** (<code>boolean</code>) Compile the code before running tests. __*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false`.
440
439
  * **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
441
440
  * **docgen** (<code>boolean</code>) Docgen by Typedoc. __*Default*__: false
442
441
  * **docsDirectory** (<code>string</code>) Docs directory. __*Default*__: "docs"
@@ -548,6 +547,7 @@ new AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
548
547
  * **logging** (<code>[LoggerOptions](#projen-loggeroptions)</code>) Configure logging options such as verbosity. __*Default*__: {}
549
548
  * **outdir** (<code>string</code>) The root directory of the project. __*Default*__: "."
550
549
  * **parent** (<code>[Project](#projen-project)</code>) The parent project, if this project is part of a bigger project. __*Optional*__
550
+ * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
551
551
  * **projenrcJson** (<code>boolean</code>) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
552
552
  * **projenrcJsonOptions** (<code>[json.ProjenrcOptions](#projen-json-projenrcoptions)</code>) Options for .projenrc.json. __*Default*__: default options
553
553
  * **autoApproveOptions** (<code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code>) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
@@ -558,6 +558,7 @@ new AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
558
558
  * **githubOptions** (<code>[github.GitHubOptions](#projen-github-githuboptions)</code>) Options for GitHub integration. __*Default*__: see GitHubOptions
559
559
  * **gitpod** (<code>boolean</code>) Add a Gitpod development environment. __*Default*__: false
560
560
  * **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
561
+ * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
561
562
  * **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
562
563
  * **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
563
564
  * **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
@@ -591,7 +592,6 @@ new AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
591
592
  * **packageName** (<code>string</code>) The "name" in package.json. __*Default*__: defaults to project name
592
593
  * **peerDependencyOptions** (<code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code>) Options for `peerDeps`. __*Optional*__
593
594
  * **peerDeps** (<code>Array<string></code>) Peer dependencies for this module. __*Default*__: []
594
- * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
595
595
  * **repository** (<code>string</code>) The repository is the location where the actual code for your package lives. __*Optional*__
596
596
  * **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*__
597
597
  * **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
@@ -628,12 +628,10 @@ new AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
628
628
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
629
629
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
630
630
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
631
- * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
632
631
  * **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
633
632
  * **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
634
633
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
635
634
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
636
- * **projenDuringBuild** (<code>boolean</code>) Execute `projen` as the first step of the `build` task to synthesize project files. __*Default*__: true
637
635
  * **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
638
636
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
639
637
  * **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
@@ -648,7 +646,6 @@ new AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
648
646
  * **workflowBootstrapSteps** (<code>Array<any></code>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
649
647
  * **workflowGitIdentity** (<code>[github.GitIdentity](#projen-github-gitidentity)</code>) The git identity to use in workflows. __*Default*__: GitHub Actions
650
648
  * **workflowNodeVersion** (<code>string</code>) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
651
- * **compileBeforeTest** (<code>boolean</code>) Compile the code before running tests. __*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false`.
652
649
  * **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
653
650
  * **docgen** (<code>boolean</code>) Docgen by Typedoc. __*Default*__: false
654
651
  * **docsDirectory** (<code>string</code>) Docs directory. __*Default*__: "docs"
@@ -727,6 +724,7 @@ new Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
727
724
  * **logging** (<code>[LoggerOptions](#projen-loggeroptions)</code>) Configure logging options such as verbosity. __*Default*__: {}
728
725
  * **outdir** (<code>string</code>) The root directory of the project. __*Default*__: "."
729
726
  * **parent** (<code>[Project](#projen-project)</code>) The parent project, if this project is part of a bigger project. __*Optional*__
727
+ * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
730
728
  * **projenrcJson** (<code>boolean</code>) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
731
729
  * **projenrcJsonOptions** (<code>[json.ProjenrcOptions](#projen-json-projenrcoptions)</code>) Options for .projenrc.json. __*Default*__: default options
732
730
  * **autoApproveOptions** (<code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code>) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
@@ -737,6 +735,7 @@ new Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
737
735
  * **githubOptions** (<code>[github.GitHubOptions](#projen-github-githuboptions)</code>) Options for GitHub integration. __*Default*__: see GitHubOptions
738
736
  * **gitpod** (<code>boolean</code>) Add a Gitpod development environment. __*Default*__: false
739
737
  * **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
738
+ * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
740
739
  * **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
741
740
  * **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
742
741
  * **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
@@ -770,7 +769,6 @@ new Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
770
769
  * **packageName** (<code>string</code>) The "name" in package.json. __*Default*__: defaults to project name
771
770
  * **peerDependencyOptions** (<code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code>) Options for `peerDeps`. __*Optional*__
772
771
  * **peerDeps** (<code>Array<string></code>) Peer dependencies for this module. __*Default*__: []
773
- * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
774
772
  * **repository** (<code>string</code>) The repository is the location where the actual code for your package lives. __*Optional*__
775
773
  * **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*__
776
774
  * **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
@@ -807,12 +805,10 @@ new Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
807
805
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
808
806
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
809
807
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
810
- * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
811
808
  * **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
812
809
  * **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
813
810
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
814
811
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
815
- * **projenDuringBuild** (<code>boolean</code>) Execute `projen` as the first step of the `build` task to synthesize project files. __*Default*__: true
816
812
  * **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
817
813
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
818
814
  * **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
@@ -827,7 +823,6 @@ new Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
827
823
  * **workflowBootstrapSteps** (<code>Array<any></code>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
828
824
  * **workflowGitIdentity** (<code>[github.GitIdentity](#projen-github-gitidentity)</code>) The git identity to use in workflows. __*Default*__: GitHub Actions
829
825
  * **workflowNodeVersion** (<code>string</code>) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
830
- * **compileBeforeTest** (<code>boolean</code>) Compile the code before running tests. __*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false`.
831
826
  * **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
832
827
  * **docgen** (<code>boolean</code>) Docgen by Typedoc. __*Default*__: false
833
828
  * **docsDirectory** (<code>string</code>) Docs directory. __*Default*__: "docs"
@@ -959,6 +954,7 @@ new ConstructLibrary(options: ConstructLibraryOptions)
959
954
  * **logging** (<code>[LoggerOptions](#projen-loggeroptions)</code>) Configure logging options such as verbosity. __*Default*__: {}
960
955
  * **outdir** (<code>string</code>) The root directory of the project. __*Default*__: "."
961
956
  * **parent** (<code>[Project](#projen-project)</code>) The parent project, if this project is part of a bigger project. __*Optional*__
957
+ * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
962
958
  * **projenrcJson** (<code>boolean</code>) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
963
959
  * **projenrcJsonOptions** (<code>[json.ProjenrcOptions](#projen-json-projenrcoptions)</code>) Options for .projenrc.json. __*Default*__: default options
964
960
  * **autoApproveOptions** (<code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code>) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
@@ -969,6 +965,7 @@ new ConstructLibrary(options: ConstructLibraryOptions)
969
965
  * **githubOptions** (<code>[github.GitHubOptions](#projen-github-githuboptions)</code>) Options for GitHub integration. __*Default*__: see GitHubOptions
970
966
  * **gitpod** (<code>boolean</code>) Add a Gitpod development environment. __*Default*__: false
971
967
  * **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
968
+ * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
972
969
  * **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
973
970
  * **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
974
971
  * **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
@@ -1002,7 +999,6 @@ new ConstructLibrary(options: ConstructLibraryOptions)
1002
999
  * **packageName** (<code>string</code>) The "name" in package.json. __*Default*__: defaults to project name
1003
1000
  * **peerDependencyOptions** (<code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code>) Options for `peerDeps`. __*Optional*__
1004
1001
  * **peerDeps** (<code>Array<string></code>) Peer dependencies for this module. __*Default*__: []
1005
- * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
1006
1002
  * **repository** (<code>string</code>) The repository is the location where the actual code for your package lives. __*Optional*__
1007
1003
  * **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*__
1008
1004
  * **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
@@ -1039,12 +1035,10 @@ new ConstructLibrary(options: ConstructLibraryOptions)
1039
1035
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
1040
1036
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
1041
1037
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
1042
- * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
1043
1038
  * **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
1044
1039
  * **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
1045
1040
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
1046
1041
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
1047
- * **projenDuringBuild** (<code>boolean</code>) Execute `projen` as the first step of the `build` task to synthesize project files. __*Default*__: true
1048
1042
  * **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
1049
1043
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
1050
1044
  * **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
@@ -1059,7 +1053,6 @@ new ConstructLibrary(options: ConstructLibraryOptions)
1059
1053
  * **workflowBootstrapSteps** (<code>Array<any></code>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
1060
1054
  * **workflowGitIdentity** (<code>[github.GitIdentity](#projen-github-gitidentity)</code>) The git identity to use in workflows. __*Default*__: GitHub Actions
1061
1055
  * **workflowNodeVersion** (<code>string</code>) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
1062
- * **compileBeforeTest** (<code>boolean</code>) Compile the code before running tests. __*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false`.
1063
1056
  * **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
1064
1057
  * **docgen** (<code>boolean</code>) Docgen by Typedoc. __*Default*__: false
1065
1058
  * **docsDirectory** (<code>string</code>) Docs directory. __*Default*__: "docs"
@@ -1115,6 +1108,7 @@ new ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
1115
1108
  * **logging** (<code>[LoggerOptions](#projen-loggeroptions)</code>) Configure logging options such as verbosity. __*Default*__: {}
1116
1109
  * **outdir** (<code>string</code>) The root directory of the project. __*Default*__: "."
1117
1110
  * **parent** (<code>[Project](#projen-project)</code>) The parent project, if this project is part of a bigger project. __*Optional*__
1111
+ * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
1118
1112
  * **projenrcJson** (<code>boolean</code>) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
1119
1113
  * **projenrcJsonOptions** (<code>[json.ProjenrcOptions](#projen-json-projenrcoptions)</code>) Options for .projenrc.json. __*Default*__: default options
1120
1114
  * **autoApproveOptions** (<code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code>) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
@@ -1125,6 +1119,7 @@ new ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
1125
1119
  * **githubOptions** (<code>[github.GitHubOptions](#projen-github-githuboptions)</code>) Options for GitHub integration. __*Default*__: see GitHubOptions
1126
1120
  * **gitpod** (<code>boolean</code>) Add a Gitpod development environment. __*Default*__: false
1127
1121
  * **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
1122
+ * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
1128
1123
  * **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
1129
1124
  * **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
1130
1125
  * **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
@@ -1158,7 +1153,6 @@ new ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
1158
1153
  * **packageName** (<code>string</code>) The "name" in package.json. __*Default*__: defaults to project name
1159
1154
  * **peerDependencyOptions** (<code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code>) Options for `peerDeps`. __*Optional*__
1160
1155
  * **peerDeps** (<code>Array<string></code>) Peer dependencies for this module. __*Default*__: []
1161
- * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
1162
1156
  * **repository** (<code>string</code>) The repository is the location where the actual code for your package lives. __*Optional*__
1163
1157
  * **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*__
1164
1158
  * **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
@@ -1195,12 +1189,10 @@ new ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
1195
1189
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
1196
1190
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
1197
1191
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
1198
- * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
1199
1192
  * **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
1200
1193
  * **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
1201
1194
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
1202
1195
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
1203
- * **projenDuringBuild** (<code>boolean</code>) Execute `projen` as the first step of the `build` task to synthesize project files. __*Default*__: true
1204
1196
  * **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
1205
1197
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
1206
1198
  * **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
@@ -1215,7 +1207,6 @@ new ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
1215
1207
  * **workflowBootstrapSteps** (<code>Array<any></code>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
1216
1208
  * **workflowGitIdentity** (<code>[github.GitIdentity](#projen-github-gitidentity)</code>) The git identity to use in workflows. __*Default*__: GitHub Actions
1217
1209
  * **workflowNodeVersion** (<code>string</code>) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
1218
- * **compileBeforeTest** (<code>boolean</code>) Compile the code before running tests. __*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false`.
1219
1210
  * **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
1220
1211
  * **docgen** (<code>boolean</code>) Docgen by Typedoc. __*Default*__: false
1221
1212
  * **docsDirectory** (<code>string</code>) Docs directory. __*Default*__: "docs"
@@ -1284,6 +1275,7 @@ new ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
1284
1275
  * **logging** (<code>[LoggerOptions](#projen-loggeroptions)</code>) Configure logging options such as verbosity. __*Default*__: {}
1285
1276
  * **outdir** (<code>string</code>) The root directory of the project. __*Default*__: "."
1286
1277
  * **parent** (<code>[Project](#projen-project)</code>) The parent project, if this project is part of a bigger project. __*Optional*__
1278
+ * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
1287
1279
  * **projenrcJson** (<code>boolean</code>) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
1288
1280
  * **projenrcJsonOptions** (<code>[json.ProjenrcOptions](#projen-json-projenrcoptions)</code>) Options for .projenrc.json. __*Default*__: default options
1289
1281
  * **autoApproveOptions** (<code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code>) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
@@ -1294,6 +1286,7 @@ new ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
1294
1286
  * **githubOptions** (<code>[github.GitHubOptions](#projen-github-githuboptions)</code>) Options for GitHub integration. __*Default*__: see GitHubOptions
1295
1287
  * **gitpod** (<code>boolean</code>) Add a Gitpod development environment. __*Default*__: false
1296
1288
  * **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
1289
+ * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
1297
1290
  * **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
1298
1291
  * **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
1299
1292
  * **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
@@ -1327,7 +1320,6 @@ new ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
1327
1320
  * **packageName** (<code>string</code>) The "name" in package.json. __*Default*__: defaults to project name
1328
1321
  * **peerDependencyOptions** (<code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code>) Options for `peerDeps`. __*Optional*__
1329
1322
  * **peerDeps** (<code>Array<string></code>) Peer dependencies for this module. __*Default*__: []
1330
- * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
1331
1323
  * **repository** (<code>string</code>) The repository is the location where the actual code for your package lives. __*Optional*__
1332
1324
  * **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*__
1333
1325
  * **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
@@ -1364,12 +1356,10 @@ new ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
1364
1356
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
1365
1357
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
1366
1358
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
1367
- * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
1368
1359
  * **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
1369
1360
  * **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
1370
1361
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
1371
1362
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
1372
- * **projenDuringBuild** (<code>boolean</code>) Execute `projen` as the first step of the `build` task to synthesize project files. __*Default*__: true
1373
1363
  * **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
1374
1364
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
1375
1365
  * **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
@@ -1384,7 +1374,6 @@ new ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
1384
1374
  * **workflowBootstrapSteps** (<code>Array<any></code>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
1385
1375
  * **workflowGitIdentity** (<code>[github.GitIdentity](#projen-github-gitidentity)</code>) The git identity to use in workflows. __*Default*__: GitHub Actions
1386
1376
  * **workflowNodeVersion** (<code>string</code>) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
1387
- * **compileBeforeTest** (<code>boolean</code>) Compile the code before running tests. __*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false`.
1388
1377
  * **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
1389
1378
  * **docgen** (<code>boolean</code>) Docgen by Typedoc. __*Default*__: false
1390
1379
  * **docsDirectory** (<code>string</code>) Docs directory. __*Default*__: "docs"
@@ -1460,6 +1449,7 @@ new ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
1460
1449
  * **logging** (<code>[LoggerOptions](#projen-loggeroptions)</code>) Configure logging options such as verbosity. __*Default*__: {}
1461
1450
  * **outdir** (<code>string</code>) The root directory of the project. __*Default*__: "."
1462
1451
  * **parent** (<code>[Project](#projen-project)</code>) The parent project, if this project is part of a bigger project. __*Optional*__
1452
+ * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
1463
1453
  * **projenrcJson** (<code>boolean</code>) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
1464
1454
  * **projenrcJsonOptions** (<code>[json.ProjenrcOptions](#projen-json-projenrcoptions)</code>) Options for .projenrc.json. __*Default*__: default options
1465
1455
  * **autoApproveOptions** (<code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code>) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
@@ -1470,6 +1460,7 @@ new ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
1470
1460
  * **githubOptions** (<code>[github.GitHubOptions](#projen-github-githuboptions)</code>) Options for GitHub integration. __*Default*__: see GitHubOptions
1471
1461
  * **gitpod** (<code>boolean</code>) Add a Gitpod development environment. __*Default*__: false
1472
1462
  * **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
1463
+ * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
1473
1464
  * **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
1474
1465
  * **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
1475
1466
  * **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
@@ -1503,7 +1494,6 @@ new ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
1503
1494
  * **packageName** (<code>string</code>) The "name" in package.json. __*Default*__: defaults to project name
1504
1495
  * **peerDependencyOptions** (<code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code>) Options for `peerDeps`. __*Optional*__
1505
1496
  * **peerDeps** (<code>Array<string></code>) Peer dependencies for this module. __*Default*__: []
1506
- * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
1507
1497
  * **repository** (<code>string</code>) The repository is the location where the actual code for your package lives. __*Optional*__
1508
1498
  * **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*__
1509
1499
  * **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
@@ -1540,12 +1530,10 @@ new ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
1540
1530
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
1541
1531
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
1542
1532
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
1543
- * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
1544
1533
  * **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
1545
1534
  * **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
1546
1535
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
1547
1536
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
1548
- * **projenDuringBuild** (<code>boolean</code>) Execute `projen` as the first step of the `build` task to synthesize project files. __*Default*__: true
1549
1537
  * **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
1550
1538
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
1551
1539
  * **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
@@ -1560,7 +1548,6 @@ new ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
1560
1548
  * **workflowBootstrapSteps** (<code>Array<any></code>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
1561
1549
  * **workflowGitIdentity** (<code>[github.GitIdentity](#projen-github-gitidentity)</code>) The git identity to use in workflows. __*Default*__: GitHub Actions
1562
1550
  * **workflowNodeVersion** (<code>string</code>) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
1563
- * **compileBeforeTest** (<code>boolean</code>) Compile the code before running tests. __*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false`.
1564
1551
  * **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
1565
1552
  * **docgen** (<code>boolean</code>) Docgen by Typedoc. __*Default*__: false
1566
1553
  * **docsDirectory** (<code>string</code>) Docs directory. __*Default*__: "docs"
@@ -2058,6 +2045,7 @@ new GitHubProject(options: GitHubProjectOptions)
2058
2045
  * **logging** (<code>[LoggerOptions](#projen-loggeroptions)</code>) Configure logging options such as verbosity. __*Default*__: {}
2059
2046
  * **outdir** (<code>string</code>) The root directory of the project. __*Default*__: "."
2060
2047
  * **parent** (<code>[Project](#projen-project)</code>) The parent project, if this project is part of a bigger project. __*Optional*__
2048
+ * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
2061
2049
  * **projenrcJson** (<code>boolean</code>) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
2062
2050
  * **projenrcJsonOptions** (<code>[json.ProjenrcOptions](#projen-json-projenrcoptions)</code>) Options for .projenrc.json. __*Default*__: default options
2063
2051
  * **autoApproveOptions** (<code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code>) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
@@ -2068,6 +2056,7 @@ new GitHubProject(options: GitHubProjectOptions)
2068
2056
  * **githubOptions** (<code>[github.GitHubOptions](#projen-github-githuboptions)</code>) Options for GitHub integration. __*Default*__: see GitHubOptions
2069
2057
  * **gitpod** (<code>boolean</code>) Add a Gitpod development environment. __*Default*__: false
2070
2058
  * **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
2059
+ * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
2071
2060
  * **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
2072
2061
  * **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
2073
2062
  * **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
@@ -2532,6 +2521,7 @@ new JsiiProject(options: JsiiProjectOptions)
2532
2521
  * **logging** (<code>[LoggerOptions](#projen-loggeroptions)</code>) Configure logging options such as verbosity. __*Default*__: {}
2533
2522
  * **outdir** (<code>string</code>) The root directory of the project. __*Default*__: "."
2534
2523
  * **parent** (<code>[Project](#projen-project)</code>) The parent project, if this project is part of a bigger project. __*Optional*__
2524
+ * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
2535
2525
  * **projenrcJson** (<code>boolean</code>) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
2536
2526
  * **projenrcJsonOptions** (<code>[json.ProjenrcOptions](#projen-json-projenrcoptions)</code>) Options for .projenrc.json. __*Default*__: default options
2537
2527
  * **autoApproveOptions** (<code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code>) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
@@ -2542,6 +2532,7 @@ new JsiiProject(options: JsiiProjectOptions)
2542
2532
  * **githubOptions** (<code>[github.GitHubOptions](#projen-github-githuboptions)</code>) Options for GitHub integration. __*Default*__: see GitHubOptions
2543
2533
  * **gitpod** (<code>boolean</code>) Add a Gitpod development environment. __*Default*__: false
2544
2534
  * **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
2535
+ * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
2545
2536
  * **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
2546
2537
  * **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
2547
2538
  * **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
@@ -2575,7 +2566,6 @@ new JsiiProject(options: JsiiProjectOptions)
2575
2566
  * **packageName** (<code>string</code>) The "name" in package.json. __*Default*__: defaults to project name
2576
2567
  * **peerDependencyOptions** (<code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code>) Options for `peerDeps`. __*Optional*__
2577
2568
  * **peerDeps** (<code>Array<string></code>) Peer dependencies for this module. __*Default*__: []
2578
- * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
2579
2569
  * **repository** (<code>string</code>) The repository is the location where the actual code for your package lives. __*Optional*__
2580
2570
  * **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*__
2581
2571
  * **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
@@ -2612,12 +2602,10 @@ new JsiiProject(options: JsiiProjectOptions)
2612
2602
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
2613
2603
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
2614
2604
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
2615
- * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
2616
2605
  * **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
2617
2606
  * **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
2618
2607
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
2619
2608
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
2620
- * **projenDuringBuild** (<code>boolean</code>) Execute `projen` as the first step of the `build` task to synthesize project files. __*Default*__: true
2621
2609
  * **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
2622
2610
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
2623
2611
  * **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
@@ -2632,7 +2620,6 @@ new JsiiProject(options: JsiiProjectOptions)
2632
2620
  * **workflowBootstrapSteps** (<code>Array<any></code>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
2633
2621
  * **workflowGitIdentity** (<code>[github.GitIdentity](#projen-github-gitidentity)</code>) The git identity to use in workflows. __*Default*__: GitHub Actions
2634
2622
  * **workflowNodeVersion** (<code>string</code>) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
2635
- * **compileBeforeTest** (<code>boolean</code>) Compile the code before running tests. __*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false`.
2636
2623
  * **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
2637
2624
  * **docgen** (<code>boolean</code>) Docgen by Typedoc. __*Default*__: false
2638
2625
  * **docsDirectory** (<code>string</code>) Docs directory. __*Default*__: "docs"
@@ -3025,7 +3012,6 @@ new NodePackage(project: Project, options?: NodePackageOptions)
3025
3012
  * **packageName** (<code>string</code>) The "name" in package.json. __*Default*__: defaults to project name
3026
3013
  * **peerDependencyOptions** (<code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code>) Options for `peerDeps`. __*Optional*__
3027
3014
  * **peerDeps** (<code>Array<string></code>) Peer dependencies for this module. __*Default*__: []
3028
- * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
3029
3015
  * **repository** (<code>string</code>) The repository is the location where the actual code for your package lives. __*Optional*__
3030
3016
  * **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*__
3031
3017
  * **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
@@ -3050,7 +3036,7 @@ Name | Type | Description
3050
3036
  **npmRegistryUrl**🔹 | <code>string</code> | npm registry (e.g. `https://registry.npmjs.org`). Use `npmRegistryHost` to get just the host name.
3051
3037
  **packageManager**🔹 | <code>[NodePackageManager](#projen-nodepackagemanager)</code> | The package manager to use.
3052
3038
  **packageName**🔹 | <code>string</code> | The name of the npm package.
3053
- **projenCommand**🔹 | <code>string</code> | The command to use in order to run the projen CLI.
3039
+ **projenCommand**🔹 | <code>string</code> | The command which executes "projen".
3054
3040
  **codeArtifactOptions**?🔹 | <code>[CodeArtifactOptions](#projen-codeartifactoptions)</code> | Options for publishing npm package to AWS CodeArtifact.<br/>__*Default*__: undefined
3055
3041
  **license**?🔹 | <code>string</code> | The SPDX license of this module.<br/>__*Optional*__
3056
3042
  **maxNodeVersion**?🔹 | <code>string</code> | Maximum node version required by this pacakge.<br/>__*Default*__: no maximum.
@@ -3288,6 +3274,7 @@ new NodeProject(options: NodeProjectOptions)
3288
3274
  * **logging** (<code>[LoggerOptions](#projen-loggeroptions)</code>) Configure logging options such as verbosity. __*Default*__: {}
3289
3275
  * **outdir** (<code>string</code>) The root directory of the project. __*Default*__: "."
3290
3276
  * **parent** (<code>[Project](#projen-project)</code>) The parent project, if this project is part of a bigger project. __*Optional*__
3277
+ * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
3291
3278
  * **projenrcJson** (<code>boolean</code>) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
3292
3279
  * **projenrcJsonOptions** (<code>[json.ProjenrcOptions](#projen-json-projenrcoptions)</code>) Options for .projenrc.json. __*Default*__: default options
3293
3280
  * **autoApproveOptions** (<code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code>) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
@@ -3298,6 +3285,7 @@ new NodeProject(options: NodeProjectOptions)
3298
3285
  * **githubOptions** (<code>[github.GitHubOptions](#projen-github-githuboptions)</code>) Options for GitHub integration. __*Default*__: see GitHubOptions
3299
3286
  * **gitpod** (<code>boolean</code>) Add a Gitpod development environment. __*Default*__: false
3300
3287
  * **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
3288
+ * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
3301
3289
  * **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
3302
3290
  * **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
3303
3291
  * **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
@@ -3331,7 +3319,6 @@ new NodeProject(options: NodeProjectOptions)
3331
3319
  * **packageName** (<code>string</code>) The "name" in package.json. __*Default*__: defaults to project name
3332
3320
  * **peerDependencyOptions** (<code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code>) Options for `peerDeps`. __*Optional*__
3333
3321
  * **peerDeps** (<code>Array<string></code>) Peer dependencies for this module. __*Default*__: []
3334
- * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
3335
3322
  * **repository** (<code>string</code>) The repository is the location where the actual code for your package lives. __*Optional*__
3336
3323
  * **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*__
3337
3324
  * **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
@@ -3368,12 +3355,10 @@ new NodeProject(options: NodeProjectOptions)
3368
3355
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
3369
3356
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
3370
3357
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
3371
- * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
3372
3358
  * **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
3373
3359
  * **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
3374
3360
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
3375
3361
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
3376
- * **projenDuringBuild** (<code>boolean</code>) Execute `projen` as the first step of the `build` task to synthesize project files. __*Default*__: true
3377
3362
  * **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
3378
3363
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
3379
3364
  * **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
@@ -3398,9 +3383,7 @@ Name | Type | Description
3398
3383
  -----|------|-------------
3399
3384
  **allowLibraryDependencies**⚠️ | <code>boolean</code> | <span></span>
3400
3385
  **antitamper**🔹 | <code>boolean</code> | Indicates if workflows have anti-tamper checks.
3401
- **buildTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | The task responsible for a full release build.
3402
3386
  **bundler**🔹 | <code>[javascript.Bundler](#projen-javascript-bundler)</code> | <span></span>
3403
- **compileTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | Compiles the code.
3404
3387
  **entrypoint**⚠️ | <code>string</code> | <span></span>
3405
3388
  **installWorkflowSteps**🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | <span></span>
3406
3389
  **manifest**⚠️ | <code>any</code> | <span></span>
@@ -3408,9 +3391,7 @@ Name | Type | Description
3408
3391
  **npmRegistry**⚠️ | <code>string</code> | <span></span>
3409
3392
  **package**🔹 | <code>[NodePackage](#projen-nodepackage)</code> | API for managing the node package.
3410
3393
  **packageManager**⚠️ | <code>[NodePackageManager](#projen-nodepackagemanager)</code> | The package manager to use.
3411
- **projenCommand**🔹 | <code>string</code> | The command to use in order to run the projen CLI.
3412
3394
  **runScriptCommand**🔹 | <code>string</code> | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager).
3413
- **testTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | Tests the code.
3414
3395
  **autoMerge**?🔹 | <code>[github.AutoMerge](#projen-github-automerge)</code> | Automatic PR merges.<br/>__*Optional*__
3415
3396
  **buildWorkflow**?🔹 | <code>[github.TaskWorkflow](#projen-github-taskworkflow)</code> | The PR build GitHub workflow.<br/>__*Optional*__
3416
3397
  **buildWorkflowJobId**?🔹 | <code>string</code> | __*Optional*__
@@ -3437,19 +3418,6 @@ addBins(bins: Map<string, string>): void
3437
3418
 
3438
3419
 
3439
3420
 
3440
- #### addBuildCommand(...commands)⚠️ <a id="projen-nodeproject-addbuildcommand"></a>
3441
-
3442
- DEPRECATED.
3443
-
3444
- ```ts
3445
- addBuildCommand(...commands: string[]): void
3446
- ```
3447
-
3448
- * **commands** (<code>string</code>) *No description*
3449
-
3450
-
3451
-
3452
-
3453
3421
  #### addBundledDeps(...deps)🔹 <a id="projen-nodeproject-addbundleddeps"></a>
3454
3422
 
3455
3423
  Defines bundled dependencies.
@@ -3763,6 +3731,7 @@ new Project(options: ProjectOptions)
3763
3731
  * **logging** (<code>[LoggerOptions](#projen-loggeroptions)</code>) Configure logging options such as verbosity. __*Default*__: {}
3764
3732
  * **outdir** (<code>string</code>) The root directory of the project. __*Default*__: "."
3765
3733
  * **parent** (<code>[Project](#projen-project)</code>) The parent project, if this project is part of a bigger project. __*Optional*__
3734
+ * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
3766
3735
  * **projenrcJson** (<code>boolean</code>) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
3767
3736
  * **projenrcJsonOptions** (<code>[json.ProjenrcOptions](#projen-json-projenrcoptions)</code>) Options for .projenrc.json. __*Default*__: default options
3768
3737
 
@@ -3773,7 +3742,10 @@ new Project(options: ProjectOptions)
3773
3742
 
3774
3743
  Name | Type | Description
3775
3744
  -----|------|-------------
3745
+ **buildTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | <span></span>
3746
+ **compileTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | <span></span>
3776
3747
  **components**🔹 | <code>Array<[Component](#projen-component)></code> | Returns all the components within this project.
3748
+ **defaultTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | This is the "default" task, the one that executes "projen".
3777
3749
  **deps**🔹 | <code>[deps.Dependencies](#projen-deps-dependencies)</code> | Project dependencies.
3778
3750
  **files**🔹 | <code>Array<[FileBase](#projen-filebase)></code> | All files in this project.
3779
3751
  **gitattributes**🔹 | <code>[git.GitAttributesFile](#projen-git-gitattributesfile)</code> | The .gitattributes file for this repository.
@@ -3781,8 +3753,14 @@ Name | Type | Description
3781
3753
  **logger**🔹 | <code>[Logger](#projen-logger)</code> | Logging utilities.
3782
3754
  **name**🔹 | <code>string</code> | Project name.
3783
3755
  **outdir**🔹 | <code>string</code> | Absolute output directory of this project.
3756
+ **packageTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | <span></span>
3757
+ **postCompileTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | <span></span>
3758
+ **preCompileTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | <span></span>
3759
+ **projectBuild**🔹 | <code>[ProjectBuild](#projen-projectbuild)</code> | Manages the build process of the project.
3760
+ **projenCommand**🔹 | <code>string</code> | The command to use in order to run the projen CLI.
3784
3761
  **root**🔹 | <code>[Project](#projen-project)</code> | The root project.
3785
3762
  **tasks**🔹 | <code>[tasks.Tasks](#projen-tasks-tasks)</code> | Project tasks.
3763
+ **testTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | <span></span>
3786
3764
  **newProject**?🔹 | <code>[NewProject](#projen-newproject)</code> | The options used when this project is bootstrapped via `projen new`.<br/>__*Optional*__
3787
3765
  **parent**?🔹 | <code>[Project](#projen-project)</code> | A parent project.<br/>__*Optional*__
3788
3766
  *static* **DEFAULT_TASK**🔹 | <code>string</code> | The name of the default task (the task executed when `projen` is run without arguments).
@@ -4002,6 +3980,47 @@ __Returns__:
4002
3980
 
4003
3981
 
4004
3982
 
3983
+ ## class ProjectBuild 🔹 <a id="projen-projectbuild"></a>
3984
+
3985
+ Manages a standard build process for all projects.
3986
+
3987
+ Build spawns these tasks in order:
3988
+ 1. default
3989
+ 2. pre-compile
3990
+ 3. compile
3991
+ 4. post-compile
3992
+ 5. test
3993
+ 6. package
3994
+
3995
+ __Extends__: [Component](#projen-component)
3996
+
3997
+ ### Initializer
3998
+
3999
+
4000
+
4001
+
4002
+ ```ts
4003
+ new ProjectBuild(project: Project)
4004
+ ```
4005
+
4006
+ * **project** (<code>[Project](#projen-project)</code>) *No description*
4007
+
4008
+
4009
+
4010
+ ### Properties
4011
+
4012
+
4013
+ Name | Type | Description
4014
+ -----|------|-------------
4015
+ **buildTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | The task responsible for a full release build.
4016
+ **compileTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | Compiles the code.
4017
+ **packageTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | The "package" task.
4018
+ **postCompileTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | Post-compile task.
4019
+ **preCompileTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | Pre-compile task.
4020
+ **testTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | Tests the code.
4021
+
4022
+
4023
+
4005
4024
  ## class Projects 🔹 <a id="projen-projects"></a>
4006
4025
 
4007
4026
  Programmatic API for projen.
@@ -4419,6 +4438,7 @@ new TypeScriptAppProject(options: TypeScriptProjectOptions)
4419
4438
  * **logging** (<code>[LoggerOptions](#projen-loggeroptions)</code>) Configure logging options such as verbosity. __*Default*__: {}
4420
4439
  * **outdir** (<code>string</code>) The root directory of the project. __*Default*__: "."
4421
4440
  * **parent** (<code>[Project](#projen-project)</code>) The parent project, if this project is part of a bigger project. __*Optional*__
4441
+ * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
4422
4442
  * **projenrcJson** (<code>boolean</code>) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
4423
4443
  * **projenrcJsonOptions** (<code>[json.ProjenrcOptions](#projen-json-projenrcoptions)</code>) Options for .projenrc.json. __*Default*__: default options
4424
4444
  * **autoApproveOptions** (<code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code>) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
@@ -4429,6 +4449,7 @@ new TypeScriptAppProject(options: TypeScriptProjectOptions)
4429
4449
  * **githubOptions** (<code>[github.GitHubOptions](#projen-github-githuboptions)</code>) Options for GitHub integration. __*Default*__: see GitHubOptions
4430
4450
  * **gitpod** (<code>boolean</code>) Add a Gitpod development environment. __*Default*__: false
4431
4451
  * **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
4452
+ * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
4432
4453
  * **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
4433
4454
  * **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
4434
4455
  * **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
@@ -4462,7 +4483,6 @@ new TypeScriptAppProject(options: TypeScriptProjectOptions)
4462
4483
  * **packageName** (<code>string</code>) The "name" in package.json. __*Default*__: defaults to project name
4463
4484
  * **peerDependencyOptions** (<code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code>) Options for `peerDeps`. __*Optional*__
4464
4485
  * **peerDeps** (<code>Array<string></code>) Peer dependencies for this module. __*Default*__: []
4465
- * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
4466
4486
  * **repository** (<code>string</code>) The repository is the location where the actual code for your package lives. __*Optional*__
4467
4487
  * **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*__
4468
4488
  * **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
@@ -4499,12 +4519,10 @@ new TypeScriptAppProject(options: TypeScriptProjectOptions)
4499
4519
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
4500
4520
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
4501
4521
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
4502
- * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
4503
4522
  * **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
4504
4523
  * **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
4505
4524
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
4506
4525
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
4507
- * **projenDuringBuild** (<code>boolean</code>) Execute `projen` as the first step of the `build` task to synthesize project files. __*Default*__: true
4508
4526
  * **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
4509
4527
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
4510
4528
  * **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
@@ -4519,7 +4537,6 @@ new TypeScriptAppProject(options: TypeScriptProjectOptions)
4519
4537
  * **workflowBootstrapSteps** (<code>Array<any></code>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
4520
4538
  * **workflowGitIdentity** (<code>[github.GitIdentity](#projen-github-gitidentity)</code>) The git identity to use in workflows. __*Default*__: GitHub Actions
4521
4539
  * **workflowNodeVersion** (<code>string</code>) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
4522
- * **compileBeforeTest** (<code>boolean</code>) Compile the code before running tests. __*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false`.
4523
4540
  * **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
4524
4541
  * **docgen** (<code>boolean</code>) Docgen by Typedoc. __*Default*__: false
4525
4542
  * **docsDirectory** (<code>string</code>) Docs directory. __*Default*__: "docs"
@@ -4561,6 +4578,7 @@ new TypeScriptLibraryProject(options: TypeScriptProjectOptions)
4561
4578
  * **logging** (<code>[LoggerOptions](#projen-loggeroptions)</code>) Configure logging options such as verbosity. __*Default*__: {}
4562
4579
  * **outdir** (<code>string</code>) The root directory of the project. __*Default*__: "."
4563
4580
  * **parent** (<code>[Project](#projen-project)</code>) The parent project, if this project is part of a bigger project. __*Optional*__
4581
+ * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
4564
4582
  * **projenrcJson** (<code>boolean</code>) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
4565
4583
  * **projenrcJsonOptions** (<code>[json.ProjenrcOptions](#projen-json-projenrcoptions)</code>) Options for .projenrc.json. __*Default*__: default options
4566
4584
  * **autoApproveOptions** (<code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code>) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
@@ -4571,6 +4589,7 @@ new TypeScriptLibraryProject(options: TypeScriptProjectOptions)
4571
4589
  * **githubOptions** (<code>[github.GitHubOptions](#projen-github-githuboptions)</code>) Options for GitHub integration. __*Default*__: see GitHubOptions
4572
4590
  * **gitpod** (<code>boolean</code>) Add a Gitpod development environment. __*Default*__: false
4573
4591
  * **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
4592
+ * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
4574
4593
  * **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
4575
4594
  * **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
4576
4595
  * **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
@@ -4604,7 +4623,6 @@ new TypeScriptLibraryProject(options: TypeScriptProjectOptions)
4604
4623
  * **packageName** (<code>string</code>) The "name" in package.json. __*Default*__: defaults to project name
4605
4624
  * **peerDependencyOptions** (<code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code>) Options for `peerDeps`. __*Optional*__
4606
4625
  * **peerDeps** (<code>Array<string></code>) Peer dependencies for this module. __*Default*__: []
4607
- * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
4608
4626
  * **repository** (<code>string</code>) The repository is the location where the actual code for your package lives. __*Optional*__
4609
4627
  * **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*__
4610
4628
  * **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
@@ -4641,12 +4659,10 @@ new TypeScriptLibraryProject(options: TypeScriptProjectOptions)
4641
4659
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
4642
4660
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
4643
4661
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
4644
- * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
4645
4662
  * **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
4646
4663
  * **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
4647
4664
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
4648
4665
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
4649
- * **projenDuringBuild** (<code>boolean</code>) Execute `projen` as the first step of the `build` task to synthesize project files. __*Default*__: true
4650
4666
  * **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
4651
4667
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
4652
4668
  * **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
@@ -4661,7 +4677,6 @@ new TypeScriptLibraryProject(options: TypeScriptProjectOptions)
4661
4677
  * **workflowBootstrapSteps** (<code>Array<any></code>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
4662
4678
  * **workflowGitIdentity** (<code>[github.GitIdentity](#projen-github-gitidentity)</code>) The git identity to use in workflows. __*Default*__: GitHub Actions
4663
4679
  * **workflowNodeVersion** (<code>string</code>) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
4664
- * **compileBeforeTest** (<code>boolean</code>) Compile the code before running tests. __*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false`.
4665
4680
  * **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
4666
4681
  * **docgen** (<code>boolean</code>) Docgen by Typedoc. __*Default*__: false
4667
4682
  * **docsDirectory** (<code>string</code>) Docs directory. __*Default*__: "docs"
@@ -4703,6 +4718,7 @@ new TypeScriptProject(options: TypeScriptProjectOptions)
4703
4718
  * **logging** (<code>[LoggerOptions](#projen-loggeroptions)</code>) Configure logging options such as verbosity. __*Default*__: {}
4704
4719
  * **outdir** (<code>string</code>) The root directory of the project. __*Default*__: "."
4705
4720
  * **parent** (<code>[Project](#projen-project)</code>) The parent project, if this project is part of a bigger project. __*Optional*__
4721
+ * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
4706
4722
  * **projenrcJson** (<code>boolean</code>) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
4707
4723
  * **projenrcJsonOptions** (<code>[json.ProjenrcOptions](#projen-json-projenrcoptions)</code>) Options for .projenrc.json. __*Default*__: default options
4708
4724
  * **autoApproveOptions** (<code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code>) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
@@ -4713,6 +4729,7 @@ new TypeScriptProject(options: TypeScriptProjectOptions)
4713
4729
  * **githubOptions** (<code>[github.GitHubOptions](#projen-github-githuboptions)</code>) Options for GitHub integration. __*Default*__: see GitHubOptions
4714
4730
  * **gitpod** (<code>boolean</code>) Add a Gitpod development environment. __*Default*__: false
4715
4731
  * **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
4732
+ * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
4716
4733
  * **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
4717
4734
  * **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
4718
4735
  * **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
@@ -4746,7 +4763,6 @@ new TypeScriptProject(options: TypeScriptProjectOptions)
4746
4763
  * **packageName** (<code>string</code>) The "name" in package.json. __*Default*__: defaults to project name
4747
4764
  * **peerDependencyOptions** (<code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code>) Options for `peerDeps`. __*Optional*__
4748
4765
  * **peerDeps** (<code>Array<string></code>) Peer dependencies for this module. __*Default*__: []
4749
- * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
4750
4766
  * **repository** (<code>string</code>) The repository is the location where the actual code for your package lives. __*Optional*__
4751
4767
  * **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*__
4752
4768
  * **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
@@ -4783,12 +4799,10 @@ new TypeScriptProject(options: TypeScriptProjectOptions)
4783
4799
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
4784
4800
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
4785
4801
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
4786
- * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
4787
4802
  * **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
4788
4803
  * **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
4789
4804
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
4790
4805
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
4791
- * **projenDuringBuild** (<code>boolean</code>) Execute `projen` as the first step of the `build` task to synthesize project files. __*Default*__: true
4792
4806
  * **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
4793
4807
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
4794
4808
  * **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
@@ -4803,7 +4817,6 @@ new TypeScriptProject(options: TypeScriptProjectOptions)
4803
4817
  * **workflowBootstrapSteps** (<code>Array<any></code>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
4804
4818
  * **workflowGitIdentity** (<code>[github.GitIdentity](#projen-github-gitidentity)</code>) The git identity to use in workflows. __*Default*__: GitHub Actions
4805
4819
  * **workflowNodeVersion** (<code>string</code>) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
4806
- * **compileBeforeTest** (<code>boolean</code>) Compile the code before running tests. __*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false`.
4807
4820
  * **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
4808
4821
  * **docgen** (<code>boolean</code>) Docgen by Typedoc. __*Default*__: false
4809
4822
  * **docsDirectory** (<code>string</code>) Docs directory. __*Default*__: "docs"
@@ -4837,7 +4850,6 @@ Name | Type | Description
4837
4850
  **watchTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | The "watch" task.
4838
4851
  **docgen**?🔹 | <code>boolean</code> | __*Optional*__
4839
4852
  **eslint**?🔹 | <code>[Eslint](#projen-eslint)</code> | __*Optional*__
4840
- **packageTask**?🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | The "package" task (or undefined if `package` is set to `false`).<br/>__*Optional*__
4841
4853
  **tsconfig**?🔹 | <code>[TypescriptConfig](#projen-typescriptconfig)</code> | __*Optional*__
4842
4854
  **tsconfigEslint**?🔹 | <code>[TypescriptConfig](#projen-typescriptconfig)</code> | __*Optional*__
4843
4855
 
@@ -5188,6 +5200,7 @@ new awscdk.AwsCdkJavaApp(options: AwsCdkJavaAppOptions)
5188
5200
  * **logging** (<code>[LoggerOptions](#projen-loggeroptions)</code>) Configure logging options such as verbosity. __*Default*__: {}
5189
5201
  * **outdir** (<code>string</code>) The root directory of the project. __*Default*__: "."
5190
5202
  * **parent** (<code>[Project](#projen-project)</code>) The parent project, if this project is part of a bigger project. __*Optional*__
5203
+ * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
5191
5204
  * **projenrcJson** (<code>boolean</code>) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
5192
5205
  * **projenrcJsonOptions** (<code>[json.ProjenrcOptions](#projen-json-projenrcoptions)</code>) Options for .projenrc.json. __*Default*__: default options
5193
5206
  * **autoApproveOptions** (<code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code>) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
@@ -5198,6 +5211,7 @@ new awscdk.AwsCdkJavaApp(options: AwsCdkJavaAppOptions)
5198
5211
  * **githubOptions** (<code>[github.GitHubOptions](#projen-github-githuboptions)</code>) Options for GitHub integration. __*Default*__: see GitHubOptions
5199
5212
  * **gitpod** (<code>boolean</code>) Add a Gitpod development environment. __*Default*__: false
5200
5213
  * **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
5214
+ * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
5201
5215
  * **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
5202
5216
  * **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
5203
5217
  * **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
@@ -5696,6 +5710,7 @@ new github.GitHub(project: Project, options?: GitHubOptions)
5696
5710
  * **project** (<code>[Project](#projen-project)</code>) *No description*
5697
5711
  * **options** (<code>[github.GitHubOptions](#projen-github-githuboptions)</code>) *No description*
5698
5712
  * **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
5713
+ * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for Mergify. __*Default*__: default options
5699
5714
  * **workflows** (<code>boolean</code>) Enables GitHub workflows. __*Default*__: true
5700
5715
 
5701
5716
 
@@ -6037,6 +6052,7 @@ new java.JavaProject(options: JavaProjectOptions)
6037
6052
  * **logging** (<code>[LoggerOptions](#projen-loggeroptions)</code>) Configure logging options such as verbosity. __*Default*__: {}
6038
6053
  * **outdir** (<code>string</code>) The root directory of the project. __*Default*__: "."
6039
6054
  * **parent** (<code>[Project](#projen-project)</code>) The parent project, if this project is part of a bigger project. __*Optional*__
6055
+ * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
6040
6056
  * **projenrcJson** (<code>boolean</code>) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
6041
6057
  * **projenrcJsonOptions** (<code>[json.ProjenrcOptions](#projen-json-projenrcoptions)</code>) Options for .projenrc.json. __*Default*__: default options
6042
6058
  * **autoApproveOptions** (<code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code>) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
@@ -6047,6 +6063,7 @@ new java.JavaProject(options: JavaProjectOptions)
6047
6063
  * **githubOptions** (<code>[github.GitHubOptions](#projen-github-githuboptions)</code>) Options for GitHub integration. __*Default*__: see GitHubOptions
6048
6064
  * **gitpod** (<code>boolean</code>) Add a Gitpod development environment. __*Default*__: false
6049
6065
  * **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
6066
+ * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
6050
6067
  * **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
6051
6068
  * **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
6052
6069
  * **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
@@ -6077,7 +6094,6 @@ new java.JavaProject(options: JavaProjectOptions)
6077
6094
 
6078
6095
  Name | Type | Description
6079
6096
  -----|------|-------------
6080
- **buildTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | The primary build task.
6081
6097
  **compile**🔹 | <code>[java.MavenCompile](#projen-java-mavencompile)</code> | Compile component.
6082
6098
  **distdir**🔹 | <code>string</code> | Maven artifact output directory.
6083
6099
  **packaging**🔹 | <code>[java.MavenPackaging](#projen-java-mavenpackaging)</code> | Packaging component.
@@ -6186,14 +6202,6 @@ new java.MavenCompile(project: Project, pom: Pom, options?: MavenCompileOptions)
6186
6202
 
6187
6203
 
6188
6204
 
6189
- ### Properties
6190
-
6191
-
6192
- Name | Type | Description
6193
- -----|------|-------------
6194
- **compileTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | <span></span>
6195
-
6196
-
6197
6205
 
6198
6206
  ## class MavenPackaging 🔹 <a id="projen-java-mavenpackaging"></a>
6199
6207
 
@@ -6222,14 +6230,6 @@ new java.MavenPackaging(project: Project, pom: Pom, options?: MavenPackagingOpti
6222
6230
 
6223
6231
 
6224
6232
 
6225
- ### Properties
6226
-
6227
-
6228
- Name | Type | Description
6229
- -----|------|-------------
6230
- **task**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | The "package" task.
6231
-
6232
-
6233
6233
 
6234
6234
  ## class MavenSample 🔹 <a id="projen-java-mavensample"></a>
6235
6235
 
@@ -6418,13 +6418,12 @@ __Extends__: [Component](#projen-component)
6418
6418
  Creates a `Bundler`.
6419
6419
 
6420
6420
  ```ts
6421
- new javascript.Bundler(project: Project, options: BundlerOptions)
6421
+ new javascript.Bundler(project: Project, options?: BundlerOptions)
6422
6422
  ```
6423
6423
 
6424
6424
  * **project** (<code>[Project](#projen-project)</code>) *No description*
6425
6425
  * **options** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) *No description*
6426
6426
  * **esbuildVersion** (<code>string</code>) The semantic version requirement for `esbuild`. __*Default*__: no specific version (implies latest)
6427
- * **parentTask** (<code>[tasks.Task](#projen-tasks-task)</code>) A parent task that will spawn the "bundle" task (usually "compile").
6428
6427
 
6429
6428
 
6430
6429
 
@@ -6689,7 +6688,6 @@ new python.Poetry(project: PythonProject, options: PythonPackagingOptions)
6689
6688
  Name | Type | Description
6690
6689
  -----|------|-------------
6691
6690
  **installTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | A task that installs and updates dependencies.
6692
- **packageTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | A task that packages the project for distribution.
6693
6691
  **publishTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | A task that uploads the package to a package repository.
6694
6692
  **publishTestTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | A task that uploads the package to the Test PyPI repository.
6695
6693
 
@@ -6854,14 +6852,6 @@ new python.Pytest(project: PythonProject, options?: PytestOptions)
6854
6852
 
6855
6853
 
6856
6854
 
6857
- ### Properties
6858
-
6859
-
6860
- Name | Type | Description
6861
- -----|------|-------------
6862
- **testTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | <span></span>
6863
-
6864
-
6865
6855
 
6866
6856
  ## class PythonProject 🔹 <a id="projen-python-pythonproject"></a>
6867
6857
 
@@ -6885,6 +6875,7 @@ new python.PythonProject(options: PythonProjectOptions)
6885
6875
  * **logging** (<code>[LoggerOptions](#projen-loggeroptions)</code>) Configure logging options such as verbosity. __*Default*__: {}
6886
6876
  * **outdir** (<code>string</code>) The root directory of the project. __*Default*__: "."
6887
6877
  * **parent** (<code>[Project](#projen-project)</code>) The parent project, if this project is part of a bigger project. __*Optional*__
6878
+ * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
6888
6879
  * **projenrcJson** (<code>boolean</code>) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
6889
6880
  * **projenrcJsonOptions** (<code>[json.ProjenrcOptions](#projen-json-projenrcoptions)</code>) Options for .projenrc.json. __*Default*__: default options
6890
6881
  * **autoApproveOptions** (<code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code>) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
@@ -6895,6 +6886,7 @@ new python.PythonProject(options: PythonProjectOptions)
6895
6886
  * **githubOptions** (<code>[github.GitHubOptions](#projen-github-githuboptions)</code>) Options for GitHub integration. __*Default*__: see GitHubOptions
6896
6887
  * **gitpod** (<code>boolean</code>) Add a Gitpod development environment. __*Default*__: false
6897
6888
  * **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
6889
+ * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
6898
6890
  * **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
6899
6891
  * **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
6900
6892
  * **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
@@ -7146,7 +7138,6 @@ new python.Setuptools(project: PythonProject, options: PythonPackagingOptions)
7146
7138
 
7147
7139
  Name | Type | Description
7148
7140
  -----|------|-------------
7149
- **packageTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | A task that packages the project for distribution.
7150
7141
  **publishTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | A task that uploads the package to a package repository.
7151
7142
  **publishTestTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | A task that uploads the package to the Test PyPI repository.
7152
7143
 
@@ -7647,6 +7638,18 @@ exec(command: string, options?: TaskStepOptions): void
7647
7638
 
7648
7639
 
7649
7640
 
7641
+ #### lock()🔹 <a id="projen-tasks-task-lock"></a>
7642
+
7643
+ Forbid additional changes to this task.
7644
+
7645
+ ```ts
7646
+ lock(): void
7647
+ ```
7648
+
7649
+
7650
+
7651
+
7652
+
7650
7653
  #### prepend(shell, options?)⚠️ <a id="projen-tasks-task-prepend"></a>
7651
7654
 
7652
7655
  Adds a command at the beginning of the task.
@@ -8176,6 +8179,7 @@ new web.NextJsProject(options: NextJsProjectOptions)
8176
8179
  * **logging** (<code>[LoggerOptions](#projen-loggeroptions)</code>) Configure logging options such as verbosity. __*Default*__: {}
8177
8180
  * **outdir** (<code>string</code>) The root directory of the project. __*Default*__: "."
8178
8181
  * **parent** (<code>[Project](#projen-project)</code>) The parent project, if this project is part of a bigger project. __*Optional*__
8182
+ * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
8179
8183
  * **projenrcJson** (<code>boolean</code>) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
8180
8184
  * **projenrcJsonOptions** (<code>[json.ProjenrcOptions](#projen-json-projenrcoptions)</code>) Options for .projenrc.json. __*Default*__: default options
8181
8185
  * **autoApproveOptions** (<code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code>) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
@@ -8186,6 +8190,7 @@ new web.NextJsProject(options: NextJsProjectOptions)
8186
8190
  * **githubOptions** (<code>[github.GitHubOptions](#projen-github-githuboptions)</code>) Options for GitHub integration. __*Default*__: see GitHubOptions
8187
8191
  * **gitpod** (<code>boolean</code>) Add a Gitpod development environment. __*Default*__: false
8188
8192
  * **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
8193
+ * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
8189
8194
  * **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
8190
8195
  * **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
8191
8196
  * **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
@@ -8219,7 +8224,6 @@ new web.NextJsProject(options: NextJsProjectOptions)
8219
8224
  * **packageName** (<code>string</code>) The "name" in package.json. __*Default*__: defaults to project name
8220
8225
  * **peerDependencyOptions** (<code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code>) Options for `peerDeps`. __*Optional*__
8221
8226
  * **peerDeps** (<code>Array<string></code>) Peer dependencies for this module. __*Default*__: []
8222
- * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
8223
8227
  * **repository** (<code>string</code>) The repository is the location where the actual code for your package lives. __*Optional*__
8224
8228
  * **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*__
8225
8229
  * **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
@@ -8256,12 +8260,10 @@ new web.NextJsProject(options: NextJsProjectOptions)
8256
8260
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
8257
8261
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
8258
8262
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
8259
- * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
8260
8263
  * **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
8261
8264
  * **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
8262
8265
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
8263
8266
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
8264
- * **projenDuringBuild** (<code>boolean</code>) Execute `projen` as the first step of the `build` task to synthesize project files. __*Default*__: true
8265
8267
  * **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
8266
8268
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
8267
8269
  * **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
@@ -8316,6 +8318,7 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
8316
8318
  * **logging** (<code>[LoggerOptions](#projen-loggeroptions)</code>) Configure logging options such as verbosity. __*Default*__: {}
8317
8319
  * **outdir** (<code>string</code>) The root directory of the project. __*Default*__: "."
8318
8320
  * **parent** (<code>[Project](#projen-project)</code>) The parent project, if this project is part of a bigger project. __*Optional*__
8321
+ * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
8319
8322
  * **projenrcJson** (<code>boolean</code>) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
8320
8323
  * **projenrcJsonOptions** (<code>[json.ProjenrcOptions](#projen-json-projenrcoptions)</code>) Options for .projenrc.json. __*Default*__: default options
8321
8324
  * **autoApproveOptions** (<code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code>) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
@@ -8326,6 +8329,7 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
8326
8329
  * **githubOptions** (<code>[github.GitHubOptions](#projen-github-githuboptions)</code>) Options for GitHub integration. __*Default*__: see GitHubOptions
8327
8330
  * **gitpod** (<code>boolean</code>) Add a Gitpod development environment. __*Default*__: false
8328
8331
  * **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
8332
+ * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
8329
8333
  * **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
8330
8334
  * **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
8331
8335
  * **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
@@ -8359,7 +8363,6 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
8359
8363
  * **packageName** (<code>string</code>) The "name" in package.json. __*Default*__: defaults to project name
8360
8364
  * **peerDependencyOptions** (<code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code>) Options for `peerDeps`. __*Optional*__
8361
8365
  * **peerDeps** (<code>Array<string></code>) Peer dependencies for this module. __*Default*__: []
8362
- * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
8363
8366
  * **repository** (<code>string</code>) The repository is the location where the actual code for your package lives. __*Optional*__
8364
8367
  * **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*__
8365
8368
  * **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
@@ -8396,12 +8399,10 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
8396
8399
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
8397
8400
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
8398
8401
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
8399
- * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
8400
8402
  * **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
8401
8403
  * **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
8402
8404
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
8403
8405
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
8404
- * **projenDuringBuild** (<code>boolean</code>) Execute `projen` as the first step of the `build` task to synthesize project files. __*Default*__: true
8405
8406
  * **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
8406
8407
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
8407
8408
  * **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
@@ -8416,7 +8417,6 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
8416
8417
  * **workflowBootstrapSteps** (<code>Array<any></code>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
8417
8418
  * **workflowGitIdentity** (<code>[github.GitIdentity](#projen-github-gitidentity)</code>) The git identity to use in workflows. __*Default*__: GitHub Actions
8418
8419
  * **workflowNodeVersion** (<code>string</code>) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
8419
- * **compileBeforeTest** (<code>boolean</code>) Compile the code before running tests. __*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false`.
8420
8420
  * **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
8421
8421
  * **docgen** (<code>boolean</code>) Docgen by Typedoc. __*Default*__: false
8422
8422
  * **docsDirectory** (<code>string</code>) Docs directory. __*Default*__: "docs"
@@ -8530,6 +8530,7 @@ new web.ReactProject(options: ReactProjectOptions)
8530
8530
  * **logging** (<code>[LoggerOptions](#projen-loggeroptions)</code>) Configure logging options such as verbosity. __*Default*__: {}
8531
8531
  * **outdir** (<code>string</code>) The root directory of the project. __*Default*__: "."
8532
8532
  * **parent** (<code>[Project](#projen-project)</code>) The parent project, if this project is part of a bigger project. __*Optional*__
8533
+ * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
8533
8534
  * **projenrcJson** (<code>boolean</code>) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
8534
8535
  * **projenrcJsonOptions** (<code>[json.ProjenrcOptions](#projen-json-projenrcoptions)</code>) Options for .projenrc.json. __*Default*__: default options
8535
8536
  * **autoApproveOptions** (<code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code>) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
@@ -8540,6 +8541,7 @@ new web.ReactProject(options: ReactProjectOptions)
8540
8541
  * **githubOptions** (<code>[github.GitHubOptions](#projen-github-githuboptions)</code>) Options for GitHub integration. __*Default*__: see GitHubOptions
8541
8542
  * **gitpod** (<code>boolean</code>) Add a Gitpod development environment. __*Default*__: false
8542
8543
  * **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
8544
+ * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
8543
8545
  * **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
8544
8546
  * **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
8545
8547
  * **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
@@ -8573,7 +8575,6 @@ new web.ReactProject(options: ReactProjectOptions)
8573
8575
  * **packageName** (<code>string</code>) The "name" in package.json. __*Default*__: defaults to project name
8574
8576
  * **peerDependencyOptions** (<code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code>) Options for `peerDeps`. __*Optional*__
8575
8577
  * **peerDeps** (<code>Array<string></code>) Peer dependencies for this module. __*Default*__: []
8576
- * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
8577
8578
  * **repository** (<code>string</code>) The repository is the location where the actual code for your package lives. __*Optional*__
8578
8579
  * **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*__
8579
8580
  * **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
@@ -8610,12 +8611,10 @@ new web.ReactProject(options: ReactProjectOptions)
8610
8611
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
8611
8612
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
8612
8613
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
8613
- * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
8614
8614
  * **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
8615
8615
  * **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
8616
8616
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
8617
8617
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
8618
- * **projenDuringBuild** (<code>boolean</code>) Execute `projen` as the first step of the `build` task to synthesize project files. __*Default*__: true
8619
8618
  * **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
8620
8619
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
8621
8620
  * **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
@@ -8711,6 +8710,7 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
8711
8710
  * **logging** (<code>[LoggerOptions](#projen-loggeroptions)</code>) Configure logging options such as verbosity. __*Default*__: {}
8712
8711
  * **outdir** (<code>string</code>) The root directory of the project. __*Default*__: "."
8713
8712
  * **parent** (<code>[Project](#projen-project)</code>) The parent project, if this project is part of a bigger project. __*Optional*__
8713
+ * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
8714
8714
  * **projenrcJson** (<code>boolean</code>) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
8715
8715
  * **projenrcJsonOptions** (<code>[json.ProjenrcOptions](#projen-json-projenrcoptions)</code>) Options for .projenrc.json. __*Default*__: default options
8716
8716
  * **autoApproveOptions** (<code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code>) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
@@ -8721,6 +8721,7 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
8721
8721
  * **githubOptions** (<code>[github.GitHubOptions](#projen-github-githuboptions)</code>) Options for GitHub integration. __*Default*__: see GitHubOptions
8722
8722
  * **gitpod** (<code>boolean</code>) Add a Gitpod development environment. __*Default*__: false
8723
8723
  * **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
8724
+ * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
8724
8725
  * **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
8725
8726
  * **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
8726
8727
  * **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
@@ -8754,7 +8755,6 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
8754
8755
  * **packageName** (<code>string</code>) The "name" in package.json. __*Default*__: defaults to project name
8755
8756
  * **peerDependencyOptions** (<code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code>) Options for `peerDeps`. __*Optional*__
8756
8757
  * **peerDeps** (<code>Array<string></code>) Peer dependencies for this module. __*Default*__: []
8757
- * **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
8758
8758
  * **repository** (<code>string</code>) The repository is the location where the actual code for your package lives. __*Optional*__
8759
8759
  * **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*__
8760
8760
  * **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
@@ -8791,12 +8791,10 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
8791
8791
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
8792
8792
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
8793
8793
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
8794
- * **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
8795
8794
  * **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
8796
8795
  * **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
8797
8796
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
8798
8797
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
8799
- * **projenDuringBuild** (<code>boolean</code>) Execute `projen` as the first step of the `build` task to synthesize project files. __*Default*__: true
8800
8798
  * **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
8801
8799
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
8802
8800
  * **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
@@ -8811,7 +8809,6 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
8811
8809
  * **workflowBootstrapSteps** (<code>Array<any></code>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
8812
8810
  * **workflowGitIdentity** (<code>[github.GitIdentity](#projen-github-gitidentity)</code>) The git identity to use in workflows. __*Default*__: GitHub Actions
8813
8811
  * **workflowNodeVersion** (<code>string</code>) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
8814
- * **compileBeforeTest** (<code>boolean</code>) Compile the code before running tests. __*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false`.
8815
8812
  * **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
8816
8813
  * **docgen** (<code>boolean</code>) Docgen by Typedoc. __*Default*__: false
8817
8814
  * **docsDirectory** (<code>string</code>) Docs directory. __*Default*__: "docs"
@@ -8921,7 +8918,6 @@ Name | Type | Description
8921
8918
  **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.<br/>__*Default*__: if this option is not specified, only public repositories are supported
8922
8919
  **compat**?🔹 | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation.<br/>__*Default*__: false
8923
8920
  **compatIgnore**?🔹 | <code>string</code> | Name of the ignore file for API compatibility tests.<br/>__*Default*__: ".compatignore"
8924
- **compileBeforeTest**?🔹 | <code>boolean</code> | Compile the code before running tests.<br/>__*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false`.
8925
8921
  **constructsVersion**?🔹 | <code>string</code> | Minimum target version of constructs being tested against. If not provided, the default value depends on the configured `cdkVersion`:.<br/>__*Default*__: When the default behavior is used, the dependency on `constructs` will only be added as a `peerDependency`. Otherwise, a `devDependency` will also be added, set to the exact version configrued here.
8926
8922
  **copyrightOwner**?🔹 | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
8927
8923
  **copyrightPeriod**?🔹 | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
@@ -8960,7 +8956,7 @@ Name | Type | Description
8960
8956
  **majorVersion**?🔹 | <code>number</code> | Major version to release from the default branch.<br/>__*Default*__: Major version is not enforced.
8961
8957
  **maxNodeVersion**?🔹 | <code>string</code> | Minimum node.js version to require via `engines` (inclusive).<br/>__*Default*__: no max
8962
8958
  **mergify**?⚠️ | <code>boolean</code> | Whether mergify should be enabled on this repository or not.<br/>__*Default*__: true
8963
- **mergifyOptions**?🔹 | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
8959
+ **mergifyOptions**?⚠️ | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
8964
8960
  **minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
8965
8961
  **mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
8966
8962
  **npmAccess**?🔹 | <code>[NpmAccess](#projen-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
@@ -8982,7 +8978,6 @@ Name | Type | Description
8982
8978
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
8983
8979
  **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
8984
8980
  **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
8985
- **projenDuringBuild**?🔹 | <code>boolean</code> | Execute `projen` as the first step of the `build` task to synthesize project files.<br/>__*Default*__: true
8986
8981
  **projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
8987
8982
  **projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
8988
8983
  **projenUpgradeSecret**?🔹 | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
@@ -9071,7 +9066,6 @@ Name | Type | Description
9071
9066
  **codeArtifactOptions**?🔹 | <code>[CodeArtifactOptions](#projen-codeartifactoptions)</code> | Options for publishing npm package to AWS CodeArtifact.<br/>__*Default*__: undefined
9072
9067
  **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.<br/>__*Default*__: false
9073
9068
  **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.<br/>__*Default*__: if this option is not specified, only public repositories are supported
9074
- **compileBeforeTest**?🔹 | <code>boolean</code> | Compile the code before running tests.<br/>__*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false`.
9075
9069
  **context**?🔹 | <code>Map<string, string></code> | Additional context to include in `cdk.json`.<br/>__*Default*__: no additional context
9076
9070
  **copyrightOwner**?🔹 | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
9077
9071
  **copyrightPeriod**?🔹 | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
@@ -9109,7 +9103,7 @@ Name | Type | Description
9109
9103
  **majorVersion**?🔹 | <code>number</code> | Major version to release from the default branch.<br/>__*Default*__: Major version is not enforced.
9110
9104
  **maxNodeVersion**?🔹 | <code>string</code> | Minimum node.js version to require via `engines` (inclusive).<br/>__*Default*__: no max
9111
9105
  **mergify**?⚠️ | <code>boolean</code> | Whether mergify should be enabled on this repository or not.<br/>__*Default*__: true
9112
- **mergifyOptions**?🔹 | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
9106
+ **mergifyOptions**?⚠️ | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
9113
9107
  **minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
9114
9108
  **mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
9115
9109
  **npmAccess**?🔹 | <code>[NpmAccess](#projen-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
@@ -9131,7 +9125,6 @@ Name | Type | Description
9131
9125
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
9132
9126
  **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
9133
9127
  **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
9134
- **projenDuringBuild**?🔹 | <code>boolean</code> | Execute `projen` as the first step of the `build` task to synthesize project files.<br/>__*Default*__: true
9135
9128
  **projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
9136
9129
  **projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
9137
9130
  **projenUpgradeSecret**?🔹 | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
@@ -9231,7 +9224,6 @@ Name | Type | Description
9231
9224
  **codeArtifactOptions**?🔹 | <code>[CodeArtifactOptions](#projen-codeartifactoptions)</code> | Options for publishing npm package to AWS CodeArtifact.<br/>__*Default*__: undefined
9232
9225
  **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.<br/>__*Default*__: false
9233
9226
  **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.<br/>__*Default*__: if this option is not specified, only public repositories are supported
9234
- **compileBeforeTest**?🔹 | <code>boolean</code> | Compile the code before running tests.<br/>__*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false`.
9235
9227
  **constructsVersion**?🔹 | <code>string</code> | constructs verion.<br/>__*Default*__: "3.2.34"
9236
9228
  **constructsVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for constructs.<br/>__*Default*__: false
9237
9229
  **copyrightOwner**?🔹 | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
@@ -9267,7 +9259,7 @@ Name | Type | Description
9267
9259
  **majorVersion**?🔹 | <code>number</code> | Major version to release from the default branch.<br/>__*Default*__: Major version is not enforced.
9268
9260
  **maxNodeVersion**?🔹 | <code>string</code> | Minimum node.js version to require via `engines` (inclusive).<br/>__*Default*__: no max
9269
9261
  **mergify**?⚠️ | <code>boolean</code> | Whether mergify should be enabled on this repository or not.<br/>__*Default*__: true
9270
- **mergifyOptions**?🔹 | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
9262
+ **mergifyOptions**?⚠️ | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
9271
9263
  **minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
9272
9264
  **mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
9273
9265
  **npmAccess**?🔹 | <code>[NpmAccess](#projen-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
@@ -9289,7 +9281,6 @@ Name | Type | Description
9289
9281
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
9290
9282
  **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
9291
9283
  **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
9292
- **projenDuringBuild**?🔹 | <code>boolean</code> | Execute `projen` as the first step of the `build` task to synthesize project files.<br/>__*Default*__: true
9293
9284
  **projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
9294
9285
  **projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
9295
9286
  **projenUpgradeSecret**?🔹 | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
@@ -9393,7 +9384,6 @@ Name | Type | Description
9393
9384
  **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.<br/>__*Default*__: if this option is not specified, only public repositories are supported
9394
9385
  **compat**?⚠️ | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation.<br/>__*Default*__: false
9395
9386
  **compatIgnore**?⚠️ | <code>string</code> | Name of the ignore file for API compatibility tests.<br/>__*Default*__: ".compatignore"
9396
- **compileBeforeTest**?⚠️ | <code>boolean</code> | Compile the code before running tests.<br/>__*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false`.
9397
9387
  **constructsVersion**?⚠️ | <code>string</code> | Minimum target version of constructs being tested against. If not provided, the default value depends on the configured `cdkVersion`:.<br/>__*Default*__: When the default behavior is used, the dependency on `constructs` will only be added as a `peerDependency`. Otherwise, a `devDependency` will also be added, set to the exact version configrued here.
9398
9388
  **copyrightOwner**?⚠️ | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
9399
9389
  **copyrightPeriod**?⚠️ | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
@@ -9454,7 +9444,6 @@ Name | Type | Description
9454
9444
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
9455
9445
  **projenCommand**?⚠️ | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
9456
9446
  **projenDevDependency**?⚠️ | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
9457
- **projenDuringBuild**?⚠️ | <code>boolean</code> | Execute `projen` as the first step of the `build` task to synthesize project files.<br/>__*Default*__: true
9458
9447
  **projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
9459
9448
  **projenUpgradeSchedule**?⚠️ | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
9460
9449
  **projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
@@ -9548,7 +9537,6 @@ Name | Type | Description
9548
9537
  **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.<br/>__*Default*__: if this option is not specified, only public repositories are supported
9549
9538
  **compat**?🔹 | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation.<br/>__*Default*__: false
9550
9539
  **compatIgnore**?🔹 | <code>string</code> | Name of the ignore file for API compatibility tests.<br/>__*Default*__: ".compatignore"
9551
- **compileBeforeTest**?🔹 | <code>boolean</code> | Compile the code before running tests.<br/>__*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false`.
9552
9540
  **constructsVersion**?🔹 | <code>string</code> | constructs verion.<br/>__*Default*__: "3.2.34"
9553
9541
  **constructsVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for constructs.<br/>__*Default*__: false
9554
9542
  **copyrightOwner**?🔹 | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
@@ -9586,7 +9574,7 @@ Name | Type | Description
9586
9574
  **majorVersion**?🔹 | <code>number</code> | Major version to release from the default branch.<br/>__*Default*__: Major version is not enforced.
9587
9575
  **maxNodeVersion**?🔹 | <code>string</code> | Minimum node.js version to require via `engines` (inclusive).<br/>__*Default*__: no max
9588
9576
  **mergify**?⚠️ | <code>boolean</code> | Whether mergify should be enabled on this repository or not.<br/>__*Default*__: true
9589
- **mergifyOptions**?🔹 | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
9577
+ **mergifyOptions**?⚠️ | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
9590
9578
  **minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
9591
9579
  **mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
9592
9580
  **npmAccess**?🔹 | <code>[NpmAccess](#projen-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
@@ -9608,7 +9596,6 @@ Name | Type | Description
9608
9596
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
9609
9597
  **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
9610
9598
  **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
9611
- **projenDuringBuild**?🔹 | <code>boolean</code> | Execute `projen` as the first step of the `build` task to synthesize project files.<br/>__*Default*__: true
9612
9599
  **projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
9613
9600
  **projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
9614
9601
  **projenUpgradeSecret**?🔹 | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
@@ -9699,7 +9686,6 @@ Name | Type | Description
9699
9686
  **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.<br/>__*Default*__: if this option is not specified, only public repositories are supported
9700
9687
  **compat**?🔹 | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation.<br/>__*Default*__: false
9701
9688
  **compatIgnore**?🔹 | <code>string</code> | Name of the ignore file for API compatibility tests.<br/>__*Default*__: ".compatignore"
9702
- **compileBeforeTest**?🔹 | <code>boolean</code> | Compile the code before running tests.<br/>__*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false`.
9703
9689
  **copyrightOwner**?🔹 | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
9704
9690
  **copyrightPeriod**?🔹 | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
9705
9691
  **dependabot**?🔹 | <code>boolean</code> | Use dependabot to handle dependency upgrades.<br/>__*Default*__: false
@@ -9735,7 +9721,7 @@ Name | Type | Description
9735
9721
  **majorVersion**?🔹 | <code>number</code> | Major version to release from the default branch.<br/>__*Default*__: Major version is not enforced.
9736
9722
  **maxNodeVersion**?🔹 | <code>string</code> | Minimum node.js version to require via `engines` (inclusive).<br/>__*Default*__: no max
9737
9723
  **mergify**?⚠️ | <code>boolean</code> | Whether mergify should be enabled on this repository or not.<br/>__*Default*__: true
9738
- **mergifyOptions**?🔹 | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
9724
+ **mergifyOptions**?⚠️ | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
9739
9725
  **minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
9740
9726
  **mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
9741
9727
  **npmAccess**?🔹 | <code>[NpmAccess](#projen-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
@@ -9757,7 +9743,6 @@ Name | Type | Description
9757
9743
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
9758
9744
  **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
9759
9745
  **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
9760
- **projenDuringBuild**?🔹 | <code>boolean</code> | Execute `projen` as the first step of the `build` task to synthesize project files.<br/>__*Default*__: true
9761
9746
  **projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
9762
9747
  **projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
9763
9748
  **projenUpgradeSecret**?🔹 | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
@@ -9847,7 +9832,6 @@ Name | Type | Description
9847
9832
  **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.<br/>__*Default*__: if this option is not specified, only public repositories are supported
9848
9833
  **compat**?🔹 | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation.<br/>__*Default*__: false
9849
9834
  **compatIgnore**?🔹 | <code>string</code> | Name of the ignore file for API compatibility tests.<br/>__*Default*__: ".compatignore"
9850
- **compileBeforeTest**?🔹 | <code>boolean</code> | Compile the code before running tests.<br/>__*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false`.
9851
9835
  **copyrightOwner**?🔹 | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
9852
9836
  **copyrightPeriod**?🔹 | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
9853
9837
  **dependabot**?🔹 | <code>boolean</code> | Use dependabot to handle dependency upgrades.<br/>__*Default*__: false
@@ -9883,7 +9867,7 @@ Name | Type | Description
9883
9867
  **majorVersion**?🔹 | <code>number</code> | Major version to release from the default branch.<br/>__*Default*__: Major version is not enforced.
9884
9868
  **maxNodeVersion**?🔹 | <code>string</code> | Minimum node.js version to require via `engines` (inclusive).<br/>__*Default*__: no max
9885
9869
  **mergify**?⚠️ | <code>boolean</code> | Whether mergify should be enabled on this repository or not.<br/>__*Default*__: true
9886
- **mergifyOptions**?🔹 | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
9870
+ **mergifyOptions**?⚠️ | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
9887
9871
  **minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
9888
9872
  **mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
9889
9873
  **npmAccess**?🔹 | <code>[NpmAccess](#projen-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
@@ -9905,7 +9889,6 @@ Name | Type | Description
9905
9889
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
9906
9890
  **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
9907
9891
  **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
9908
- **projenDuringBuild**?🔹 | <code>boolean</code> | Execute `projen` as the first step of the `build` task to synthesize project files.<br/>__*Default*__: true
9909
9892
  **projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
9910
9893
  **projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
9911
9894
  **projenUpgradeSecret**?🔹 | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
@@ -10189,9 +10172,11 @@ Name | Type | Description
10189
10172
  **gitpod**?🔹 | <code>boolean</code> | Add a Gitpod development environment.<br/>__*Default*__: false
10190
10173
  **logging**?🔹 | <code>[LoggerOptions](#projen-loggeroptions)</code> | Configure logging options such as verbosity.<br/>__*Default*__: {}
10191
10174
  **mergify**?⚠️ | <code>boolean</code> | Whether mergify should be enabled on this repository or not.<br/>__*Default*__: true
10175
+ **mergifyOptions**?⚠️ | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
10192
10176
  **outdir**?🔹 | <code>string</code> | The root directory of the project.<br/>__*Default*__: "."
10193
10177
  **parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
10194
10178
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
10179
+ **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
10195
10180
  **projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
10196
10181
  **projenrcJsonOptions**?🔹 | <code>[json.ProjenrcOptions](#projen-json-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
10197
10182
  **readme**?🔹 | <code>[SampleReadmeProps](#projen-samplereadmeprops)</code> | The README setup.<br/>__*Default*__: { filename: 'README.md', contents: '# replace this' }
@@ -10681,7 +10666,6 @@ Name | Type | Description
10681
10666
  **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.<br/>__*Default*__: if this option is not specified, only public repositories are supported
10682
10667
  **compat**?🔹 | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation.<br/>__*Default*__: false
10683
10668
  **compatIgnore**?🔹 | <code>string</code> | Name of the ignore file for API compatibility tests.<br/>__*Default*__: ".compatignore"
10684
- **compileBeforeTest**?🔹 | <code>boolean</code> | Compile the code before running tests.<br/>__*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false`.
10685
10669
  **copyrightOwner**?🔹 | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
10686
10670
  **copyrightPeriod**?🔹 | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
10687
10671
  **dependabot**?🔹 | <code>boolean</code> | Use dependabot to handle dependency upgrades.<br/>__*Default*__: false
@@ -10717,7 +10701,7 @@ Name | Type | Description
10717
10701
  **majorVersion**?🔹 | <code>number</code> | Major version to release from the default branch.<br/>__*Default*__: Major version is not enforced.
10718
10702
  **maxNodeVersion**?🔹 | <code>string</code> | Minimum node.js version to require via `engines` (inclusive).<br/>__*Default*__: no max
10719
10703
  **mergify**?⚠️ | <code>boolean</code> | Whether mergify should be enabled on this repository or not.<br/>__*Default*__: true
10720
- **mergifyOptions**?🔹 | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
10704
+ **mergifyOptions**?⚠️ | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
10721
10705
  **minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
10722
10706
  **mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
10723
10707
  **npmAccess**?🔹 | <code>[NpmAccess](#projen-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
@@ -10739,7 +10723,6 @@ Name | Type | Description
10739
10723
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
10740
10724
  **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
10741
10725
  **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
10742
- **projenDuringBuild**?🔹 | <code>boolean</code> | Execute `projen` as the first step of the `build` task to synthesize project files.<br/>__*Default*__: true
10743
10726
  **projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
10744
10727
  **projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
10745
10728
  **projenUpgradeSecret**?🔹 | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
@@ -10930,7 +10913,6 @@ Name | Type | Description
10930
10913
  **packageName**?🔹 | <code>string</code> | The "name" in package.json.<br/>__*Default*__: defaults to project name
10931
10914
  **peerDependencyOptions**?🔹 | <code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code> | Options for `peerDeps`.<br/>__*Optional*__
10932
10915
  **peerDeps**?🔹 | <code>Array<string></code> | Peer dependencies for this module.<br/>__*Default*__: []
10933
- **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
10934
10916
  **repository**?🔹 | <code>string</code> | The repository is the location where the actual code for your package lives.<br/>__*Optional*__
10935
10917
  **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.<br/>__*Optional*__
10936
10918
  **scripts**?🔹 | <code>Map<string, string></code> | npm scripts to include.<br/>__*Default*__: {}
@@ -10995,7 +10977,7 @@ Name | Type | Description
10995
10977
  **majorVersion**?🔹 | <code>number</code> | Major version to release from the default branch.<br/>__*Default*__: Major version is not enforced.
10996
10978
  **maxNodeVersion**?🔹 | <code>string</code> | Minimum node.js version to require via `engines` (inclusive).<br/>__*Default*__: no max
10997
10979
  **mergify**?⚠️ | <code>boolean</code> | Whether mergify should be enabled on this repository or not.<br/>__*Default*__: true
10998
- **mergifyOptions**?🔹 | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
10980
+ **mergifyOptions**?⚠️ | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
10999
10981
  **minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
11000
10982
  **mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
11001
10983
  **npmAccess**?🔹 | <code>[NpmAccess](#projen-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
@@ -11016,7 +10998,6 @@ Name | Type | Description
11016
10998
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
11017
10999
  **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
11018
11000
  **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
11019
- **projenDuringBuild**?🔹 | <code>boolean</code> | Execute `projen` as the first step of the `build` task to synthesize project files.<br/>__*Default*__: true
11020
11001
  **projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
11021
11002
  **projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
11022
11003
  **projenUpgradeSecret**?🔹 | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
@@ -11113,6 +11094,7 @@ Name | Type | Description
11113
11094
  **logging**?🔹 | <code>[LoggerOptions](#projen-loggeroptions)</code> | Configure logging options such as verbosity.<br/>__*Default*__: {}
11114
11095
  **outdir**?🔹 | <code>string</code> | The root directory of the project.<br/>__*Default*__: "."
11115
11096
  **parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
11097
+ **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
11116
11098
  **projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
11117
11099
  **projenrcJsonOptions**?🔹 | <code>[json.ProjenrcOptions](#projen-json-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
11118
11100
 
@@ -11319,7 +11301,6 @@ Name | Type | Description
11319
11301
  **codeArtifactOptions**?⚠️ | <code>[CodeArtifactOptions](#projen-codeartifactoptions)</code> | Options for publishing npm package to AWS CodeArtifact.<br/>__*Default*__: undefined
11320
11302
  **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.<br/>__*Default*__: false
11321
11303
  **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.<br/>__*Default*__: if this option is not specified, only public repositories are supported
11322
- **compileBeforeTest**?⚠️ | <code>boolean</code> | Compile the code before running tests.<br/>__*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false`.
11323
11304
  **copyrightOwner**?⚠️ | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
11324
11305
  **copyrightPeriod**?⚠️ | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
11325
11306
  **dependabot**?⚠️ | <code>boolean</code> | Use dependabot to handle dependency upgrades.<br/>__*Default*__: false
@@ -11375,7 +11356,6 @@ Name | Type | Description
11375
11356
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
11376
11357
  **projenCommand**?⚠️ | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
11377
11358
  **projenDevDependency**?⚠️ | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
11378
- **projenDuringBuild**?⚠️ | <code>boolean</code> | Execute `projen` as the first step of the `build` task to synthesize project files.<br/>__*Default*__: true
11379
11359
  **projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
11380
11360
  **projenUpgradeSchedule**?⚠️ | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
11381
11361
  **projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
@@ -11453,7 +11433,6 @@ Name | Type | Description
11453
11433
  **codeArtifactOptions**?🔹 | <code>[CodeArtifactOptions](#projen-codeartifactoptions)</code> | Options for publishing npm package to AWS CodeArtifact.<br/>__*Default*__: undefined
11454
11434
  **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.<br/>__*Default*__: false
11455
11435
  **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.<br/>__*Default*__: if this option is not specified, only public repositories are supported
11456
- **compileBeforeTest**?🔹 | <code>boolean</code> | Compile the code before running tests.<br/>__*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false`.
11457
11436
  **copyrightOwner**?🔹 | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
11458
11437
  **copyrightPeriod**?🔹 | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
11459
11438
  **dependabot**?🔹 | <code>boolean</code> | Use dependabot to handle dependency upgrades.<br/>__*Default*__: false
@@ -11487,7 +11466,7 @@ Name | Type | Description
11487
11466
  **majorVersion**?🔹 | <code>number</code> | Major version to release from the default branch.<br/>__*Default*__: Major version is not enforced.
11488
11467
  **maxNodeVersion**?🔹 | <code>string</code> | Minimum node.js version to require via `engines` (inclusive).<br/>__*Default*__: no max
11489
11468
  **mergify**?⚠️ | <code>boolean</code> | Whether mergify should be enabled on this repository or not.<br/>__*Default*__: true
11490
- **mergifyOptions**?🔹 | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
11469
+ **mergifyOptions**?⚠️ | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
11491
11470
  **minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
11492
11471
  **mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
11493
11472
  **npmAccess**?🔹 | <code>[NpmAccess](#projen-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
@@ -11509,7 +11488,6 @@ Name | Type | Description
11509
11488
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
11510
11489
  **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
11511
11490
  **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
11512
- **projenDuringBuild**?🔹 | <code>boolean</code> | Execute `projen` as the first step of the `build` task to synthesize project files.<br/>__*Default*__: true
11513
11491
  **projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
11514
11492
  **projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
11515
11493
  **projenUpgradeSecret**?🔹 | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
@@ -11712,11 +11690,13 @@ Name | Type | Description
11712
11690
  **junitOptions**?🔹 | <code>[java.JunitOptions](#projen-java-junitoptions)</code> | junit options.<br/>__*Default*__: defaults
11713
11691
  **logging**?🔹 | <code>[LoggerOptions](#projen-loggeroptions)</code> | Configure logging options such as verbosity.<br/>__*Default*__: {}
11714
11692
  **mergify**?⚠️ | <code>boolean</code> | Whether mergify should be enabled on this repository or not.<br/>__*Default*__: true
11693
+ **mergifyOptions**?⚠️ | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
11715
11694
  **outdir**?🔹 | <code>string</code> | The root directory of the project.<br/>__*Default*__: "."
11716
11695
  **packaging**?🔹 | <code>string</code> | Project packaging format.<br/>__*Default*__: "jar"
11717
11696
  **packagingOptions**?🔹 | <code>[java.MavenPackagingOptions](#projen-java-mavenpackagingoptions)</code> | Packaging options.<br/>__*Default*__: defaults
11718
11697
  **parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
11719
11698
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
11699
+ **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
11720
11700
  **projenrcJava**?🔹 | <code>boolean</code> | Use projenrc in java.<br/>__*Default*__: true
11721
11701
  **projenrcJavaOptions**?🔹 | <code>[java.ProjenrcOptions](#projen-java-projenrcoptions)</code> | Options related to projenrc in java.<br/>__*Default*__: default options
11722
11702
  **projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
@@ -11941,6 +11921,7 @@ Name | Type | Description
11941
11921
  Name | Type | Description
11942
11922
  -----|------|-------------
11943
11923
  **mergify**?🔹 | <code>boolean</code> | Whether mergify should be enabled on this repository or not.<br/>__*Default*__: true
11924
+ **mergifyOptions**?🔹 | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for Mergify.<br/>__*Default*__: default options
11944
11925
  **workflows**?🔹 | <code>boolean</code> | Enables GitHub workflows.<br/>__*Default*__: true
11945
11926
 
11946
11927
 
@@ -12117,11 +12098,13 @@ Name | Type | Description
12117
12098
  **junitOptions**?🔹 | <code>[java.JunitOptions](#projen-java-junitoptions)</code> | junit options.<br/>__*Default*__: defaults
12118
12099
  **logging**?🔹 | <code>[LoggerOptions](#projen-loggeroptions)</code> | Configure logging options such as verbosity.<br/>__*Default*__: {}
12119
12100
  **mergify**?⚠️ | <code>boolean</code> | Whether mergify should be enabled on this repository or not.<br/>__*Default*__: true
12101
+ **mergifyOptions**?⚠️ | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
12120
12102
  **outdir**?🔹 | <code>string</code> | The root directory of the project.<br/>__*Default*__: "."
12121
12103
  **packaging**?🔹 | <code>string</code> | Project packaging format.<br/>__*Default*__: "jar"
12122
12104
  **packagingOptions**?🔹 | <code>[java.MavenPackagingOptions](#projen-java-mavenpackagingoptions)</code> | Packaging options.<br/>__*Default*__: defaults
12123
12105
  **parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
12124
12106
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
12107
+ **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
12125
12108
  **projenrcJava**?🔹 | <code>boolean</code> | Use projenrc in java.<br/>__*Default*__: true
12126
12109
  **projenrcJavaOptions**?🔹 | <code>[java.ProjenrcOptions](#projen-java-projenrcoptions)</code> | Options related to projenrc in java.<br/>__*Default*__: default options
12127
12110
  **projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
@@ -12163,11 +12146,13 @@ Name | Type | Description
12163
12146
  **junitOptions**?🔹 | <code>[java.JunitOptions](#projen-java-junitoptions)</code> | junit options.<br/>__*Default*__: defaults
12164
12147
  **logging**?🔹 | <code>[LoggerOptions](#projen-loggeroptions)</code> | Configure logging options such as verbosity.<br/>__*Default*__: {}
12165
12148
  **mergify**?⚠️ | <code>boolean</code> | Whether mergify should be enabled on this repository or not.<br/>__*Default*__: true
12149
+ **mergifyOptions**?⚠️ | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
12166
12150
  **outdir**?🔹 | <code>string</code> | The root directory of the project.<br/>__*Default*__: "."
12167
12151
  **packaging**?🔹 | <code>string</code> | Project packaging format.<br/>__*Default*__: "jar"
12168
12152
  **packagingOptions**?🔹 | <code>[java.MavenPackagingOptions](#projen-java-mavenpackagingoptions)</code> | Packaging options.<br/>__*Default*__: defaults
12169
12153
  **parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
12170
12154
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
12155
+ **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
12171
12156
  **projenrcJava**?🔹 | <code>boolean</code> | Use projenrc in java.<br/>__*Default*__: true
12172
12157
  **projenrcJavaOptions**?🔹 | <code>[java.ProjenrcOptions](#projen-java-projenrcoptions)</code> | Options related to projenrc in java.<br/>__*Default*__: default options
12173
12158
  **projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
@@ -12344,7 +12329,6 @@ Options for `Bundler`.
12344
12329
 
12345
12330
  Name | Type | Description
12346
12331
  -----|------|-------------
12347
- **parentTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | A parent task that will spawn the "bundle" task (usually "compile").
12348
12332
  **esbuildVersion**?🔹 | <code>string</code> | The semantic version requirement for `esbuild`.<br/>__*Default*__: no specific version (implies latest)
12349
12333
 
12350
12334
 
@@ -12491,7 +12475,6 @@ __Implemented by__: [python.Poetry](#projen-python-poetry), [python.Setuptools](
12491
12475
 
12492
12476
  Name | Type | Description
12493
12477
  -----|------|-------------
12494
- **packageTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | A task that packages the project for distribution.
12495
12478
  **publishTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | A task that uploads the package to a package repository.
12496
12479
 
12497
12480
 
@@ -12647,12 +12630,14 @@ Name | Type | Description
12647
12630
  **license**?🔹 | <code>string</code> | License of this package as an SPDX identifier.<br/>__*Optional*__
12648
12631
  **logging**?🔹 | <code>[LoggerOptions](#projen-loggeroptions)</code> | Configure logging options such as verbosity.<br/>__*Default*__: {}
12649
12632
  **mergify**?⚠️ | <code>boolean</code> | Whether mergify should be enabled on this repository or not.<br/>__*Default*__: true
12633
+ **mergifyOptions**?⚠️ | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
12650
12634
  **outdir**?🔹 | <code>string</code> | The root directory of the project.<br/>__*Default*__: "."
12651
12635
  **parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
12652
12636
  **pip**?🔹 | <code>boolean</code> | Use pip with a requirements.txt file to track project dependencies.<br/>__*Default*__: true
12653
12637
  **poetry**?🔹 | <code>boolean</code> | Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing.<br/>__*Default*__: false
12654
12638
  **poetryOptions**?🔹 | <code>[python.PoetryPyprojectOptionsWithoutDeps](#projen-python-poetrypyprojectoptionswithoutdeps)</code> | Additional options to set for poetry if using poetry.<br/>__*Optional*__
12655
12639
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
12640
+ **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
12656
12641
  **projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
12657
12642
  **projenrcJsonOptions**?🔹 | <code>[json.ProjenrcOptions](#projen-json-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
12658
12643
  **projenrcPython**?🔹 | <code>boolean</code> | Use projenrc in python.<br/>__*Default*__: false
@@ -13317,7 +13302,7 @@ Name | Type | Description
13317
13302
  **majorVersion**?🔹 | <code>number</code> | Major version to release from the default branch.<br/>__*Default*__: Major version is not enforced.
13318
13303
  **maxNodeVersion**?🔹 | <code>string</code> | Minimum node.js version to require via `engines` (inclusive).<br/>__*Default*__: no max
13319
13304
  **mergify**?⚠️ | <code>boolean</code> | Whether mergify should be enabled on this repository or not.<br/>__*Default*__: true
13320
- **mergifyOptions**?🔹 | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
13305
+ **mergifyOptions**?⚠️ | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
13321
13306
  **minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
13322
13307
  **mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
13323
13308
  **npmAccess**?🔹 | <code>[NpmAccess](#projen-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
@@ -13338,7 +13323,6 @@ Name | Type | Description
13338
13323
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
13339
13324
  **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
13340
13325
  **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
13341
- **projenDuringBuild**?🔹 | <code>boolean</code> | Execute `projen` as the first step of the `build` task to synthesize project files.<br/>__*Default*__: true
13342
13326
  **projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
13343
13327
  **projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
13344
13328
  **projenUpgradeSecret**?🔹 | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
@@ -13411,7 +13395,6 @@ Name | Type | Description
13411
13395
  **codeArtifactOptions**?🔹 | <code>[CodeArtifactOptions](#projen-codeartifactoptions)</code> | Options for publishing npm package to AWS CodeArtifact.<br/>__*Default*__: undefined
13412
13396
  **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.<br/>__*Default*__: false
13413
13397
  **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.<br/>__*Default*__: if this option is not specified, only public repositories are supported
13414
- **compileBeforeTest**?🔹 | <code>boolean</code> | Compile the code before running tests.<br/>__*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false`.
13415
13398
  **copyrightOwner**?🔹 | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
13416
13399
  **copyrightPeriod**?🔹 | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
13417
13400
  **dependabot**?🔹 | <code>boolean</code> | Use dependabot to handle dependency upgrades.<br/>__*Default*__: false
@@ -13445,7 +13428,7 @@ Name | Type | Description
13445
13428
  **majorVersion**?🔹 | <code>number</code> | Major version to release from the default branch.<br/>__*Default*__: Major version is not enforced.
13446
13429
  **maxNodeVersion**?🔹 | <code>string</code> | Minimum node.js version to require via `engines` (inclusive).<br/>__*Default*__: no max
13447
13430
  **mergify**?⚠️ | <code>boolean</code> | Whether mergify should be enabled on this repository or not.<br/>__*Default*__: true
13448
- **mergifyOptions**?🔹 | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
13431
+ **mergifyOptions**?⚠️ | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
13449
13432
  **minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
13450
13433
  **mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
13451
13434
  **npmAccess**?🔹 | <code>[NpmAccess](#projen-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
@@ -13467,7 +13450,6 @@ Name | Type | Description
13467
13450
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
13468
13451
  **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
13469
13452
  **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
13470
- **projenDuringBuild**?🔹 | <code>boolean</code> | Execute `projen` as the first step of the `build` task to synthesize project files.<br/>__*Default*__: true
13471
13453
  **projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
13472
13454
  **projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
13473
13455
  **projenUpgradeSecret**?🔹 | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
@@ -13601,7 +13583,7 @@ Name | Type | Description
13601
13583
  **majorVersion**?🔹 | <code>number</code> | Major version to release from the default branch.<br/>__*Default*__: Major version is not enforced.
13602
13584
  **maxNodeVersion**?🔹 | <code>string</code> | Minimum node.js version to require via `engines` (inclusive).<br/>__*Default*__: no max
13603
13585
  **mergify**?⚠️ | <code>boolean</code> | Whether mergify should be enabled on this repository or not.<br/>__*Default*__: true
13604
- **mergifyOptions**?🔹 | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
13586
+ **mergifyOptions**?⚠️ | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
13605
13587
  **minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
13606
13588
  **mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
13607
13589
  **npmAccess**?🔹 | <code>[NpmAccess](#projen-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
@@ -13622,7 +13604,6 @@ Name | Type | Description
13622
13604
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
13623
13605
  **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
13624
13606
  **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
13625
- **projenDuringBuild**?🔹 | <code>boolean</code> | Execute `projen` as the first step of the `build` task to synthesize project files.<br/>__*Default*__: true
13626
13607
  **projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
13627
13608
  **projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
13628
13609
  **projenUpgradeSecret**?🔹 | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
@@ -13723,7 +13704,6 @@ Name | Type | Description
13723
13704
  **codeArtifactOptions**?🔹 | <code>[CodeArtifactOptions](#projen-codeartifactoptions)</code> | Options for publishing npm package to AWS CodeArtifact.<br/>__*Default*__: undefined
13724
13705
  **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.<br/>__*Default*__: false
13725
13706
  **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.<br/>__*Default*__: if this option is not specified, only public repositories are supported
13726
- **compileBeforeTest**?🔹 | <code>boolean</code> | Compile the code before running tests.<br/>__*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false`.
13727
13707
  **copyrightOwner**?🔹 | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
13728
13708
  **copyrightPeriod**?🔹 | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
13729
13709
  **dependabot**?🔹 | <code>boolean</code> | Use dependabot to handle dependency upgrades.<br/>__*Default*__: false
@@ -13757,7 +13737,7 @@ Name | Type | Description
13757
13737
  **majorVersion**?🔹 | <code>number</code> | Major version to release from the default branch.<br/>__*Default*__: Major version is not enforced.
13758
13738
  **maxNodeVersion**?🔹 | <code>string</code> | Minimum node.js version to require via `engines` (inclusive).<br/>__*Default*__: no max
13759
13739
  **mergify**?⚠️ | <code>boolean</code> | Whether mergify should be enabled on this repository or not.<br/>__*Default*__: true
13760
- **mergifyOptions**?🔹 | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
13740
+ **mergifyOptions**?⚠️ | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
13761
13741
  **minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
13762
13742
  **mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
13763
13743
  **npmAccess**?🔹 | <code>[NpmAccess](#projen-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
@@ -13779,7 +13759,6 @@ Name | Type | Description
13779
13759
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
13780
13760
  **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
13781
13761
  **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
13782
- **projenDuringBuild**?🔹 | <code>boolean</code> | Execute `projen` as the first step of the `build` task to synthesize project files.<br/>__*Default*__: true
13783
13762
  **projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
13784
13763
  **projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
13785
13764
  **projenUpgradeSecret**?🔹 | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests