Skip to content

Commit

Permalink
clarify cli generation gives at least not better inference (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jakobeha committed Apr 1, 2024
1 parent fa7929b commit 1875a91
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ pub fn process_declaration(decl: rust::DeclarationStatement<'_>) {

## Usage

In order to generate the bindings, you can either invoke `type-sitter-cli` directly, or use the procedural macros in `type-sitter-proc`. The CLI tool is recommended, as it's more flexible and will give your IDE better inference.
In order to generate the bindings, you can either invoke `type-sitter-cli` directly, or use the procedural macros in `type-sitter-proc`. The CLI tool is recommended, as it's more tested and will give your IDE at least as good inference.

The generated code depends on `type-sitter-lib`, so you must include `type-sitter-lib` as a dependency.

Expand Down
2 changes: 1 addition & 1 deletion type-sitter-proc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![Crates.io](https://img.shields.io/crates/v/type-sitter-proc.svg)](https://crates.io/crates/type-sitter-proc)

See [type-sitter](https://github.com/Jakobeha/type-sitter#readme) for more information. This provides procedural macros which will generate typed node wrappers. However, it's highly recommended to use [type-sitter-cli](https://crates.io/crates/type-sitter-cli) instead, as it's more tested and will give your IDE better inference.
See [type-sitter](https://github.com/Jakobeha/type-sitter#readme) for more information. This provides procedural macros which will generate typed node wrappers. However, it's highly recommended to use [type-sitter-cli](https://crates.io/crates/type-sitter-cli) instead, as it's more tested and will give your IDE at least as good inference.

If a project depends on this (and as with [type-sitter-cli](https://crates.io/crates/type-sitter-cli)), it *must also* depend on [type-sitter-lib](https://crates.io/crates/type-sitter-lib) and [tree-sitter](https://crates.io/crates/tree-sitter).

Expand Down

0 comments on commit 1875a91

Please sign in to comment.