You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/features/task-runner.md
+15-6Lines changed: 15 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,17 +4,26 @@ Project tasks are defined in a [`mise.toml`](https://mise.jdx.dev/) file. A `Mak
4
4
5
5
Run any task with:
6
6
7
+
/// tab | :simple-make: make
8
+
7
9
```bash
8
10
make <task>
9
-
# or directly:
11
+
```
12
+
13
+
///
14
+
15
+
/// tab | :material-wrench: mise
16
+
17
+
```bash
10
18
mise run <task>
11
19
```
12
20
13
-
> [!TIP]
14
-
> Prefer `mise run` over `make` when running tasks directly:
15
-
>
16
-
> -**Auto-completion**: Run `make mise-setup-completions` to install shell completions for mise, giving you tab-completion for all tasks.
17
-
> -**Flags & arguments**: mise tasks can accept flags and positional arguments (e.g. `mise run docker-build --dev`, `mise run test -- -k test_foo`), which is not possible through `make`.
21
+
///
22
+
23
+
!!! tip "Prefer `mise run` over `make` when running tasks directly"
24
+
25
+
- **Auto-completion**: Run `make mise-setup-completions` to install shell completions for mise, giving you tab-completion for all tasks.
26
+
- **Flags & arguments**: mise tasks can accept flags and positional arguments (e.g. `mise run docker-build --dev`, `mise run test -- -k test_foo`), which is not possible through `make`.
Copy file name to clipboardExpand all lines: docs/features/testing.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,15 +6,15 @@ The template configures a full testing setup with pytest, coverage reporting, an
6
6
7
7
[pytest](https://github.com/pytest-dev/pytest) is the default test runner. Tests live in the `tests/` directory.
8
8
9
-
/// tab | make
9
+
/// tab | :simple-make: make
10
10
11
11
```bash
12
12
make test
13
13
```
14
14
15
15
///
16
16
17
-
/// tab | mise
17
+
/// tab | :material-wrench: mise
18
18
19
19
```bash
20
20
mise run test
@@ -26,15 +26,15 @@ mise run test
26
26
27
27
[Coverage.py](https://github.com/nedbat/coveragepy) generates test coverage reports in text, HTML, and XML formats.
28
28
29
-
/// tab | make
29
+
/// tab | :simple-make: make
30
30
31
31
```bash
32
32
make coverage
33
33
```
34
34
35
35
///
36
36
37
-
/// tab | mise
37
+
/// tab | :material-wrench: mise
38
38
39
39
```bash
40
40
mise run coverage
@@ -48,15 +48,15 @@ The coverage threshold is configurable via the `coverage_threshold` template var
48
48
49
49
[Tox](https://github.com/tox-dev/tox) with [tox-uv](https://github.com/tox-dev/tox-uv) runs your test suite across multiple Python versions.
50
50
51
-
/// tab | make
51
+
/// tab | :simple-make: make
52
52
53
53
```bash
54
54
make tox
55
55
```
56
56
57
57
///
58
58
59
-
/// tab | mise
59
+
/// tab | :material-wrench: mise
60
60
61
61
```bash
62
62
mise run tox
@@ -70,7 +70,7 @@ Tox is included by default but can be disabled by setting `tox: false` during pr
70
70
71
71
For parallel test execution, enable the `pytest_xdist` option during generation. This adds [pytest-xdist](https://github.com/pytest-dev/pytest-xdist) to your test dependencies.
72
72
73
-
/// tab | make
73
+
/// tab | :simple-make: make
74
74
75
75
```bash
76
76
# Tests automatically run in parallel when pytest-xdist is installed
@@ -79,7 +79,7 @@ make test
79
79
80
80
///
81
81
82
-
/// tab | mise
82
+
/// tab | :material-wrench: mise
83
83
84
84
```bash
85
85
# Tests automatically run in parallel when pytest-xdist is installed
The template runs post-generation tasks (`git init`, `make setup-dev`, etc.) defined in `copier.yaml`, which requires the `--trust` flag.
27
+
The template runs post-generation tasks (`git init`, `make setup-dev`, etc.) defined in `copier.yaml`, which requires the `--trust` flag.
28
28
29
-
!!! tip "Additional flags" - Add `--prereleases` to include pre-release template versions - Add `--vcs-ref=HEAD` to use the latest commit instead of the latest release
29
+
!!! tip "Additional flags"
30
+
- Add `--prereleases` to include pre-release template versions
31
+
- Add `--vcs-ref=HEAD` to use the latest commit instead of the latest release
0 commit comments