Skip to content

Commit 52308f6

Browse files
Update readme with more developer instructions
1 parent 933575e commit 52308f6

1 file changed

Lines changed: 22 additions & 4 deletions

File tree

README.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ foo bar baz: "foo bar baz"
7474
```yaml
7575
repos:
7676
- repo: https://github.com/cursorless-dev/talon-tools
77-
rev: v0.7.0
77+
rev: v0.8.0
7878
hooks:
7979
- id: talon-fmt
8080
- id: snippet-fmt
@@ -91,10 +91,28 @@ repos:
9191

9292
```sh
9393
# Try formatter without pre-commit
94-
node out/treeSitterFormatter.js test.scm
94+
node out/talonFormatter.js test.talon
9595
9696
# Try formatter with pre-commit
97-
pre-commit try-repo . tree-sitter-fmt --files test.scm -v
97+
pre-commit try-repo . talon-fmt --files test.talon -v
98+
```
99+
100+
Install the hooks locally:
101+
102+
```yaml
103+
# .pre-commit-config.yaml
104+
repos:
105+
- repo: .
106+
rev: HEAD
107+
hooks:
108+
- id: talon-fmt
109+
- id: snippet-fmt
110+
- id: tree-sitter-fmt
111+
```
112+
113+
```sh
114+
pre-commit install
115+
pre-commit run --all-files
98116
```
99117

100118
## Release
@@ -104,5 +122,5 @@ When creating a new release do the following:
104122
- Update version in [`package.json`](./package.json)
105123
- Update version in [`README.md`](./README.md#pre-commit)
106124
- Run build: `npm run build`
107-
- Add new tag eg `v1.2.0`
125+
- Add new tag eg `git tag v1.2.0`
108126
- Publish lib: `npm publish --access public`

0 commit comments

Comments
 (0)