@dekobon/tree-sitter-groovy 0.2.0

package/LICENSE-APACHE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Elijah Zupancic
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,187 @@
+# tree-sitter-groovy
+
+[![CI](https://github.com/dekobon/tree-sitter-groovy/actions/workflows/ci.yml/badge.svg)](https://github.com/dekobon/tree-sitter-groovy/actions/workflows/ci.yml)
+[![CodeQL](https://github.com/dekobon/tree-sitter-groovy/actions/workflows/codeql.yml/badge.svg)](https://github.com/dekobon/tree-sitter-groovy/actions/workflows/codeql.yml)
+[![npm](https://img.shields.io/npm/v/@dekobon/tree-sitter-groovy)](https://www.npmjs.com/package/@dekobon/tree-sitter-groovy)
+[![crates.io](https://img.shields.io/crates/v/dekobon-tree-sitter-groovy)](https://crates.io/crates/dekobon-tree-sitter-groovy)
+[![PyPI](https://img.shields.io/pypi/v/dekobon-tree-sitter-groovy)](https://pypi.org/project/dekobon-tree-sitter-groovy/)
+
+Tree-sitter grammar for [Apache Groovy](https://groovy-lang.org/) —
+the JVM scripting language used in Jenkins pipelines, Gradle build
+files, and Spock test specifications.
+
+**Published as**: `@dekobon/tree-sitter-groovy` on npm,
+`dekobon-tree-sitter-groovy` on crates.io and PyPI,
+`github.com/dekobon/tree-sitter-groovy` as a Go module / Swift package.
+The unscoped name belongs to the upstream comparison grammar linked
+below; the C library (no naming conflict) still ships as
+`libtree-sitter-groovy`.
+
+This grammar is **purpose-built** for Groovy (it does not extend the
+`tree-sitter-java` grammar). It synthesises the best ideas from the
+two existing community grammars while closing every operator and
+statement gap they left open:
+
+- [`amaanq/tree-sitter-groovy`](https://github.com/amaanq/tree-sitter-groovy)
+  — clean precedence table and shebang handling, but mis-shapes
+  Groovy-specific syntax (Elvis `?:`, safe navigation `?.`, spread
+  operators, regex `=~` / `==~`, traits, exclusive ranges, identity
+  `===` / `!==`, spaceship `<=>`, etc.) as Java-shaped parse trees.
+- [`murtaza64/tree-sitter-groovy`](https://github.com/murtaza64/tree-sitter-groovy)
+  — purpose-built for Groovy, broad operator coverage and slashy
+  strings, but has open bugs around empty block comments, multi-catch,
+  multi-assignment, enums, switch-arrow, and a `pipeline`-at-EOF
+  constraint.
+
+The full design is in [`SPECIFICATION.md`](SPECIFICATION.md).
+
+## Status
+
+Fully functional Groovy 2.x--4.x parser with complete operator
+coverage, GString interpolation, generics, closures, command chains,
+and six language bindings. See [Known limitations](#known-limitations)
+for deferred items.
+
+## Operator coverage
+
+Every Groovy operator emits a **distinct named node** so downstream
+tooling can identify each by node kind alone — no `MISSING`-child
+inspection, no tree-shape heuristics. This is the contract that
+closes
+[`dekobon/big-code-analysis#246`](https://github.com/dekobon/big-code-analysis/issues/246)
+(Elvis short-circuit counting) and
+[`dekobon/big-code-analysis#247`](https://github.com/dekobon/big-code-analysis/issues/247)
+(all Groovy-specific operator gaps).
+
+| Category | Operators |
+|---|---|
+| Arithmetic | `+` `-` `*` `/` `%` `**` `++` `--` |
+| Relational | `<` `<=` `>` `>=` `==` `!=` `<=>` (spaceship) |
+| Identity | `===` `!==` |
+| Regex | `=~` (find) `==~` (match) |
+| Logical | `&&` `\|\|` `!` `==>` (implication) |
+| Bitwise | `&` `\|` `^` `~` `<<` `>>` `>>>` |
+| Conditional | `? :` (ternary) `?:` (Elvis) |
+| Assignment | `=` `+=` `-=` `*=` `/=` `%=` `**=` `<<=` `>>=` `>>>=` `&=` `^=` `\|=` `?=` (Elvis assign) |
+| Range | `..` `..<` `<..` `<..<` |
+| Member access | `.` `?.` `??.` (safe chain dot) `*.` (spread-dot) `.&` (method pointer) `.@` (direct field) `::` (method reference) |
+| Subscript | `[]` `?[]` (safe index) |
+| Spread | `*args` `*:` (spread-map) |
+| Membership | `in` `!in` `instanceof` `!instanceof` |
+| Coercion | `as` |
+
+## Editor support
+
+Tree-sitter queries (`queries/groovy/highlights.scm`,
+`folds.scm`, `indents.scm`, `injections.scm`) are provided for editor
+integration. Slashy and dollar-slashy string bodies inject as `regex`
+for nested regex highlighting.
+
+Recognized file extensions: `.groovy`, `.gradle`, `.gvy`, `.gy`, and
+`Jenkinsfile`.
+
+### Filetype detection
+
+The repo ships `ftdetect/groovy.lua` and `ftplugin/groovy.lua` for
+Neovim. Neovim's built-in filetype detection already maps `*.groovy`,
+`*.gradle`, and the bare filename `Jenkinsfile` to filetype `groovy`;
+the shipped `ftdetect/groovy.lua` fills the gaps by mapping:
+
+- `*.gvy` and `*.gy` — declared in `tree-sitter.json` but not in
+  Neovim's defaults.
+- `*.jenkinsfile` — uncommon (the canonical name is `Jenkinsfile`) but
+  declared in `tree-sitter.json` and used by some teams as an
+  editor-detection hook.
+- `Jenkinsfile.*` variants (`Jenkinsfile.ci`, `Jenkinsfile.release`,
+  …) — common in repos with multiple pipelines, not handled by
+  Neovim's built-in detection.
+
+The existing `ftplugin/groovy.lua` then calls `vim.treesitter.start()`.
+Highlighting only renders once the parser binary and
+`queries/groovy/highlights.scm` are registered with `nvim-treesitter`
+(or equivalent) — without that, the `start()` call is a no-op and the
+buffer falls back to non-treesitter highlighting.
+
+For files that don't match any of those (e.g. a hand-named
+`build-pipeline` with no extension), opt in with one of:
+
+- **Modeline** at the top of the file:
+  `// vim: set filetype=groovy :`
+- **Per-project autocmd** in `.nvim.lua` (sourced after `:cd` into the
+  project via Neovim's `'exrc'`). Note `vim.fn.getcwd()` is evaluated
+  when the autocmd is *defined*, so this snippet belongs in a
+  per-project config, not a global `init.lua`:
+
+  ```lua
+  vim.api.nvim_create_autocmd({ "BufRead", "BufNewFile" }, {
+    pattern = vim.fn.getcwd() .. "/jenkins/*",
+    callback = function() vim.bo.filetype = "groovy" end,
+  })
+  ```
+
+Other editors follow the same pattern: rely on built-in detection for
+the common extensions and override per-directory or via a header
+comment for the rest.
+
+## Building
+
+```bash
+npm install
+make build
+make test
+```
+
+## Bindings
+
+Available bindings: C, Go, Node.js, Python, Rust, Swift. See
+`bindings/` for binding-specific READMEs and tests.
+
+For Rust consumers:
+
+```toml
+[dependencies]
+dekobon-tree-sitter-groovy = "0.1"
+tree-sitter = "0.25"
+```
+
+```rust
+let mut parser = tree_sitter::Parser::new();
+let language = dekobon_tree_sitter_groovy::LANGUAGE;
+parser.set_language(&language.into()).expect("Error loading Groovy parser");
+let tree = parser.parse(source, None).unwrap();
+```
+
+## Known limitations
+
+These are documented in detail in
+[`docs/divergences-from-spec.md`](docs/divergences-from-spec.md).
+
+- **Groovy 5 contextual keywords** (`val`, `async`, `await`, `defer`)
+  are not yet exposed as keyword tokens. They parse as plain
+  identifiers, matching Groovy 2.x--4.x compiler behavior.
+- **Typed local declarations require an initializer** -- `String x`
+  is ambiguous with `String(x)` (method call). Use `String x = ...`
+  or `def x` instead.
+- **Leading-operator line continuation** -- `a\n+ b` greedily joins
+  as `a + b` rather than splitting into two statements. Idiomatic
+  Groovy places continuation operators at the end of the previous
+  line.
+
+## Contributing
+
+See [`CONTRIBUTING.md`](CONTRIBUTING.md) for how to build, test, and
+submit changes. [`AGENTS.md`](AGENTS.md) covers project conventions
+(commit messages, versioning, validation gates) and
+[`SPECIFICATION.md`](SPECIFICATION.md) is the authoritative grammar
+design document.
+
+## Acknowledgements
+
+We are grateful for the work done in the [murtaza64/tree-sitter-groovy](https://github.com/murtaza64/tree-sitter-groovy)
+and [amaanq/tree-sitter-groovy](https://github.com/amaanq/tree-sitter-groovy). These projects served as inspiration
+for some of the approaches in this project
+
+## License
+
+Dual-licensed under [Apache License 2.0](LICENSE-APACHE) or
+[MIT](LICENSE-MIT).

package/binding.gyp

@@ -0,0 +1,21 @@
+{
+  "targets": [
+    {
+      "target_name": "tree_sitter_groovy_binding",
+      "dependencies": [
+        "<!(node -p \"require('node-addon-api').targets\"):node_addon_api_except",
+      ],
+      "include_dirs": [
+        "src",
+      ],
+      "sources": [
+        "bindings/node/binding.cc",
+        "src/parser.c",
+        "src/scanner.c",
+      ],
+      "cflags_c": [
+        "-std=c11",
+      ],
+    }
+  ]
+}

package/bindings/node/binding.cc

@@ -0,0 +1,19 @@
+#include <napi.h>
+
+typedef struct TSLanguage TSLanguage;
+
+extern "C" const TSLanguage *tree_sitter_groovy();
+
+// "tree-sitter", "language" hashed with BLAKE2
+const napi_type_tag LANGUAGE_TYPE_TAG = {
+  0x8AF2E5212AD58ABF, 0xD5006CAD83ABBA16
+};
+
+Napi::Object Init(Napi::Env env, Napi::Object exports) {
+    auto language = Napi::External<TSLanguage>::New(env, const_cast<TSLanguage *>(tree_sitter_groovy()));
+    language.TypeTag(&LANGUAGE_TYPE_TAG);
+    exports["language"] = language;
+    return exports;
+}
+
+NODE_API_MODULE(tree_sitter_groovy_binding, Init)

package/bindings/node/binding_test.js

@@ -0,0 +1,24 @@
+/// <reference types='node' />
+
+const assert = require('node:assert');
+const {test} = require('node:test');
+
+let TreeSitter;
+try {
+  TreeSitter = require('tree-sitter');
+} catch (err) {
+  if (err.code !== 'MODULE_NOT_FOUND') throw err;
+}
+
+test('can load grammar', {skip: TreeSitter ? false : 'tree-sitter peer not installed'}, () => {
+  const parser = new TreeSitter();
+  assert.doesNotThrow(() => parser.setLanguage(require('.')));
+});
+
+test('exposes HIGHLIGHTS_QUERY', () => {
+  const binding = require('.');
+  assert.strictEqual(typeof binding.HIGHLIGHTS_QUERY, 'string');
+  assert.ok(binding.HIGHLIGHTS_QUERY.length > 0);
+  assert.strictEqual(binding.HIGHLIGHTS_QUERY, binding.HIGHLIGHTS_QUERY,
+    'second access returns the cached value');
+});

package/bindings/node/index.d.ts

@@ -0,0 +1,56 @@
+type BaseNode = {
+  type: string;
+  named: boolean;
+};
+
+type ChildNode = {
+  multiple: boolean;
+  required: boolean;
+  types: BaseNode[];
+};
+
+type NodeInfo =
+  | (BaseNode & {
+      subtypes: BaseNode[];
+    })
+  | (BaseNode & {
+      fields: { [name: string]: ChildNode };
+      children: ChildNode[];
+    });
+
+/**
+ * The tree-sitter binding for this grammar.
+ *
+ * @see {@linkcode https://tree-sitter.github.io/node-tree-sitter/interfaces/Language.html Parser.Language}
+ *
+ * @example
+ * const Parser = require("tree-sitter");
+ * const Groovy = require("@dekobon/tree-sitter-groovy");
+ *
+ * const parser = new Parser();
+ * parser.setLanguage(Groovy);
+ */
+declare const binding: {
+  /**
+   * The inner language object.
+   * @private
+   */
+  language: unknown;
+
+  /**
+   * The content of the `node-types.json` file for this grammar.
+   * Loaded eagerly on require; `undefined` if the file is missing.
+   *
+   * @see {@linkplain https://tree-sitter.github.io/tree-sitter/using-parsers/6-static-node-types Static Node Types}
+   */
+  nodeTypeInfo?: NodeInfo[];
+
+  /**
+   * The syntax highlighting query for this grammar
+   * (`queries/groovy/highlights.scm`). Loaded lazily on first access;
+   * `undefined` if the file is missing.
+   */
+  HIGHLIGHTS_QUERY?: string;
+};
+
+export = binding;

package/bindings/node/index.js

@@ -0,0 +1,27 @@
+const path = require('path');
+const root = path.join(__dirname, '..', '..');
+
+module.exports = require('node-gyp-build')(root);
+
+try {
+  module.exports.nodeTypeInfo = require('../../src/node-types.json');
+} catch {
+  // ignore if file is missing
+}
+
+Object.defineProperty(module.exports, 'HIGHLIGHTS_QUERY', {
+  configurable: true,
+  enumerable: true,
+  get() {
+    delete module.exports.HIGHLIGHTS_QUERY;
+    try {
+      module.exports.HIGHLIGHTS_QUERY = require('fs').readFileSync(
+        path.join(root, 'queries', 'groovy', 'highlights.scm'),
+        'utf8',
+      );
+    } catch {
+      // ignore if file is missing
+    }
+    return module.exports.HIGHLIGHTS_QUERY;
+  },
+});