docs: Variable escaping in tasks (#20730)
This commit is contained in:
parent
9e8ff3f198
commit
e25a03cd3c
1 changed files with 32 additions and 0 deletions
|
@ -93,6 +93,38 @@ You can also use verbose syntax that allows specifying a default if a given vari
|
||||||
|
|
||||||
These environmental variables can also be used in tasks `cwd`, `args` and `label` fields.
|
These environmental variables can also be used in tasks `cwd`, `args` and `label` fields.
|
||||||
|
|
||||||
|
### Variable Quoting
|
||||||
|
|
||||||
|
When working with paths containing spaces or other special characters, please ensure variables are properly escaped.
|
||||||
|
|
||||||
|
For example, instead of this (which will fail if the path has a space):
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"label": "stat current file",
|
||||||
|
"command": "stat $ZED_FILE"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Provide the
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"label": "stat current file",
|
||||||
|
"command": "stat",
|
||||||
|
"args": ["$ZED_FILE"]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Or explicitly include escaped quotes like so:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"label": "stat current file",
|
||||||
|
"command": "stat \"$ZED_FILE\""
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
## Oneshot tasks
|
## Oneshot tasks
|
||||||
|
|
||||||
The same task modal opened via `task: spawn` supports arbitrary bash-like command execution: type a command inside the modal text field, and use `opt-enter` to spawn it.
|
The same task modal opened via `task: spawn` supports arbitrary bash-like command execution: type a command inside the modal text field, and use `opt-enter` to spawn it.
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue