projen 0.52.21 → 0.52.25
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 +139 -107
- package/changelog.md +3 -3
- package/docs/api/API.md +42 -39
- package/lib/awscdk/auto-discover.d.ts +14 -46
- package/lib/awscdk/auto-discover.js +8 -22
- package/lib/awscdk/awscdk-app-java.d.ts +10 -32
- package/lib/awscdk/awscdk-app-java.js +5 -9
- package/lib/awscdk/awscdk-app-ts.d.ts +15 -35
- package/lib/awscdk/awscdk-app-ts.js +6 -14
- package/lib/awscdk/awscdk-construct.d.ts +14 -28
- package/lib/awscdk/awscdk-construct.js +8 -16
- package/lib/awscdk/awscdk-deps-java.d.ts +1 -8
- package/lib/awscdk/awscdk-deps-java.js +3 -10
- package/lib/awscdk/awscdk-deps-js.d.ts +1 -8
- package/lib/awscdk/awscdk-deps-js.js +3 -10
- package/lib/awscdk/awscdk-deps.d.ts +28 -67
- package/lib/awscdk/awscdk-deps.js +5 -12
- package/lib/awscdk/cdk-config.d.ts +19 -51
- package/lib/awscdk/cdk-config.js +13 -11
- package/lib/awscdk/cdk-tasks.d.ts +7 -24
- package/lib/awscdk/cdk-tasks.js +3 -8
- package/lib/awscdk/integration-test.d.ts +7 -29
- package/lib/awscdk/integration-test.js +3 -8
- package/lib/awscdk/lambda-function.d.ts +22 -50
- package/lib/awscdk/lambda-function.js +11 -24
- package/lib/build/build-workflow.d.ts +33 -78
- package/lib/build/build-workflow.js +15 -25
- package/lib/cdk/auto-discover-base.d.ts +11 -34
- package/lib/cdk/auto-discover-base.js +5 -15
- package/lib/cdk/construct-lib.d.ts +8 -22
- package/lib/cdk/construct-lib.js +3 -8
- package/lib/cdk/integration-test-base.d.ts +12 -38
- package/lib/cdk/integration-test-base.js +2 -8
- package/lib/cdk/jsii-docgen.d.ts +6 -12
- package/lib/cdk/jsii-docgen.js +6 -8
- package/lib/cdk/jsii-project.d.ts +16 -95
- package/lib/cdk/jsii-project.js +3 -10
- package/lib/cdk8s/auto-discover.d.ts +6 -23
- package/lib/cdk8s/auto-discover.js +6 -15
- package/lib/cdk8s/cdk8s-app-ts.d.ts +21 -43
- package/lib/cdk8s/cdk8s-app-ts.js +4 -7
- package/lib/cdk8s/cdk8s-construct.d.ts +12 -27
- package/lib/cdk8s/cdk8s-construct.js +3 -7
- package/lib/cdk8s/integration-test.d.ts +2 -9
- package/lib/cdk8s/integration-test.js +3 -8
- package/lib/cdktf/cdktf-construct.d.ts +3 -12
- package/lib/cdktf/cdktf-construct.js +3 -7
- package/lib/component.d.ts +4 -17
- package/lib/component.js +6 -19
- package/lib/dependencies.d.ts +44 -77
- package/lib/dependencies.js +50 -38
- package/lib/dev-env.d.ts +26 -53
- package/lib/dev-env.js +9 -19
- package/lib/docker-compose.d.ts +83 -209
- package/lib/docker-compose.js +38 -61
- package/lib/file.d.ts +24 -71
- package/lib/file.js +4 -16
- package/lib/gitattributes.d.ts +3 -14
- package/lib/gitattributes.js +5 -16
- package/lib/github/auto-approve.d.ts +7 -23
- package/lib/github/auto-approve.js +3 -8
- package/lib/github/auto-merge.d.ts +7 -29
- package/lib/github/auto-merge.js +7 -16
- package/lib/github/dependabot.d.ts +54 -147
- package/lib/github/dependabot.js +81 -22
- package/lib/github/github-project.d.ts +26 -70
- package/lib/github/github-project.js +5 -10
- package/lib/github/github.d.ts +19 -58
- package/lib/github/github.js +9 -30
- package/lib/github/mergify.d.ts +9 -54
- package/lib/github/mergify.js +2 -14
- package/lib/github/pr-template.d.ts +3 -13
- package/lib/github/pr-template.js +3 -8
- package/lib/github/pull-request-lint.d.ts +8 -28
- package/lib/github/pull-request-lint.js +3 -9
- package/lib/github/stale.d.ts +17 -47
- package/lib/github/stale.js +6 -10
- package/lib/github/task-workflow.d.ts +21 -63
- package/lib/github/task-workflow.js +3 -8
- package/lib/github/workflows-model.d.ts +199 -582
- package/lib/github/workflows-model.js +5 -4
- package/lib/github/workflows.d.ts +14 -41
- package/lib/github/workflows.js +8 -16
- package/lib/gitlab/configuration-model.d.ts +145 -947
- package/lib/gitlab/configuration-model.js +11 -28
- package/lib/gitlab/configuration.d.ts +31 -121
- package/lib/gitlab/configuration.js +14 -49
- package/lib/gitlab/gitlab-configuration.d.ts +2 -13
- package/lib/gitlab/gitlab-configuration.js +4 -15
- package/lib/gitlab/nested-configuration.d.ts +1 -9
- package/lib/gitlab/nested-configuration.js +3 -8
- package/lib/gitpod.d.ts +71 -167
- package/lib/gitpod.js +75 -42
- package/lib/ignore-file.d.ts +4 -23
- package/lib/ignore-file.js +6 -25
- package/lib/ini.d.ts +2 -14
- package/lib/ini.js +3 -13
- package/lib/java/java-project.d.ts +29 -70
- package/lib/java/java-project.js +10 -17
- package/lib/java/junit.d.ts +5 -17
- package/lib/java/junit.js +3 -8
- package/lib/java/maven-compile.d.ts +4 -13
- package/lib/java/maven-compile.js +3 -8
- package/lib/java/maven-packaging.d.ts +6 -21
- package/lib/java/maven-packaging.js +3 -8
- package/lib/java/maven-sample.d.ts +2 -12
- package/lib/java/maven-sample.js +3 -8
- package/lib/java/pom.d.ts +38 -100
- package/lib/java/pom.js +13 -25
- package/lib/java/projenrc.d.ts +7 -22
- package/lib/java/projenrc.js +3 -8
- package/lib/javascript/bundler.d.ts +30 -72
- package/lib/javascript/bundler.js +13 -21
- package/lib/javascript/eslint.d.ts +27 -84
- package/lib/javascript/eslint.js +11 -30
- package/lib/javascript/jest.d.ts +91 -344
- package/lib/javascript/jest.js +6 -23
- package/lib/javascript/node-package.d.ts +111 -259
- package/lib/javascript/node-package.js +64 -81
- package/lib/javascript/node-project.d.ts +112 -220
- package/lib/javascript/node-project.js +54 -73
- package/lib/javascript/npm-config.d.ts +9 -19
- package/lib/javascript/npm-config.js +9 -16
- package/lib/javascript/prettier.d.ts +65 -196
- package/lib/javascript/prettier.js +70 -46
- package/lib/javascript/projenrc.d.ts +2 -12
- package/lib/javascript/projenrc.js +3 -8
- package/lib/javascript/typescript-config.d.ts +62 -158
- package/lib/javascript/typescript-config.js +31 -18
- package/lib/javascript/upgrade-dependencies.d.ts +35 -94
- package/lib/javascript/upgrade-dependencies.js +21 -51
- package/lib/json.d.ts +3 -17
- package/lib/json.js +3 -13
- package/lib/license.d.ts +3 -20
- package/lib/license.js +2 -13
- package/lib/logger.d.ts +18 -62
- package/lib/logger.js +17 -37
- package/lib/makefile.d.ts +14 -45
- package/lib/makefile.js +7 -25
- package/lib/object-file.d.ts +19 -39
- package/lib/object-file.js +17 -28
- package/lib/option-hints.d.ts +4 -13
- package/lib/option-hints.js +11 -5
- package/lib/project-build.d.ts +7 -26
- package/lib/project-build.js +3 -8
- package/lib/project.d.ts +64 -186
- package/lib/project.js +43 -91
- package/lib/projects.d.ts +11 -32
- package/lib/projects.js +4 -8
- package/lib/projenrc-json.d.ts +2 -12
- package/lib/projenrc-json.js +3 -8
- package/lib/python/pip.d.ts +7 -23
- package/lib/python/pip.js +8 -17
- package/lib/python/poetry.d.ts +36 -121
- package/lib/python/poetry.js +12 -26
- package/lib/python/projenrc.d.ts +4 -15
- package/lib/python/projenrc.js +3 -8
- package/lib/python/pytest.d.ts +3 -16
- package/lib/python/pytest.js +2 -8
- package/lib/python/python-deps.d.ts +7 -21
- package/lib/python/python-deps.js +1 -1
- package/lib/python/python-env.d.ts +1 -6
- package/lib/python/python-env.js +1 -1
- package/lib/python/python-packaging.d.ts +12 -34
- package/lib/python/python-packaging.js +1 -1
- package/lib/python/python-project.d.ts +34 -79
- package/lib/python/python-project.js +7 -20
- package/lib/python/python-sample.d.ts +2 -9
- package/lib/python/python-sample.js +3 -8
- package/lib/python/requirements-file.d.ts +4 -19
- package/lib/python/requirements-file.js +5 -15
- package/lib/python/setuppy.d.ts +11 -39
- package/lib/python/setuppy.js +3 -13
- package/lib/python/setuptools.d.ts +2 -14
- package/lib/python/setuptools.js +3 -8
- package/lib/python/venv.d.ts +4 -14
- package/lib/python/venv.js +4 -11
- package/lib/readme.d.ts +7 -16
- package/lib/readme.js +5 -7
- package/lib/release/publisher.d.ts +103 -206
- package/lib/release/publisher.js +47 -59
- package/lib/release/release-trigger.d.ts +16 -48
- package/lib/release/release-trigger.js +8 -18
- package/lib/release/release.d.ts +50 -110
- package/lib/release/release.js +9 -24
- package/lib/run-task.js +1820 -0
- package/lib/sample-file.d.ts +14 -47
- package/lib/sample-file.js +9 -30
- package/lib/semver.d.ts +4 -21
- package/lib/semver.js +6 -20
- package/lib/source-code.d.ts +7 -23
- package/lib/source-code.js +7 -19
- package/lib/task-model.d.ts +21 -61
- package/lib/task-model.js +1 -1
- package/lib/task-runtime.d.ts +7 -24
- package/lib/task-runtime.js +7 -20
- package/lib/task.d.ts +29 -73
- package/lib/task.js +28 -61
- package/lib/tasks.d.ts +12 -34
- package/lib/tasks.js +14 -36
- package/lib/testing.d.ts +6 -10
- package/lib/testing.js +8 -12
- package/lib/textfile.d.ts +9 -24
- package/lib/textfile.js +9 -19
- package/lib/toml.d.ts +2 -14
- package/lib/toml.js +3 -13
- package/lib/typescript/projenrc.d.ts +4 -14
- package/lib/typescript/projenrc.js +3 -8
- package/lib/typescript/typescript-typedoc.d.ts +1 -6
- package/lib/typescript/typescript-typedoc.js +3 -8
- package/lib/typescript/typescript.d.ts +24 -82
- package/lib/typescript/typescript.js +6 -15
- package/lib/version.d.ts +9 -38
- package/lib/version.js +2 -11
- package/lib/vscode/devcontainer.d.ts +10 -30
- package/lib/vscode/devcontainer.js +10 -26
- package/lib/vscode/launch-config.d.ts +18 -97
- package/lib/vscode/launch-config.js +9 -15
- package/lib/vscode/vscode.d.ts +0 -9
- package/lib/vscode/vscode.js +2 -11
- package/lib/web/next.d.ts +19 -60
- package/lib/web/next.js +6 -20
- package/lib/web/postcss.d.ts +3 -24
- package/lib/web/postcss.js +3 -8
- package/lib/web/react.d.ts +13 -60
- package/lib/web/react.js +7 -32
- package/lib/web/tailwind.d.ts +1 -15
- package/lib/web/tailwind.js +3 -7
- package/lib/xmlfile.d.ts +2 -14
- package/lib/xmlfile.js +3 -13
- package/lib/yaml.d.ts +4 -19
- package/lib/yaml.js +3 -13
- package/package.json +5 -5
- package/releasetag.txt +1 -1
- package/version.txt +1 -1
|
@@ -6,14 +6,9 @@ const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
|
|
|
6
6
|
const component_1 = require("../component");
|
|
7
7
|
const ini_1 = require("../ini");
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
* @experimental
|
|
9
|
+
* File representing the local NPM config in .npmrc
|
|
12
10
|
*/
|
|
13
11
|
class NpmConfig extends component_1.Component {
|
|
14
|
-
/**
|
|
15
|
-
* @experimental
|
|
16
|
-
*/
|
|
17
12
|
constructor(project, options = {}) {
|
|
18
13
|
super(project);
|
|
19
14
|
/**
|
|
@@ -27,21 +22,19 @@ class NpmConfig extends component_1.Component {
|
|
|
27
22
|
}
|
|
28
23
|
}
|
|
29
24
|
/**
|
|
30
|
-
*
|
|
25
|
+
* configure a scoped registry
|
|
31
26
|
*
|
|
32
|
-
* @param url the URL of the registry to use
|
|
33
|
-
* @param scope the scope the registry is used for;
|
|
34
|
-
* @experimental
|
|
27
|
+
* @param url the URL of the registry to use
|
|
28
|
+
* @param scope the scope the registry is used for; leave empty for the default registry
|
|
35
29
|
*/
|
|
36
30
|
addRegistry(url, scope) {
|
|
37
31
|
this.addConfig(scope ? `${scope}:registry` : "registry", url);
|
|
38
32
|
}
|
|
39
33
|
/**
|
|
40
|
-
*
|
|
34
|
+
* configure a generic property
|
|
41
35
|
*
|
|
42
|
-
* @param name the name of the property
|
|
43
|
-
* @param value the value of the property
|
|
44
|
-
* @experimental
|
|
36
|
+
* @param name the name of the property
|
|
37
|
+
* @param value the value of the property
|
|
45
38
|
*/
|
|
46
39
|
addConfig(name, value) {
|
|
47
40
|
this.config[name] = value;
|
|
@@ -49,5 +42,5 @@ class NpmConfig extends component_1.Component {
|
|
|
49
42
|
}
|
|
50
43
|
exports.NpmConfig = NpmConfig;
|
|
51
44
|
_a = JSII_RTTI_SYMBOL_1;
|
|
52
|
-
NpmConfig[_a] = { fqn: "projen.javascript.NpmConfig", version: "0.52.
|
|
53
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
45
|
+
NpmConfig[_a] = { fqn: "projen.javascript.NpmConfig", version: "0.52.25" };
|
|
46
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtLWNvbmZpZy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9qYXZhc2NyaXB0L25wbS1jb25maWcudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSw0Q0FBeUM7QUFDekMsZ0NBQWlDO0FBaUJqQzs7R0FFRztBQUNILE1BQWEsU0FBVSxTQUFRLHFCQUFTO0lBT3RDLFlBQVksT0FBb0IsRUFBRSxVQUE0QixFQUFFO1FBQzlELEtBQUssQ0FBQyxPQUFPLENBQUMsQ0FBQztRQVBqQjs7O1dBR0c7UUFDYyxXQUFNLEdBQVEsRUFBRSxDQUFDO1FBS2hDLElBQUksYUFBTyxDQUFDLE9BQU8sRUFBRSxRQUFRLEVBQUUsRUFBRSxHQUFHLEVBQUUsSUFBSSxDQUFDLE1BQU0sRUFBRSxDQUFDLENBQUM7UUFFckQsSUFBSSxPQUFPLENBQUMsUUFBUSxFQUFFO1lBQ3BCLElBQUksQ0FBQyxXQUFXLENBQUMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxDQUFDO1NBQ3BDO0lBQ0gsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0ksV0FBVyxDQUFDLEdBQVcsRUFBRSxLQUFjO1FBQzVDLElBQUksQ0FBQyxTQUFTLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxHQUFHLEtBQUssV0FBVyxDQUFDLENBQUMsQ0FBQyxVQUFVLEVBQUUsR0FBRyxDQUFDLENBQUM7SUFDaEUsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0ksU0FBUyxDQUFDLElBQVksRUFBRSxLQUFhO1FBQzFDLElBQUksQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLEdBQUcsS0FBSyxDQUFDO0lBQzVCLENBQUM7O0FBbkNILDhCQW9DQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IENvbXBvbmVudCB9IGZyb20gXCIuLi9jb21wb25lbnRcIjtcbmltcG9ydCB7IEluaUZpbGUgfSBmcm9tIFwiLi4vaW5pXCI7XG5pbXBvcnQgeyBOb2RlUHJvamVjdCB9IGZyb20gXCIuLi9qYXZhc2NyaXB0XCI7XG5cbi8qKlxuICogT3B0aW9ucyB0byBjb25maWd1cmUgdGhlIGxvY2FsIE5QTSBjb25maWdcbiAqL1xuZXhwb3J0IGludGVyZmFjZSBOcG1Db25maWdPcHRpb25zIHtcbiAgLyoqXG4gICAqIFVSTCBvZiB0aGUgcmVnaXN0cnkgbWlycm9yIHRvIHVzZVxuICAgKlxuICAgKiBZb3UgY2FuIGNoYW5nZSB0aGlzIG9yIGFkZCBzY29wZWQgcmVnaXN0cmllcyB1c2luZyB0aGUgYWRkUmVnaXN0cnkgbWV0aG9kXG4gICAqXG4gICAqIEBkZWZhdWx0IC0gdXNlIG5wbWpzIGRlZmF1bHQgcmVnaXN0cnlcbiAgICovXG4gIHJlYWRvbmx5IHJlZ2lzdHJ5Pzogc3RyaW5nO1xufVxuXG4vKipcbiAqIEZpbGUgcmVwcmVzZW50aW5nIHRoZSBsb2NhbCBOUE0gY29uZmlnIGluIC5ucG1yY1xuICovXG5leHBvcnQgY2xhc3MgTnBtQ29uZmlnIGV4dGVuZHMgQ29tcG9uZW50IHtcbiAgLyoqXG4gICAqIFRoZSBjb25maWcgb2JqZWN0LiBUaGlzIG9iamVjdCBjYW4gYmUgbXV0YXRlZCB1bnRpbCB0aGUgcHJvamVjdCBpc1xuICAgKiBzeW50aGVzaXplZC5cbiAgICovXG4gIHByaXZhdGUgcmVhZG9ubHkgY29uZmlnOiBhbnkgPSB7fTtcblxuICBjb25zdHJ1Y3Rvcihwcm9qZWN0OiBOb2RlUHJvamVjdCwgb3B0aW9uczogTnBtQ29uZmlnT3B0aW9ucyA9IHt9KSB7XG4gICAgc3VwZXIocHJvamVjdCk7XG5cbiAgICBuZXcgSW5pRmlsZShwcm9qZWN0LCBcIi5ucG1yY1wiLCB7IG9iajogdGhpcy5jb25maWcgfSk7XG5cbiAgICBpZiAob3B0aW9ucy5yZWdpc3RyeSkge1xuICAgICAgdGhpcy5hZGRSZWdpc3RyeShvcHRpb25zLnJlZ2lzdHJ5KTtcbiAgICB9XG4gIH1cblxuICAvKipcbiAgICogY29uZmlndXJlIGEgc2NvcGVkIHJlZ2lzdHJ5XG4gICAqXG4gICAqIEBwYXJhbSB1cmwgdGhlIFVSTCBvZiB0aGUgcmVnaXN0cnkgdG8gdXNlXG4gICAqIEBwYXJhbSBzY29wZSB0aGUgc2NvcGUgdGhlIHJlZ2lzdHJ5IGlzIHVzZWQgZm9yOyBsZWF2ZSBlbXB0eSBmb3IgdGhlIGRlZmF1bHQgcmVnaXN0cnlcbiAgICovXG4gIHB1YmxpYyBhZGRSZWdpc3RyeSh1cmw6IHN0cmluZywgc2NvcGU/OiBzdHJpbmcpIHtcbiAgICB0aGlzLmFkZENvbmZpZyhzY29wZSA/IGAke3Njb3BlfTpyZWdpc3RyeWAgOiBcInJlZ2lzdHJ5XCIsIHVybCk7XG4gIH1cblxuICAvKipcbiAgICogY29uZmlndXJlIGEgZ2VuZXJpYyBwcm9wZXJ0eVxuICAgKlxuICAgKiBAcGFyYW0gbmFtZSB0aGUgbmFtZSBvZiB0aGUgcHJvcGVydHlcbiAgICogQHBhcmFtIHZhbHVlIHRoZSB2YWx1ZSBvZiB0aGUgcHJvcGVydHlcbiAgICovXG4gIHB1YmxpYyBhZGRDb25maWcobmFtZTogc3RyaW5nLCB2YWx1ZTogc3RyaW5nKSB7XG4gICAgdGhpcy5jb25maWdbbmFtZV0gPSB2YWx1ZTtcbiAgfVxufVxuIl19
|
|
@@ -3,344 +3,260 @@ import { IgnoreFile } from "../ignore-file";
|
|
|
3
3
|
import { NodeProject } from "../javascript";
|
|
4
4
|
import { Project } from "../project";
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* Options for Prettier
|
|
7
7
|
*
|
|
8
|
-
* @experimental
|
|
9
8
|
*/
|
|
10
9
|
export interface PrettierOptions {
|
|
11
10
|
/**
|
|
12
|
-
*
|
|
11
|
+
* Defines an .prettierIgnore file
|
|
13
12
|
*
|
|
14
13
|
* @default true
|
|
15
|
-
* @experimental
|
|
16
14
|
*/
|
|
17
15
|
readonly ignoreFile?: boolean;
|
|
18
16
|
/**
|
|
19
|
-
*
|
|
20
|
-
*
|
|
17
|
+
* Prettier settings.
|
|
21
18
|
* @default - default settings
|
|
22
|
-
* @experimental
|
|
23
19
|
*/
|
|
24
20
|
readonly settings?: PrettierSettings;
|
|
25
21
|
/**
|
|
26
|
-
*
|
|
22
|
+
* Provide a list of patterns to override prettier configuration.
|
|
27
23
|
*
|
|
28
24
|
* @default []
|
|
29
25
|
* @see https://prettier.io/docs/en/configuration.html#configuration-overrides
|
|
30
|
-
* @experimental
|
|
31
26
|
*/
|
|
32
27
|
readonly overrides?: PrettierOverride[];
|
|
33
28
|
}
|
|
34
29
|
/**
|
|
35
|
-
*
|
|
30
|
+
* Options to set in Prettier directly or through overrides
|
|
36
31
|
*
|
|
37
32
|
* @see https://prettier.io/docs/en/options.html
|
|
38
|
-
* @experimental
|
|
39
33
|
*/
|
|
40
34
|
export interface PrettierSettings {
|
|
41
35
|
/**
|
|
42
|
-
*
|
|
36
|
+
* Include parentheses around a sole arrow function parameter.
|
|
43
37
|
*
|
|
44
38
|
* @default ArrowParens.ALWAYS
|
|
45
|
-
* @experimental
|
|
46
39
|
*/
|
|
47
40
|
readonly arrowParens?: ArrowParens;
|
|
48
41
|
/**
|
|
49
|
-
*
|
|
42
|
+
* Put > of opening tags on the last line instead of on a new line.
|
|
50
43
|
*
|
|
51
44
|
* @default false
|
|
52
|
-
* @experimental
|
|
53
45
|
*/
|
|
54
46
|
readonly bracketSameLine?: boolean;
|
|
55
47
|
/**
|
|
56
|
-
*
|
|
48
|
+
* Print spaces between brackets.
|
|
57
49
|
*
|
|
58
50
|
* @default true
|
|
59
|
-
* @experimental
|
|
60
51
|
*/
|
|
61
52
|
readonly bracketSpacing?: boolean;
|
|
62
53
|
/**
|
|
63
|
-
*
|
|
64
|
-
*
|
|
54
|
+
* Print (to stderr) where a cursor at the given position would move to after formatting.
|
|
65
55
|
* This option cannot be used with --range-start and --range-end.
|
|
66
56
|
*
|
|
67
57
|
* @default -1
|
|
68
|
-
* @experimental
|
|
69
58
|
*/
|
|
70
59
|
readonly cursorOffset?: number;
|
|
71
60
|
/**
|
|
72
|
-
*
|
|
61
|
+
* Control how Prettier formats quoted code embedded in the file.
|
|
73
62
|
*
|
|
74
63
|
* @default EmbeddedLanguageFormatting.AUTO
|
|
75
|
-
* @experimental
|
|
76
64
|
*/
|
|
77
65
|
readonly embeddedLanguageFormatting?: EmbeddedLanguageFormatting;
|
|
78
66
|
/**
|
|
79
|
-
*
|
|
67
|
+
* Which end of line characters to apply.
|
|
80
68
|
*
|
|
81
69
|
* @default EndOfLine.LF
|
|
82
|
-
* @experimental
|
|
83
70
|
*/
|
|
84
71
|
readonly endOfLine?: EndOfLine;
|
|
85
72
|
/**
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
* This will be used to do parser inference.
|
|
89
|
-
*
|
|
73
|
+
* Specify the input filepath. This will be used to do parser inference.
|
|
90
74
|
* @default none
|
|
91
|
-
* @experimental
|
|
92
75
|
*/
|
|
93
76
|
readonly filepath?: string;
|
|
94
77
|
/**
|
|
95
|
-
*
|
|
78
|
+
* How to handle whitespaces in HTML.
|
|
96
79
|
*
|
|
97
80
|
* @default HTMLWhitespaceSensitivity.CSS
|
|
98
|
-
* @experimental
|
|
99
81
|
*/
|
|
100
82
|
readonly htmlWhitespaceSensitivity?: HTMLWhitespaceSensitivity;
|
|
101
83
|
/**
|
|
102
|
-
*
|
|
84
|
+
* Insert @format pragma into file's first docblock comment.
|
|
103
85
|
*
|
|
104
86
|
* @default false
|
|
105
|
-
* @experimental
|
|
106
87
|
*/
|
|
107
88
|
readonly insertPragma?: boolean;
|
|
108
89
|
/**
|
|
109
|
-
*
|
|
90
|
+
* Use single quotes in JSX.
|
|
110
91
|
*
|
|
111
92
|
* @default false
|
|
112
|
-
* @experimental
|
|
113
93
|
*/
|
|
114
94
|
readonly jsxSingleQuote?: boolean;
|
|
115
95
|
/**
|
|
116
|
-
*
|
|
96
|
+
* Which parser to use.
|
|
117
97
|
*
|
|
118
98
|
* @default - Prettier automatically infers the parser from the input file path, so you shouldn’t have to change this setting.
|
|
119
|
-
* @experimental
|
|
120
99
|
*/
|
|
121
100
|
readonly parser?: string;
|
|
122
101
|
/**
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
* Multiple plugins can be passed as separate `--plugin`s.
|
|
102
|
+
* Add a plugin. Multiple plugins can be passed as separate `--plugin`s.
|
|
126
103
|
*
|
|
127
104
|
* @default []
|
|
128
|
-
* @experimental
|
|
129
105
|
*/
|
|
130
106
|
readonly plugins?: string[];
|
|
131
107
|
/**
|
|
132
|
-
*
|
|
133
|
-
*
|
|
108
|
+
* Custom directory that contains prettier plugins in node_modules subdirectory.
|
|
134
109
|
* Overrides default behavior when plugins are searched relatively to the location of
|
|
135
110
|
* Prettier.
|
|
136
111
|
* Multiple values are accepted.
|
|
137
112
|
*
|
|
138
113
|
* @default []
|
|
139
|
-
* @experimental
|
|
140
114
|
*/
|
|
141
115
|
readonly pluginSearchDirs?: string[];
|
|
142
116
|
/**
|
|
143
|
-
*
|
|
117
|
+
* The line length where Prettier will try wrap.
|
|
144
118
|
*
|
|
145
119
|
* @default 80
|
|
146
|
-
* @experimental
|
|
147
120
|
*/
|
|
148
121
|
readonly printWidth?: number;
|
|
149
122
|
/**
|
|
150
|
-
*
|
|
123
|
+
* How to wrap prose.
|
|
151
124
|
*
|
|
152
125
|
* @default ProseWrap.PRESERVE
|
|
153
|
-
* @experimental
|
|
154
126
|
*/
|
|
155
127
|
readonly proseWrap?: ProseWrap;
|
|
156
128
|
/**
|
|
157
|
-
*
|
|
129
|
+
* Change when properties in objects are quoted.
|
|
158
130
|
*
|
|
159
131
|
* @default QuoteProps.ASNEEDED
|
|
160
|
-
* @experimental
|
|
161
132
|
*/
|
|
162
133
|
readonly quoteProps?: QuoteProps;
|
|
163
134
|
/**
|
|
164
|
-
*
|
|
165
|
-
*
|
|
135
|
+
* Format code ending at a given character offset (exclusive).
|
|
166
136
|
* The range will extend forwards to the end of the selected statement.
|
|
167
137
|
* This option cannot be used with --cursor-offset.
|
|
168
138
|
*
|
|
169
139
|
* @default null
|
|
170
|
-
* @experimental
|
|
171
140
|
*/
|
|
172
141
|
readonly rangeEnd?: number;
|
|
173
142
|
/**
|
|
174
|
-
*
|
|
175
|
-
*
|
|
143
|
+
* Format code starting at a given character offset.
|
|
176
144
|
* The range will extend backwards to the start of the first line containing the selected
|
|
177
145
|
* statement.
|
|
178
146
|
* This option cannot be used with --cursor-offset.
|
|
179
147
|
*
|
|
180
148
|
* @default 0
|
|
181
|
-
* @experimental
|
|
182
149
|
*/
|
|
183
150
|
readonly rangeStart?: number;
|
|
184
151
|
/**
|
|
185
|
-
*
|
|
152
|
+
* Require either '@prettier' or '@format' to be present in the file's first docblock
|
|
153
|
+
* comment
|
|
154
|
+
* in order for it to be formatted.
|
|
186
155
|
*
|
|
187
156
|
* @default false
|
|
188
|
-
* @experimental
|
|
189
157
|
*/
|
|
190
158
|
readonly requirePragma?: boolean;
|
|
191
159
|
/**
|
|
192
|
-
*
|
|
160
|
+
* Print semicolons.
|
|
193
161
|
*
|
|
194
162
|
* @default true
|
|
195
|
-
* @experimental
|
|
196
163
|
*/
|
|
197
164
|
readonly semi?: boolean;
|
|
198
165
|
/**
|
|
199
|
-
*
|
|
166
|
+
* Use single quotes instead of double quotes.
|
|
200
167
|
*
|
|
201
168
|
* @default false
|
|
202
|
-
* @experimental
|
|
203
169
|
*/
|
|
204
170
|
readonly singleQuote?: boolean;
|
|
205
171
|
/**
|
|
206
|
-
*
|
|
172
|
+
* Number of spaces per indentation level.
|
|
207
173
|
*
|
|
208
174
|
* @default 2
|
|
209
|
-
* @experimental
|
|
210
175
|
*/
|
|
211
176
|
readonly tabWidth?: number;
|
|
212
177
|
/**
|
|
213
|
-
*
|
|
178
|
+
* Print trailing commas wherever possible when multi-line.
|
|
214
179
|
*
|
|
215
180
|
* @default TrailingComma.ES5
|
|
216
|
-
* @experimental
|
|
217
181
|
*/
|
|
218
182
|
readonly trailingComma?: TrailingComma;
|
|
219
183
|
/**
|
|
220
|
-
*
|
|
184
|
+
* Indent with tabs instead of spaces.
|
|
221
185
|
*
|
|
222
186
|
* @default false
|
|
223
|
-
* @experimental
|
|
224
187
|
*/
|
|
225
188
|
readonly useTabs?: boolean;
|
|
226
189
|
/**
|
|
227
|
-
*
|
|
190
|
+
* Indent script and style tags in Vue files.
|
|
228
191
|
*
|
|
229
192
|
* @default false
|
|
230
|
-
* @experimental
|
|
231
193
|
*/
|
|
232
194
|
readonly vueIndentScriptAndStyle?: boolean;
|
|
233
195
|
}
|
|
234
|
-
/**
|
|
235
|
-
* @experimental
|
|
236
|
-
*/
|
|
237
196
|
export declare enum ArrowParens {
|
|
238
197
|
/**
|
|
239
|
-
*
|
|
240
|
-
*
|
|
241
|
-
* Example: `(x) => x`
|
|
242
|
-
*
|
|
243
|
-
* @experimental
|
|
198
|
+
* Always include parens. Example: `(x) => x`
|
|
244
199
|
*/
|
|
245
200
|
ALWAYS = "always",
|
|
246
201
|
/**
|
|
247
|
-
*
|
|
248
|
-
*
|
|
249
|
-
* Example: `x => x`
|
|
250
|
-
*
|
|
251
|
-
* @experimental
|
|
202
|
+
* Omit parens when possible. Example: `x => x`
|
|
252
203
|
*/
|
|
253
204
|
AVOID = "avoid"
|
|
254
205
|
}
|
|
255
|
-
/**
|
|
256
|
-
* @experimental
|
|
257
|
-
*/
|
|
258
206
|
export declare enum EmbeddedLanguageFormatting {
|
|
259
207
|
/**
|
|
260
|
-
*
|
|
261
|
-
*
|
|
262
|
-
* @experimental
|
|
208
|
+
* Format embedded code if Prettier can automatically identify it.
|
|
263
209
|
*/
|
|
264
210
|
AUTO = "auto",
|
|
265
211
|
/**
|
|
266
|
-
*
|
|
267
|
-
*
|
|
268
|
-
* @experimental
|
|
212
|
+
* Never automatically format embedded code.
|
|
269
213
|
*/
|
|
270
214
|
OFF = "off"
|
|
271
215
|
}
|
|
272
|
-
/**
|
|
273
|
-
* @experimental
|
|
274
|
-
*/
|
|
275
216
|
export declare enum EndOfLine {
|
|
276
217
|
/**
|
|
277
|
-
*
|
|
278
|
-
*
|
|
279
|
-
* @experimental
|
|
218
|
+
* Maintain existing (mixed values within one file are normalised by looking
|
|
219
|
+
* at what's used after the first line)
|
|
280
220
|
*/
|
|
281
221
|
AUTO = "auto",
|
|
282
222
|
/**
|
|
283
|
-
*
|
|
284
|
-
*
|
|
285
|
-
* @experimental
|
|
223
|
+
* Carriage Return character only (\r), used very rarely
|
|
286
224
|
*/
|
|
287
225
|
CR = "cr",
|
|
288
226
|
/**
|
|
289
|
-
*
|
|
290
|
-
*
|
|
291
|
-
* @experimental
|
|
227
|
+
* Carriage Return + Line Feed characters (\r\n), common on Windows
|
|
292
228
|
*/
|
|
293
229
|
CRLF = "crlf",
|
|
294
230
|
/**
|
|
295
|
-
*
|
|
296
|
-
*
|
|
297
|
-
* @experimental
|
|
231
|
+
* Line Feed only (\n), common on Linux and macOS as well as inside git repos
|
|
298
232
|
*/
|
|
299
233
|
LF = "lf"
|
|
300
234
|
}
|
|
301
|
-
/**
|
|
302
|
-
* @experimental
|
|
303
|
-
*/
|
|
304
235
|
export declare enum HTMLWhitespaceSensitivity {
|
|
305
236
|
/**
|
|
306
|
-
*
|
|
307
|
-
*
|
|
308
|
-
* @experimental
|
|
237
|
+
* Respect the default value of CSS display property.
|
|
309
238
|
*/
|
|
310
239
|
CSS = "css",
|
|
311
240
|
/**
|
|
312
|
-
*
|
|
313
|
-
*
|
|
314
|
-
* @experimental
|
|
241
|
+
* Whitespaces are considered insignificant.
|
|
315
242
|
*/
|
|
316
243
|
IGNORE = "ignore",
|
|
317
244
|
/**
|
|
318
|
-
*
|
|
319
|
-
*
|
|
320
|
-
* @experimental
|
|
245
|
+
* Whitespaces are considered significant.
|
|
321
246
|
*/
|
|
322
247
|
STRICT = "strict"
|
|
323
248
|
}
|
|
324
|
-
/**
|
|
325
|
-
* @experimental
|
|
326
|
-
*/
|
|
327
249
|
export interface PrettierOverride {
|
|
328
250
|
/**
|
|
329
|
-
*
|
|
330
|
-
*
|
|
331
|
-
* @experimental
|
|
251
|
+
* Exclude these files from this override.
|
|
332
252
|
*/
|
|
333
253
|
readonly excludeFiles?: Files;
|
|
334
254
|
/**
|
|
335
|
-
*
|
|
336
|
-
*
|
|
337
|
-
* @experimental
|
|
255
|
+
* Include these files in this override.
|
|
338
256
|
*/
|
|
339
257
|
readonly files: Files;
|
|
340
258
|
/**
|
|
341
|
-
*
|
|
342
|
-
*
|
|
343
|
-
* @experimental
|
|
259
|
+
* The options to apply for this override.
|
|
344
260
|
*/
|
|
345
261
|
readonly settings: PrettierSettings;
|
|
346
262
|
}
|
|
@@ -350,95 +266,59 @@ export interface PrettierOverride {
|
|
|
350
266
|
* Include these files in this override.
|
|
351
267
|
*/
|
|
352
268
|
export declare type Files = string[] | string;
|
|
353
|
-
/**
|
|
354
|
-
* @experimental
|
|
355
|
-
*/
|
|
356
269
|
export declare enum ProseWrap {
|
|
357
270
|
/**
|
|
358
|
-
*
|
|
359
|
-
*
|
|
360
|
-
* @experimental
|
|
271
|
+
* Wrap prose if it exceeds the print width.
|
|
361
272
|
*/
|
|
362
273
|
ALWAYS = "always",
|
|
363
274
|
/**
|
|
364
|
-
*
|
|
365
|
-
*
|
|
366
|
-
* @experimental
|
|
275
|
+
* Do not wrap prose.
|
|
367
276
|
*/
|
|
368
277
|
NEVER = "never",
|
|
369
278
|
/**
|
|
370
|
-
*
|
|
371
|
-
*
|
|
372
|
-
* @experimental
|
|
279
|
+
* Wrap prose as-is.
|
|
373
280
|
*/
|
|
374
281
|
PRESERVE = "preserve"
|
|
375
282
|
}
|
|
376
|
-
/**
|
|
377
|
-
* @experimental
|
|
378
|
-
*/
|
|
379
283
|
export declare enum QuoteProps {
|
|
380
284
|
/**
|
|
381
|
-
*
|
|
382
|
-
*
|
|
383
|
-
* @experimental
|
|
285
|
+
* Only add quotes around object properties where required.
|
|
384
286
|
*/
|
|
385
287
|
ASNEEDED = "as-needed",
|
|
386
288
|
/**
|
|
387
|
-
*
|
|
388
|
-
*
|
|
389
|
-
* @experimental
|
|
289
|
+
* If at least one property in an object requires quotes, quote all properties.
|
|
390
290
|
*/
|
|
391
291
|
CONSISTENT = "consistent",
|
|
392
292
|
/**
|
|
393
|
-
*
|
|
394
|
-
*
|
|
395
|
-
* @experimental
|
|
293
|
+
* Respect the input use of quotes in object properties.
|
|
396
294
|
*/
|
|
397
295
|
PRESERVE = "preserve"
|
|
398
296
|
}
|
|
399
|
-
/**
|
|
400
|
-
* @experimental
|
|
401
|
-
*/
|
|
402
297
|
export declare enum TrailingComma {
|
|
403
298
|
/**
|
|
404
|
-
*
|
|
405
|
-
*
|
|
406
|
-
* @experimental
|
|
299
|
+
* Trailing commas wherever possible (including function arguments).
|
|
407
300
|
*/
|
|
408
301
|
ALL = "all",
|
|
409
302
|
/**
|
|
410
|
-
*
|
|
411
|
-
*
|
|
412
|
-
* @experimental
|
|
303
|
+
* Trailing commas where valid in ES5 (objects, arrays, etc.)
|
|
413
304
|
*/
|
|
414
305
|
ES5 = "es5",
|
|
415
306
|
/**
|
|
416
|
-
*
|
|
417
|
-
*
|
|
418
|
-
* @experimental
|
|
307
|
+
* No trailing commas.
|
|
419
308
|
*/
|
|
420
309
|
NONE = "none"
|
|
421
310
|
}
|
|
422
311
|
/**
|
|
423
|
-
*
|
|
424
|
-
*
|
|
425
|
-
* @experimental
|
|
312
|
+
* Represents prettier configuration.
|
|
426
313
|
*/
|
|
427
314
|
export declare class Prettier extends Component {
|
|
428
|
-
/**
|
|
429
|
-
* @experimental
|
|
430
|
-
*/
|
|
431
315
|
static of(project: Project): Prettier | undefined;
|
|
432
316
|
/**
|
|
433
|
-
*
|
|
434
|
-
*
|
|
435
|
-
* @experimental
|
|
317
|
+
* Direct access to the prettier settings
|
|
436
318
|
*/
|
|
437
319
|
readonly settings: PrettierSettings;
|
|
438
320
|
/**
|
|
439
|
-
*
|
|
440
|
-
*
|
|
441
|
-
* @experimental
|
|
321
|
+
* The .prettierIgnore file.
|
|
442
322
|
*/
|
|
443
323
|
readonly ignoreFile?: IgnoreFile;
|
|
444
324
|
/**
|
|
@@ -447,34 +327,23 @@ export declare class Prettier extends Component {
|
|
|
447
327
|
* @internal
|
|
448
328
|
*/
|
|
449
329
|
private readonly _overrides;
|
|
450
|
-
/**
|
|
451
|
-
* @experimental
|
|
452
|
-
*/
|
|
453
330
|
constructor(project: NodeProject, options: PrettierOptions);
|
|
454
331
|
/**
|
|
455
|
-
*
|
|
456
|
-
*
|
|
332
|
+
* Add a prettier override
|
|
457
333
|
* @see https://prettier.io/docs/en/configuration.html#configuration-overrides
|
|
458
|
-
* @
|
|
334
|
+
* @param {PrettierOverride} override
|
|
459
335
|
*/
|
|
460
336
|
addOverride(override: PrettierOverride): void;
|
|
461
337
|
/**
|
|
462
|
-
*
|
|
338
|
+
* Defines Prettier ignore Patterns
|
|
339
|
+
* these patterns will be added to the file .prettierignore
|
|
463
340
|
*
|
|
464
|
-
* @param pattern filepatterns so exclude from prettier formatting
|
|
465
|
-
* @experimental
|
|
341
|
+
* @param pattern filepatterns so exclude from prettier formatting
|
|
466
342
|
*/
|
|
467
343
|
addIgnorePattern(pattern: string): void;
|
|
468
344
|
/**
|
|
469
|
-
*
|
|
470
|
-
*
|
|
471
|
-
* @experimental
|
|
345
|
+
* Access to the Prettieroverrides to extend those
|
|
472
346
|
*/
|
|
473
347
|
get overrides(): PrettierOverride[];
|
|
474
|
-
/**
|
|
475
|
-
* (experimental) Called before synthesis.
|
|
476
|
-
*
|
|
477
|
-
* @experimental
|
|
478
|
-
*/
|
|
479
348
|
preSynthesize(): void;
|
|
480
349
|
}
|