projen 0.47.14 → 0.49.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 (126) hide show
  1. package/.jsii +841 -566
  2. package/API.md +297 -208
  3. package/changelog.md +11 -1
  4. package/docs/components.md +21 -0
  5. package/lib/awscdk/auto-discover.js +1 -1
  6. package/lib/awscdk/{java-app.d.ts → awscdk-app-java.d.ts} +10 -27
  7. package/lib/awscdk/awscdk-app-java.js +87 -0
  8. package/lib/awscdk/awscdk-app-ts.js +4 -4
  9. package/lib/awscdk/awscdk-construct.js +5 -5
  10. package/lib/awscdk/awscdk-deps-java.d.ts +14 -0
  11. package/lib/awscdk/awscdk-deps-java.js +30 -0
  12. package/lib/awscdk/awscdk-deps-js.d.ts +14 -0
  13. package/lib/awscdk/awscdk-deps-js.js +31 -0
  14. package/lib/awscdk/awscdk-deps.d.ts +56 -8
  15. package/lib/awscdk/awscdk-deps.js +13 -12
  16. package/lib/awscdk/cdk-config.js +1 -1
  17. package/lib/awscdk/cdk-tasks.js +1 -1
  18. package/lib/awscdk/index.d.ts +3 -1
  19. package/lib/awscdk/index.js +4 -2
  20. package/lib/awscdk/integration-test.js +1 -1
  21. package/lib/awscdk/lambda-function.js +2 -2
  22. package/lib/build/build-workflow.js +1 -1
  23. package/lib/cdk/construct-lib.js +1 -1
  24. package/lib/cdk/jsii-docgen.js +1 -1
  25. package/lib/cdk/jsii-project.js +1 -1
  26. package/lib/cdk8s/cdk8s-app-ts.js +1 -1
  27. package/lib/cdk8s/cdk8s-construct.js +1 -1
  28. package/lib/cdktf/cdktf-construct.js +1 -1
  29. package/lib/component.js +1 -1
  30. package/lib/dependencies.js +1 -1
  31. package/lib/dev-env.js +1 -1
  32. package/lib/docker-compose.js +2 -2
  33. package/lib/file.js +1 -1
  34. package/lib/gitattributes.js +1 -1
  35. package/lib/github/auto-approve.js +1 -1
  36. package/lib/github/auto-merge.js +1 -1
  37. package/lib/github/dependabot.js +1 -1
  38. package/lib/github/github-project.js +1 -1
  39. package/lib/github/github.js +1 -1
  40. package/lib/github/mergify.js +1 -1
  41. package/lib/github/pr-template.js +1 -1
  42. package/lib/github/pull-request-lint.js +1 -1
  43. package/lib/github/stale.js +1 -1
  44. package/lib/github/task-workflow.js +1 -1
  45. package/lib/github/workflows.js +1 -1
  46. package/lib/gitpod.js +1 -1
  47. package/lib/ignore-file.js +1 -1
  48. package/lib/ini.js +1 -1
  49. package/lib/java/java-project.d.ts +1 -0
  50. package/lib/java/java-project.js +2 -2
  51. package/lib/java/junit.js +1 -1
  52. package/lib/java/maven-compile.js +1 -1
  53. package/lib/java/maven-packaging.js +1 -1
  54. package/lib/java/maven-sample.js +1 -1
  55. package/lib/java/pom.js +1 -1
  56. package/lib/java/projenrc.js +1 -1
  57. package/lib/javascript/bundler.js +1 -1
  58. package/lib/javascript/eslint.d.ts +21 -0
  59. package/lib/javascript/eslint.js +46 -24
  60. package/lib/javascript/jest.js +1 -1
  61. package/lib/javascript/node-package.d.ts +7 -0
  62. package/lib/javascript/node-package.js +30 -10
  63. package/lib/javascript/node-project.d.ts +1 -21
  64. package/lib/javascript/node-project.js +31 -44
  65. package/lib/javascript/npm-config.js +1 -1
  66. package/lib/javascript/prettier.d.ts +78 -48
  67. package/lib/javascript/prettier.js +27 -6
  68. package/lib/javascript/projenrc.js +1 -1
  69. package/lib/javascript/typescript-config.js +1 -1
  70. package/lib/javascript/upgrade-dependencies.js +2 -2
  71. package/lib/json.js +1 -1
  72. package/lib/license.js +1 -1
  73. package/lib/logger.js +1 -1
  74. package/lib/makefile.js +1 -1
  75. package/lib/object-file.js +1 -1
  76. package/lib/project-build.js +1 -1
  77. package/lib/project.js +1 -1
  78. package/lib/projects.js +1 -1
  79. package/lib/projenrc-json.js +1 -1
  80. package/lib/python/pip.js +1 -1
  81. package/lib/python/poetry.js +2 -2
  82. package/lib/python/projenrc.js +1 -1
  83. package/lib/python/pytest.js +1 -1
  84. package/lib/python/python-project.js +1 -1
  85. package/lib/python/python-sample.js +1 -1
  86. package/lib/python/requirements-file.js +1 -1
  87. package/lib/python/setuppy.js +1 -1
  88. package/lib/python/setuptools.js +1 -1
  89. package/lib/python/venv.js +1 -1
  90. package/lib/readme.js +1 -1
  91. package/lib/release/publisher.js +1 -1
  92. package/lib/release/release-trigger.js +1 -1
  93. package/lib/release/release.js +1 -1
  94. package/lib/sample-file.js +2 -2
  95. package/lib/semver.js +1 -1
  96. package/lib/source-code.js +1 -1
  97. package/lib/task-runtime.js +1 -1
  98. package/lib/task.js +1 -1
  99. package/lib/tasks.js +1 -1
  100. package/lib/testing.js +1 -1
  101. package/lib/textfile.js +1 -1
  102. package/lib/toml.js +1 -1
  103. package/lib/typescript/projenrc.js +1 -1
  104. package/lib/typescript/typescript-typedoc.js +1 -1
  105. package/lib/typescript/typescript.js +3 -3
  106. package/lib/version.js +1 -1
  107. package/lib/vscode/devcontainer.js +1 -1
  108. package/lib/vscode/launch-config.js +1 -1
  109. package/lib/vscode/vscode.js +1 -1
  110. package/lib/web/next.js +3 -3
  111. package/lib/web/postcss.js +1 -1
  112. package/lib/web/react.js +4 -4
  113. package/lib/web/tailwind.js +1 -1
  114. package/lib/xmlfile.js +1 -1
  115. package/lib/yaml.js +1 -1
  116. package/node_modules/xmlbuilder2/node_modules/@types/node/README.md +1 -1
  117. package/node_modules/xmlbuilder2/node_modules/@types/node/globals.d.ts +3 -3
  118. package/node_modules/xmlbuilder2/node_modules/@types/node/http.d.ts +1 -1
  119. package/node_modules/xmlbuilder2/node_modules/@types/node/http2.d.ts +3 -3
  120. package/node_modules/xmlbuilder2/node_modules/@types/node/net.d.ts +3 -3
  121. package/node_modules/xmlbuilder2/node_modules/@types/node/package.json +2 -2
  122. package/node_modules/xmlbuilder2/node_modules/@types/node/stream.d.ts +8 -8
  123. package/package.json +2 -2
  124. package/releasetag.txt +1 -1
  125. package/version.txt +1 -1
  126. package/lib/awscdk/java-app.js +0 -90
