projen 0.47.2 → 0.47.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +1335 -161
- package/API.md +427 -3
- package/changelog.md +3 -3
- package/lib/awscdk/auto-discover.js +1 -1
- package/lib/awscdk/awscdk-app-ts.js +1 -1
- package/lib/awscdk/awscdk-construct.js +2 -2
- package/lib/awscdk/awscdk-deps.js +1 -1
- package/lib/awscdk/cdk-config.js +1 -1
- package/lib/awscdk/cdk-tasks.js +1 -1
- package/lib/awscdk/integration-test.js +1 -1
- package/lib/awscdk/java-app.js +1 -1
- package/lib/awscdk/lambda-function.js +2 -2
- package/lib/build/build-workflow.js +5 -9
- package/lib/cdk/construct-lib.js +1 -1
- package/lib/cdk/jsii-docgen.js +1 -1
- package/lib/cdk/jsii-project.d.ts +1 -1
- package/lib/cdk/jsii-project.js +2 -2
- package/lib/cdk8s/cdk8s-app-ts.js +1 -1
- package/lib/cdk8s/cdk8s-construct.js +1 -1
- package/lib/cdktf/cdktf-construct.js +1 -1
- package/lib/component.js +1 -1
- package/lib/dependencies.js +1 -1
- package/lib/dev-env.js +1 -1
- package/lib/docker-compose.js +2 -2
- package/lib/file.js +1 -1
- package/lib/gitattributes.js +1 -1
- package/lib/github/auto-approve.js +1 -1
- package/lib/github/auto-merge.d.ts +26 -7
- package/lib/github/auto-merge.js +33 -11
- package/lib/github/dependabot.js +1 -1
- package/lib/github/github-project.js +1 -1
- package/lib/github/github.js +1 -1
- package/lib/github/mergify.js +1 -1
- package/lib/github/pr-template.js +1 -1
- package/lib/github/pull-request-lint.js +1 -1
- package/lib/github/stale.js +1 -1
- package/lib/github/task-workflow.js +1 -1
- package/lib/github/workflow-actions.d.ts +11 -6
- package/lib/github/workflow-actions.js +8 -8
- package/lib/github/workflows.js +1 -1
- package/lib/gitpod.js +1 -1
- package/lib/ignore-file.js +1 -1
- package/lib/ini.js +1 -1
- package/lib/java/java-project.js +1 -1
- package/lib/java/junit.js +1 -1
- package/lib/java/maven-compile.js +1 -1
- package/lib/java/maven-packaging.js +1 -1
- package/lib/java/maven-sample.js +1 -1
- package/lib/java/pom.js +1 -1
- package/lib/java/projenrc.js +1 -1
- package/lib/javascript/bundler.js +1 -1
- package/lib/javascript/eslint.js +1 -1
- package/lib/javascript/index.d.ts +2 -1
- package/lib/javascript/index.js +3 -2
- package/lib/javascript/jest.js +1 -1
- package/lib/javascript/node-package.js +1 -1
- package/lib/javascript/node-project.d.ts +40 -2
- package/lib/javascript/node-project.js +38 -22
- package/lib/javascript/npm-config.js +1 -1
- package/lib/javascript/prettier.d.ts +444 -0
- package/lib/javascript/prettier.js +113 -0
- package/lib/javascript/projenrc.js +1 -1
- package/lib/javascript/typescript-config.js +1 -1
- package/lib/javascript/upgrade-dependencies.js +16 -4
- package/lib/json.js +1 -1
- package/lib/license.js +1 -1
- package/lib/logger.js +1 -1
- package/lib/makefile.js +1 -1
- package/lib/object-file.js +1 -1
- package/lib/project-build.js +1 -1
- package/lib/project.js +1 -1
- package/lib/projects.js +1 -1
- package/lib/projenrc-json.js +1 -1
- package/lib/python/pip.js +1 -1
- package/lib/python/poetry.js +2 -2
- package/lib/python/projenrc.js +1 -1
- package/lib/python/pytest.js +1 -1
- package/lib/python/python-project.js +1 -1
- package/lib/python/python-sample.js +1 -1
- package/lib/python/requirements-file.js +1 -1
- package/lib/python/setuppy.js +1 -1
- package/lib/python/setuptools.js +1 -1
- package/lib/python/venv.js +1 -1
- package/lib/readme.js +1 -1
- package/lib/release/publisher.js +1 -1
- package/lib/release/release-trigger.js +1 -1
- package/lib/release/release.js +3 -3
- package/lib/sample-file.js +2 -2
- package/lib/semver.js +1 -1
- package/lib/source-code.js +1 -1
- package/lib/task-runtime.js +1 -1
- package/lib/task.js +1 -1
- package/lib/tasks.js +1 -1
- package/lib/testing.js +1 -1
- package/lib/textfile.js +1 -1
- package/lib/toml.js +1 -1
- package/lib/typescript/projenrc.js +1 -1
- package/lib/typescript/typescript-typedoc.js +1 -1
- package/lib/typescript/typescript.js +3 -3
- package/lib/version.js +1 -1
- package/lib/vscode/devcontainer.js +1 -1
- package/lib/vscode/launch-config.js +1 -1
- package/lib/vscode/vscode.js +1 -1
- package/lib/web/next.js +3 -3
- package/lib/web/postcss.js +1 -1
- package/lib/web/react.js +4 -4
- package/lib/web/tailwind.js +1 -1
- package/lib/xmlfile.js +1 -1
- package/lib/yaml.js +1 -1
- package/package.json +1 -1
- package/releasetag.txt +1 -1
- package/rfcs/project-creation-prompt.md +95 -0
- package/version.txt +1 -1
package/API.md
CHANGED
|
@@ -79,6 +79,7 @@ Name|Description
|
|
|
79
79
|
[javascript.NodePackage](#projen-javascript-nodepackage)|Represents the npm `package.json` file.
|
|
80
80
|
[javascript.NodeProject](#projen-javascript-nodeproject)|Node.js project.
|
|
81
81
|
[javascript.NpmConfig](#projen-javascript-npmconfig)|File representing the local NPM config in .npmrc.
|
|
82
|
+
[javascript.Prettier](#projen-javascript-prettier)|Represents prettier configuration.
|
|
82
83
|
[javascript.Projenrc](#projen-javascript-projenrc)|Sets up a javascript project to use TypeScript for projenrc.
|
|
83
84
|
[javascript.TypescriptConfig](#projen-javascript-typescriptconfig)|*No description*
|
|
84
85
|
[javascript.UpgradeDependencies](#projen-javascript-upgradedependencies)|Upgrade node project dependencies.
|
|
@@ -230,6 +231,9 @@ Name|Description
|
|
|
230
231
|
[javascript.NodeProjectOptions](#projen-javascript-nodeprojectoptions)|*No description*
|
|
231
232
|
[javascript.NpmConfigOptions](#projen-javascript-npmconfigoptions)|Options to configure the local NPM config.
|
|
232
233
|
[javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions)|*No description*
|
|
234
|
+
[javascript.PrettierBaseOptions](#projen-javascript-prettierbaseoptions)|Options to set in Prettier directly or through overrides.
|
|
235
|
+
[javascript.PrettierOptions](#projen-javascript-prettieroptions)|Options for Prettier.
|
|
236
|
+
[javascript.PrettierOverride](#projen-javascript-prettieroverride)|*No description*
|
|
233
237
|
[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)|*No description*
|
|
234
238
|
[javascript.TypeScriptCompilerOptions](#projen-javascript-typescriptcompileroptions)|*No description*
|
|
235
239
|
[javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)|*No description*
|
|
@@ -295,6 +299,7 @@ Name|Description
|
|
|
295
299
|
[IDockerComposeVolumeConfig](#projen-idockercomposevolumeconfig)|Storage for volume configuration.
|
|
296
300
|
[IResolvable](#projen-iresolvable)|*No description*
|
|
297
301
|
[IResolver](#projen-iresolver)|API for resolving tokens when synthesizing file content.
|
|
302
|
+
[github.IAddConditionsLater](#projen-github-iaddconditionslater)|*No description*
|
|
298
303
|
[github.IJobProvider](#projen-github-ijobprovider)|*No description*
|
|
299
304
|
[python.IPackageProvider](#projen-python-ipackageprovider)|*No description*
|
|
300
305
|
[python.IPythonDeps](#projen-python-ipythondeps)|*No description*
|
|
@@ -320,9 +325,16 @@ Name|Description
|
|
|
320
325
|
[github.DependabotRegistryType](#projen-github-dependabotregistrytype)|Each configuration type requires you to provide particular settings.
|
|
321
326
|
[github.DependabotScheduleInterval](#projen-github-dependabotscheduleinterval)|How often to check for new versions and raise pull requests for version updates.
|
|
322
327
|
[github.VersioningStrategy](#projen-github-versioningstrategy)|The strategy to use when edits manifest and lock files.
|
|
328
|
+
[javascript.ArrowParens](#projen-javascript-arrowparens)|*No description*
|
|
323
329
|
[javascript.AutoRelease](#projen-javascript-autorelease)|Automatic bump modes.
|
|
330
|
+
[javascript.EmbeddedLanguageFormatting](#projen-javascript-embeddedlanguageformatting)|*No description*
|
|
331
|
+
[javascript.EndOfLine](#projen-javascript-endofline)|*No description*
|
|
332
|
+
[javascript.HTMLWhitespaceSensitivity](#projen-javascript-htmlwhitespacesensitivity)|*No description*
|
|
324
333
|
[javascript.NodePackageManager](#projen-javascript-nodepackagemanager)|The node package manager to use.
|
|
325
334
|
[javascript.NpmAccess](#projen-javascript-npmaccess)|Npm package access level.
|
|
335
|
+
[javascript.ProseWrap](#projen-javascript-prosewrap)|*No description*
|
|
336
|
+
[javascript.QuoteProps](#projen-javascript-quoteprops)|*No description*
|
|
337
|
+
[javascript.TrailingComma](#projen-javascript-trailingcomma)|*No description*
|
|
326
338
|
[javascript.TypeScriptJsxMode](#projen-javascript-typescriptjsxmode)|Determines how JSX should get transformed into valid JavaScript.
|
|
327
339
|
[javascript.TypeScriptModuleResolution](#projen-javascript-typescriptmoduleresolution)|Determines how modules get resolved.
|
|
328
340
|
[vscode.InternalConsoleOptions](#projen-vscode-internalconsoleoptions)|Controls the visibility of the VSCode Debug Console panel during a debugging session Source: https://code.visualstudio.com/docs/editor/debugging#_launchjson-attributes.
|
|
@@ -2983,6 +2995,9 @@ new awscdk.AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
|
|
|
2983
2995
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
2984
2996
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
2985
2997
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
2998
|
+
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
2999
|
+
* **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
|
|
3000
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
2986
3001
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
2987
3002
|
* **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
|
|
2988
3003
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -3376,6 +3391,9 @@ new awscdk.AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
|
|
|
3376
3391
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
3377
3392
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
3378
3393
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
3394
|
+
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
3395
|
+
* **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
|
|
3396
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
3379
3397
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
3380
3398
|
* **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
|
|
3381
3399
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -3645,6 +3663,9 @@ new awscdk.ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
|
|
|
3645
3663
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
3646
3664
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
3647
3665
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
3666
|
+
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
3667
|
+
* **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
|
|
3668
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
3648
3669
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
3649
3670
|
* **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
|
|
3650
3671
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -4017,6 +4038,9 @@ new cdk.ConstructLibrary(options: ConstructLibraryOptions)
|
|
|
4017
4038
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
4018
4039
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
4019
4040
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
4041
|
+
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
4042
|
+
* **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
|
|
4043
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
4020
4044
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
4021
4045
|
* **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
|
|
4022
4046
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -4200,6 +4224,9 @@ new cdk.JsiiProject(options: JsiiProjectOptions)
|
|
|
4200
4224
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
4201
4225
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
4202
4226
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
4227
|
+
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
4228
|
+
* **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
|
|
4229
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
4203
4230
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
4204
4231
|
* **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
|
|
4205
4232
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -4369,6 +4396,9 @@ new cdk8s.Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
|
|
|
4369
4396
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
4370
4397
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
4371
4398
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
4399
|
+
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
4400
|
+
* **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
|
|
4401
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
4372
4402
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
4373
4403
|
* **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
|
|
4374
4404
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -4540,6 +4570,9 @@ new cdk8s.ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
|
|
|
4540
4570
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
4541
4571
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
4542
4572
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
4573
|
+
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
4574
|
+
* **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
|
|
4575
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
4543
4576
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
4544
4577
|
* **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
|
|
4545
4578
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -4720,6 +4753,9 @@ new cdktf.ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
|
|
|
4720
4753
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
4721
4754
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
4722
4755
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
4756
|
+
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
4757
|
+
* **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
|
|
4758
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
4723
4759
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
4724
4760
|
* **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
|
|
4725
4761
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -4825,14 +4861,42 @@ __Extends__: [Component](#projen-component)
|
|
|
4825
4861
|
|
|
4826
4862
|
|
|
4827
4863
|
```ts
|
|
4828
|
-
new github.AutoMerge(github: GitHub, options
|
|
4864
|
+
new github.AutoMerge(github: GitHub, options?: AutoMergeOptions)
|
|
4829
4865
|
```
|
|
4830
4866
|
|
|
4831
4867
|
* **github** (<code>[github.GitHub](#projen-github-github)</code>) *No description*
|
|
4832
4868
|
* **options** (<code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code>) *No description*
|
|
4833
4869
|
* **approvedReviews** (<code>number</code>) Number of approved code reviews. __*Default*__: 1
|
|
4834
4870
|
* **blockingLabels** (<code>Array<string></code>) List of labels that will prevent auto-merging. __*Default*__: ['do-not-merge']
|
|
4835
|
-
|
|
4871
|
+
|
|
4872
|
+
|
|
4873
|
+
### Methods
|
|
4874
|
+
|
|
4875
|
+
|
|
4876
|
+
#### addConditions(...conditions)🔹 <a id="projen-github-automerge-addconditions"></a>
|
|
4877
|
+
|
|
4878
|
+
Adds conditions to the auto merge rule.
|
|
4879
|
+
|
|
4880
|
+
```ts
|
|
4881
|
+
addConditions(...conditions: string[]): void
|
|
4882
|
+
```
|
|
4883
|
+
|
|
4884
|
+
* **conditions** (<code>string</code>) The conditions to add (mergify syntax).
|
|
4885
|
+
|
|
4886
|
+
|
|
4887
|
+
|
|
4888
|
+
|
|
4889
|
+
#### addConditionsLater(later)🔹 <a id="projen-github-automerge-addconditionslater"></a>
|
|
4890
|
+
|
|
4891
|
+
Adds conditions that will be rendered only during synthesis.
|
|
4892
|
+
|
|
4893
|
+
```ts
|
|
4894
|
+
addConditionsLater(later: IAddConditionsLater): void
|
|
4895
|
+
```
|
|
4896
|
+
|
|
4897
|
+
* **later** (<code>[github.IAddConditionsLater](#projen-github-iaddconditionslater)</code>) The later.
|
|
4898
|
+
|
|
4899
|
+
|
|
4836
4900
|
|
|
4837
4901
|
|
|
4838
4902
|
|
|
@@ -6484,6 +6548,9 @@ new javascript.NodeProject(options: NodeProjectOptions)
|
|
|
6484
6548
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
6485
6549
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
6486
6550
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
6551
|
+
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
6552
|
+
* **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
|
|
6553
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
6487
6554
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
6488
6555
|
* **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
|
|
6489
6556
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -6524,6 +6591,8 @@ Name | Type | Description
|
|
|
6524
6591
|
**maxNodeVersion**?🔹 | <code>string</code> | Maximum node version required by this pacakge.<br/>__*Optional*__
|
|
6525
6592
|
**minNodeVersion**?🔹 | <code>string</code> | Minimum node.js version required by this package.<br/>__*Optional*__
|
|
6526
6593
|
**npmignore**?🔹 | <code>[IgnoreFile](#projen-ignorefile)</code> | The .npmignore file.<br/>__*Optional*__
|
|
6594
|
+
**prettier**?🔹 | <code>[javascript.Prettier](#projen-javascript-prettier)</code> | __*Optional*__
|
|
6595
|
+
**prettierIgnore**?🔹 | <code>[IgnoreFile](#projen-ignorefile)</code> | The .prettierIgnore file.<br/>__*Optional*__
|
|
6527
6596
|
**publisher**?⚠️ | <code>[release.Publisher](#projen-release-publisher)</code> | Package publisher.<br/>__*Optional*__
|
|
6528
6597
|
**release**?🔹 | <code>[release.Release](#projen-release-release)</code> | Release management.<br/>__*Optional*__
|
|
6529
6598
|
**upgradeWorkflow**?🔹 | <code>[javascript.UpgradeDependencies](#projen-javascript-upgradedependencies)</code> | The upgrade workflow.<br/>__*Optional*__
|
|
@@ -6658,6 +6727,19 @@ addPeerDeps(...deps: string[]): void
|
|
|
6658
6727
|
|
|
6659
6728
|
|
|
6660
6729
|
|
|
6730
|
+
#### addPrettierIgnore(pattern)🔹 <a id="projen-javascript-nodeproject-addprettierignore"></a>
|
|
6731
|
+
|
|
6732
|
+
Defines Prettier ignore Patterns these patterns will be added to the file .prettierignore.
|
|
6733
|
+
|
|
6734
|
+
```ts
|
|
6735
|
+
addPrettierIgnore(pattern: string): void
|
|
6736
|
+
```
|
|
6737
|
+
|
|
6738
|
+
* **pattern** (<code>string</code>) filepatterns so exclude from prettier formatting.
|
|
6739
|
+
|
|
6740
|
+
|
|
6741
|
+
|
|
6742
|
+
|
|
6661
6743
|
#### addTestCommand(...commands)⚠️ <a id="projen-javascript-nodeproject-addtestcommand"></a>
|
|
6662
6744
|
|
|
6663
6745
|
DEPRECATED.
|
|
@@ -6784,6 +6866,96 @@ addRegistry(url: string, scope?: string): void
|
|
|
6784
6866
|
|
|
6785
6867
|
|
|
6786
6868
|
|
|
6869
|
+
## class Prettier 🔹 <a id="projen-javascript-prettier"></a>
|
|
6870
|
+
|
|
6871
|
+
Represents prettier configuration.
|
|
6872
|
+
|
|
6873
|
+
__Submodule__: javascript
|
|
6874
|
+
|
|
6875
|
+
__Extends__: [Component](#projen-component)
|
|
6876
|
+
|
|
6877
|
+
### Initializer
|
|
6878
|
+
|
|
6879
|
+
|
|
6880
|
+
|
|
6881
|
+
|
|
6882
|
+
```ts
|
|
6883
|
+
new javascript.Prettier(project: NodeProject, options: PrettierOptions)
|
|
6884
|
+
```
|
|
6885
|
+
|
|
6886
|
+
* **project** (<code>[javascript.NodeProject](#projen-javascript-nodeproject)</code>) *No description*
|
|
6887
|
+
* **options** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) *No description*
|
|
6888
|
+
* **arrowParens** (<code>[javascript.ArrowParens](#projen-javascript-arrowparens)</code>) Include parentheses around a sole arrow function parameter. __*Default*__: ArrowParens.ALWAYS
|
|
6889
|
+
* **bracketSameLine** (<code>boolean</code>) Put > of opening tags on the last line instead of on a new line. __*Default*__: false
|
|
6890
|
+
* **bracketSpacing** (<code>boolean</code>) Print spaces between brackets. __*Default*__: true
|
|
6891
|
+
* **cursorOffset** (<code>number</code>) Print (to stderr) where a cursor at the given position would move to after formatting. __*Default*__: -1
|
|
6892
|
+
* **embeddedLanguageFormatting** (<code>[javascript.EmbeddedLanguageFormatting](#projen-javascript-embeddedlanguageformatting)</code>) Control how Prettier formats quoted code embedded in the file. __*Default*__: EmbeddedLanguageFormatting.AUTO
|
|
6893
|
+
* **endOfLine** (<code>[javascript.EndOfLine](#projen-javascript-endofline)</code>) Which end of line characters to apply. __*Default*__: EndOfLine.LF
|
|
6894
|
+
* **filepath** (<code>string</code>) Specify the input filepath. __*Default*__: none
|
|
6895
|
+
* **htmlWhitespaceSensitivity** (<code>[javascript.HTMLWhitespaceSensitivity](#projen-javascript-htmlwhitespacesensitivity)</code>) How to handle whitespaces in HTML. __*Default*__: HTMLWhitespaceSensitivity.CSS
|
|
6896
|
+
* **insertPragma** (<code>boolean</code>) Insert @format pragma into file's first docblock comment. __*Default*__: false
|
|
6897
|
+
* **jsxSingleQuote** (<code>boolean</code>) Use single quotes in JSX. __*Default*__: false
|
|
6898
|
+
* **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.
|
|
6899
|
+
* **plugins** (<code>Array<string></code>) Add a plugin. __*Default*__: []
|
|
6900
|
+
* **pluginSearchDirs** (<code>Array<string></code>) Custom directory that contains prettier plugins in node_modules subdirectory. __*Default*__: []
|
|
6901
|
+
* **printWidth** (<code>number</code>) The line length where Prettier will try wrap. __*Default*__: 80
|
|
6902
|
+
* **proseWrap** (<code>[javascript.ProseWrap](#projen-javascript-prosewrap)</code>) How to wrap prose. __*Default*__: ProseWrap.PRESERVE
|
|
6903
|
+
* **quoteProps** (<code>[javascript.QuoteProps](#projen-javascript-quoteprops)</code>) Change when properties in objects are quoted. __*Default*__: QuoteProps.ASNEEDED
|
|
6904
|
+
* **rangeEnd** (<code>number</code>) Format code ending at a given character offset (exclusive). __*Default*__: null
|
|
6905
|
+
* **rangeStart** (<code>number</code>) Format code starting at a given character offset. __*Default*__: 0
|
|
6906
|
+
* **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
|
|
6907
|
+
* **semi** (<code>boolean</code>) Print semicolons. __*Default*__: true
|
|
6908
|
+
* **singleQuote** (<code>boolean</code>) Use single quotes instead of double quotes. __*Default*__: false
|
|
6909
|
+
* **tabWidth** (<code>number</code>) Number of spaces per indentation level. __*Default*__: 2
|
|
6910
|
+
* **trailingComma** (<code>[javascript.TrailingComma](#projen-javascript-trailingcomma)</code>) Print trailing commas wherever possible when multi-line. __*Default*__: TrailingComma.ES5
|
|
6911
|
+
* **useTabs** (<code>boolean</code>) Indent with tabs instead of spaces. __*Default*__: false
|
|
6912
|
+
* **vueIndentScriptAndStyle** (<code>boolean</code>) Indent script and style tags in Vue files. __*Default*__: false
|
|
6913
|
+
* **overrides** (<code>Array<[javascript.PrettierOverride](#projen-javascript-prettieroverride)></code>) Provide a list of patterns to override prettier configuration. __*Default*__: []
|
|
6914
|
+
|
|
6915
|
+
|
|
6916
|
+
|
|
6917
|
+
### Properties
|
|
6918
|
+
|
|
6919
|
+
|
|
6920
|
+
Name | Type | Description
|
|
6921
|
+
-----|------|-------------
|
|
6922
|
+
**config**🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Direct access to the prettier configuration.
|
|
6923
|
+
**overrides**🔹 | <code>Array<[javascript.PrettierOverride](#projen-javascript-prettieroverride)></code> | Access to the Prettieroverrides to extend those.
|
|
6924
|
+
|
|
6925
|
+
### Methods
|
|
6926
|
+
|
|
6927
|
+
|
|
6928
|
+
#### addOverride(override)🔹 <a id="projen-javascript-prettier-addoverride"></a>
|
|
6929
|
+
|
|
6930
|
+
Add a prettier override.
|
|
6931
|
+
|
|
6932
|
+
```ts
|
|
6933
|
+
addOverride(override: PrettierOverride): void
|
|
6934
|
+
```
|
|
6935
|
+
|
|
6936
|
+
* **override** (<code>[javascript.PrettierOverride](#projen-javascript-prettieroverride)</code>) *No description*
|
|
6937
|
+
* **files** (<code>string | Array<string></code>) Include these files in this override.
|
|
6938
|
+
* **options** (<code>[javascript.PrettierBaseOptions](#projen-javascript-prettierbaseoptions)</code>) The options to apply for this override.
|
|
6939
|
+
* **excludeFiles** (<code>string | Array<string></code>) Exclude these files from this override. __*Optional*__
|
|
6940
|
+
|
|
6941
|
+
|
|
6942
|
+
|
|
6943
|
+
|
|
6944
|
+
#### *static* of(project)🔹 <a id="projen-javascript-prettier-of"></a>
|
|
6945
|
+
|
|
6946
|
+
|
|
6947
|
+
|
|
6948
|
+
```ts
|
|
6949
|
+
static of(project: Project): Prettier
|
|
6950
|
+
```
|
|
6951
|
+
|
|
6952
|
+
* **project** (<code>[Project](#projen-project)</code>) *No description*
|
|
6953
|
+
|
|
6954
|
+
__Returns__:
|
|
6955
|
+
* <code>[javascript.Prettier](#projen-javascript-prettier)</code>
|
|
6956
|
+
|
|
6957
|
+
|
|
6958
|
+
|
|
6787
6959
|
## class Projenrc 🔹 <a id="projen-javascript-projenrc"></a>
|
|
6788
6960
|
|
|
6789
6961
|
Sets up a javascript project to use TypeScript for projenrc.
|
|
@@ -8115,6 +8287,9 @@ new typescript.TypeScriptAppProject(options: TypeScriptProjectOptions)
|
|
|
8115
8287
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
8116
8288
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
8117
8289
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
8290
|
+
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
8291
|
+
* **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
|
|
8292
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
8118
8293
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
8119
8294
|
* **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
|
|
8120
8295
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -8263,6 +8438,9 @@ new typescript.TypeScriptLibraryProject(options: TypeScriptProjectOptions)
|
|
|
8263
8438
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
8264
8439
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
8265
8440
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
8441
|
+
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
8442
|
+
* **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
|
|
8443
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
8266
8444
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
8267
8445
|
* **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
|
|
8268
8446
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -8411,6 +8589,9 @@ new typescript.TypeScriptProject(options: TypeScriptProjectOptions)
|
|
|
8411
8589
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
8412
8590
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
8413
8591
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
8592
|
+
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
8593
|
+
* **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
|
|
8594
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
8414
8595
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
8415
8596
|
* **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
|
|
8416
8597
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -8804,6 +8985,9 @@ new web.NextJsProject(options: NextJsProjectOptions)
|
|
|
8804
8985
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
8805
8986
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
8806
8987
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
8988
|
+
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
8989
|
+
* **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
|
|
8990
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
8807
8991
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
8808
8992
|
* **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
|
|
8809
8993
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -8950,6 +9134,9 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
|
|
|
8950
9134
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
8951
9135
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
8952
9136
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
9137
|
+
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
9138
|
+
* **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
|
|
9139
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
8953
9140
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
8954
9141
|
* **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
|
|
8955
9142
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -9168,6 +9355,9 @@ new web.ReactProject(options: ReactProjectOptions)
|
|
|
9168
9355
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
9169
9356
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
9170
9357
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
9358
|
+
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
9359
|
+
* **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
|
|
9360
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
9171
9361
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
9172
9362
|
* **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
|
|
9173
9363
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -9355,6 +9545,9 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
|
|
|
9355
9545
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
9356
9546
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
9357
9547
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
9548
|
+
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
9549
|
+
* **prettierIgnoreEnabled** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: false
|
|
9550
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
9358
9551
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
9359
9552
|
* **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
|
|
9360
9553
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -10446,6 +10639,9 @@ Name | Type | Description
|
|
|
10446
10639
|
**peerDeps**?🔹 | <code>Array<string></code> | Peer dependencies for this module.<br/>__*Default*__: []
|
|
10447
10640
|
**postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
|
|
10448
10641
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
10642
|
+
**prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
10643
|
+
**prettierIgnoreEnabled**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
|
|
10644
|
+
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
10449
10645
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
10450
10646
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
10451
10647
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -10707,6 +10903,9 @@ Name | Type | Description
|
|
|
10707
10903
|
**peerDeps**?🔹 | <code>Array<string></code> | Peer dependencies for this module.<br/>__*Default*__: []
|
|
10708
10904
|
**postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
|
|
10709
10905
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
10906
|
+
**prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
10907
|
+
**prettierIgnoreEnabled**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
|
|
10908
|
+
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
10710
10909
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
10711
10910
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
10712
10911
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -10905,6 +11104,9 @@ Name | Type | Description
|
|
|
10905
11104
|
**peerDeps**?⚠️ | <code>Array<string></code> | Peer dependencies for this module.<br/>__*Default*__: []
|
|
10906
11105
|
**postBuildSteps**?⚠️ | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
|
|
10907
11106
|
**prerelease**?⚠️ | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
11107
|
+
**prettier**?⚠️ | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
11108
|
+
**prettierIgnoreEnabled**?⚠️ | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
|
|
11109
|
+
**prettierOptions**?⚠️ | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
10908
11110
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
10909
11111
|
**projenCommand**?⚠️ | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
10910
11112
|
**projenDevDependency**?⚠️ | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -11155,6 +11357,9 @@ Name | Type | Description
|
|
|
11155
11357
|
**peerDeps**?🔹 | <code>Array<string></code> | Peer dependencies for this module.<br/>__*Default*__: []
|
|
11156
11358
|
**postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
|
|
11157
11359
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
11360
|
+
**prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
11361
|
+
**prettierIgnoreEnabled**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
|
|
11362
|
+
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
11158
11363
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
11159
11364
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
11160
11365
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -11369,6 +11574,9 @@ Name | Type | Description
|
|
|
11369
11574
|
**peerDeps**?🔹 | <code>Array<string></code> | Peer dependencies for this module.<br/>__*Default*__: []
|
|
11370
11575
|
**postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
|
|
11371
11576
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
11577
|
+
**prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
11578
|
+
**prettierIgnoreEnabled**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
|
|
11579
|
+
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
11372
11580
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
11373
11581
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
11374
11582
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -11540,6 +11748,9 @@ Name | Type | Description
|
|
|
11540
11748
|
**peerDeps**?🔹 | <code>Array<string></code> | Peer dependencies for this module.<br/>__*Default*__: []
|
|
11541
11749
|
**postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
|
|
11542
11750
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
11751
|
+
**prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
11752
|
+
**prettierIgnoreEnabled**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
|
|
11753
|
+
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
11543
11754
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
11544
11755
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
11545
11756
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -11691,6 +11902,9 @@ Name | Type | Description
|
|
|
11691
11902
|
**peerDeps**?🔹 | <code>Array<string></code> | Peer dependencies for this module.<br/>__*Default*__: []
|
|
11692
11903
|
**postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
|
|
11693
11904
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
11905
|
+
**prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
11906
|
+
**prettierIgnoreEnabled**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
|
|
11907
|
+
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
11694
11908
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
11695
11909
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
11696
11910
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -11844,6 +12058,9 @@ Name | Type | Description
|
|
|
11844
12058
|
**peerDeps**?🔹 | <code>Array<string></code> | Peer dependencies for this module.<br/>__*Default*__: []
|
|
11845
12059
|
**postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
|
|
11846
12060
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
12061
|
+
**prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
12062
|
+
**prettierIgnoreEnabled**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
|
|
12063
|
+
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
11847
12064
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
11848
12065
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
11849
12066
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -11931,7 +12148,6 @@ Name | Type | Description
|
|
|
11931
12148
|
-----|------|-------------
|
|
11932
12149
|
**approvedReviews**?🔹 | <code>number</code> | Number of approved code reviews.<br/>__*Default*__: 1
|
|
11933
12150
|
**blockingLabels**?🔹 | <code>Array<string></code> | List of labels that will prevent auto-merging.<br/>__*Default*__: ['do-not-merge']
|
|
11934
|
-
**buildJob**?🔹 | <code>string</code> | The GitHub job ID of the build workflow.<br/>__*Optional*__
|
|
11935
12151
|
|
|
11936
12152
|
|
|
11937
12153
|
|
|
@@ -12069,6 +12285,27 @@ Name | Type | Description
|
|
|
12069
12285
|
|
|
12070
12286
|
|
|
12071
12287
|
|
|
12288
|
+
## interface IAddConditionsLater 🔹 <a id="projen-github-iaddconditionslater"></a>
|
|
12289
|
+
|
|
12290
|
+
|
|
12291
|
+
|
|
12292
|
+
### Methods
|
|
12293
|
+
|
|
12294
|
+
|
|
12295
|
+
#### render()🔹 <a id="projen-github-iaddconditionslater-render"></a>
|
|
12296
|
+
|
|
12297
|
+
|
|
12298
|
+
|
|
12299
|
+
```ts
|
|
12300
|
+
render(): Array<string>
|
|
12301
|
+
```
|
|
12302
|
+
|
|
12303
|
+
|
|
12304
|
+
__Returns__:
|
|
12305
|
+
* <code>Array<string></code>
|
|
12306
|
+
|
|
12307
|
+
|
|
12308
|
+
|
|
12072
12309
|
## interface IJobProvider 🔹 <a id="projen-github-ijobprovider"></a>
|
|
12073
12310
|
|
|
12074
12311
|
|
|
@@ -12822,6 +13059,9 @@ Name | Type | Description
|
|
|
12822
13059
|
**peerDeps**?🔹 | <code>Array<string></code> | Peer dependencies for this module.<br/>__*Default*__: []
|
|
12823
13060
|
**postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
|
|
12824
13061
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
13062
|
+
**prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
13063
|
+
**prettierIgnoreEnabled**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
|
|
13064
|
+
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
12825
13065
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
12826
13066
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
12827
13067
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -12893,6 +13133,96 @@ Name | Type | Description
|
|
|
12893
13133
|
|
|
12894
13134
|
|
|
12895
13135
|
|
|
13136
|
+
## struct PrettierBaseOptions 🔹 <a id="projen-javascript-prettierbaseoptions"></a>
|
|
13137
|
+
|
|
13138
|
+
|
|
13139
|
+
Options to set in Prettier directly or through overrides.
|
|
13140
|
+
|
|
13141
|
+
|
|
13142
|
+
|
|
13143
|
+
Name | Type | Description
|
|
13144
|
+
-----|------|-------------
|
|
13145
|
+
**arrowParens**?🔹 | <code>[javascript.ArrowParens](#projen-javascript-arrowparens)</code> | Include parentheses around a sole arrow function parameter.<br/>__*Default*__: ArrowParens.ALWAYS
|
|
13146
|
+
**bracketSameLine**?🔹 | <code>boolean</code> | Put > of opening tags on the last line instead of on a new line.<br/>__*Default*__: false
|
|
13147
|
+
**bracketSpacing**?🔹 | <code>boolean</code> | Print spaces between brackets.<br/>__*Default*__: true
|
|
13148
|
+
**cursorOffset**?🔹 | <code>number</code> | Print (to stderr) where a cursor at the given position would move to after formatting.<br/>__*Default*__: -1
|
|
13149
|
+
**embeddedLanguageFormatting**?🔹 | <code>[javascript.EmbeddedLanguageFormatting](#projen-javascript-embeddedlanguageformatting)</code> | Control how Prettier formats quoted code embedded in the file.<br/>__*Default*__: EmbeddedLanguageFormatting.AUTO
|
|
13150
|
+
**endOfLine**?🔹 | <code>[javascript.EndOfLine](#projen-javascript-endofline)</code> | Which end of line characters to apply.<br/>__*Default*__: EndOfLine.LF
|
|
13151
|
+
**filepath**?🔹 | <code>string</code> | Specify the input filepath.<br/>__*Default*__: none
|
|
13152
|
+
**htmlWhitespaceSensitivity**?🔹 | <code>[javascript.HTMLWhitespaceSensitivity](#projen-javascript-htmlwhitespacesensitivity)</code> | How to handle whitespaces in HTML.<br/>__*Default*__: HTMLWhitespaceSensitivity.CSS
|
|
13153
|
+
**insertPragma**?🔹 | <code>boolean</code> | Insert @format pragma into file's first docblock comment.<br/>__*Default*__: false
|
|
13154
|
+
**jsxSingleQuote**?🔹 | <code>boolean</code> | Use single quotes in JSX.<br/>__*Default*__: false
|
|
13155
|
+
**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.
|
|
13156
|
+
**pluginSearchDirs**?🔹 | <code>Array<string></code> | Custom directory that contains prettier plugins in node_modules subdirectory.<br/>__*Default*__: []
|
|
13157
|
+
**plugins**?🔹 | <code>Array<string></code> | Add a plugin.<br/>__*Default*__: []
|
|
13158
|
+
**printWidth**?🔹 | <code>number</code> | The line length where Prettier will try wrap.<br/>__*Default*__: 80
|
|
13159
|
+
**proseWrap**?🔹 | <code>[javascript.ProseWrap](#projen-javascript-prosewrap)</code> | How to wrap prose.<br/>__*Default*__: ProseWrap.PRESERVE
|
|
13160
|
+
**quoteProps**?🔹 | <code>[javascript.QuoteProps](#projen-javascript-quoteprops)</code> | Change when properties in objects are quoted.<br/>__*Default*__: QuoteProps.ASNEEDED
|
|
13161
|
+
**rangeEnd**?🔹 | <code>number</code> | Format code ending at a given character offset (exclusive).<br/>__*Default*__: null
|
|
13162
|
+
**rangeStart**?🔹 | <code>number</code> | Format code starting at a given character offset.<br/>__*Default*__: 0
|
|
13163
|
+
**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
|
|
13164
|
+
**semi**?🔹 | <code>boolean</code> | Print semicolons.<br/>__*Default*__: true
|
|
13165
|
+
**singleQuote**?🔹 | <code>boolean</code> | Use single quotes instead of double quotes.<br/>__*Default*__: false
|
|
13166
|
+
**tabWidth**?🔹 | <code>number</code> | Number of spaces per indentation level.<br/>__*Default*__: 2
|
|
13167
|
+
**trailingComma**?🔹 | <code>[javascript.TrailingComma](#projen-javascript-trailingcomma)</code> | Print trailing commas wherever possible when multi-line.<br/>__*Default*__: TrailingComma.ES5
|
|
13168
|
+
**useTabs**?🔹 | <code>boolean</code> | Indent with tabs instead of spaces.<br/>__*Default*__: false
|
|
13169
|
+
**vueIndentScriptAndStyle**?🔹 | <code>boolean</code> | Indent script and style tags in Vue files.<br/>__*Default*__: false
|
|
13170
|
+
|
|
13171
|
+
|
|
13172
|
+
|
|
13173
|
+
## struct PrettierOptions 🔹 <a id="projen-javascript-prettieroptions"></a>
|
|
13174
|
+
|
|
13175
|
+
|
|
13176
|
+
Options for Prettier.
|
|
13177
|
+
|
|
13178
|
+
|
|
13179
|
+
|
|
13180
|
+
Name | Type | Description
|
|
13181
|
+
-----|------|-------------
|
|
13182
|
+
**arrowParens**?🔹 | <code>[javascript.ArrowParens](#projen-javascript-arrowparens)</code> | Include parentheses around a sole arrow function parameter.<br/>__*Default*__: ArrowParens.ALWAYS
|
|
13183
|
+
**bracketSameLine**?🔹 | <code>boolean</code> | Put > of opening tags on the last line instead of on a new line.<br/>__*Default*__: false
|
|
13184
|
+
**bracketSpacing**?🔹 | <code>boolean</code> | Print spaces between brackets.<br/>__*Default*__: true
|
|
13185
|
+
**cursorOffset**?🔹 | <code>number</code> | Print (to stderr) where a cursor at the given position would move to after formatting.<br/>__*Default*__: -1
|
|
13186
|
+
**embeddedLanguageFormatting**?🔹 | <code>[javascript.EmbeddedLanguageFormatting](#projen-javascript-embeddedlanguageformatting)</code> | Control how Prettier formats quoted code embedded in the file.<br/>__*Default*__: EmbeddedLanguageFormatting.AUTO
|
|
13187
|
+
**endOfLine**?🔹 | <code>[javascript.EndOfLine](#projen-javascript-endofline)</code> | Which end of line characters to apply.<br/>__*Default*__: EndOfLine.LF
|
|
13188
|
+
**filepath**?🔹 | <code>string</code> | Specify the input filepath.<br/>__*Default*__: none
|
|
13189
|
+
**htmlWhitespaceSensitivity**?🔹 | <code>[javascript.HTMLWhitespaceSensitivity](#projen-javascript-htmlwhitespacesensitivity)</code> | How to handle whitespaces in HTML.<br/>__*Default*__: HTMLWhitespaceSensitivity.CSS
|
|
13190
|
+
**insertPragma**?🔹 | <code>boolean</code> | Insert @format pragma into file's first docblock comment.<br/>__*Default*__: false
|
|
13191
|
+
**jsxSingleQuote**?🔹 | <code>boolean</code> | Use single quotes in JSX.<br/>__*Default*__: false
|
|
13192
|
+
**overrides**?🔹 | <code>Array<[javascript.PrettierOverride](#projen-javascript-prettieroverride)></code> | Provide a list of patterns to override prettier configuration.<br/>__*Default*__: []
|
|
13193
|
+
**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.
|
|
13194
|
+
**pluginSearchDirs**?🔹 | <code>Array<string></code> | Custom directory that contains prettier plugins in node_modules subdirectory.<br/>__*Default*__: []
|
|
13195
|
+
**plugins**?🔹 | <code>Array<string></code> | Add a plugin.<br/>__*Default*__: []
|
|
13196
|
+
**printWidth**?🔹 | <code>number</code> | The line length where Prettier will try wrap.<br/>__*Default*__: 80
|
|
13197
|
+
**proseWrap**?🔹 | <code>[javascript.ProseWrap](#projen-javascript-prosewrap)</code> | How to wrap prose.<br/>__*Default*__: ProseWrap.PRESERVE
|
|
13198
|
+
**quoteProps**?🔹 | <code>[javascript.QuoteProps](#projen-javascript-quoteprops)</code> | Change when properties in objects are quoted.<br/>__*Default*__: QuoteProps.ASNEEDED
|
|
13199
|
+
**rangeEnd**?🔹 | <code>number</code> | Format code ending at a given character offset (exclusive).<br/>__*Default*__: null
|
|
13200
|
+
**rangeStart**?🔹 | <code>number</code> | Format code starting at a given character offset.<br/>__*Default*__: 0
|
|
13201
|
+
**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
|
|
13202
|
+
**semi**?🔹 | <code>boolean</code> | Print semicolons.<br/>__*Default*__: true
|
|
13203
|
+
**singleQuote**?🔹 | <code>boolean</code> | Use single quotes instead of double quotes.<br/>__*Default*__: false
|
|
13204
|
+
**tabWidth**?🔹 | <code>number</code> | Number of spaces per indentation level.<br/>__*Default*__: 2
|
|
13205
|
+
**trailingComma**?🔹 | <code>[javascript.TrailingComma](#projen-javascript-trailingcomma)</code> | Print trailing commas wherever possible when multi-line.<br/>__*Default*__: TrailingComma.ES5
|
|
13206
|
+
**useTabs**?🔹 | <code>boolean</code> | Indent with tabs instead of spaces.<br/>__*Default*__: false
|
|
13207
|
+
**vueIndentScriptAndStyle**?🔹 | <code>boolean</code> | Indent script and style tags in Vue files.<br/>__*Default*__: false
|
|
13208
|
+
|
|
13209
|
+
|
|
13210
|
+
|
|
13211
|
+
## struct PrettierOverride 🔹 <a id="projen-javascript-prettieroverride"></a>
|
|
13212
|
+
|
|
13213
|
+
|
|
13214
|
+
|
|
13215
|
+
|
|
13216
|
+
|
|
13217
|
+
|
|
13218
|
+
Name | Type | Description
|
|
13219
|
+
-----|------|-------------
|
|
13220
|
+
**files**🔹 | <code>string | Array<string></code> | Include these files in this override.
|
|
13221
|
+
**options**🔹 | <code>[javascript.PrettierBaseOptions](#projen-javascript-prettierbaseoptions)</code> | The options to apply for this override.
|
|
13222
|
+
**excludeFiles**?🔹 | <code>string | Array<string></code> | Exclude these files from this override.<br/>__*Optional*__
|
|
13223
|
+
|
|
13224
|
+
|
|
13225
|
+
|
|
12896
13226
|
## struct ProjenrcOptions 🔹 <a id="projen-javascript-projenrcoptions"></a>
|
|
12897
13227
|
|
|
12898
13228
|
|
|
@@ -13807,6 +14137,9 @@ Name | Type | Description
|
|
|
13807
14137
|
**peerDeps**?⚠️ | <code>Array<string></code> | Peer dependencies for this module.<br/>__*Default*__: []
|
|
13808
14138
|
**postBuildSteps**?⚠️ | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
|
|
13809
14139
|
**prerelease**?⚠️ | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
14140
|
+
**prettier**?⚠️ | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
14141
|
+
**prettierIgnoreEnabled**?⚠️ | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
|
|
14142
|
+
**prettierOptions**?⚠️ | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
13810
14143
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
13811
14144
|
**projenCommand**?⚠️ | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
13812
14145
|
**projenDevDependency**?⚠️ | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -13945,6 +14278,9 @@ Name | Type | Description
|
|
|
13945
14278
|
**peerDeps**?🔹 | <code>Array<string></code> | Peer dependencies for this module.<br/>__*Default*__: []
|
|
13946
14279
|
**postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
|
|
13947
14280
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
14281
|
+
**prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
14282
|
+
**prettierIgnoreEnabled**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
|
|
14283
|
+
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
13948
14284
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
13949
14285
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
13950
14286
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -14181,6 +14517,9 @@ Name | Type | Description
|
|
|
14181
14517
|
**peerDeps**?🔹 | <code>Array<string></code> | Peer dependencies for this module.<br/>__*Default*__: []
|
|
14182
14518
|
**postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
|
|
14183
14519
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
14520
|
+
**prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
14521
|
+
**prettierIgnoreEnabled**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
|
|
14522
|
+
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
14184
14523
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
14185
14524
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
14186
14525
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -14314,6 +14653,9 @@ Name | Type | Description
|
|
|
14314
14653
|
**peerDeps**?🔹 | <code>Array<string></code> | Peer dependencies for this module.<br/>__*Default*__: []
|
|
14315
14654
|
**postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
|
|
14316
14655
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
14656
|
+
**prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
14657
|
+
**prettierIgnoreEnabled**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
|
|
14658
|
+
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
14317
14659
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
14318
14660
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
14319
14661
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -14475,6 +14817,9 @@ Name | Type | Description
|
|
|
14475
14817
|
**peerDeps**?🔹 | <code>Array<string></code> | Peer dependencies for this module.<br/>__*Default*__: []
|
|
14476
14818
|
**postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
|
|
14477
14819
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
14820
|
+
**prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
14821
|
+
**prettierIgnoreEnabled**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
|
|
14822
|
+
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
14478
14823
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
14479
14824
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
14480
14825
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -14636,6 +14981,9 @@ Name | Type | Description
|
|
|
14636
14981
|
**peerDeps**?🔹 | <code>Array<string></code> | Peer dependencies for this module.<br/>__*Default*__: []
|
|
14637
14982
|
**postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
|
|
14638
14983
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
14984
|
+
**prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
14985
|
+
**prettierIgnoreEnabled**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: false
|
|
14986
|
+
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
14639
14987
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
14640
14988
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
14641
14989
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -14880,6 +15228,16 @@ Name | Description
|
|
|
14880
15228
|
**INCREASE_IF_NECESSARY** 🔹|Increase the version requirement only when required by the new version.
|
|
14881
15229
|
|
|
14882
15230
|
|
|
15231
|
+
## enum ArrowParens 🔹 <a id="projen-javascript-arrowparens"></a>
|
|
15232
|
+
|
|
15233
|
+
|
|
15234
|
+
|
|
15235
|
+
Name | Description
|
|
15236
|
+
-----|-----
|
|
15237
|
+
**ALWAYS** 🔹|
|
|
15238
|
+
**AVOID** 🔹|
|
|
15239
|
+
|
|
15240
|
+
|
|
14883
15241
|
## enum AutoRelease 🔹 <a id="projen-javascript-autorelease"></a>
|
|
14884
15242
|
|
|
14885
15243
|
Automatic bump modes.
|
|
@@ -14890,6 +15248,39 @@ Name | Description
|
|
|
14890
15248
|
**DAILY** 🔹|Automatically bump & release a new version on a daily basis.
|
|
14891
15249
|
|
|
14892
15250
|
|
|
15251
|
+
## enum EmbeddedLanguageFormatting 🔹 <a id="projen-javascript-embeddedlanguageformatting"></a>
|
|
15252
|
+
|
|
15253
|
+
|
|
15254
|
+
|
|
15255
|
+
Name | Description
|
|
15256
|
+
-----|-----
|
|
15257
|
+
**AUTO** 🔹|
|
|
15258
|
+
**OFF** 🔹|
|
|
15259
|
+
|
|
15260
|
+
|
|
15261
|
+
## enum EndOfLine 🔹 <a id="projen-javascript-endofline"></a>
|
|
15262
|
+
|
|
15263
|
+
|
|
15264
|
+
|
|
15265
|
+
Name | Description
|
|
15266
|
+
-----|-----
|
|
15267
|
+
**AUTO** 🔹|
|
|
15268
|
+
**CR** 🔹|
|
|
15269
|
+
**CRLF** 🔹|
|
|
15270
|
+
**LF** 🔹|
|
|
15271
|
+
|
|
15272
|
+
|
|
15273
|
+
## enum HTMLWhitespaceSensitivity 🔹 <a id="projen-javascript-htmlwhitespacesensitivity"></a>
|
|
15274
|
+
|
|
15275
|
+
|
|
15276
|
+
|
|
15277
|
+
Name | Description
|
|
15278
|
+
-----|-----
|
|
15279
|
+
**CSS** 🔹|
|
|
15280
|
+
**IGNORE** 🔹|
|
|
15281
|
+
**STRICT** 🔹|
|
|
15282
|
+
|
|
15283
|
+
|
|
14893
15284
|
## enum NodePackageManager 🔹 <a id="projen-javascript-nodepackagemanager"></a>
|
|
14894
15285
|
|
|
14895
15286
|
The node package manager to use.
|
|
@@ -14911,6 +15302,39 @@ Name | Description
|
|
|
14911
15302
|
**RESTRICTED** 🔹|Package can only be accessed with credentials.
|
|
14912
15303
|
|
|
14913
15304
|
|
|
15305
|
+
## enum ProseWrap 🔹 <a id="projen-javascript-prosewrap"></a>
|
|
15306
|
+
|
|
15307
|
+
|
|
15308
|
+
|
|
15309
|
+
Name | Description
|
|
15310
|
+
-----|-----
|
|
15311
|
+
**ALWAYS** 🔹|
|
|
15312
|
+
**NEVER** 🔹|
|
|
15313
|
+
**PRESERVE** 🔹|
|
|
15314
|
+
|
|
15315
|
+
|
|
15316
|
+
## enum QuoteProps 🔹 <a id="projen-javascript-quoteprops"></a>
|
|
15317
|
+
|
|
15318
|
+
|
|
15319
|
+
|
|
15320
|
+
Name | Description
|
|
15321
|
+
-----|-----
|
|
15322
|
+
**ASNEEDED** 🔹|
|
|
15323
|
+
**CONSISTENT** 🔹|
|
|
15324
|
+
**PRESERVE** 🔹|
|
|
15325
|
+
|
|
15326
|
+
|
|
15327
|
+
## enum TrailingComma 🔹 <a id="projen-javascript-trailingcomma"></a>
|
|
15328
|
+
|
|
15329
|
+
|
|
15330
|
+
|
|
15331
|
+
Name | Description
|
|
15332
|
+
-----|-----
|
|
15333
|
+
**ALL** 🔹|
|
|
15334
|
+
**ES5** 🔹|
|
|
15335
|
+
**NONE** 🔹|
|
|
15336
|
+
|
|
15337
|
+
|
|
14914
15338
|
## enum TypeScriptJsxMode 🔹 <a id="projen-javascript-typescriptjsxmode"></a>
|
|
14915
15339
|
|
|
14916
15340
|
Determines how JSX should get transformed into valid JavaScript.
|