projen 0.47.15 → 0.48.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.
- package/.jsii +417 -342
- package/API.md +118 -169
- package/changelog.md +12 -1
- package/docs/components.md +21 -0
- 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 +1 -1
- package/lib/cdk/construct-lib.js +1 -1
- package/lib/cdk/jsii-docgen.js +1 -1
- package/lib/cdk/jsii-project.js +1 -1
- 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.js +1 -1
- package/lib/github/dependabot.js +1 -1
- package/lib/github/github-project.js +1 -1
- package/lib/github/github.js +1 -1
- package/lib/github/mergify.js +1 -1
- package/lib/github/pr-template.js +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/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.d.ts +21 -0
- package/lib/javascript/eslint.js +46 -24
- package/lib/javascript/jest.js +1 -1
- package/lib/javascript/node-package.js +1 -1
- package/lib/javascript/node-project.d.ts +1 -21
- package/lib/javascript/node-project.js +31 -44
- package/lib/javascript/npm-config.js +1 -1
- package/lib/javascript/prettier.d.ts +78 -48
- package/lib/javascript/prettier.js +27 -6
- package/lib/javascript/projenrc.js +1 -1
- package/lib/javascript/typescript-config.js +1 -1
- package/lib/javascript/upgrade-dependencies.js +2 -2
- 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 +1 -1
- 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/version.txt +1 -1
package/API.md
CHANGED
|
@@ -231,9 +231,9 @@ Name|Description
|
|
|
231
231
|
[javascript.NodeProjectOptions](#projen-javascript-nodeprojectoptions)|*No description*
|
|
232
232
|
[javascript.NpmConfigOptions](#projen-javascript-npmconfigoptions)|Options to configure the local NPM config.
|
|
233
233
|
[javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions)|*No description*
|
|
234
|
-
[javascript.PrettierBaseOptions](#projen-javascript-prettierbaseoptions)|Options to set in Prettier directly or through overrides.
|
|
235
234
|
[javascript.PrettierOptions](#projen-javascript-prettieroptions)|Options for Prettier.
|
|
236
235
|
[javascript.PrettierOverride](#projen-javascript-prettieroverride)|*No description*
|
|
236
|
+
[javascript.PrettierSettings](#projen-javascript-prettiersettings)|Options to set in Prettier directly or through overrides.
|
|
237
237
|
[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)|*No description*
|
|
238
238
|
[javascript.TypeScriptCompilerOptions](#projen-javascript-typescriptcompileroptions)|*No description*
|
|
239
239
|
[javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)|*No description*
|
|
@@ -2998,8 +2998,7 @@ new awscdk.AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
|
|
|
2998
2998
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
2999
2999
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
3000
3000
|
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
3001
|
-
* **
|
|
3002
|
-
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
3001
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
|
|
3003
3002
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
3004
3003
|
* **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
3004
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -3394,8 +3393,7 @@ new awscdk.AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
|
|
|
3394
3393
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
3395
3394
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
3396
3395
|
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
3397
|
-
* **
|
|
3398
|
-
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
3396
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
|
|
3399
3397
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
3400
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
|
|
3401
3399
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -3666,8 +3664,7 @@ new awscdk.ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
|
|
|
3666
3664
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
3667
3665
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
3668
3666
|
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
3669
|
-
* **
|
|
3670
|
-
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
3667
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
|
|
3671
3668
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
3672
3669
|
* **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
3670
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -4041,8 +4038,7 @@ new cdk.ConstructLibrary(options: ConstructLibraryOptions)
|
|
|
4041
4038
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
4042
4039
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
4043
4040
|
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
4044
|
-
* **
|
|
4045
|
-
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
4041
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
|
|
4046
4042
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
4047
4043
|
* **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
4044
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -4227,8 +4223,7 @@ new cdk.JsiiProject(options: JsiiProjectOptions)
|
|
|
4227
4223
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
4228
4224
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
4229
4225
|
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
4230
|
-
* **
|
|
4231
|
-
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
4226
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
|
|
4232
4227
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
4233
4228
|
* **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
4229
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -4399,8 +4394,7 @@ new cdk8s.Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
|
|
|
4399
4394
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
4400
4395
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
4401
4396
|
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
4402
|
-
* **
|
|
4403
|
-
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
4397
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
|
|
4404
4398
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
4405
4399
|
* **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
4400
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -4573,8 +4567,7 @@ new cdk8s.ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
|
|
|
4573
4567
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
4574
4568
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
4575
4569
|
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
4576
|
-
* **
|
|
4577
|
-
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
4570
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
|
|
4578
4571
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
4579
4572
|
* **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
4573
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -4756,8 +4749,7 @@ new cdktf.ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
|
|
|
4756
4749
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
4757
4750
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
4758
4751
|
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
4759
|
-
* **
|
|
4760
|
-
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
4752
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
|
|
4761
4753
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
4762
4754
|
* **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
4755
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -5956,6 +5948,19 @@ Name | Type | Description
|
|
|
5956
5948
|
### Methods
|
|
5957
5949
|
|
|
5958
5950
|
|
|
5951
|
+
#### addExtends(...extendList)🔹 <a id="projen-javascript-eslint-addextends"></a>
|
|
5952
|
+
|
|
5953
|
+
Adds an `extends` item to the eslint configuration.
|
|
5954
|
+
|
|
5955
|
+
```ts
|
|
5956
|
+
addExtends(...extendList: string[]): void
|
|
5957
|
+
```
|
|
5958
|
+
|
|
5959
|
+
* **extendList** (<code>string</code>) The list of "extends" to add.
|
|
5960
|
+
|
|
5961
|
+
|
|
5962
|
+
|
|
5963
|
+
|
|
5959
5964
|
#### addIgnorePattern(pattern)🔹 <a id="projen-javascript-eslint-addignorepattern"></a>
|
|
5960
5965
|
|
|
5961
5966
|
Do not lint these files.
|
|
@@ -5984,6 +5989,19 @@ addOverride(override: EslintOverride): void
|
|
|
5984
5989
|
|
|
5985
5990
|
|
|
5986
5991
|
|
|
5992
|
+
#### addPlugins(...plugins)🔹 <a id="projen-javascript-eslint-addplugins"></a>
|
|
5993
|
+
|
|
5994
|
+
Adds an eslint plugin.
|
|
5995
|
+
|
|
5996
|
+
```ts
|
|
5997
|
+
addPlugins(...plugins: string[]): void
|
|
5998
|
+
```
|
|
5999
|
+
|
|
6000
|
+
* **plugins** (<code>string</code>) *No description*
|
|
6001
|
+
|
|
6002
|
+
|
|
6003
|
+
|
|
6004
|
+
|
|
5987
6005
|
#### addRules(rules)🔹 <a id="projen-javascript-eslint-addrules"></a>
|
|
5988
6006
|
|
|
5989
6007
|
Add an eslint rule.
|
|
@@ -6551,8 +6569,7 @@ new javascript.NodeProject(options: NodeProjectOptions)
|
|
|
6551
6569
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
6552
6570
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
6553
6571
|
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
6554
|
-
* **
|
|
6555
|
-
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
6572
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
|
|
6556
6573
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
6557
6574
|
* **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
6575
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -6594,7 +6611,6 @@ Name | Type | Description
|
|
|
6594
6611
|
**minNodeVersion**?🔹 | <code>string</code> | Minimum node.js version required by this package.<br/>__*Optional*__
|
|
6595
6612
|
**npmignore**?🔹 | <code>[IgnoreFile](#projen-ignorefile)</code> | The .npmignore file.<br/>__*Optional*__
|
|
6596
6613
|
**prettier**?🔹 | <code>[javascript.Prettier](#projen-javascript-prettier)</code> | __*Optional*__
|
|
6597
|
-
**prettierIgnore**?🔹 | <code>[IgnoreFile](#projen-ignorefile)</code> | The .prettierIgnore file.<br/>__*Optional*__
|
|
6598
6614
|
**publisher**?⚠️ | <code>[release.Publisher](#projen-release-publisher)</code> | Package publisher.<br/>__*Optional*__
|
|
6599
6615
|
**release**?🔹 | <code>[release.Release](#projen-release-release)</code> | Release management.<br/>__*Optional*__
|
|
6600
6616
|
**upgradeWorkflow**?🔹 | <code>[javascript.UpgradeDependencies](#projen-javascript-upgradedependencies)</code> | The upgrade workflow.<br/>__*Optional*__
|
|
@@ -6729,19 +6745,6 @@ addPeerDeps(...deps: string[]): void
|
|
|
6729
6745
|
|
|
6730
6746
|
|
|
6731
6747
|
|
|
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
6748
|
#### addTestCommand(...commands)⚠️ <a id="projen-javascript-nodeproject-addtestcommand"></a>
|
|
6746
6749
|
|
|
6747
6750
|
DEPRECATED.
|
|
@@ -6887,32 +6890,9 @@ new javascript.Prettier(project: NodeProject, options: PrettierOptions)
|
|
|
6887
6890
|
|
|
6888
6891
|
* **project** (<code>[javascript.NodeProject](#projen-javascript-nodeproject)</code>) *No description*
|
|
6889
6892
|
* **options** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) *No description*
|
|
6890
|
-
* **
|
|
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
|
|
6893
|
+
* **ignoreFile** (<code>boolean</code>) Defines an .prettierIgnore file. __*Default*__: true
|
|
6915
6894
|
* **overrides** (<code>Array<[javascript.PrettierOverride](#projen-javascript-prettieroverride)></code>) Provide a list of patterns to override prettier configuration. __*Default*__: []
|
|
6895
|
+
* **settings** (<code>[javascript.PrettierSettings](#projen-javascript-prettiersettings)</code>) Prettier settings. __*Default*__: default settings
|
|
6916
6896
|
|
|
6917
6897
|
|
|
6918
6898
|
|
|
@@ -6921,12 +6901,26 @@ new javascript.Prettier(project: NodeProject, options: PrettierOptions)
|
|
|
6921
6901
|
|
|
6922
6902
|
Name | Type | Description
|
|
6923
6903
|
-----|------|-------------
|
|
6924
|
-
**config**🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Direct access to the prettier configuration.
|
|
6925
6904
|
**overrides**🔹 | <code>Array<[javascript.PrettierOverride](#projen-javascript-prettieroverride)></code> | Access to the Prettieroverrides to extend those.
|
|
6905
|
+
**settings**🔹 | <code>[javascript.PrettierSettings](#projen-javascript-prettiersettings)</code> | Direct access to the prettier settings.
|
|
6906
|
+
**ignoreFile**?🔹 | <code>[IgnoreFile](#projen-ignorefile)</code> | The .prettierIgnore file.<br/>__*Optional*__
|
|
6926
6907
|
|
|
6927
6908
|
### Methods
|
|
6928
6909
|
|
|
6929
6910
|
|
|
6911
|
+
#### addIgnorePattern(pattern)🔹 <a id="projen-javascript-prettier-addignorepattern"></a>
|
|
6912
|
+
|
|
6913
|
+
Defines Prettier ignore Patterns these patterns will be added to the file .prettierignore.
|
|
6914
|
+
|
|
6915
|
+
```ts
|
|
6916
|
+
addIgnorePattern(pattern: string): void
|
|
6917
|
+
```
|
|
6918
|
+
|
|
6919
|
+
* **pattern** (<code>string</code>) filepatterns so exclude from prettier formatting.
|
|
6920
|
+
|
|
6921
|
+
|
|
6922
|
+
|
|
6923
|
+
|
|
6930
6924
|
#### addOverride(override)🔹 <a id="projen-javascript-prettier-addoverride"></a>
|
|
6931
6925
|
|
|
6932
6926
|
Add a prettier override.
|
|
@@ -6937,7 +6931,7 @@ addOverride(override: PrettierOverride): void
|
|
|
6937
6931
|
|
|
6938
6932
|
* **override** (<code>[javascript.PrettierOverride](#projen-javascript-prettieroverride)</code>) *No description*
|
|
6939
6933
|
* **files** (<code>string | Array<string></code>) Include these files in this override.
|
|
6940
|
-
* **
|
|
6934
|
+
* **settings** (<code>[javascript.PrettierSettings](#projen-javascript-prettiersettings)</code>) The options to apply for this override.
|
|
6941
6935
|
* **excludeFiles** (<code>string | Array<string></code>) Exclude these files from this override. __*Optional*__
|
|
6942
6936
|
|
|
6943
6937
|
|
|
@@ -8312,8 +8306,7 @@ new typescript.TypeScriptAppProject(options: TypeScriptProjectOptions)
|
|
|
8312
8306
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
8313
8307
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
8314
8308
|
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
8315
|
-
* **
|
|
8316
|
-
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
8309
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
|
|
8317
8310
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
8318
8311
|
* **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
8312
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -8463,8 +8456,7 @@ new typescript.TypeScriptLibraryProject(options: TypeScriptProjectOptions)
|
|
|
8463
8456
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
8464
8457
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
8465
8458
|
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
8466
|
-
* **
|
|
8467
|
-
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
8459
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
|
|
8468
8460
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
8469
8461
|
* **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
8462
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -8614,8 +8606,7 @@ new typescript.TypeScriptProject(options: TypeScriptProjectOptions)
|
|
|
8614
8606
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
8615
8607
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
8616
8608
|
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
8617
|
-
* **
|
|
8618
|
-
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
8609
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
|
|
8619
8610
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
8620
8611
|
* **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
8612
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -9010,8 +9001,7 @@ new web.NextJsProject(options: NextJsProjectOptions)
|
|
|
9010
9001
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
9011
9002
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
9012
9003
|
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
9013
|
-
* **
|
|
9014
|
-
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
9004
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
|
|
9015
9005
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
9016
9006
|
* **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
9007
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -9159,8 +9149,7 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
|
|
|
9159
9149
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
9160
9150
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
9161
9151
|
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
9162
|
-
* **
|
|
9163
|
-
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
9152
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
|
|
9164
9153
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
9165
9154
|
* **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
9155
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -9380,8 +9369,7 @@ new web.ReactProject(options: ReactProjectOptions)
|
|
|
9380
9369
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
9381
9370
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
9382
9371
|
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
9383
|
-
* **
|
|
9384
|
-
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
9372
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
|
|
9385
9373
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
9386
9374
|
* **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
9375
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -9570,8 +9558,7 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
|
|
|
9570
9558
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
9571
9559
|
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
9572
9560
|
* **prettier** (<code>boolean</code>) Setup prettier. __*Default*__: false
|
|
9573
|
-
* **
|
|
9574
|
-
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: opinionated default options
|
|
9561
|
+
* **prettierOptions** (<code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code>) Prettier options. __*Default*__: default options
|
|
9575
9562
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
9576
9563
|
* **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
9564
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -10665,8 +10652,7 @@ Name | Type | Description
|
|
|
10665
10652
|
**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
10653
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
10667
10654
|
**prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
10668
|
-
**
|
|
10669
|
-
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
10655
|
+
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
10670
10656
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
10671
10657
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
10672
10658
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -10929,8 +10915,7 @@ Name | Type | Description
|
|
|
10929
10915
|
**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
10916
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
10931
10917
|
**prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
10932
|
-
**
|
|
10933
|
-
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
10918
|
+
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
10934
10919
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
10935
10920
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
10936
10921
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -11130,8 +11115,7 @@ Name | Type | Description
|
|
|
11130
11115
|
**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
11116
|
**prerelease**?⚠️ | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
11132
11117
|
**prettier**?⚠️ | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
11133
|
-
**
|
|
11134
|
-
**prettierOptions**?⚠️ | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
11118
|
+
**prettierOptions**?⚠️ | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
11135
11119
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
11136
11120
|
**projenCommand**?⚠️ | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
11137
11121
|
**projenDevDependency**?⚠️ | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -11383,8 +11367,7 @@ Name | Type | Description
|
|
|
11383
11367
|
**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
11368
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
11385
11369
|
**prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
11386
|
-
**
|
|
11387
|
-
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
11370
|
+
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
11388
11371
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
11389
11372
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
11390
11373
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -11600,8 +11583,7 @@ Name | Type | Description
|
|
|
11600
11583
|
**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
11584
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
11602
11585
|
**prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
11603
|
-
**
|
|
11604
|
-
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
11586
|
+
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
11605
11587
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
11606
11588
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
11607
11589
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -11774,8 +11756,7 @@ Name | Type | Description
|
|
|
11774
11756
|
**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
11757
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
11776
11758
|
**prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
11777
|
-
**
|
|
11778
|
-
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
11759
|
+
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
11779
11760
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
11780
11761
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
11781
11762
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -11928,8 +11909,7 @@ Name | Type | Description
|
|
|
11928
11909
|
**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
11910
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
11930
11911
|
**prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
11931
|
-
**
|
|
11932
|
-
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
11912
|
+
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
11933
11913
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
11934
11914
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
11935
11915
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -12084,8 +12064,7 @@ Name | Type | Description
|
|
|
12084
12064
|
**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
12065
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
12086
12066
|
**prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
12087
|
-
**
|
|
12088
|
-
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
12067
|
+
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
12089
12068
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
12090
12069
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
12091
12070
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -13085,8 +13064,7 @@ Name | Type | Description
|
|
|
13085
13064
|
**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
13065
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
13087
13066
|
**prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
13088
|
-
**
|
|
13089
|
-
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
13067
|
+
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
13090
13068
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
13091
13069
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
13092
13070
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -13158,47 +13136,40 @@ Name | Type | Description
|
|
|
13158
13136
|
|
|
13159
13137
|
|
|
13160
13138
|
|
|
13161
|
-
## struct
|
|
13139
|
+
## struct PrettierOptions 🔹 <a id="projen-javascript-prettieroptions"></a>
|
|
13162
13140
|
|
|
13163
13141
|
|
|
13164
|
-
Options
|
|
13142
|
+
Options for Prettier.
|
|
13165
13143
|
|
|
13166
13144
|
|
|
13167
13145
|
|
|
13168
13146
|
Name | Type | Description
|
|
13169
13147
|
-----|------|-------------
|
|
13170
|
-
**
|
|
13171
|
-
**
|
|
13172
|
-
**
|
|
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
|
|
13148
|
+
**ignoreFile**?🔹 | <code>boolean</code> | Defines an .prettierIgnore file.<br/>__*Default*__: true
|
|
13149
|
+
**overrides**?🔹 | <code>Array<[javascript.PrettierOverride](#projen-javascript-prettieroverride)></code> | Provide a list of patterns to override prettier configuration.<br/>__*Default*__: []
|
|
13150
|
+
**settings**?🔹 | <code>[javascript.PrettierSettings](#projen-javascript-prettiersettings)</code> | Prettier settings.<br/>__*Default*__: default settings
|
|
13195
13151
|
|
|
13196
13152
|
|
|
13197
13153
|
|
|
13198
|
-
## struct
|
|
13154
|
+
## struct PrettierOverride 🔹 <a id="projen-javascript-prettieroverride"></a>
|
|
13155
|
+
|
|
13199
13156
|
|
|
13200
13157
|
|
|
13201
|
-
|
|
13158
|
+
|
|
13159
|
+
|
|
13160
|
+
|
|
13161
|
+
Name | Type | Description
|
|
13162
|
+
-----|------|-------------
|
|
13163
|
+
**files**🔹 | <code>string | Array<string></code> | Include these files in this override.
|
|
13164
|
+
**settings**🔹 | <code>[javascript.PrettierSettings](#projen-javascript-prettiersettings)</code> | The options to apply for this override.
|
|
13165
|
+
**excludeFiles**?🔹 | <code>string | Array<string></code> | Exclude these files from this override.<br/>__*Optional*__
|
|
13166
|
+
|
|
13167
|
+
|
|
13168
|
+
|
|
13169
|
+
## struct PrettierSettings 🔹 <a id="projen-javascript-prettiersettings"></a>
|
|
13170
|
+
|
|
13171
|
+
|
|
13172
|
+
Options to set in Prettier directly or through overrides.
|
|
13202
13173
|
|
|
13203
13174
|
|
|
13204
13175
|
|
|
@@ -13214,7 +13185,6 @@ Name | Type | Description
|
|
|
13214
13185
|
**htmlWhitespaceSensitivity**?🔹 | <code>[javascript.HTMLWhitespaceSensitivity](#projen-javascript-htmlwhitespacesensitivity)</code> | How to handle whitespaces in HTML.<br/>__*Default*__: HTMLWhitespaceSensitivity.CSS
|
|
13215
13186
|
**insertPragma**?🔹 | <code>boolean</code> | Insert @format pragma into file's first docblock comment.<br/>__*Default*__: false
|
|
13216
13187
|
**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
13188
|
**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
13189
|
**pluginSearchDirs**?🔹 | <code>Array<string></code> | Custom directory that contains prettier plugins in node_modules subdirectory.<br/>__*Default*__: []
|
|
13220
13190
|
**plugins**?🔹 | <code>Array<string></code> | Add a plugin.<br/>__*Default*__: []
|
|
@@ -13233,21 +13203,6 @@ Name | Type | Description
|
|
|
13233
13203
|
|
|
13234
13204
|
|
|
13235
13205
|
|
|
13236
|
-
## struct PrettierOverride 🔹 <a id="projen-javascript-prettieroverride"></a>
|
|
13237
|
-
|
|
13238
|
-
|
|
13239
|
-
|
|
13240
|
-
|
|
13241
|
-
|
|
13242
|
-
|
|
13243
|
-
Name | Type | Description
|
|
13244
|
-
-----|------|-------------
|
|
13245
|
-
**files**🔹 | <code>string | 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 | Array<string></code> | Exclude these files from this override.<br/>__*Optional*__
|
|
13248
|
-
|
|
13249
|
-
|
|
13250
|
-
|
|
13251
13206
|
## struct ProjenrcOptions 🔹 <a id="projen-javascript-projenrcoptions"></a>
|
|
13252
13207
|
|
|
13253
13208
|
|
|
@@ -14163,8 +14118,7 @@ Name | Type | Description
|
|
|
14163
14118
|
**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
14119
|
**prerelease**?⚠️ | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
14165
14120
|
**prettier**?⚠️ | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
14166
|
-
**
|
|
14167
|
-
**prettierOptions**?⚠️ | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
14121
|
+
**prettierOptions**?⚠️ | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
14168
14122
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
14169
14123
|
**projenCommand**?⚠️ | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
14170
14124
|
**projenDevDependency**?⚠️ | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -14304,8 +14258,7 @@ Name | Type | Description
|
|
|
14304
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*__: []
|
|
14305
14259
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
14306
14260
|
**prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
14307
|
-
**
|
|
14308
|
-
**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
|
|
14309
14262
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
14310
14263
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
14311
14264
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -14543,8 +14496,7 @@ Name | Type | Description
|
|
|
14543
14496
|
**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
14497
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
14545
14498
|
**prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
14546
|
-
**
|
|
14547
|
-
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
14499
|
+
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
14548
14500
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
14549
14501
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
14550
14502
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -14679,8 +14631,7 @@ Name | Type | Description
|
|
|
14679
14631
|
**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
14632
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
14681
14633
|
**prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
14682
|
-
**
|
|
14683
|
-
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
14634
|
+
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
14684
14635
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
14685
14636
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
14686
14637
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -14843,8 +14794,7 @@ Name | Type | Description
|
|
|
14843
14794
|
**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
14795
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
14845
14796
|
**prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
14846
|
-
**
|
|
14847
|
-
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
14797
|
+
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
14848
14798
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
14849
14799
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
14850
14800
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -15007,8 +14957,7 @@ Name | Type | Description
|
|
|
15007
14957
|
**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
14958
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
15009
14959
|
**prettier**?🔹 | <code>boolean</code> | Setup prettier.<br/>__*Default*__: false
|
|
15010
|
-
**
|
|
15011
|
-
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: opinionated default options
|
|
14960
|
+
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
15012
14961
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
15013
14962
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
15014
14963
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
@@ -15259,8 +15208,8 @@ Name | Description
|
|
|
15259
15208
|
|
|
15260
15209
|
Name | Description
|
|
15261
15210
|
-----|-----
|
|
15262
|
-
**ALWAYS** 🔹|
|
|
15263
|
-
**AVOID** 🔹|
|
|
15211
|
+
**ALWAYS** 🔹|Always include parens.
|
|
15212
|
+
**AVOID** 🔹|Omit parens when possible.
|
|
15264
15213
|
|
|
15265
15214
|
|
|
15266
15215
|
## enum AutoRelease 🔹 <a id="projen-javascript-autorelease"></a>
|
|
@@ -15279,8 +15228,8 @@ Name | Description
|
|
|
15279
15228
|
|
|
15280
15229
|
Name | Description
|
|
15281
15230
|
-----|-----
|
|
15282
|
-
**AUTO** 🔹|
|
|
15283
|
-
**OFF** 🔹|
|
|
15231
|
+
**AUTO** 🔹|Format embedded code if Prettier can automatically identify it.
|
|
15232
|
+
**OFF** 🔹|Never automatically format embedded code.
|
|
15284
15233
|
|
|
15285
15234
|
|
|
15286
15235
|
## enum EndOfLine 🔹 <a id="projen-javascript-endofline"></a>
|
|
@@ -15289,10 +15238,10 @@ Name | Description
|
|
|
15289
15238
|
|
|
15290
15239
|
Name | Description
|
|
15291
15240
|
-----|-----
|
|
15292
|
-
**AUTO** 🔹|
|
|
15293
|
-
**CR** 🔹|
|
|
15294
|
-
**CRLF** 🔹|
|
|
15295
|
-
**LF** 🔹|
|
|
15241
|
+
**AUTO** 🔹|Maintain existing (mixed values within one file are normalised by looking at what's used after the first line).
|
|
15242
|
+
**CR** 🔹|Carriage Return character only (\r), used very rarely.
|
|
15243
|
+
**CRLF** 🔹|Carriage Return + Line Feed characters (\r\n), common on Windows.
|
|
15244
|
+
**LF** 🔹|Line Feed only (\n), common on Linux and macOS as well as inside git repos.
|
|
15296
15245
|
|
|
15297
15246
|
|
|
15298
15247
|
## enum HTMLWhitespaceSensitivity 🔹 <a id="projen-javascript-htmlwhitespacesensitivity"></a>
|
|
@@ -15301,9 +15250,9 @@ Name | Description
|
|
|
15301
15250
|
|
|
15302
15251
|
Name | Description
|
|
15303
15252
|
-----|-----
|
|
15304
|
-
**CSS** 🔹|
|
|
15305
|
-
**IGNORE** 🔹|
|
|
15306
|
-
**STRICT** 🔹|
|
|
15253
|
+
**CSS** 🔹|Respect the default value of CSS display property.
|
|
15254
|
+
**IGNORE** 🔹|Whitespaces are considered insignificant.
|
|
15255
|
+
**STRICT** 🔹|Whitespaces are considered significant.
|
|
15307
15256
|
|
|
15308
15257
|
|
|
15309
15258
|
## enum NodePackageManager 🔹 <a id="projen-javascript-nodepackagemanager"></a>
|
|
@@ -15333,9 +15282,9 @@ Name | Description
|
|
|
15333
15282
|
|
|
15334
15283
|
Name | Description
|
|
15335
15284
|
-----|-----
|
|
15336
|
-
**ALWAYS** 🔹|
|
|
15337
|
-
**NEVER** 🔹|
|
|
15338
|
-
**PRESERVE** 🔹|
|
|
15285
|
+
**ALWAYS** 🔹|Wrap prose if it exceeds the print width.
|
|
15286
|
+
**NEVER** 🔹|Do not wrap prose.
|
|
15287
|
+
**PRESERVE** 🔹|Wrap prose as-is.
|
|
15339
15288
|
|
|
15340
15289
|
|
|
15341
15290
|
## enum QuoteProps 🔹 <a id="projen-javascript-quoteprops"></a>
|
|
@@ -15344,9 +15293,9 @@ Name | Description
|
|
|
15344
15293
|
|
|
15345
15294
|
Name | Description
|
|
15346
15295
|
-----|-----
|
|
15347
|
-
**ASNEEDED** 🔹|
|
|
15348
|
-
**CONSISTENT** 🔹|
|
|
15349
|
-
**PRESERVE** 🔹|
|
|
15296
|
+
**ASNEEDED** 🔹|Only add quotes around object properties where required.
|
|
15297
|
+
**CONSISTENT** 🔹|If at least one property in an object requires quotes, quote all properties.
|
|
15298
|
+
**PRESERVE** 🔹|Respect the input use of quotes in object properties.
|
|
15350
15299
|
|
|
15351
15300
|
|
|
15352
15301
|
## enum TrailingComma 🔹 <a id="projen-javascript-trailingcomma"></a>
|
|
@@ -15355,9 +15304,9 @@ Name | Description
|
|
|
15355
15304
|
|
|
15356
15305
|
Name | Description
|
|
15357
15306
|
-----|-----
|
|
15358
|
-
**ALL** 🔹|
|
|
15359
|
-
**ES5** 🔹|
|
|
15360
|
-
**NONE** 🔹|
|
|
15307
|
+
**ALL** 🔹|Trailing commas wherever possible (including function arguments).
|
|
15308
|
+
**ES5** 🔹|Trailing commas where valid in ES5 (objects, arrays, etc.).
|
|
15309
|
+
**NONE** 🔹|No trailing commas.
|
|
15361
15310
|
|
|
15362
15311
|
|
|
15363
15312
|
## enum TypeScriptJsxMode 🔹 <a id="projen-javascript-typescriptjsxmode"></a>
|