Skip to content

Commit e12f4fd

Browse files
committed
add development notes to readme
1 parent b7156ad commit e12f4fd

File tree

2 files changed

+25
-6
lines changed

2 files changed

+25
-6
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,3 +59,22 @@ The program will use the following file priority:
5959
4. [`.tool-versions` from `asdf`](https://asdf-vm.com/guide/getting-started.html#local)
6060

6161
### Default global packages
62+
63+
64+
## Development
65+
66+
This project uses [Task](https://taskfile.dev/installation) to execute various development commands.
67+
68+
e.g. to run a command via a debug build, run:
69+
70+
```shell
71+
task run -- install 12
72+
```
73+
74+
To build a release artifact, run:
75+
76+
```shell
77+
task build:release
78+
```
79+
80+
You can find all the commands in the [Taskfile](./Taskfile.yml).

Taskfile.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ tasks:
44
lint:
55
desc: Lint code
66
cmds:
7-
- cargo clippy
7+
- cargo clippy {{.CLI_ARGS}}
88
lint:fix:
99
desc: Lint code and fix problems with autofixes
1010
cmds:
@@ -13,7 +13,7 @@ tasks:
1313
format:
1414
desc: Format code
1515
cmds:
16-
- cargo fmt --all
16+
- cargo fmt --all {{.CLI_ARGS}}
1717

1818
test:
1919
desc: Run tests
@@ -23,12 +23,12 @@ tasks:
2323
- test-data/**
2424
- tests/**
2525
cmds:
26-
- cargo test
26+
- cargo test {{.CLI_ARGS}}
2727

2828
run:
2929
desc: "Run the CLI with a debug build: task run -- <...args>"
3030
cmds:
31-
- cargo run
31+
- cargo run {{.CLI_ARGS}}
3232

3333
build:
3434
desc: Build debug artifacts
@@ -38,7 +38,7 @@ tasks:
3838
generates:
3939
- target/debug/**
4040
cmds:
41-
- cargo build
41+
- cargo build {{.CLI_ARGS}}
4242

4343
build:release:
4444
desc: Build release artifacts
@@ -48,4 +48,4 @@ tasks:
4848
generates:
4949
- target/release/**
5050
cmds:
51-
- cargo build --release --locked
51+
- cargo build --release --locked {{.CLI_ARGS}}

0 commit comments

Comments
 (0)