Skip to content

Commit 8278341

Browse files
authored
docs: update integration doc with details of extension config namespace change (#2428)
* docs: update integration doc with details of extension config namespace change * docs: add descriptions of sorting modes
1 parent d5bed6b commit 8278341

4 files changed

Lines changed: 27 additions & 8 deletions

File tree

website/src/docs/integrations.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ outline: deep
1212

1313
Task has an
1414
[official extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=task.vscode-task).
15-
The code for this project can be found
16-
[here](https://github.com/go-task/vscode-task). To use this extension, you must
17-
have Task v3.23.0+ installed on your system.
15+
The code for this project can be found in
16+
[our GitHub repository](https://github.com/go-task/vscode-task). To use this
17+
extension, you must have Task v3.45.3+ installed on your system.
1818

1919
This extension provides the following features (and more):
2020

@@ -30,6 +30,19 @@ To get autocompletion and validation for your Taskfile, see the
3030

3131
![Task for Visual Studio Code](https://github.com/go-task/vscode-task/blob/main/res/preview.png?raw=true)
3232

33+
### Configuration namespace change
34+
35+
In v1.0.0 of the extension, the configuration namespace was changed from `task`
36+
to `taskfile` in order to fix
37+
[an issue](https://github.com/go-task/vscode-task/issues/56).
38+
39+
![Configuration namespace change warning](../public/img/config-namespace-change.png)
40+
41+
If you receive a warning like the one above, you will need to update your
42+
settings to use the new `taskfile` namespace instead:
43+
44+
![Configuration namespace diff](../public/img/config-namespace-diff.png)
45+
3346
## Schema
3447

3548
This was initially created by @KROSF in

website/src/docs/reference/cli.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,8 @@ task deploy --silent
118118

119119
#### `--disable-fuzzy`
120120

121-
Disable fuzzy matching for task names. When enabled, Task will not suggest similar task names when you mistype a task name.
121+
Disable fuzzy matching for task names. When enabled, Task will not suggest
122+
similar task names when you mistype a task name.
122123

123124
```bash
124125
task buidl --disable-fuzzy
@@ -274,7 +275,12 @@ task --list --json
274275

275276
#### `--sort <mode>`
276277

277-
Change task listing order. Available modes: `default`, `alphanumeric`, `none`.
278+
Change task listing order. Available modes:
279+
280+
- `default` - Sorts tasks alphabetically by name, but ensures that root tasks
281+
(tasks without a namespace) are listed before namespaced tasks.
282+
- `alphanumeric` - Sort tasks alphabetically by name.
283+
- `none` - No sorting. Uses the order as defined in the Taskfile.
278284

279285
```bash
280286
task --list --sort alphanumeric
@@ -314,9 +320,9 @@ task deploy --yes
314320
Enable interactive prompts for missing required variables. When a required
315321
variable is not provided, Task will prompt for input instead of failing.
316322

317-
Task automatically detects non-TTY environments (like CI pipelines) and
318-
skips prompts. This flag can also be set in `.taskrc.yml` to enable prompts
319-
by default.
323+
Task automatically detects non-TTY environments (like CI pipelines) and skips
324+
prompts. This flag can also be set in `.taskrc.yml` to enable prompts by
325+
default.
320326

321327
```bash
322328
task deploy --interactive
9.42 KB
Loading
5.84 KB
Loading

0 commit comments

Comments
 (0)