package/API.md CHANGED
@@ -40,6 +40,8 @@ Name|Description
40
40
  [awscdk.AutoDiscover](#projen-awscdk-autodiscover)|Automatically creates a `LambdaFunction` for all `.lambda.ts` files under the source directory of the project.
41
41
  [awscdk.AwsCdkConstructLibrary](#projen-awscdk-awscdkconstructlibrary)|AWS CDK construct library project.
42
42
  [awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps)|Manages dependencies on the AWS CDK.
43
+ [awscdk.AwsCdkDepsJava](#projen-awscdk-awscdkdepsjava)|Manages dependencies on the AWS CDK for Java projects.
44
+ [awscdk.AwsCdkDepsJs](#projen-awscdk-awscdkdepsjs)|Manages dependencies on the AWS CDK for Node.js projects.
43
45
  [awscdk.AwsCdkJavaApp](#projen-awscdk-awscdkjavaapp)|AWS CDK app in Java.
44
46
  [awscdk.AwsCdkTypeScriptApp](#projen-awscdk-awscdktypescriptapp)|AWS CDK app in TypeScript.
45
47
  [awscdk.CdkConfig](#projen-awscdk-cdkconfig)|Represents cdk.json file.
@@ -169,6 +171,7 @@ Name|Description
169
171
  [awscdk.AwsCdkDepsCommonOptions](#projen-awscdk-awscdkdepscommonoptions)|Options for `AwsCdkDeps`.
170
172
  [awscdk.AwsCdkDepsOptions](#projen-awscdk-awscdkdepsoptions)|*No description*
171
173
  [awscdk.AwsCdkJavaAppOptions](#projen-awscdk-awscdkjavaappoptions)|*No description*
174
+ [awscdk.AwsCdkPackageNames](#projen-awscdk-awscdkpackagenames)|Language-specific AWS CDK package names.
172
175
  [awscdk.AwsCdkTypeScriptAppOptions](#projen-awscdk-awscdktypescriptappoptions)|*No description*
173
176
  [awscdk.CdkConfigCommonOptions](#projen-awscdk-cdkconfigcommonoptions)|Common options for `cdk.json`.
174
177
  [awscdk.CdkConfigOptions](#projen-awscdk-cdkconfigoptions)|Options for `CdkJson`.
@@ -231,9 +234,9 @@ Name|Description
231
234
  [javascript.NodeProjectOptions](#projen-javascript-nodeprojectoptions)|*No description*
232
235
  [javascript.NpmConfigOptions](#projen-javascript-npmconfigoptions)|Options to configure the local NPM config.
233
236
  [javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions)|*No description*
234
- [javascript.PrettierBaseOptions](#projen-javascript-prettierbaseoptions)|Options to set in Prettier directly or through overrides.
235
237
  [javascript.PrettierOptions](#projen-javascript-prettieroptions)|Options for Prettier.
236
238
  [javascript.PrettierOverride](#projen-javascript-prettieroverride)|*No description*
239
+ [javascript.PrettierSettings](#projen-javascript-prettiersettings)|Options to set in Prettier directly or through overrides.
237
240
  [javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)|*No description*
238
241
  [javascript.TypeScriptCompilerOptions](#projen-javascript-typescriptcompileroptions)|*No description*
239
242
  [javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)|*No description*
@@ -2998,8 +3001,7 @@ new awscdk.AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
2998
3001
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
2999
3002
  * **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
3000
3003
  * **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
3001
- * **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
3002
- * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
3004
+ * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
3003
3005
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
3004
3006
  * **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
3005
3007
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
@@ -3046,9 +3048,9 @@ new awscdk.AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
3046
3048
  * **rootdir** (<code>string</code>) *No description* __*Default*__: "."
3047
3049
  * **catalog** (<code>[cdk.Catalog](#projen-cdk-catalog)</code>) Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:. __*Default*__: new version will be announced
3048
3050
  * **cdkVersion** (<code>string</code>) Minimum version of the AWS CDK to depend on.
3049
- * **cdkAssert** (<code>boolean</code>) Install the @aws-cdk/assert library? __*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
3050
- * **cdkAssertions** (<code>boolean</code>) Install the @aws-cdk/assertions library? __*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
3051
- * **cdkDependencies** (<code>Array<string></code>) Which AWS CDK modules (those that start with "@aws-cdk/") does this library require when consumed? __*Optional*__
3051
+ * **cdkAssert** (<code>boolean</code>) Warning: NodeJS only. __*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
3052
+ * **cdkAssertions** (<code>boolean</code>) Install the assertions library? __*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
3053
+ * **cdkDependencies** (<code>Array<string></code>) Which AWS CDKv1 modules this project requires. __*Optional*__
3052
3054
  * **cdkDependenciesAsDeps** (<code>boolean</code>) If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). __*Default*__: true
3053
3055
  * **cdkTestDependencies** (<code>Array<string></code>) AWS CDK modules required for testing. __*Optional*__
3054
3056
  * **cdkVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for CDK. __*Optional*__
@@ -3107,6 +3109,7 @@ Manages dependencies on the AWS CDK.
3107
3109
  __Submodule__: awscdk
3108
3110
 
3109
3111
  __Extends__: [Component](#projen-component)
3112
+ __Implemented by__: [awscdk.AwsCdkDepsJava](#projen-awscdk-awscdkdepsjava), [awscdk.AwsCdkDepsJs](#projen-awscdk-awscdkdepsjs)
3110
3113
 
3111
3114
  ### Initializer
3112
3115
 
@@ -3120,9 +3123,9 @@ new awscdk.AwsCdkDeps(project: Project, options: AwsCdkDepsOptions)
3120
3123
  * **project** (<code>[Project](#projen-project)</code>) *No description*
3121
3124
  * **options** (<code>[awscdk.AwsCdkDepsOptions](#projen-awscdk-awscdkdepsoptions)</code>) *No description*
3122
3125
  * **cdkVersion** (<code>string</code>) Minimum version of the AWS CDK to depend on.
3123
- * **cdkAssert** (<code>boolean</code>) Install the @aws-cdk/assert library? __*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
3124
- * **cdkAssertions** (<code>boolean</code>) Install the @aws-cdk/assertions library? __*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
3125
- * **cdkDependencies** (<code>Array<string></code>) Which AWS CDK modules (those that start with "@aws-cdk/") does this library require when consumed? __*Optional*__
3126
+ * **cdkAssert** (<code>boolean</code>) Warning: NodeJS only. __*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
3127
+ * **cdkAssertions** (<code>boolean</code>) Install the assertions library? __*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
3128
+ * **cdkDependencies** (<code>Array<string></code>) Which AWS CDKv1 modules this project requires. __*Optional*__
3126
3129
  * **cdkDependenciesAsDeps** (<code>boolean</code>) If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). __*Default*__: true
3127
3130
  * **cdkTestDependencies** (<code>Array<string></code>) AWS CDK modules required for testing. __*Optional*__
3128
3131
  * **cdkVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for CDK. __*Optional*__
@@ -3173,11 +3176,117 @@ This method is not supported in CDK v2. Use `project.addPeerDeps()` or
3173
3176
  addV1DevDependencies(...deps: string[]): void
3174
3177
  ```
3175
3178
 
3176
- * **deps** (<code>string</code>) names of cdk modules (e.g. `@aws-cdk/aws-lambda`).
3179
+ * **deps** (<code>string</code>) fully qualified names of cdk modules (e.g. `@aws-cdk/aws-lambda`).
3180
+
3181
+
3182
+
3183
+
3184
+ #### protected packageNames()🔹 <a id="projen-awscdk-awscdkdeps-packagenames"></a>
3185
+
3186
+ Return a configuration object with information about package naming in various languages.
3187
+
3188
+ ```ts
3189
+ protected packageNames(): AwsCdkPackageNames
3190
+ ```
3177
3191
 
3178
3192
 
3193
+ __Returns__:
3194
+ * <code>[awscdk.AwsCdkPackageNames](#projen-awscdk-awscdkpackagenames)</code>
3195
+
3179
3196
 
3180
3197
 
3198
+ ## class AwsCdkDepsJava 🔹 <a id="projen-awscdk-awscdkdepsjava"></a>
3199
+
3200
+ Manages dependencies on the AWS CDK for Java projects.
3201
+
3202
+ __Submodule__: awscdk
3203
+
3204
+ __Extends__: [awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps)
3205
+
3206
+ ### Initializer
3207
+
3208
+
3209
+
3210
+
3211
+ ```ts
3212
+ new awscdk.AwsCdkDepsJava(project: Project, options: AwsCdkDepsOptions)
3213
+ ```
3214
+
3215
+ * **project** (<code>[Project](#projen-project)</code>) *No description*
3216
+ * **options** (<code>[awscdk.AwsCdkDepsOptions](#projen-awscdk-awscdkdepsoptions)</code>) *No description*
3217
+ * **cdkVersion** (<code>string</code>) Minimum version of the AWS CDK to depend on.
3218
+ * **cdkAssert** (<code>boolean</code>) Warning: NodeJS only. __*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
3219
+ * **cdkAssertions** (<code>boolean</code>) Install the assertions library? __*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
3220
+ * **cdkDependencies** (<code>Array<string></code>) Which AWS CDKv1 modules this project requires. __*Optional*__
3221
+ * **cdkDependenciesAsDeps** (<code>boolean</code>) If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). __*Default*__: true
3222
+ * **cdkTestDependencies** (<code>Array<string></code>) AWS CDK modules required for testing. __*Optional*__
3223
+ * **cdkVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for CDK. __*Optional*__
3224
+ * **constructsVersion** (<code>string</code>) Minimum version of the `constructs` library to depend on. __*Default*__: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
3225
+ * **dependencyType** (<code>[DependencyType](#projen-dependencytype)</code>) The type of dependency to use for runtime AWS CDK and `constructs` modules.
3226
+
3227
+
3228
+ ### Methods
3229
+
3230
+
3231
+ #### protected packageNames()🔹 <a id="projen-awscdk-awscdkdepsjava-packagenames"></a>
3232
+
3233
+ Return a configuration object with information about package naming in various languages.
3234
+
3235
+ ```ts
3236
+ protected packageNames(): AwsCdkPackageNames
3237
+ ```
3238
+
3239
+
3240
+ __Returns__:
3241
+ * <code>[awscdk.AwsCdkPackageNames](#projen-awscdk-awscdkpackagenames)</code>
3242
+
3243
+
3244
+
3245
+ ## class AwsCdkDepsJs 🔹 <a id="projen-awscdk-awscdkdepsjs"></a>
3246
+
3247
+ Manages dependencies on the AWS CDK for Node.js projects.
3248
+
3249
+ __Submodule__: awscdk
3250
+
3251
+ __Extends__: [awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps)
3252
+
3253
+ ### Initializer
3254
+
3255
+
3256
+
3257
+
3258
+ ```ts
3259
+ new awscdk.AwsCdkDepsJs(project: Project, options: AwsCdkDepsOptions)
3260
+ ```
3261
+
3262
+ * **project** (<code>[Project](#projen-project)</code>) *No description*
3263
+ * **options** (<code>[awscdk.AwsCdkDepsOptions](#projen-awscdk-awscdkdepsoptions)</code>) *No description*
3264
+ * **cdkVersion** (<code>string</code>) Minimum version of the AWS CDK to depend on.
3265
+ * **cdkAssert** (<code>boolean</code>) Warning: NodeJS only. __*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
3266
+ * **cdkAssertions** (<code>boolean</code>) Install the assertions library? __*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
3267
+ * **cdkDependencies** (<code>Array<string></code>) Which AWS CDKv1 modules this project requires. __*Optional*__
3268
+ * **cdkDependenciesAsDeps** (<code>boolean</code>) If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). __*Default*__: true
3269
+ * **cdkTestDependencies** (<code>Array<string></code>) AWS CDK modules required for testing. __*Optional*__
3270
+ * **cdkVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for CDK. __*Optional*__
3271
+ * **constructsVersion** (<code>string</code>) Minimum version of the `constructs` library to depend on. __*Default*__: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
3272
+ * **dependencyType** (<code>[DependencyType](#projen-dependencytype)</code>) The type of dependency to use for runtime AWS CDK and `constructs` modules.
3273
+
3274
+
3275
+ ### Methods
3276
+
3277
+
3278
+ #### protected packageNames()🔹 <a id="projen-awscdk-awscdkdepsjs-packagenames"></a>
3279
+
3280
+ Return a configuration object with information about package naming in various languages.
3281
+
3282
+ ```ts
3283
+ protected packageNames(): AwsCdkPackageNames
3284
+ ```
3285
+
3286
+
3287
+ __Returns__:
3288
+ * <code>[awscdk.AwsCdkPackageNames](#projen-awscdk-awscdkpackagenames)</code>
3289
+
3181
3290
 
3182
3291
 
3183
3292
  ## class AwsCdkJavaApp 🔹 <a id="projen-awscdk-awscdkjavaapp"></a>
@@ -3235,7 +3344,7 @@ new awscdk.AwsCdkJavaApp(options: AwsCdkJavaAppOptions)
3235
3344
  * **projenrcJava** (<code>boolean</code>) Use projenrc in java. __*Default*__: true
3236
3345
  * **projenrcJavaOptions** (<code>[java.ProjenrcOptions](#projen-java-projenrcoptions)</code>) Options related to projenrc in java. __*Default*__: default options
3237
3346
  * **testDeps** (<code>Array<string></code>) List of test dependencies for this project. __*Default*__: []
3238
- * **sample** (<code>boolean</code>) Include sample code and test if the relevant directories don't exist. __*Optional*__
3347
+ * **sample** (<code>boolean</code>) Include sample code and test if the relevant directories don't exist. __*Default*__: true
3239
3348
  * **sampleJavaPackage** (<code>string</code>) The java package to use for the code sample. __*Default*__: "org.acme"
3240
3349
  * **buildCommand** (<code>string</code>) A command to execute before synthesis. __*Default*__: no build command
3241
3350
  * **cdkout** (<code>string</code>) cdk.out directory. __*Default*__: "cdk.out"
@@ -3244,9 +3353,15 @@ new awscdk.AwsCdkJavaApp(options: AwsCdkJavaAppOptions)
3244
3353
  * **requireApproval** (<code>[awscdk.ApprovalLevel](#projen-awscdk-approvallevel)</code>) To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. __*Default*__: ApprovalLevel.BROADENING
3245
3354
  * **watchExcludes** (<code>Array<string></code>) Glob patterns to exclude from `cdk watch`. __*Default*__: []
3246
3355
  * **watchIncludes** (<code>Array<string></code>) Glob patterns to include in `cdk watch`. __*Default*__: []
3247
- * **cdkVersion** (<code>string</code>) AWS CDK version to use (you can use semantic versioning).
3356
+ * **cdkVersion** (<code>string</code>) Minimum version of the AWS CDK to depend on.
3357
+ * **cdkAssert** (<code>boolean</code>) Warning: NodeJS only. __*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
3358
+ * **cdkAssertions** (<code>boolean</code>) Install the assertions library? __*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
3359
+ * **cdkDependencies** (<code>Array<string></code>) Which AWS CDKv1 modules this project requires. __*Optional*__
3360
+ * **cdkDependenciesAsDeps** (<code>boolean</code>) If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). __*Default*__: true
3361
+ * **cdkTestDependencies** (<code>Array<string></code>) AWS CDK modules required for testing. __*Optional*__
3362
+ * **cdkVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for CDK. __*Optional*__
3363
+ * **constructsVersion** (<code>string</code>) Minimum version of the `constructs` library to depend on. __*Default*__: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
3248
3364
  * **mainClass** (<code>string</code>) The name of the Java class with the static `main()` method.
3249
- * **cdkDependencies** (<code>Array<string></code>) Which AWS CDK modules this app uses. __*Optional*__
3250
3365
 
3251
3366
 
3252
3367
 
@@ -3256,8 +3371,8 @@ new awscdk.AwsCdkJavaApp(options: AwsCdkJavaAppOptions)
3256
3371
  Name | Type | Description
3257
3372
  -----|------|-------------
3258
3373
  **cdkConfig**🔹 | <code>[awscdk.CdkConfig](#projen-awscdk-cdkconfig)</code> | The `cdk.json` file.
3374
+ **cdkDeps**🔹 | <code>[awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps)</code> | CDK dependency management helper class.
3259
3375
  **cdkTasks**🔹 | <code>[awscdk.CdkTasks](#projen-awscdk-cdktasks)</code> | CDK tasks.
3260
- **cdkVersion**🔹 | <code>string</code> | The CDK version this app is using.
3261
3376
  **mainClass**🔹 | <code>string</code> | The full name of the main class of the java app (package.Class).
3262
3377
  **mainClassName**🔹 | <code>string</code> | The name of the Java class with the static `main()` method.
3263
3378
  **mainPackage**🔹 | <code>string</code> | The name of the Java package that includes the main class.
@@ -3265,7 +3380,7 @@ Name | Type | Description
3265
3380
  ### Methods
3266
3381
 
3267
3382
 
3268
- #### addCdkDependency(...modules)🔹 <a id="projen-awscdk-awscdkjavaapp-addcdkdependency"></a>
3383
+ #### addCdkDependency(...modules)⚠️ <a id="projen-awscdk-awscdkjavaapp-addcdkdependency"></a>
3269
3384
 
3270
3385
  Adds an AWS CDK module dependencies.
3271
3386
 
@@ -3273,7 +3388,7 @@ Adds an AWS CDK module dependencies.
3273
3388
  addCdkDependency(...modules: string[]): void
3274
3389
  ```
3275
3390
 
3276
- * **modules** (<code>string</code>) The list of modules to depend on (e.g. "core", "aws-lambda", etc).
3391
+ * **modules** (<code>string</code>) The list of modules to depend on (e.g. "software.amazon.awscdk/aws-lambda", "software.amazon.awscdk/aws-iam", etc).
3277
3392
 
3278
3393
 
3279
3394
 
@@ -3394,8 +3509,7 @@ new awscdk.AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
3394
3509
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
3395
3510
  * **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
3396
3511
  * **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
3397
- * **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
3398
- * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
3512
+ * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
3399
3513
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
3400
3514
  * **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
3401
3515
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
@@ -3435,9 +3549,9 @@ new awscdk.AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
3435
3549
  * **watchExcludes** (<code>Array<string></code>) Glob patterns to exclude from `cdk watch`. __*Default*__: []
3436
3550
  * **watchIncludes** (<code>Array<string></code>) Glob patterns to include in `cdk watch`. __*Default*__: []
3437
3551
  * **cdkVersion** (<code>string</code>) Minimum version of the AWS CDK to depend on.
3438
- * **cdkAssert** (<code>boolean</code>) Install the @aws-cdk/assert library? __*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
3439
- * **cdkAssertions** (<code>boolean</code>) Install the @aws-cdk/assertions library? __*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
3440
- * **cdkDependencies** (<code>Array<string></code>) Which AWS CDK modules (those that start with "@aws-cdk/") does this library require when consumed? __*Optional*__
3552
+ * **cdkAssert** (<code>boolean</code>) Warning: NodeJS only. __*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
3553
+ * **cdkAssertions** (<code>boolean</code>) Install the assertions library? __*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
3554
+ * **cdkDependencies** (<code>Array<string></code>) Which AWS CDKv1 modules this project requires. __*Optional*__
3441
3555
  * **cdkDependenciesAsDeps** (<code>boolean</code>) If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). __*Default*__: true
3442
3556
  * **cdkTestDependencies** (<code>Array<string></code>) AWS CDK modules required for testing. __*Optional*__
3443
3557
  * **cdkVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for CDK. __*Optional*__
@@ -3666,8 +3780,7 @@ new awscdk.ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
3666
3780
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
3667
3781
  * **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
3668
3782
  * **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
3669
- * **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
3670
- * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
3783
+ * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
3671
3784
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
3672
3785
  * **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
3673
3786
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
@@ -3714,9 +3827,9 @@ new awscdk.ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
3714
3827
  * **rootdir** (<code>string</code>) *No description* __*Default*__: "."
3715
3828
  * **catalog** (<code>[cdk.Catalog](#projen-cdk-catalog)</code>) Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:. __*Default*__: new version will be announced
3716
3829
  * **cdkVersion** (<code>string</code>) Minimum version of the AWS CDK to depend on.
3717
- * **cdkAssert** (<code>boolean</code>) Install the @aws-cdk/assert library? __*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
3718
- * **cdkAssertions** (<code>boolean</code>) Install the @aws-cdk/assertions library? __*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
3719
- * **cdkDependencies** (<code>Array<string></code>) Which AWS CDK modules (those that start with "@aws-cdk/") does this library require when consumed? __*Optional*__
3830
+ * **cdkAssert** (<code>boolean</code>) Warning: NodeJS only. __*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
3831
+ * **cdkAssertions** (<code>boolean</code>) Install the assertions library? __*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
3832
+ * **cdkDependencies** (<code>Array<string></code>) Which AWS CDKv1 modules this project requires. __*Optional*__
3720
3833
  * **cdkDependenciesAsDeps** (<code>boolean</code>) If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). __*Default*__: true
3721
3834
  * **cdkTestDependencies** (<code>Array<string></code>) AWS CDK modules required for testing. __*Optional*__
3722
3835
  * **cdkVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for CDK. __*Optional*__
@@ -4041,8 +4154,7 @@ new cdk.ConstructLibrary(options: ConstructLibraryOptions)
4041
4154
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
4042
4155
  * **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
4043
4156
  * **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
4044
- * **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
4045
- * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
4157
+ * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
4046
4158
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
4047
4159
  * **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
4048
4160
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
@@ -4227,8 +4339,7 @@ new cdk.JsiiProject(options: JsiiProjectOptions)
4227
4339
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
4228
4340
  * **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
4229
4341
  * **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
4230
- * **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
4231
- * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
4342
+ * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
4232
4343
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
4233
4344
  * **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
4234
4345
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
@@ -4399,8 +4510,7 @@ new cdk8s.Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
4399
4510
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
4400
4511
  * **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
4401
4512
  * **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
4402
- * **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
4403
- * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
4513
+ * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
4404
4514
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
4405
4515
  * **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
4406
4516
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
@@ -4573,8 +4683,7 @@ new cdk8s.ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
4573
4683
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
4574
4684
  * **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
4575
4685
  * **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
4576
- * **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
4577
- * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
4686
+ * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
4578
4687
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
4579
4688
  * **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
4580
4689
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
@@ -4756,8 +4865,7 @@ new cdktf.ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
4756
4865
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
4757
4866
  * **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
4758
4867
  * **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
4759
- * **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
4760
- * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
4868
+ * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
4761
4869
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
4762
4870
  * **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
4763
4871
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
@@ -5518,7 +5626,7 @@ new java.JavaProject(options: JavaProjectOptions)
5518
5626
  * **projenrcJava** (<code>boolean</code>) Use projenrc in java. __*Default*__: true
5519
5627
  * **projenrcJavaOptions** (<code>[java.ProjenrcOptions](#projen-java-projenrcoptions)</code>) Options related to projenrc in java. __*Default*__: default options
5520
5628
  * **testDeps** (<code>Array<string></code>) List of test dependencies for this project. __*Default*__: []
5521
- * **sample** (<code>boolean</code>) Include sample code and test if the relevant directories don't exist. __*Optional*__
5629
+ * **sample** (<code>boolean</code>) Include sample code and test if the relevant directories don't exist. __*Default*__: true
5522
5630
  * **sampleJavaPackage** (<code>string</code>) The java package to use for the code sample. __*Default*__: "org.acme"
5523
5631
 
5524
5632
 
@@ -5956,6 +6064,19 @@ Name | Type | Description
5956
6064
  ### Methods
5957
6065
 
5958
6066
 
6067
+ #### addExtends(...extendList)🔹 <a id="projen-javascript-eslint-addextends"></a>
6068
+
6069
+ Adds an `extends` item to the eslint configuration.
6070
+
6071
+ ```ts
6072
+ addExtends(...extendList: string[]): void
6073
+ ```
6074
+
6075
+ * **extendList** (<code>string</code>) The list of "extends" to add.
6076
+
6077
+
6078
+
6079
+
5959
6080
  #### addIgnorePattern(pattern)🔹 <a id="projen-javascript-eslint-addignorepattern"></a>
5960
6081
 
5961
6082
  Do not lint these files.
@@ -5984,6 +6105,19 @@ addOverride(override: EslintOverride): void
5984
6105
 
5985
6106
 
5986
6107
 
6108
+ #### addPlugins(...plugins)🔹 <a id="projen-javascript-eslint-addplugins"></a>
6109
+
6110
+ Adds an eslint plugin.
6111
+
6112
+ ```ts
6113
+ addPlugins(...plugins: string[]): void
6114
+ ```
6115
+
6116
+ * **plugins** (<code>string</code>) *No description*
6117
+
6118
+
6119
+
6120
+
5987
6121
  #### addRules(rules)🔹 <a id="projen-javascript-eslint-addrules"></a>
5988
6122
 
5989
6123
  Add an eslint rule.
@@ -6551,8 +6685,7 @@ new javascript.NodeProject(options: NodeProjectOptions)
6551
6685
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
6552
6686
  * **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
6553
6687
  * **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
6554
- * **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
6555
- * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
6688
+ * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
6556
6689
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
6557
6690
  * **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
6558
6691
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
@@ -6594,7 +6727,6 @@ Name | Type | Description
6594
6727
  **minNodeVersion**?🔹 | <code>string</code> | Minimum node.js version required by this package.<br/>__*Optional*__
6595
6728
  **npmignore**?🔹 | <code>[IgnoreFile](#projen-ignorefile)</code> | The .npmignore file.<br/>__*Optional*__
6596
6729
  **prettier**?🔹 | <code>[javascript.Prettier](#projen-javascript-prettier)</code> | __*Optional*__
6597
- **prettierIgnore**?🔹 | <code>[IgnoreFile](#projen-ignorefile)</code> | The .prettierIgnore file.<br/>__*Optional*__
6598
6730
  **publisher**?⚠️ | <code>[release.Publisher](#projen-release-publisher)</code> | Package publisher.<br/>__*Optional*__
6599
6731
  **release**?🔹 | <code>[release.Release](#projen-release-release)</code> | Release management.<br/>__*Optional*__
6600
6732
  **upgradeWorkflow**?🔹 | <code>[javascript.UpgradeDependencies](#projen-javascript-upgradedependencies)</code> | The upgrade workflow.<br/>__*Optional*__
@@ -6729,19 +6861,6 @@ addPeerDeps(...deps: string[]): void
6729
6861
 
6730
6862
 
6731
6863
 
6732
- #### addPrettierIgnore(pattern)🔹 <a id="projen-javascript-nodeproject-addprettierignore"></a>
6733
-
6734
- Defines Prettier ignore Patterns these patterns will be added to the file .prettierignore.
6735
-
6736
- ```ts
6737
- addPrettierIgnore(pattern: string): void
6738
- ```
6739
-
6740
- * **pattern** (<code>string</code>) filepatterns so exclude from prettier formatting.
6741
-
6742
-
6743
-
6744
-
6745
6864
  #### addTestCommand(...commands)⚠️ <a id="projen-javascript-nodeproject-addtestcommand"></a>
6746
6865
 
6747
6866
  DEPRECATED.
@@ -6887,32 +7006,9 @@ new javascript.Prettier(project: NodeProject, options: PrettierOptions)
6887
7006
 
6888
7007
  * **project** (<code>[javascript.NodeProject](#projen-javascript-nodeproject)</code>) *No description*
6889
7008
  * **options** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) *No description*
6890
- * **arrowParens** (<code>[javascript.ArrowParens](#projen-javascript-arrowparens)</code>) Include parentheses around a sole arrow function parameter. __*Default*__: ArrowParens.ALWAYS
6891
- * **bracketSameLine** (<code>boolean</code>) Put > of opening tags on the last line instead of on a new line. __*Default*__: false
6892
- * **bracketSpacing** (<code>boolean</code>) Print spaces between brackets. __*Default*__: true
6893
- * **cursorOffset** (<code>number</code>) Print (to stderr) where a cursor at the given position would move to after formatting. __*Default*__: -1
6894
- * **embeddedLanguageFormatting** (<code>[javascript.EmbeddedLanguageFormatting](#projen-javascript-embeddedlanguageformatting)</code>) Control how Prettier formats quoted code embedded in the file. __*Default*__: EmbeddedLanguageFormatting.AUTO
6895
- * **endOfLine** (<code>[javascript.EndOfLine](#projen-javascript-endofline)</code>) Which end of line characters to apply. __*Default*__: EndOfLine.LF
6896
- * **filepath** (<code>string</code>) Specify the input filepath. __*Default*__: none
6897
- * **htmlWhitespaceSensitivity** (<code>[javascript.HTMLWhitespaceSensitivity](#projen-javascript-htmlwhitespacesensitivity)</code>) How to handle whitespaces in HTML. __*Default*__: HTMLWhitespaceSensitivity.CSS
6898
- * **insertPragma** (<code>boolean</code>) Insert @format pragma into file's first docblock comment. __*Default*__: false
6899
- * **jsxSingleQuote** (<code>boolean</code>) Use single quotes in JSX. __*Default*__: false
6900
- * **parser** (<code>string</code>) Which parser to use. __*Default*__: Prettier automatically infers the parser from the input file path, so you shouldn’t have to change this setting.
6901
- * **plugins** (<code>Array<string></code>) Add a plugin. __*Default*__: []
6902
- * **pluginSearchDirs** (<code>Array<string></code>) Custom directory that contains prettier plugins in node_modules subdirectory. __*Default*__: []
6903
- * **printWidth** (<code>number</code>) The line length where Prettier will try wrap. __*Default*__: 80
6904
- * **proseWrap** (<code>[javascript.ProseWrap](#projen-javascript-prosewrap)</code>) How to wrap prose. __*Default*__: ProseWrap.PRESERVE
6905
- * **quoteProps** (<code>[javascript.QuoteProps](#projen-javascript-quoteprops)</code>) Change when properties in objects are quoted. __*Default*__: QuoteProps.ASNEEDED
6906
- * **rangeEnd** (<code>number</code>) Format code ending at a given character offset (exclusive). __*Default*__: null
6907
- * **rangeStart** (<code>number</code>) Format code starting at a given character offset. __*Default*__: 0
6908
- * **requirePragma** (<code>boolean</code>) Require either '@prettier' or '@format' to be present in the file's first docblock comment in order for it to be formatted. __*Default*__: false
6909
- * **semi** (<code>boolean</code>) Print semicolons. __*Default*__: true
6910
- * **singleQuote** (<code>boolean</code>) Use single quotes instead of double quotes. __*Default*__: false
6911
- * **tabWidth** (<code>number</code>) Number of spaces per indentation level. __*Default*__: 2
6912
- * **trailingComma** (<code>[javascript.TrailingComma](#projen-javascript-trailingcomma)</code>) Print trailing commas wherever possible when multi-line. __*Default*__: TrailingComma.ES5
6913
- * **useTabs** (<code>boolean</code>) Indent with tabs instead of spaces. __*Default*__: false
6914
- * **vueIndentScriptAndStyle** (<code>boolean</code>) Indent script and style tags in Vue files. __*Default*__: false
7009
+ * **ignoreFile** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: true
6915
7010
  * **overrides** (<code>Array<[javascript.PrettierOverride](#projen-javascript-prettieroverride)></code>) Provide a list of patterns to override prettier configuration. __*Default*__: []
7011
+ * **settings** (<code>[javascript.PrettierSettings](#projen-javascript-prettiersettings)</code>) Prettier settings. __*Default*__: default settings
6916
7012
 
6917
7013
 
6918
7014
 
@@ -6921,12 +7017,26 @@ new javascript.Prettier(project: NodeProject, options: PrettierOptions)
6921
7017
 
6922
7018
  Name | Type | Description
6923
7019
  -----|------|-------------
6924
- **config**🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Direct access to the prettier configuration.
6925
7020
  **overrides**🔹 | <code>Array<[javascript.PrettierOverride](#projen-javascript-prettieroverride)></code> | Access to the Prettieroverrides to extend those.
7021
+ **settings**🔹 | <code>[javascript.PrettierSettings](#projen-javascript-prettiersettings)</code> | Direct access to the prettier settings.
7022
+ **ignoreFile**?🔹 | <code>[IgnoreFile](#projen-ignorefile)</code> | The .prettierIgnore file.<br/>__*Optional*__
6926
7023
 
6927
7024
  ### Methods
6928
7025
 
6929
7026
 
7027
+ #### addIgnorePattern(pattern)🔹 <a id="projen-javascript-prettier-addignorepattern"></a>
7028
+
7029
+ Defines Prettier ignore Patterns these patterns will be added to the file .prettierignore.
7030
+
7031
+ ```ts
7032
+ addIgnorePattern(pattern: string): void
7033
+ ```
7034
+
7035
+ * **pattern** (<code>string</code>) filepatterns so exclude from prettier formatting.
7036
+
7037
+
7038
+
7039
+
6930
7040
  #### addOverride(override)🔹 <a id="projen-javascript-prettier-addoverride"></a>
6931
7041
 
6932
7042
  Add a prettier override.
@@ -6937,7 +7047,7 @@ addOverride(override: PrettierOverride): void
6937
7047
 
6938
7048
  * **override** (<code>[javascript.PrettierOverride](#projen-javascript-prettieroverride)</code>) *No description*
6939
7049
  * **files** (<code>string &#124; Array<string></code>) Include these files in this override.
6940
- * **options** (<code>[javascript.PrettierBaseOptions](#projen-javascript-prettierbaseoptions)</code>) The options to apply for this override.
7050
+ * **settings** (<code>[javascript.PrettierSettings](#projen-javascript-prettiersettings)</code>) The options to apply for this override.
6941
7051
  * **excludeFiles** (<code>string &#124; Array<string></code>) Exclude these files from this override. __*Optional*__
6942
7052
 
6943
7053
 
@@ -8312,8 +8422,7 @@ new typescript.TypeScriptAppProject(options: TypeScriptProjectOptions)
8312
8422
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
8313
8423
  * **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
8314
8424
  * **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
8315
- * **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
8316
- * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
8425
+ * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
8317
8426
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
8318
8427
  * **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
8319
8428
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
@@ -8463,8 +8572,7 @@ new typescript.TypeScriptLibraryProject(options: TypeScriptProjectOptions)
8463
8572
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
8464
8573
  * **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
8465
8574
  * **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
8466
- * **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
8467
- * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
8575
+ * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
8468
8576
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
8469
8577
  * **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
8470
8578
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
@@ -8614,8 +8722,7 @@ new typescript.TypeScriptProject(options: TypeScriptProjectOptions)
8614
8722
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
8615
8723
  * **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
8616
8724
  * **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
8617
- * **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
8618
- * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
8725
+ * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
8619
8726
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
8620
8727
  * **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
8621
8728
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
@@ -9010,8 +9117,7 @@ new web.NextJsProject(options: NextJsProjectOptions)
9010
9117
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
9011
9118
  * **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
9012
9119
  * **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
9013
- * **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
9014
- * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
9120
+ * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
9015
9121
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
9016
9122
  * **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
9017
9123
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
@@ -9159,8 +9265,7 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
9159
9265
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
9160
9266
  * **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
9161
9267
  * **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
9162
- * **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
9163
- * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
9268
+ * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
9164
9269
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
9165
9270
  * **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
9166
9271
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
@@ -9380,8 +9485,7 @@ new web.ReactProject(options: ReactProjectOptions)
9380
9485
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
9381
9486
  * **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
9382
9487
  * **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
9383
- * **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
9384
- * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
9488
+ * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
9385
9489
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
9386
9490
  * **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
9387
9491
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
@@ -9570,8 +9674,7 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
9570
9674
  * **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
9571
9675
  * **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
9572
9676
  * **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
9573
- * **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
9574
- * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
9677
+ * **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
9575
9678
  * **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
9576
9679
  * **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
9577
9680
  * **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
@@ -10595,9 +10698,9 @@ Name | Type | Description
10595
10698
  **bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
10596
10699
  **bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
10597
10700
  **catalog**?🔹 | <code>[cdk.Catalog](#projen-cdk-catalog)</code> | Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:.<br/>__*Default*__: new version will be announced
10598
- **cdkAssert**?⚠️ | <code>boolean</code> | Install the @aws-cdk/assert library?<br/>__*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
10599
- **cdkAssertions**?🔹 | <code>boolean</code> | Install the @aws-cdk/assertions library?<br/>__*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
10600
- **cdkDependencies**?⚠️ | <code>Array<string></code> | Which AWS CDK modules (those that start with "@aws-cdk/") does this library require when consumed?<br/>__*Optional*__
10701
+ **cdkAssert**?⚠️ | <code>boolean</code> | Warning: NodeJS only.<br/>__*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
10702
+ **cdkAssertions**?🔹 | <code>boolean</code> | Install the assertions library?<br/>__*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
10703
+ **cdkDependencies**?⚠️ | <code>Array<string></code> | Which AWS CDKv1 modules this project requires.<br/>__*Optional*__
10601
10704
  **cdkDependenciesAsDeps**?⚠️ | <code>boolean</code> | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`).<br/>__*Default*__: true
10602
10705
  **cdkTestDependencies**?⚠️ | <code>Array<string></code> | AWS CDK modules required for testing.<br/>__*Optional*__
10603
10706
  **cdkVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for CDK.<br/>__*Optional*__
@@ -10665,8 +10768,7 @@ Name | Type | Description
10665
10768
  **postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
10666
10769
  **prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
10667
10770
  **prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
10668
- **prettierIgnoreEnabled**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
10669
- **prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
10771
+ **prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
10670
10772
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
10671
10773
  **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
10672
10774
  **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
@@ -10737,9 +10839,9 @@ Options for `AwsCdkDeps`.
10737
10839
  Name | Type | Description
10738
10840
  -----|------|-------------
10739
10841
  **cdkVersion**🔹 | <code>string</code> | Minimum version of the AWS CDK to depend on.
10740
- **cdkAssert**?⚠️ | <code>boolean</code> | Install the @aws-cdk/assert library?<br/>__*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
10741
- **cdkAssertions**?🔹 | <code>boolean</code> | Install the @aws-cdk/assertions library?<br/>__*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
10742
- **cdkDependencies**?⚠️ | <code>Array<string></code> | Which AWS CDK modules (those that start with "@aws-cdk/") does this library require when consumed?<br/>__*Optional*__
10842
+ **cdkAssert**?⚠️ | <code>boolean</code> | Warning: NodeJS only.<br/>__*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
10843
+ **cdkAssertions**?🔹 | <code>boolean</code> | Install the assertions library?<br/>__*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
10844
+ **cdkDependencies**?⚠️ | <code>Array<string></code> | Which AWS CDKv1 modules this project requires.<br/>__*Optional*__
10743
10845
  **cdkDependenciesAsDeps**?⚠️ | <code>boolean</code> | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`).<br/>__*Default*__: true
10744
10846
  **cdkTestDependencies**?⚠️ | <code>Array<string></code> | AWS CDK modules required for testing.<br/>__*Optional*__
10745
10847
  **cdkVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for CDK.<br/>__*Optional*__
@@ -10758,9 +10860,9 @@ Name | Type | Description
10758
10860
  -----|------|-------------
10759
10861
  **cdkVersion**🔹 | <code>string</code> | Minimum version of the AWS CDK to depend on.
10760
10862
  **dependencyType**🔹 | <code>[DependencyType](#projen-dependencytype)</code> | The type of dependency to use for runtime AWS CDK and `constructs` modules.
10761
- **cdkAssert**?⚠️ | <code>boolean</code> | Install the @aws-cdk/assert library?<br/>__*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
10762
- **cdkAssertions**?🔹 | <code>boolean</code> | Install the @aws-cdk/assertions library?<br/>__*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
10763
- **cdkDependencies**?⚠️ | <code>Array<string></code> | Which AWS CDK modules (those that start with "@aws-cdk/") does this library require when consumed?<br/>__*Optional*__
10863
+ **cdkAssert**?⚠️ | <code>boolean</code> | Warning: NodeJS only.<br/>__*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
10864
+ **cdkAssertions**?🔹 | <code>boolean</code> | Install the assertions library?<br/>__*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
10865
+ **cdkDependencies**?⚠️ | <code>Array<string></code> | Which AWS CDKv1 modules this project requires.<br/>__*Optional*__
10764
10866
  **cdkDependenciesAsDeps**?⚠️ | <code>boolean</code> | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`).<br/>__*Default*__: true
10765
10867
  **cdkTestDependencies**?⚠️ | <code>Array<string></code> | AWS CDK modules required for testing.<br/>__*Optional*__
10766
10868
  **cdkVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for CDK.<br/>__*Optional*__
@@ -10778,7 +10880,7 @@ Name | Type | Description
10778
10880
  Name | Type | Description
10779
10881
  -----|------|-------------
10780
10882
  **artifactId**🔹 | <code>string</code> | The artifactId is generally the name that the project is known by.
10781
- **cdkVersion**🔹 | <code>string</code> | AWS CDK version to use (you can use semantic versioning).
10883
+ **cdkVersion**🔹 | <code>string</code> | Minimum version of the AWS CDK to depend on.
10782
10884
  **groupId**🔹 | <code>string</code> | This is generally unique amongst an organization or a project.
10783
10885
  **mainClass**🔹 | <code>string</code> | The name of the Java class with the static `main()` method.
10784
10886
  **name**🔹 | <code>string</code> | This is the name of your project.
@@ -10786,10 +10888,16 @@ Name | Type | Description
10786
10888
  **autoApproveOptions**?🔹 | <code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code> | Enable and configure the 'auto approve' workflow.<br/>__*Default*__: auto approve is disabled
10787
10889
  **autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
10788
10890
  **buildCommand**?🔹 | <code>string</code> | A command to execute before synthesis.<br/>__*Default*__: no build command
10789
- **cdkDependencies**?🔹 | <code>Array<string></code> | Which AWS CDK modules this app uses.<br/>__*Optional*__
10891
+ **cdkAssert**?⚠️ | <code>boolean</code> | Warning: NodeJS only.<br/>__*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
10892
+ **cdkAssertions**?🔹 | <code>boolean</code> | Install the assertions library?<br/>__*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
10893
+ **cdkDependencies**?⚠️ | <code>Array<string></code> | Which AWS CDKv1 modules this project requires.<br/>__*Optional*__
10894
+ **cdkDependenciesAsDeps**?⚠️ | <code>boolean</code> | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`).<br/>__*Default*__: true
10895
+ **cdkTestDependencies**?⚠️ | <code>Array<string></code> | AWS CDK modules required for testing.<br/>__*Optional*__
10896
+ **cdkVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for CDK.<br/>__*Optional*__
10790
10897
  **cdkout**?🔹 | <code>string</code> | cdk.out directory.<br/>__*Default*__: "cdk.out"
10791
10898
  **clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
10792
10899
  **compileOptions**?🔹 | <code>[java.MavenCompileOptions](#projen-java-mavencompileoptions)</code> | Compile options.<br/>__*Default*__: defaults
10900
+ **constructsVersion**?🔹 | <code>string</code> | Minimum version of the `constructs` library to depend on.<br/>__*Default*__: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
10793
10901
  **context**?🔹 | <code>Map<string, any></code> | Additional context to include in `cdk.json`.<br/>__*Default*__: no additional context
10794
10902
  **deps**?🔹 | <code>Array<string></code> | List of runtime dependencies for this project.<br/>__*Default*__: []
10795
10903
  **description**?🔹 | <code>string</code> | Description of a project is always good.<br/>__*Default*__: undefined
@@ -10817,7 +10925,7 @@ Name | Type | Description
10817
10925
  **projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
10818
10926
  **readme**?🔹 | <code>[SampleReadmeProps](#projen-samplereadmeprops)</code> | The README setup.<br/>__*Default*__: { filename: 'README.md', contents: '# replace this' }
10819
10927
  **requireApproval**?🔹 | <code>[awscdk.ApprovalLevel](#projen-awscdk-approvallevel)</code> | To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them.<br/>__*Default*__: ApprovalLevel.BROADENING
10820
- **sample**?🔹 | <code>boolean</code> | Include sample code and test if the relevant directories don't exist.<br/>__*Optional*__
10928
+ **sample**?🔹 | <code>boolean</code> | Include sample code and test if the relevant directories don't exist.<br/>__*Default*__: true
10821
10929
  **sampleJavaPackage**?🔹 | <code>string</code> | The java package to use for the code sample.<br/>__*Default*__: "org.acme"
10822
10930
  **stale**?🔹 | <code>boolean</code> | Auto-close of stale issues and pull request.<br/>__*Default*__: true
10823
10931
  **staleOptions**?🔹 | <code>[github.StaleOptions](#projen-github-staleoptions)</code> | Auto-close stale issues and pull requests.<br/>__*Default*__: see defaults in `StaleOptions`
@@ -10829,6 +10937,24 @@ Name | Type | Description
10829
10937
 
10830
10938
 
10831
10939
 
10940
+ ## struct AwsCdkPackageNames 🔹 <a id="projen-awscdk-awscdkpackagenames"></a>
10941
+
10942
+ __Obtainable from__: [AwsCdkDeps](#projen-awscdk-awscdkdeps).[packageNames](#projen-awscdk-awscdkdeps#projen-awscdk-awscdkdeps-packagenames)(), [AwsCdkDepsJava](#projen-awscdk-awscdkdepsjava).[packageNames](#projen-awscdk-awscdkdepsjava#projen-awscdk-awscdkdepsjava-packagenames)(), [AwsCdkDepsJs](#projen-awscdk-awscdkdepsjs).[packageNames](#projen-awscdk-awscdkdepsjs#projen-awscdk-awscdkdepsjs-packagenames)()
10943
+
10944
+ Language-specific AWS CDK package names.
10945
+
10946
+
10947
+
10948
+ Name | Type | Description
10949
+ -----|------|-------------
10950
+ **assertions**🔹 | <code>string</code> | Fully qualified name of the assertions library package.
10951
+ **constructs**🔹 | <code>string</code> | Fully qualified name of the constructs library package.
10952
+ **coreV1**🔹 | <code>string</code> | Fully qualified name of the core framework package for CDKv1.
10953
+ **coreV2**🔹 | <code>string</code> | Fully qualified name of the core framework package for CDKv2.
10954
+ **assert**?🔹 | <code>string</code> | Fully qualified name of the assert library package Can be empty as it's only really available for javascript projects.<br/>__*Optional*__
10955
+
10956
+
10957
+
10832
10958
  ## struct AwsCdkTypeScriptAppOptions 🔹 <a id="projen-awscdk-awscdktypescriptappoptions"></a>
10833
10959
 
10834
10960
 
@@ -10860,9 +10986,9 @@ Name | Type | Description
10860
10986
  **buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
10861
10987
  **bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
10862
10988
  **bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
10863
- **cdkAssert**?⚠️ | <code>boolean</code> | Install the @aws-cdk/assert library?<br/>__*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
10864
- **cdkAssertions**?🔹 | <code>boolean</code> | Install the @aws-cdk/assertions library?<br/>__*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
10865
- **cdkDependencies**?⚠️ | <code>Array<string></code> | Which AWS CDK modules (those that start with "@aws-cdk/") does this library require when consumed?<br/>__*Optional*__
10989
+ **cdkAssert**?⚠️ | <code>boolean</code> | Warning: NodeJS only.<br/>__*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
10990
+ **cdkAssertions**?🔹 | <code>boolean</code> | Install the assertions library?<br/>__*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
10991
+ **cdkDependencies**?⚠️ | <code>Array<string></code> | Which AWS CDKv1 modules this project requires.<br/>__*Optional*__
10866
10992
  **cdkDependenciesAsDeps**?⚠️ | <code>boolean</code> | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`).<br/>__*Default*__: true
10867
10993
  **cdkTestDependencies**?⚠️ | <code>Array<string></code> | AWS CDK modules required for testing.<br/>__*Optional*__
10868
10994
  **cdkVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for CDK.<br/>__*Optional*__
@@ -10929,8 +11055,7 @@ Name | Type | Description
10929
11055
  **postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
10930
11056
  **prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
10931
11057
  **prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
10932
- **prettierIgnoreEnabled**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
10933
- **prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
11058
+ **prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
10934
11059
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
10935
11060
  **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
10936
11061
  **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
@@ -11060,9 +11185,9 @@ Name | Type | Description
11060
11185
  **bundledDeps**?⚠️ | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
11061
11186
  **bundlerOptions**?⚠️ | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
11062
11187
  **catalog**?⚠️ | <code>[cdk.Catalog](#projen-cdk-catalog)</code> | Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:.<br/>__*Default*__: new version will be announced
11063
- **cdkAssert**?⚠️ | <code>boolean</code> | Install the @aws-cdk/assert library?<br/>__*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
11064
- **cdkAssertions**?⚠️ | <code>boolean</code> | Install the @aws-cdk/assertions library?<br/>__*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
11065
- **cdkDependencies**?⚠️ | <code>Array<string></code> | Which AWS CDK modules (those that start with "@aws-cdk/") does this library require when consumed?<br/>__*Optional*__
11188
+ **cdkAssert**?⚠️ | <code>boolean</code> | Warning: NodeJS only.<br/>__*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
11189
+ **cdkAssertions**?⚠️ | <code>boolean</code> | Install the assertions library?<br/>__*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
11190
+ **cdkDependencies**?⚠️ | <code>Array<string></code> | Which AWS CDKv1 modules this project requires.<br/>__*Optional*__
11066
11191
  **cdkDependenciesAsDeps**?⚠️ | <code>boolean</code> | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`).<br/>__*Default*__: true
11067
11192
  **cdkTestDependencies**?⚠️ | <code>Array<string></code> | AWS CDK modules required for testing.<br/>__*Optional*__
11068
11193
  **cdkVersionPinning**?⚠️ | <code>boolean</code> | Use pinned version instead of caret version for CDK.<br/>__*Optional*__
@@ -11130,8 +11255,7 @@ Name | Type | Description
11130
11255
  **postBuildSteps**?⚠️ | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
11131
11256
  **prerelease**?⚠️ | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
11132
11257
  **prettier**?⚠️ | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
11133
- **prettierIgnoreEnabled**?⚠️ | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
11134
- **prettierOptions**?⚠️ | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
11258
+ **prettierOptions**?⚠️ | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
11135
11259
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
11136
11260
  **projenCommand**?⚠️ | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
11137
11261
  **projenDevDependency**?⚠️ | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
@@ -11383,8 +11507,7 @@ Name | Type | Description
11383
11507
  **postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
11384
11508
  **prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
11385
11509
  **prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
11386
- **prettierIgnoreEnabled**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
11387
- **prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
11510
+ **prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
11388
11511
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
11389
11512
  **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
11390
11513
  **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
@@ -11600,8 +11723,7 @@ Name | Type | Description
11600
11723
  **postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
11601
11724
  **prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
11602
11725
  **prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
11603
- **prettierIgnoreEnabled**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
11604
- **prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
11726
+ **prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
11605
11727
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
11606
11728
  **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
11607
11729
  **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
@@ -11774,8 +11896,7 @@ Name | Type | Description
11774
11896
  **postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
11775
11897
  **prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
11776
11898
  **prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
11777
- **prettierIgnoreEnabled**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
11778
- **prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
11899
+ **prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
11779
11900
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
11780
11901
  **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
11781
11902
  **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
@@ -11928,8 +12049,7 @@ Name | Type | Description
11928
12049
  **postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
11929
12050
  **prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
11930
12051
  **prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
11931
- **prettierIgnoreEnabled**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
11932
- **prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
12052
+ **prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
11933
12053
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
11934
12054
  **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
11935
12055
  **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
@@ -12084,8 +12204,7 @@ Name | Type | Description
12084
12204
  **postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
12085
12205
  **prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
12086
12206
  **prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
12087
- **prettierIgnoreEnabled**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
12088
- **prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
12207
+ **prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
12089
12208
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
12090
12209
  **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
12091
12210
  **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
@@ -12589,7 +12708,7 @@ Name | Type | Description
12589
12708
  **projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
12590
12709
  **projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
12591
12710
  **readme**?🔹 | <code>[SampleReadmeProps](#projen-samplereadmeprops)</code> | The README setup.<br/>__*Default*__: { filename: 'README.md', contents: '# replace this' }
12592
- **sample**?🔹 | <code>boolean</code> | Include sample code and test if the relevant directories don't exist.<br/>__*Optional*__
12711
+ **sample**?🔹 | <code>boolean</code> | Include sample code and test if the relevant directories don't exist.<br/>__*Default*__: true
12593
12712
  **sampleJavaPackage**?🔹 | <code>string</code> | The java package to use for the code sample.<br/>__*Default*__: "org.acme"
12594
12713
  **stale**?🔹 | <code>boolean</code> | Auto-close of stale issues and pull request.<br/>__*Default*__: true
12595
12714
  **staleOptions**?🔹 | <code>[github.StaleOptions](#projen-github-staleoptions)</code> | Auto-close stale issues and pull requests.<br/>__*Default*__: see defaults in `StaleOptions`
@@ -13085,8 +13204,7 @@ Name | Type | Description
13085
13204
  **postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
13086
13205
  **prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
13087
13206
  **prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
13088
- **prettierIgnoreEnabled**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
13089
- **prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
13207
+ **prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
13090
13208
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
13091
13209
  **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
13092
13210
  **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
@@ -13158,47 +13276,40 @@ Name | Type | Description
13158
13276
 
13159
13277
 
13160
13278
 
13161
- ## struct PrettierBaseOptions 🔹 <a id="projen-javascript-prettierbaseoptions"></a>
13279
+ ## struct PrettierOptions 🔹 <a id="projen-javascript-prettieroptions"></a>
13162
13280
 
13163
13281
 
13164
- Options to set in Prettier directly or through overrides.
13282
+ Options for Prettier.
13165
13283
 
13166
13284
 
13167
13285
 
13168
13286
  Name | Type | Description
13169
13287
  -----|------|-------------
13170
- **arrowParens**?🔹 | <code>[javascript.ArrowParens](#projen-javascript-arrowparens)</code> | Include parentheses around a sole arrow function parameter.<br/>__*Default*__: ArrowParens.ALWAYS
13171
- **bracketSameLine**?🔹 | <code>boolean</code> | Put > of opening tags on the last line instead of on a new line.<br/>__*Default*__: false
13172
- **bracketSpacing**?🔹 | <code>boolean</code> | Print spaces between brackets.<br/>__*Default*__: true
13173
- **cursorOffset**?🔹 | <code>number</code> | Print (to stderr) where a cursor at the given position would move to after formatting.<br/>__*Default*__: -1
13174
- **embeddedLanguageFormatting**?🔹 | <code>[javascript.EmbeddedLanguageFormatting](#projen-javascript-embeddedlanguageformatting)</code> | Control how Prettier formats quoted code embedded in the file.<br/>__*Default*__: EmbeddedLanguageFormatting.AUTO
13175
- **endOfLine**?🔹 | <code>[javascript.EndOfLine](#projen-javascript-endofline)</code> | Which end of line characters to apply.<br/>__*Default*__: EndOfLine.LF
13176
- **filepath**?🔹 | <code>string</code> | Specify the input filepath.<br/>__*Default*__: none
13177
- **htmlWhitespaceSensitivity**?🔹 | <code>[javascript.HTMLWhitespaceSensitivity](#projen-javascript-htmlwhitespacesensitivity)</code> | How to handle whitespaces in HTML.<br/>__*Default*__: HTMLWhitespaceSensitivity.CSS
13178
- **insertPragma**?🔹 | <code>boolean</code> | Insert @format pragma into file's first docblock comment.<br/>__*Default*__: false
13179
- **jsxSingleQuote**?🔹 | <code>boolean</code> | Use single quotes in JSX.<br/>__*Default*__: false
13180
- **parser**?🔹 | <code>string</code> | Which parser to use.<br/>__*Default*__: Prettier automatically infers the parser from the input file path, so you shouldn’t have to change this setting.
13181
- **pluginSearchDirs**?🔹 | <code>Array<string></code> | Custom directory that contains prettier plugins in node_modules subdirectory.<br/>__*Default*__: []
13182
- **plugins**?🔹 | <code>Array<string></code> | Add a plugin.<br/>__*Default*__: []
13183
- **printWidth**?🔹 | <code>number</code> | The line length where Prettier will try wrap.<br/>__*Default*__: 80
13184
- **proseWrap**?🔹 | <code>[javascript.ProseWrap](#projen-javascript-prosewrap)</code> | How to wrap prose.<br/>__*Default*__: ProseWrap.PRESERVE
13185
- **quoteProps**?🔹 | <code>[javascript.QuoteProps](#projen-javascript-quoteprops)</code> | Change when properties in objects are quoted.<br/>__*Default*__: QuoteProps.ASNEEDED
13186
- **rangeEnd**?🔹 | <code>number</code> | Format code ending at a given character offset (exclusive).<br/>__*Default*__: null
13187
- **rangeStart**?🔹 | <code>number</code> | Format code starting at a given character offset.<br/>__*Default*__: 0
13188
- **requirePragma**?🔹 | <code>boolean</code> | Require either '@prettier' or '@format' to be present in the file's first docblock comment in order for it to be formatted.<br/>__*Default*__: false
13189
- **semi**?🔹 | <code>boolean</code> | Print semicolons.<br/>__*Default*__: true
13190
- **singleQuote**?🔹 | <code>boolean</code> | Use single quotes instead of double quotes.<br/>__*Default*__: false
13191
- **tabWidth**?🔹 | <code>number</code> | Number of spaces per indentation level.<br/>__*Default*__: 2
13192
- **trailingComma**?🔹 | <code>[javascript.TrailingComma](#projen-javascript-trailingcomma)</code> | Print trailing commas wherever possible when multi-line.<br/>__*Default*__: TrailingComma.ES5
13193
- **useTabs**?🔹 | <code>boolean</code> | Indent with tabs instead of spaces.<br/>__*Default*__: false
13194
- **vueIndentScriptAndStyle**?🔹 | <code>boolean</code> | Indent script and style tags in Vue files.<br/>__*Default*__: false
13288
+ **ignoreFile**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: true
13289
+ **overrides**?🔹 | <code>Array<[javascript.PrettierOverride](#projen-javascript-prettieroverride)></code> | Provide a list of patterns to override prettier configuration.<br/>__*Default*__: []
13290
+ **settings**?🔹 | <code>[javascript.PrettierSettings](#projen-javascript-prettiersettings)</code> | Prettier settings.<br/>__*Default*__: default settings
13195
13291
 
13196
13292
 
13197
13293
 
13198
- ## struct PrettierOptions 🔹 <a id="projen-javascript-prettieroptions"></a>
13294
+ ## struct PrettierOverride 🔹 <a id="projen-javascript-prettieroverride"></a>
13199
13295
 
13200
13296
 
13201
- Options for Prettier.
13297
+
13298
+
13299
+
13300
+
13301
+ Name | Type | Description
13302
+ -----|------|-------------
13303
+ **files**🔹 | <code>string &#124; Array<string></code> | Include these files in this override.
13304
+ **settings**🔹 | <code>[javascript.PrettierSettings](#projen-javascript-prettiersettings)</code> | The options to apply for this override.
13305
+ **excludeFiles**?🔹 | <code>string &#124; Array<string></code> | Exclude these files from this override.<br/>__*Optional*__
13306
+
13307
+
13308
+
13309
+ ## struct PrettierSettings 🔹 <a id="projen-javascript-prettiersettings"></a>
13310
+
13311
+
13312
+ Options to set in Prettier directly or through overrides.
13202
13313
 
13203
13314
 
13204
13315
 
@@ -13214,7 +13325,6 @@ Name | Type | Description
13214
13325
  **htmlWhitespaceSensitivity**?🔹 | <code>[javascript.HTMLWhitespaceSensitivity](#projen-javascript-htmlwhitespacesensitivity)</code> | How to handle whitespaces in HTML.<br/>__*Default*__: HTMLWhitespaceSensitivity.CSS
13215
13326
  **insertPragma**?🔹 | <code>boolean</code> | Insert @format pragma into file's first docblock comment.<br/>__*Default*__: false
13216
13327
  **jsxSingleQuote**?🔹 | <code>boolean</code> | Use single quotes in JSX.<br/>__*Default*__: false
13217
- **overrides**?🔹 | <code>Array<[javascript.PrettierOverride](#projen-javascript-prettieroverride)></code> | Provide a list of patterns to override prettier configuration.<br/>__*Default*__: []
13218
13328
  **parser**?🔹 | <code>string</code> | Which parser to use.<br/>__*Default*__: Prettier automatically infers the parser from the input file path, so you shouldn’t have to change this setting.
13219
13329
  **pluginSearchDirs**?🔹 | <code>Array<string></code> | Custom directory that contains prettier plugins in node_modules subdirectory.<br/>__*Default*__: []
13220
13330
  **plugins**?🔹 | <code>Array<string></code> | Add a plugin.<br/>__*Default*__: []
@@ -13233,21 +13343,6 @@ Name | Type | Description
13233
13343
 
13234
13344
 
13235
13345
 
13236
- ## struct PrettierOverride 🔹 <a id="projen-javascript-prettieroverride"></a>
13237
-
13238
-
13239
-
13240
-
13241
-
13242
-
13243
- Name | Type | Description
13244
- -----|------|-------------
13245
- **files**🔹 | <code>string &#124; Array<string></code> | Include these files in this override.
13246
- **options**🔹 | <code>[javascript.PrettierBaseOptions](#projen-javascript-prettierbaseoptions)</code> | The options to apply for this override.
13247
- **excludeFiles**?🔹 | <code>string &#124; Array<string></code> | Exclude these files from this override.<br/>__*Optional*__
13248
-
13249
-
13250
-
13251
13346
  ## struct ProjenrcOptions 🔹 <a id="projen-javascript-projenrcoptions"></a>
13252
13347
 
13253
13348
 
@@ -14163,8 +14258,7 @@ Name | Type | Description
14163
14258
  **postBuildSteps**?⚠️ | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
14164
14259
  **prerelease**?⚠️ | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
14165
14260
  **prettier**?⚠️ | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
14166
- **prettierIgnoreEnabled**?⚠️ | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
14167
- **prettierOptions**?⚠️ | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
14261
+ **prettierOptions**?⚠️ | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
14168
14262
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
14169
14263
  **projenCommand**?⚠️ | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
14170
14264
  **projenDevDependency**?⚠️ | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
@@ -14304,8 +14398,7 @@ Name | Type | Description
14304
14398
  **postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
14305
14399
  **prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
14306
14400
  **prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
14307
- **prettierIgnoreEnabled**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
14308
- **prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
14401
+ **prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
14309
14402
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
14310
14403
  **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
14311
14404
  **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
@@ -14543,8 +14636,7 @@ Name | Type | Description
14543
14636
  **postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
14544
14637
  **prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
14545
14638
  **prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
14546
- **prettierIgnoreEnabled**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
14547
- **prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
14639
+ **prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
14548
14640
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
14549
14641
  **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
14550
14642
  **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
@@ -14679,8 +14771,7 @@ Name | Type | Description
14679
14771
  **postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
14680
14772
  **prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
14681
14773
  **prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
14682
- **prettierIgnoreEnabled**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
14683
- **prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
14774
+ **prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
14684
14775
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
14685
14776
  **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
14686
14777
  **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
@@ -14843,8 +14934,7 @@ Name | Type | Description
14843
14934
  **postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
14844
14935
  **prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
14845
14936
  **prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
14846
- **prettierIgnoreEnabled**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
14847
- **prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
14937
+ **prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
14848
14938
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
14849
14939
  **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
14850
14940
  **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
@@ -15007,8 +15097,7 @@ Name | Type | Description
15007
15097
  **postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
15008
15098
  **prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
15009
15099
  **prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
15010
- **prettierIgnoreEnabled**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
15011
- **prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
15100
+ **prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
15012
15101
  **projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
15013
15102
  **projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
15014
15103
  **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
@@ -15259,8 +15348,8 @@ Name | Description
15259
15348
 
15260
15349
  Name | Description
15261
15350
  -----|-----
15262
- **ALWAYS** 🔹|
15263
- **AVOID** 🔹|
15351
+ **ALWAYS** 🔹|Always include parens.
15352
+ **AVOID** 🔹|Omit parens when possible.
15264
15353
 
15265
15354
 
15266
15355
  ## enum AutoRelease 🔹 <a id="projen-javascript-autorelease"></a>
@@ -15279,8 +15368,8 @@ Name | Description
15279
15368
 
15280
15369
  Name | Description
15281
15370
  -----|-----
15282
- **AUTO** 🔹|
15283
- **OFF** 🔹|
15371
+ **AUTO** 🔹|Format embedded code if Prettier can automatically identify it.
15372
+ **OFF** 🔹|Never automatically format embedded code.
15284
15373
 
15285
15374
 
15286
15375
  ## enum EndOfLine 🔹 <a id="projen-javascript-endofline"></a>
@@ -15289,10 +15378,10 @@ Name | Description
15289
15378
 
15290
15379
  Name | Description
15291
15380
  -----|-----
15292
- **AUTO** 🔹|
15293
- **CR** 🔹|
15294
- **CRLF** 🔹|
15295
- **LF** 🔹|
15381
+ **AUTO** 🔹|Maintain existing (mixed values within one file are normalised by looking at what's used after the first line).
15382
+ **CR** 🔹|Carriage Return character only (\r), used very rarely.
15383
+ **CRLF** 🔹|Carriage Return + Line Feed characters (\r\n), common on Windows.
15384
+ **LF** 🔹|Line Feed only (\n), common on Linux and macOS as well as inside git repos.
15296
15385
 
15297
15386
 
15298
15387
  ## enum HTMLWhitespaceSensitivity 🔹 <a id="projen-javascript-htmlwhitespacesensitivity"></a>
@@ -15301,9 +15390,9 @@ Name | Description
15301
15390
 
15302
15391
  Name | Description
15303
15392
  -----|-----
15304
- **CSS** 🔹|
15305
- **IGNORE** 🔹|
15306
- **STRICT** 🔹|
15393
+ **CSS** 🔹|Respect the default value of CSS display property.
15394
+ **IGNORE** 🔹|Whitespaces are considered insignificant.
15395
+ **STRICT** 🔹|Whitespaces are considered significant.
15307
15396
 
15308
15397
 
15309
15398
  ## enum NodePackageManager 🔹 <a id="projen-javascript-nodepackagemanager"></a>
@@ -15333,9 +15422,9 @@ Name | Description
15333
15422
 
15334
15423
  Name | Description
15335
15424
  -----|-----
15336
- **ALWAYS** 🔹|
15337
- **NEVER** 🔹|
15338
- **PRESERVE** 🔹|
15425
+ **ALWAYS** 🔹|Wrap prose if it exceeds the print width.
15426
+ **NEVER** 🔹|Do not wrap prose.
15427
+ **PRESERVE** 🔹|Wrap prose as-is.
15339
15428
 
15340
15429
 
15341
15430
  ## enum QuoteProps 🔹 <a id="projen-javascript-quoteprops"></a>
@@ -15344,9 +15433,9 @@ Name | Description
15344
15433
 
15345
15434
  Name | Description
15346
15435
  -----|-----
15347
- **ASNEEDED** 🔹|
15348
- **CONSISTENT** 🔹|
15349
- **PRESERVE** 🔹|
15436
+ **ASNEEDED** 🔹|Only add quotes around object properties where required.
15437
+ **CONSISTENT** 🔹|If at least one property in an object requires quotes, quote all properties.
15438
+ **PRESERVE** 🔹|Respect the input use of quotes in object properties.
15350
15439
 
15351
15440
 
15352
15441
  ## enum TrailingComma 🔹 <a id="projen-javascript-trailingcomma"></a>
@@ -15355,9 +15444,9 @@ Name | Description
15355
15444
 
15356
15445
  Name | Description
15357
15446
  -----|-----
15358
- **ALL** 🔹|
15359
- **ES5** 🔹|
15360
- **NONE** 🔹|
15447
+ **ALL** 🔹|Trailing commas wherever possible (including function arguments).
15448
+ **ES5** 🔹|Trailing commas where valid in ES5 (objects, arrays, etc.).
15449
+ **NONE** 🔹|No trailing commas.
15361
15450
 
15362
15451
 
15363
15452
  ## enum TypeScriptJsxMode 🔹 <a id="projen-javascript-typescriptjsxmode"></a>