Skip to content

Commit 39070b9

Browse files
committed
Update readme
1 parent b40759c commit 39070b9

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ build-release: generate_word_list
1414
integration_test: build
1515
cd integration_tests && bun test
1616

17+
# Build and install dev version into Zed's extension directory for testing
1718
install_ext: build-release
1819
cp -f target/release/codebook-lsp "${HOME}/Library/Application Support/Zed/extensions/work/codebook/"
1920

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ Add your language to `codebook/crates/codebook/src/queries.rs`:
196196

197197
### 4. Add the Tree-sitter Grammar
198198

199-
Make sure the appropriate Tree-sitter grammar is added as a dependency in `Cargo.toml` and update the `language()` function to return the correct language parser.
199+
Make sure the appropriate Tree-sitter grammar is added as a dependency in `Cargo.toml` and update the `language()` function in `queries.rs` to return the correct language parser.
200200

201201
### 5. Test Your Implementation
202202

@@ -205,7 +205,9 @@ Run the tests to ensure your query is valid:
205205
cargo test -p codebook queries::tests::test_all_queries_are_valid
206206
```
207207

208-
You can also test with real code files to verify that Codebook correctly identifies spelling issues in your language.
208+
Additional language tests should go in `codebook/tests`. There are many example tests to copy.
209+
210+
You can also test with real code files to verify that Codebook correctly identifies spelling issues in your language. Example files should go in `examples/` and contain at least one spelling error to pass integration tests.
209211

210212
### Tips for Writing Effective Queries
211213

@@ -227,7 +229,7 @@ If you've successfully added support for a new language, please consider contrib
227229

228230
## Running Tests
229231

230-
Run test with `make test` after cloning.
232+
Run test with `make test` after cloning. Integration tests are also available with `make integration_test`, but requires BunJS to run.
231233

232234
## Acknowledgments
233235
- Harper: https://writewithharper.com/

0 commit comments

Comments
 (0)