Skip to content

Commit 3ddb157

Browse files
committed
chore: update CONTRIBUTING.md
1 parent ff9b6e1 commit 3ddb157

2 files changed

Lines changed: 14 additions & 9 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ mise run lint-fix # to fix lint issues
3636
mise run lint-fix -a # to fix lint in non-updated files
3737

3838
mise run check # lint-fix + tests
39+
mise run check-all # mise check + e2e tests
3940
```
4041

4142
You can install the git hooks with

mise.toml

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,28 @@ hk = "1.18.1"
77
_.path = ["./node_modules/.bin"]
88
CODE_CMD = "code"
99

10+
### Main tasks
11+
1012
[tasks.dev]
1113
description = 'Starts the project in watch mode and opens the extension in VSCode'
1214
depends = ['dev-extension', 'dev-webviews', 'start-vscode']
1315

16+
[tasks.check]
17+
description = "Lint, type-check, and test the project"
18+
depends = ['lint-fix', 'test', 'ts-check', 'docs:extractSettings']
19+
20+
[tasks.check-all]
21+
description = "Lint, type-check, test, build docs, and run e2e tests"
22+
depends = ['lint-fix', 'test', 'ts-check', 'docs:extractSettings', 'docs:build', 'e2e-tests']
23+
24+
#####################
25+
1426
[tasks."docs:extractSettings"]
1527
run = 'bun src/extract-settings.mjs'
1628
dir = "{{config_root}}/docs"
1729

1830
[tasks."docs:dev"]
19-
alias = 'doc s'
31+
alias = 'docs'
2032
description = 'Builds the documentation'
2133
run = 'exec node --run dev'
2234
dir = "{{config_root}}/docs"
@@ -94,14 +106,6 @@ run = 'node --run test'
94106
run = 'node --run e2e-tests'
95107
depends = ['install']
96108

97-
[tasks.check]
98-
description = "Lint, type-check, and test the project"
99-
depends = ['lint-fix', 'test', 'ts-check', 'docs:extractSettings']
100-
101-
[tasks.check-all]
102-
description = "Lint, type-check, test, build docs, and run e2e tests"
103-
depends = ['lint-fix', 'test', 'ts-check', 'docs:extractSettings', 'docs:build', 'e2e-tests']
104-
105109
[tasks.e2e-test-action]
106110
tools = { act = 'latest' }
107111
run = 'act push -j e2e-tests'

0 commit comments

Comments
 (0)