miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

docs(core): task dependencies with single project (#16204)

Browse Source
This commit is contained in:
Isaac Mann 2023-04-11 12:00:39 -04:00 committed by GitHub
parent afb37c8691
commit 64c35a6f8a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 41 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
docs/shared/reference/project-configuration.md
View File

@ -274,7 +274,40 @@ instance, `"dependsOn": ["build"]` of
the `test` target tells Nx that before it can test `mylib` it needs to make sure that `mylib` is built, which will
result in `mylib`'s dependencies being built as well.
You can also express the same configuration using:
You can also express task dependencies with an object syntax:
{% tabs %}
{% tab label="Version < 16" %}
```json
"build": {
"dependsOn": [{
"projects": "dependencies", // "dependencies" or "self"
"target": "build", // target name
"params": "ignore" // "forward" or "ignore", defaults to "ignore"
}]
}
```
{% /tab %}
{% tab label="Version 16+" %}
```json
"build": {
"dependsOn": [{
"projects": "{dependencies}", // "{dependencies}", "{self}" or "project-name"
"target": "build", // target name
"params": "ignore" // "forward" or "ignore", defaults to "ignore"
}]
}
```
{% /tab %}
{% /tabs %}
#### Examples
You can write the shorthand configuration above in the object syntax like this:
{% tabs %}
{% tab label="Version < 16" %}
@ -344,7 +377,7 @@ With the expanded syntax, you also have a third option available to configure ho
{% /tab %}
{% /tabs %}
Obviously this also works when defining a relation for the target of the project itself using `"projects": "self"`:
This also works when defining a relation for the target of the project itself using `"projects": "self"`:
{% tabs %}
{% tab label="Version < 16" %}
@ -371,6 +404,9 @@ Obviously this also works when defining a relation for the target of the project
Additionally, when using the expanded object syntax, you can specify individual projects in version 16 or greater.
{% tabs %}
{% tab label="Version 16+" %}
```json
"build": {
// Run is-even:pre-build and is-odd:pre-build before this target
@ -378,6 +414,9 @@ Additionally, when using the expanded object syntax, you can specify individual
}
```
{% /tab %}
{% /tabs %}
This configuration is usually not needed. Nx comes with reasonable defaults (imported in `nx.json`) which implement the
configuration above.