diff options
| author | Nathan Whitaker <17734409+nathanwhit@users.noreply.github.com> | 2024-03-27 14:14:27 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-03-27 14:14:27 -0700 |
| commit | 2dc37f411e8947d3c20cd93d1fa1937edc239499 (patch) | |
| tree | 0ecb10fb3cc0e9085130c3683155529c5de74e84 /tests | |
| parent | 68fecc6de4b2e6556adeb2730798bf42017c4be6 (diff) | |
feat(task): Task description in the form of comments (#23101)
Closes #22786.
TLDR;
```jsonc
{
"tasks": {
// Some comment
//
// describing what the task does
"dev": "deno run -A --watch main.ts"
}
}
```
```bash
deno task
```
Diffstat (limited to 'tests')
6 files changed, 46 insertions, 0 deletions
diff --git a/tests/specs/task/doc_comments_incorrect/__test__.jsonc b/tests/specs/task/doc_comments_incorrect/__test__.jsonc new file mode 100644 index 000000000..e564690e6 --- /dev/null +++ b/tests/specs/task/doc_comments_incorrect/__test__.jsonc @@ -0,0 +1,6 @@ +{ + "args": "task doesntexist", + "envs": { "NO_COLOR": "1" }, + "output": "task.out", + "exitCode": 1 +} diff --git a/tests/specs/task/doc_comments_incorrect/deno.jsonc b/tests/specs/task/doc_comments_incorrect/deno.jsonc new file mode 100644 index 000000000..6b27f2850 --- /dev/null +++ b/tests/specs/task/doc_comments_incorrect/deno.jsonc @@ -0,0 +1,7 @@ +{ + "tasks": { + // some docs + // on what this does + "lint": "deno lint" + } +} diff --git a/tests/specs/task/doc_comments_incorrect/task.out b/tests/specs/task/doc_comments_incorrect/task.out new file mode 100644 index 000000000..9d81c1768 --- /dev/null +++ b/tests/specs/task/doc_comments_incorrect/task.out @@ -0,0 +1,6 @@ +Task not found: doesntexist +Available tasks: +- lint + // some docs + // on what this does + deno lint diff --git a/tests/specs/task/doc_comments_no_args/__test__.jsonc b/tests/specs/task/doc_comments_no_args/__test__.jsonc new file mode 100644 index 000000000..2f9db088a --- /dev/null +++ b/tests/specs/task/doc_comments_no_args/__test__.jsonc @@ -0,0 +1,6 @@ +{ + "args": "task", + "envs": { "NO_COLOR": "1" }, + "output": "task.out", + "exitCode": 1 +} diff --git a/tests/specs/task/doc_comments_no_args/deno.jsonc b/tests/specs/task/doc_comments_no_args/deno.jsonc new file mode 100644 index 000000000..4b6d690c8 --- /dev/null +++ b/tests/specs/task/doc_comments_no_args/deno.jsonc @@ -0,0 +1,12 @@ +{ + "tasks": { + // this task has documentation + // + // in the form of comments + "lint": "deno lint", + /* + * block comments are fine too + */ + "fmt": "deno fmt" + } +} diff --git a/tests/specs/task/doc_comments_no_args/task.out b/tests/specs/task/doc_comments_no_args/task.out new file mode 100644 index 000000000..635e36090 --- /dev/null +++ b/tests/specs/task/doc_comments_no_args/task.out @@ -0,0 +1,9 @@ +Available tasks: +- lint + // this task has documentation + // + // in the form of comments + deno lint +- fmt + // block comments are fine too + deno fmt |