From 1ae9b0e4558fe7868f8cda2db65239cfb14836d0 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Sun, 24 Dec 2023 10:00:20 +0100
Subject: feat!: align standard captures with upstream

Problem: Sharing highlight queries with upstream tree-sitter and
Helix is difficult.

Solution: Where reasonable, use capture names in tree-sitter's standard
list or Helix's Atom-style hierarchy.

Specifically:

* tree-sitter "standard capture names"
  (https://github.com/tree-sitter/tree-sitter/blob/3f44b896852eb7daaa6df4fb778c9bb52c70c815/highlight/src/lib.rs#L20-L72):

  - `@parameter` -> `@variable.parameter`
  - `@field` -> `@variable.member`
  - `@namespace` -> `@module`
  - `@float` -> `@number.float`
  - `@symbol` -> `@string.special.symbol`
  - `@string.regex` -> `@string.regexp`
  - `@text.*` -> `@markup.*` (`strong`, `italic`, `link`, `strikethrough`; with exceptions; see below)
  - `@text.title` -> `@markup.heading`
  - `@text.literal` -> `@markup.raw`
  - `@text.reference` -> `@markup.link`
  - `@text.uri` -> `@markup.link.url` (in markup links)
  - `@string.special` -> `@markup.link.label` (non-url links)
  - `@punctuation.special` -> `@markup.list` (markdown lists only; move subitems from `@text.todo`)

* Helix captures
  (https://docs.helix-editor.com/master/themes.html#syntax-highlighting):

  - `@method` -> `@function.method`
  - `@method.call` -> `@function.method.call`
  - `@text.{todo,warning,note,danger}` -> `@comment.{error,warning,hint,info,todo}`
  - `@text.diff.{add,delete,}` -> `@diff.{plus,minus,delta}`
  - `@text.uri` -> `@string.special.url` (outside markup)
  - `@preproc` -> `@keyword.directive`
  - `@define` -> `@keyword.directive`(`.define`?)
  - `@storageclass` -> `@keyword.storage`
  - `@conditional` -> `@keyword.conditional`
  - `@debug` -> `@keyword.debug`
  - `@exception` -> `@keyword.exception`
  - `@include` -> `@keyword.import`
  - `@repeat` -> `@keyword.repeat`

* cleanup

  - remove some redundant `@conceal` (but still allow it for conceal-only patterns)
  - remove obsolete `@error` (syntax linting is out of scope for this repo)
  - sort, cleanup capture list in `CONTRIBUTING.md`
---
 tests/query/highlights/hack/as-foreach.hack |  2 +-
 tests/query/highlights/hack/generics.hack   |  6 +++---
 tests/query/highlights/hack/shapes.hack     |  2 +-
 tests/query/highlights/hack/use.hack        | 14 +++++++-------
 4 files changed, 12 insertions(+), 12 deletions(-)

(limited to 'tests/query/highlights/hack')

diff --git a/tests/query/highlights/hack/as-foreach.hack b/tests/query/highlights/hack/as-foreach.hack
index d7a66875b..611027131 100644
--- a/tests/query/highlights/hack/as-foreach.hack
+++ b/tests/query/highlights/hack/as-foreach.hack
@@ -1,5 +1,5 @@
 foreach (($array as vec[]) as $item) {}
-// ^ @repeat
+// ^ @keyword.repeat
 //                   ^ @type
 
 # Our expectation test for the code below intentionally includes an ERROR.
diff --git a/tests/query/highlights/hack/generics.hack b/tests/query/highlights/hack/generics.hack
index 66b008aa4..fc41a86a9 100644
--- a/tests/query/highlights/hack/generics.hack
+++ b/tests/query/highlights/hack/generics.hack
@@ -7,15 +7,15 @@ class Box<T> {
 
   public function __construct(T $data) {
   //                          ^ @type
-  //                             ^ @parameter
+  //                             ^ @variable.parameter
   //        ^ @keyword.function
   // ^ @type.qualifier
-  //                    ^ @method
+  //                    ^ @function.method
     $this->data = $data;
   }
 
   public function getData(): T {
-                // ^ @method
+                // ^ @function.method
   // ^ @type.qualifier
     return $this->data;
               // ^ @operator
diff --git a/tests/query/highlights/hack/shapes.hack b/tests/query/highlights/hack/shapes.hack
index bc8732433..f111689d0 100644
--- a/tests/query/highlights/hack/shapes.hack
+++ b/tests/query/highlights/hack/shapes.hack
@@ -1,7 +1,7 @@
 class C extends Superclass implements Iface {
 //      ^ @keyword          ^ @keyword
   use Trait;
-  // <- @include
+  // <- @keyword.import
   const type X = shape(
   // <- @keyword ^ @type.builtin
     "a" => int,
diff --git a/tests/query/highlights/hack/use.hack b/tests/query/highlights/hack/use.hack
index 353838a18..0b1fde364 100644
--- a/tests/query/highlights/hack/use.hack
+++ b/tests/query/highlights/hack/use.hack
@@ -8,21 +8,21 @@ use type Space\Type\T;
 //  ^ @keyword
 use namespace Space\Name\N as M;
 //  ^ @keyword
-//             ^ @namespace
+//             ^ @module
 
 use namespace Space\Name2\N2, Space\Nothing\N3 as N8, type Space\Type2\N4,;
-//                        ^ @namespace
+//                        ^ @module
 //                                                                      ^ @type
 use namespace Space\Name\N10\{A as A2, B\};
-//                        ^ @namespace
-//                                     ^ @namespace
-//                                 ^ @namespace
+//                        ^ @module
+//                                     ^ @module
+//                                 ^ @module
 use namespace Space\Name\{\C, Slash as Forward};
 
 use \What\Is\This\{function A as A2, B, const H\S\L as stdlib, function F};
 
 use type \{kind,};
 use Q\B\{kind2,};
-//    ^ @namespace
+//    ^ @module
 use type Q\B\{kind3,};
-// <- @include
+// <- @keyword.import
-- 
cgit v1.2.3-70-g09d2