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

docs(core): clarify interpolated keywords (#26486)

Browse Source 
Fixes #23511
This commit is contained in:
Isaac Mann 2024-06-10 11:23:24 -04:00 committed by GitHub
parent ccc5ad5db4
commit c7401b5657
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 2 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/shared/recipes/running-tasks/configure-inputs.md
View File

@ -62,8 +62,6 @@ This will show the task graph executed by Nx when running the command.
Clicking the task will open a tooltip which lists out all of the inputs of the task. A button within the tooltip will also reveal more details about the configuration for the project which the task belongs to. Clicking the task will open a tooltip which lists out all of the inputs of the task. A button within the tooltip will also reveal more details about the configuration for the project which the task belongs to.
[//]: # 'TODO: add gif here'
Doing so will show a view such as the one below: Doing so will show a view such as the one below:
{% project-details jsonFile="shared/concepts/myreactapp.json"%} {% project-details jsonFile="shared/concepts/myreactapp.json"%}

2
docs/shared/recipes/running-tasks/configure-outputs.md
View File

@ -31,7 +31,7 @@ These outputs files can be specified in several ways:
] ]
``` ```
All outputs explicitly specifying paths must be prefixed with either `{projectRoot}` or `{workspaceRoot}` to distinguish where the path is resolved from. `{workspaceRoot}` should only appear in the beginning of an `output` but `{projectRoot}` and `{projectName}` can be specified later in the `output` to interpolate the root or name of the a project into the output location. All outputs explicitly specifying paths must be prefixed with either `{projectRoot}` or `{workspaceRoot}` to distinguish where the path is resolved from. `{workspaceRoot}` should only appear in the beginning of an `output` but `{projectRoot}` and `{projectName}` can be specified later in the `output` to interpolate the root or name of the project into the output location.
Outputs can also be determined from the `options` of running a task via the `{options.[propertyName]}` syntax. Outputs can also be determined from the `options` of running a task via the `{options.[propertyName]}` syntax.
This is useful when an option for the task determines the output location and could be modified when the task is run. This is useful when an option for the task determines the output location and could be modified when the task is run.

2
docs/shared/reference/inputs.md
View File

@ -32,7 +32,7 @@ Source file inputs are defined like this:
} }
``` ```
Source file inputs must be prefixed with either `{projectRoot}` or `{workspaceRoot}` to distinguish where the paths should be resolved from. Source file inputs must be prefixed with either `{projectRoot}` or `{workspaceRoot}` to distinguish where the paths should be resolved from. `{workspaceRoot}` should only appear in the beginning of an input but `{projectRoot}` and `{projectName}` can be specified later in the input to interpolate the root or name of the project into the input location.
Prefixing a source file input with `!` will exclude the files matching the pattern from the set of files used to calculate the hash. Prefixing a source file input with `!` will exclude the files matching the pattern from the set of files used to calculate the hash.
Prefixing a source file input with `^` means this entry applies to the project dependencies of the project, not the project itself. Prefixing a source file input with `^` means this entry applies to the project dependencies of the project, not the project itself.