docs: change WASM/wasm to Wasm
That is the official capitalisation.
This commit is contained in:
parent
7bc8f76667
commit
88e0b4cea4
36 changed files with 122 additions and 122 deletions
|
|
@ -14,7 +14,7 @@ To make changes to Tree-sitter, you should have:
|
|||
2. A [Rust toolchain][rust], for compiling the Rust bindings, the highlighting library, and the CLI.
|
||||
3. Node.js and NPM, for generating parsers from `grammar.js` files.
|
||||
4. Either [Emscripten][emscripten], [Docker][docker], or [podman][podman] for
|
||||
compiling the library to WASM.
|
||||
compiling the library to Wasm.
|
||||
|
||||
### Building
|
||||
|
||||
|
|
@ -25,7 +25,7 @@ git clone https://github.com/tree-sitter/tree-sitter
|
|||
cd tree-sitter
|
||||
```
|
||||
|
||||
Optionally, build the WASM library. If you skip this step, then the `tree-sitter playground` command will require an internet
|
||||
Optionally, build the Wasm library. If you skip this step, then the `tree-sitter playground` command will require an internet
|
||||
connection. If you have Emscripten installed, this will use your `emcc` compiler. Otherwise, it will use Docker or Podman:
|
||||
|
||||
```sh
|
||||
|
|
@ -76,7 +76,7 @@ Then you can run the tests:
|
|||
cargo xtask test
|
||||
```
|
||||
|
||||
Similarly, to test the WASM binding, you need to compile these parsers to WASM:
|
||||
Similarly, to test the Wasm binding, you need to compile these parsers to Wasm:
|
||||
|
||||
```sh
|
||||
cargo xtask generate-fixtures --wasm
|
||||
|
|
@ -119,7 +119,7 @@ several packages that are published to package registries for different language
|
|||
* [`tree-sitter-cli`][cli crate] — The command-line tool
|
||||
|
||||
* JavaScript modules on [npmjs.com][npmjs]:
|
||||
* [`web-tree-sitter`][web-ts] — A WASM-based JavaScript binding to the core library
|
||||
* [`web-tree-sitter`][web-ts] — A Wasm-based JavaScript binding to the core library
|
||||
* [`tree-sitter-cli`][cli package] — The command-line tool
|
||||
|
||||
There are also several other dependent repositories that contain other published packages:
|
||||
|
|
@ -179,7 +179,7 @@ a short delay. Once you've made a change that you're happy with, you can submit
|
|||
The playground page is a little more complicated, but if you know some basic JavaScript and CSS you should be able to make
|
||||
changes. The playground code can be found in [`docs/src/assets/js/playground.js`][playground], and its corresponding css
|
||||
at [`docs/src/assets/css/playground.css`][playground css]. The editor of choice we use for the playground is [CodeMirror][codemirror],
|
||||
and the tree-sitter module is fetched from [here][js url]. This, along with the wasm module and wasm parsers, live in the
|
||||
and the tree-sitter module is fetched from [here][js url]. This, along with the Wasm module and Wasm parsers, live in the
|
||||
[.github.io repo][gh.io repo].
|
||||
|
||||
[admonish]: https://github.com/tommilligan/mdbook-admonish
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# `tree-sitter build`
|
||||
|
||||
The `build` command compiles your parser into a dynamically-loadable library,
|
||||
either as a shared object (`.so`, `.dylib`, or `.dll`) or as a WASM module.
|
||||
either as a shared object (`.so`, `.dylib`, or `.dll`) or as a Wasm module.
|
||||
|
||||
```bash
|
||||
tree-sitter build [OPTIONS] [PATH] # Aliases: b
|
||||
|
|
@ -18,11 +18,11 @@ will attempt to build the parser in the current working directory.
|
|||
|
||||
### `-w/--wasm`
|
||||
|
||||
Compile the parser as a WASM module.
|
||||
Compile the parser as a Wasm module.
|
||||
|
||||
### `-o/--output`
|
||||
|
||||
Specify where to output the shared object file (native or WASM). This flag accepts either an absolute path or a relative
|
||||
Specify where to output the shared object file (native or Wasm). This flag accepts either an absolute path or a relative
|
||||
path. If you don't supply this flag, the CLI will attempt to figure out what the language name is based on the parent
|
||||
directory name to use for the output file. If the CLI can't figure it out, it will default to `parser`, thus generating
|
||||
`parser.so` or `parser.wasm` in the current working directory.
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ The graphs are constructed with [graphviz dot][dot], and the output is written t
|
|||
|
||||
### `--wasm`
|
||||
|
||||
Compile and run the parser as a WASM module.
|
||||
Compile and run the parser as a Wasm module.
|
||||
|
||||
### `--dot`
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ tree-sitter playground [OPTIONS] # Aliases: play, pg, web-ui
|
|||
```
|
||||
|
||||
```admonish note
|
||||
For this to work, you must have already built the parser as a WASM module. This can be done with the [`build`](./build.md) subcommand
|
||||
For this to work, you must have already built the parser as a Wasm module. This can be done with the [`build`](./build.md) subcommand
|
||||
(`tree-sitter build --wasm`).
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -47,7 +47,7 @@ The graphs are constructed with [graphviz dot][dot], and the output is written t
|
|||
|
||||
### `--wasm`
|
||||
|
||||
Compile and run the parser as a WASM module.
|
||||
Compile and run the parser as a Wasm module.
|
||||
|
||||
### `--open-log`
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue