@willbooster/tree-sitter-cpp 1.2.1 → 1.2.3

package/README.md

@@ -5,14 +5,15 @@
 [![Test](https://github.com/WillBooster/tree-sitter-cpp/actions/workflows/test.yml/badge.svg)](https://github.com/WillBooster/tree-sitter-cpp/actions/workflows/test.yml)
 [![Test rust](https://github.com/WillBooster/tree-sitter-cpp/actions/workflows/test-rust.yml/badge.svg)](https://github.com/WillBooster/tree-sitter-cpp/actions/workflows/test-rust.yml)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
-[![wbfy](https://img.shields.io/badge/wbfy-20.26.0-1e90ff.svg)](https://github.com/WillBooster/shared/tree/main/packages/wbfy)
+[![wbfy](https://img.shields.io/badge/wbfy-20.28.8-1e90ff.svg)](https://github.com/WillBooster/shared/tree/main/packages/wbfy)
 [![crates.io](https://img.shields.io/crates/v/willbooster-tree-sitter-cpp.svg)](https://crates.io/crates/willbooster-tree-sitter-cpp)
 
 C++ grammar for [tree-sitter](https://github.com/tree-sitter/tree-sitter), forked from
 [tree-sitter/tree-sitter-cpp](https://github.com/tree-sitter/tree-sitter-cpp). We are grateful
 to its authors and contributors. This is not an official release of that project.
 
-This fork fixes parsing bugs and raises conformance with the ISO C++ standard ([working draft](https://eel.is/c++draft/)).
+This fork fixes parsing bugs and raises conformance with the ISO C++ standard
+([working draft](https://eel.is/c++draft/)).
 
 ## Usage
 
@@ -61,7 +62,8 @@ const parser = new Parser();
 parser.setLanguage(await Language.load(cpp));
 ```
 
-The package also ships the node types in `src/node-types.json`.
+The package also ships the node types in `src/node-types.json`, and the queries that `tree-sitter.json` lists: this
+grammar's in `queries/` and, in `queries/c/`, the highlights of the C grammar it extends.
 
 In Rust, depend on the [crate](https://crates.io/crates/willbooster-tree-sitter-cpp) and on
 [willbooster-tree-sitter](https://crates.io/crates/willbooster-tree-sitter), the runtime this package is tested and
@@ -79,6 +81,8 @@ let mut parser = tree_sitter::Parser::new();
 parser.set_language(&tree_sitter_cpp::LANGUAGE.into())?;
 ```
 
+The crate ships the same `tree-sitter.json` and query files as the npm package.
+
 ## Development
 
 ```sh
@@ -90,24 +94,39 @@ script/parse-examples
 cargo test --locked
 ```
 
+The scripts and tests generate, build, test, and parse with `script/tree-sitter`, the tree-sitter CLI of the
+WillBooster/tree-sitter runtime version locked in `Cargo.lock`, since the generator and the runtime of upstream's CLI are
+not the ones this package ships with. Its first run downloads that CLI from the runtime's GitHub Release, or builds it
+with `cargo` (whose build runs the CMake that `mise.toml` pins) when the download fails or the release has no binary
+that runs here. Run other CLI commands through it as well (e.g. `script/tree-sitter parse file.cpp`).
+
 `bun run test` runs:
 
 - the corpus in `test/corpus`, with the native build and with the Wasm build (the first run downloads the WASI SDK);
-- an incremental-parsing check (`test/unit/incremental.test.ts`): `tree-sitter fuzz` edits each corpus case at random,
-  reparses it, undoes the edits, and reparses again. `TREE_SITTER_SEED`, `TREE_SITTER_ITERATIONS`, and
+- an incremental-parsing check (`test/unit/incremental.test.ts`): `script/fuzz-corpus` runs `tree-sitter fuzz`, which
+  edits each corpus case at random, reparses it, undoes the edits, and reparses again. `TREE_SITTER_SEED`, `TREE_SITTER_ITERATIONS`, and
   `TREE_SITTER_EDITS` run other or more edits;
 - a check that the real-world C++ files in `examples/`, the checked-in ones and those of the cloned repositories,
-  fail to parse exactly as listed in `script/known-failures.txt`. The first run clones the repositories. The example repositories are pinned to commits in
-  `script/parse-examples`. After a grammar change or a moved pin alters that list, `script/parse-examples` rewrites
-  it; review its diff before committing;
-- a performance check (`test/unit/performance.test.ts`) that recovering from an error on each of 10,000 lines takes
-  linear time, since consumers parse files while they are being edited. It loads the Wasm build through
+  fail to parse exactly as listed in `script/known-failures.txt`. The first run clones the repositories. The example
+  repositories are pinned to commits in `script/parse-examples`. After a grammar change or a moved pin alters that
+  list, `script/parse-examples` rewrites it; review its diff before committing;
+- a performance check (`test/unit/performance.test.ts`) that recovering from an error on each line takes linear
+  time, since consumers parse files while they are being edited. It loads the Wasm build through
   @willbooster/web-tree-sitter, which `bun run build/ci` rebuilds after regenerating the parser;
+- a check (`test/unit/expressionKeywordParameter.test.ts`) that every keyword that can start an expression but not a
+  parameter is expected in the parameters of the function declarators that compete with a direct initialization, so
+  that `long(n)(sizeof(b));` stays an initialization;
+- a check (`test/unit/queries.test.ts`) that the queries `tree-sitter.json` lists compile against the grammar, are
+  published in the npm package and the crate, and that `queries/c/` matches the queries of the installed
+  @willbooster/tree-sitter-c; after updating that dependency, `script/copy-c-queries` refreshes the copy;
+- a check (`test/unit/runtimeVersion.test.ts`) that `@willbooster/web-tree-sitter` in `package.json` and
+  `willbooster-tree-sitter` in `Cargo.lock` are the same version, since the Wasm tests run on the former and the Rust
+  tests, the fuzzer, and the CLI on the latter;
 - checks that the Wasm build parses in Chromium (`test/unit/browser/`) and in Cloudflare Workers with and without
   Node.js compatibility (`test/unit/workers.test.ts`). Run `bun run test/ci-setup` once to install Chromium.
 
-CI also runs these tests on Linux arm64 and macOS, where the parser and scanner are compiled natively against each platform's C library, and fuzzes the parser with libFuzzer and sanitizers
-(`.github/workflows/robustness.yml`).
+CI also runs these tests on Linux arm64 and macOS, where the parser and scanner are compiled natively against each
+platform's C library, and fuzzes the parser with libFuzzer and sanitizers (`.github/workflows/robustness.yml`).
 
 ### References
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@willbooster/tree-sitter-cpp",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "description": "C++ grammar for tree-sitter",
   "keywords": [
     "incremental",
@@ -15,13 +15,14 @@
   "license": "MIT",
   "author": "WillBooster Inc.",
   "files": [
+    "queries/**/*.scm",
     "tree-sitter.json",
     "src/node-types.json",
     "*.wasm"
   ],
   "scripts": {
-    "build-wasm": "tree-sitter build --wasm",
-    "build/ci": "tree-sitter generate && tree-sitter build --wasm",
+    "build-wasm": "script/tree-sitter build --wasm",
+    "build/ci": "script/tree-sitter generate && script/tree-sitter build --wasm",
     "cleanup": "bun wb lint --fix --format",
     "format": "bun wb lint --format",
     "lint": "bun wb lint",
@@ -29,7 +30,7 @@
     "prepare": "(bun lefthook install || true) && (test ! -f .lefthook/normalize-bun-lockfile.sh || bash .lefthook/normalize-bun-lockfile.sh)",
     "release": "wb release",
     "prestart": "bun run build-wasm",
-    "start": "tree-sitter playground",
+    "start": "script/tree-sitter playground",
     "test": "bun wb test",
     "test/ci": "bun wb test-on-ci",
     "test/ci-setup": "bun playwright install --with-deps chromium",
@@ -43,14 +44,14 @@
     "@vitest/browser-playwright": "5.0.1",
     "@willbooster/oxfmt-config": "1.2.2",
     "@willbooster/oxlint-config": "1.4.8",
-    "@willbooster/tree-sitter-c": "1.1.3",
-    "@willbooster/wb": "22.13.1",
-    "@willbooster/web-tree-sitter": "1.0.7",
+    "@willbooster/tree-sitter-c": "1.1.6",
+    "@willbooster/wb": "22.13.2",
+    "@willbooster/web-tree-sitter": "1.0.17",
     "conventional-changelog-conventionalcommits": "10.4.0",
     "lefthook": "2.1.14",
     "oxfmt": "0.70.0",
     "oxlint": "1.85.0",
-    "oxlint-tsgolint": "7.0.2002",
+    "oxlint-tsgolint": "7.0.2003",
     "playwright": "1.63.0",
     "semantic-release": "25.0.9",
     "sort-package-json": "4.0.0",

package/queries/c/highlights.scm

@@ -0,0 +1,81 @@
+(identifier) @variable
+
+((identifier) @constant
+ (#match? @constant "^[A-Z][A-Z\\d_]*$"))
+
+"break" @keyword
+"case" @keyword
+"const" @keyword
+"continue" @keyword
+"default" @keyword
+"do" @keyword
+"else" @keyword
+"enum" @keyword
+"extern" @keyword
+"for" @keyword
+"if" @keyword
+"inline" @keyword
+"return" @keyword
+"sizeof" @keyword
+"static" @keyword
+"struct" @keyword
+"switch" @keyword
+"typedef" @keyword
+"union" @keyword
+"volatile" @keyword
+"while" @keyword
+
+"#define" @keyword
+"#elif" @keyword
+"#else" @keyword
+"#endif" @keyword
+"#if" @keyword
+"#ifdef" @keyword
+"#ifndef" @keyword
+"#include" @keyword
+(preproc_directive) @keyword
+
+"--" @operator
+"-" @operator
+"-=" @operator
+"->" @operator
+"=" @operator
+"!=" @operator
+"*" @operator
+"&" @operator
+"&&" @operator
+"+" @operator
+"++" @operator
+"+=" @operator
+"<" @operator
+"==" @operator
+">" @operator
+"||" @operator
+
+"." @delimiter
+";" @delimiter
+
+(string_literal) @string
+(system_lib_string) @string
+
+(null) @constant
+(number_literal) @number
+(char_literal) @number
+
+(field_identifier) @property
+(statement_identifier) @label
+(type_identifier) @type
+(primitive_type) @type
+(sized_type_specifier) @type
+
+(call_expression
+  function: (identifier) @function)
+(call_expression
+  function: (field_expression
+    field: (field_identifier) @function))
+(function_declarator
+  declarator: (identifier) @function)
+(preproc_function_def
+  name: (identifier) @function.special)
+
+(comment) @comment

package/queries/highlights.scm

@@ -0,0 +1,89 @@
+; inherits: c
+
+; Functions
+
+(call_expression
+  function: (qualified_identifier
+    name: (identifier) @function))
+
+(template_function
+  name: (identifier) @function)
+
+(template_method
+  name: (field_identifier) @function)
+
+(template_function
+  name: (identifier) @function)
+
+(function_declarator
+  declarator: (qualified_identifier
+    name: (identifier) @function))
+
+(function_declarator
+  declarator: (field_identifier) @function)
+
+; Types
+
+((namespace_identifier) @type
+ (#match? @type "^[A-Z]"))
+
+(auto) @type
+
+; Constants
+
+(this) @variable.builtin
+(null "nullptr" @constant)
+
+; Modules
+(module_name
+  (identifier) @module)
+
+; Keywords
+
+[
+ "catch"
+ "class"
+ "co_await"
+ "co_return"
+ "co_yield"
+ "constexpr"
+ "constinit"
+ "consteval"
+ "delete"
+ "explicit"
+ "final"
+ "friend"
+ "mutable"
+ "namespace"
+ "noexcept"
+ "new"
+ "override"
+ "private"
+ "protected"
+ "public"
+ "template"
+ "throw"
+ "try"
+ "typename"
+ "using"
+ "concept"
+ "requires"
+ "virtual"
+ "import"
+ "export"
+ "module"
+] @keyword
+
+; Strings
+
+(raw_string_literal) @string
+
+; Keywords with the shape of a call
+
+((template_function
+  name: (identifier) @keyword)
+ (#any-of? @keyword "static_cast" "dynamic_cast" "const_cast" "reinterpret_cast"))
+
+((call_expression
+  function: (identifier) @keyword)
+ (#any-of? @keyword "typeid" "noexcept"))

package/queries/injections.scm

@@ -0,0 +1,3 @@
+(raw_string_literal
+  delimiter: (raw_string_delimiter) @injection.language
+  (raw_string_content) @injection.content)

package/queries/tags.scm

@@ -0,0 +1,15 @@
+(struct_specifier name: (type_identifier) @name body:(_)) @definition.class
+
+(declaration type: (union_specifier name: (type_identifier) @name)) @definition.class
+
+(function_declarator declarator: (identifier) @name) @definition.function
+
+(function_declarator declarator: (field_identifier) @name) @definition.function
+
+(function_declarator declarator: (qualified_identifier scope: (namespace_identifier) @local.scope name: (identifier) @name)) @definition.method
+
+(type_definition declarator: (type_identifier) @name) @definition.type
+
+(enum_specifier name: (type_identifier) @name) @definition.type
+
+(class_specifier name: (type_identifier) @name) @definition.class

package/src/node-types.json

@@ -795,6 +795,10 @@
         {
           "type": "preproc_defined",
           "named": true
+        },
+        {
+          "type": "type_descriptor",
+          "named": true
         }
       ]
     }

package/tree-sitter.json

@@ -15,7 +15,7 @@
         "h"
       ],
       "highlights": [
-        "node_modules/@willbooster/tree-sitter-c/queries/highlights.scm",
+        "queries/c/highlights.scm",
         "queries/highlights.scm"
       ],
       "injections": "queries/injections.scm",
@@ -24,7 +24,7 @@
     }
   ],
   "metadata": {
-    "version": "1.2.1",
+    "version": "1.2.3",
     "license": "MIT",
     "description": "C++ grammar for tree-sitter",
     "authors": [