@willbooster/web-tree-sitter 1.5.0 → 2.0.0

package/README.md

@@ -158,12 +158,8 @@ npm install @willbooster/tree-sitter-javascript
 ```
 
 Then you can find `tree-sitter-javascript.wasm` in the `node_modules/@willbooster/tree-sitter-javascript` directory.
-Other grammar packages on npm, such as `tree-sitter-javascript`, may ship a `.wasm` file as well.
-
-#### From GitHub
-
-You can also download the `.wasm` files from the GitHub releases of grammars that publish them with Tree-sitter's
-reusable workflow, such as the tree-sitter-javascript [releases page][gh release js].
+Take a release of the grammar package that was generated for this package's major version: the releases generated for
+`@willbooster/web-tree-sitter` 1 are rejected (see [Wasm compatibility](#wasm-compatibility)).
 
 #### Generating `.wasm` files
 
@@ -171,13 +167,16 @@ You can also generate the `.wasm` file for your desired grammar with the CLI tha
 repository][releases] from v1.0.7 on carry as `tree-sitter-cli-<platform>.tar.gz` (`linux-x64`, `linux-arm64`,
 `macos-arm64`, or `macos-x64`), which extracts to an executable `tree-sitter`; a workflow builds and attaches the
 archives after a release is published, so the newest release lacks them for a while. `tree-sitter build --wasm`
-downloads [wasi-sdk][] on first use, so no other tools need to be installed. For example, for the JavaScript grammar:
+downloads [wasi-sdk][] on first use, so no other tools need to be installed. Regenerate the parser with this CLI
+before building it, because the one a grammar package ships was generated by another CLI. For example, for the
+JavaScript grammar:
 
 ```sh
 platform=macos-arm64 # or linux-x64, linux-arm64, macos-x64
-tag=v1.0.9 # a release that lists tree-sitter-cli-$platform.tar.gz among its assets
+tag=v2.0.0 # a release from v2.0.0 on that lists tree-sitter-cli-$platform.tar.gz among its assets
 curl -fsSL "https://github.com/WillBooster/tree-sitter/releases/download/$tag/tree-sitter-cli-$platform.tar.gz" | tar -xz
 npm install tree-sitter-javascript
+(cd node_modules/tree-sitter-javascript && ../../tree-sitter generate src/grammar.json)
 ./tree-sitter build --wasm node_modules/tree-sitter-javascript
 ```
 
@@ -185,11 +184,12 @@ If everything is fine, file `tree-sitter-javascript.wasm` should be generated in
 
 ### Wasm compatibility
 
-`@willbooster/web-tree-sitter` loads parsers of ABI versions 13 to 16. Compact ABI 16 parsers require this runtime's ABI 16 support.
-
-> [!WARNING]
-> Some prebuilt `.wasm` files use an older dynamic-linking format that newer versions of `web-tree-sitter` cannot
-> load, even if their parser ABI is supported. Rebuild these files using a current tree-sitter CLI.
+`@willbooster/web-tree-sitter` loads only parsers generated by the CLI of this repository, which marks them with the
+language ABI number `0x57420001`. It rejects every other `.wasm` file: the ones built from parsers that upstream's
+Tree-sitter CLI generated, such as those upstream grammar packages and releases ship, and the ones built by the CLI
+releases of this repository before v2.0.0, such as those in the `@willbooster/tree-sitter-*` releases generated for
+`@willbooster/web-tree-sitter` 1. Upstream's `web-tree-sitter` rejects the files built here. Upgrade this package and
+the grammar `.wasm` files together.
 
 ### Running .wasm in Node.js
 
@@ -254,7 +254,6 @@ For more information on the module options you can pass in, see the [emscripten
 For changes to the bindings or DSL declarations, read [the contributor guide](https://github.com/WillBooster/tree-sitter/blob/main/lib/binding_web/CONTRIBUTING.md).
 
 [emscripten-module-options]: https://emscripten.org/docs/api_reference/module.html#affecting-execution
-[gh release js]: https://github.com/tree-sitter/tree-sitter-javascript/releases/latest
 [releases]: https://github.com/WillBooster/tree-sitter/releases
 [node bindings]: https://github.com/tree-sitter/node-tree-sitter
 [wasi-sdk]: https://github.com/WebAssembly/wasi-sdk

package/debug/web-tree-sitter.cjs

@@ -3877,6 +3877,15 @@ __name(checkModule, "checkModule");
 // src/parser.ts
 var TRANSFER_BUFFER;
 var LANGUAGE_VERSION;
+function assertSupportedLanguage(language) {
+  const version = C._ts_language_abi_version(language[0]);
+  if (version !== LANGUAGE_VERSION) {
+    throw new Error(
+      `Incompatible language version 0x${(version >>> 0).toString(16)}. Expected 0x${LANGUAGE_VERSION.toString(16)}.`
+    );
+  }
+}
+__name(assertSupportedLanguage, "assertSupportedLanguage");
 var MIN_COMPATIBLE_VERSION;
 var finalizer4 = newFinalizer((addresses) => {
   C._ts_parser_delete(addresses[0]);
@@ -3939,8 +3948,8 @@ var Parser = class {
    * If the language was not successfully assigned, an error will be thrown.
    * This happens if the language was generated with an incompatible
    * version of the Tree-sitter CLI. Check the language's version using
-   * {@link Language#version} and compare it to this library's
-   * {@link LANGUAGE_VERSION} and {@link MIN_COMPATIBLE_VERSION} constants.
+   * {@link Language#abiVersion} and compare it to this library's
+   * {@link LANGUAGE_VERSION} constant.
    */
   setLanguage(language) {
     let address;
@@ -3949,12 +3958,7 @@ var Parser = class {
       this.language = null;
     } else if (language.constructor === Language) {
       address = language[0];
-      const version = C._ts_language_abi_version(address);
-      if (version < MIN_COMPATIBLE_VERSION || LANGUAGE_VERSION < version) {
-        throw new Error(
-          `Incompatible language version ${version}. Compatibility range ${MIN_COMPATIBLE_VERSION} through ${LANGUAGE_VERSION}.`
-        );
-      }
+      assertSupportedLanguage(language);
       this.language = language;
     } else {
       throw new Error("Argument must be a Language");
@@ -4352,6 +4356,7 @@ var Query = class {
    * @link {@see https://tree-sitter.github.io/tree-sitter/using-parsers/queries}
    */
   constructor(language, source) {
+    assertSupportedLanguage(language);
     const sourceLength = C.lengthBytesUTF8(source);
     const sourceAddress = C._malloc(sourceLength + 1);
     C.stringToUTF8(source, sourceAddress, sourceLength + 1);