From 1ae9b0e4558fe7868f8cda2db65239cfb14836d0 Mon Sep 17 00:00:00 2001 From: Christian Clason 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/python/fields.py | 6 +++--- tests/query/highlights/python/future_import.py | 4 ++-- tests/query/highlights/python/pattern_matching.py | 22 +++++++++++----------- tests/query/highlights/python/raise_from.py | 4 ++-- tests/query/highlights/python/yield_from.py | 4 ++-- 5 files changed, 20 insertions(+), 20 deletions(-) (limited to 'tests/query/highlights/python') diff --git a/tests/query/highlights/python/fields.py b/tests/query/highlights/python/fields.py index fb36a6311..deb280622 100644 --- a/tests/query/highlights/python/fields.py +++ b/tests/query/highlights/python/fields.py @@ -3,10 +3,10 @@ class Fields: # ^^^ @type.builtin # ^^^^ @constant.builtin self.fields = fields -# ^^^^^^ @field +# ^^^^^^ @variable.member self.__dunderfield__ = None -# ^^^^^^^^^^^^^^^ @field +# ^^^^^^^^^^^^^^^ @variable.member self._FunKyFielD = 0 -# ^^^^^^^^^^^ @field +# ^^^^^^^^^^^ @variable.member self.NOT_A_FIELD = "IM NOT A FIELD" # ^^^^^^^^^^^ @constant diff --git a/tests/query/highlights/python/future_import.py b/tests/query/highlights/python/future_import.py index 7495588a9..6790b9b6b 100644 --- a/tests/query/highlights/python/future_import.py +++ b/tests/query/highlights/python/future_import.py @@ -1,4 +1,4 @@ from __future__ import print_function -# ^ @include +# ^ @keyword.import # ^ @constant.builtin -# ^ @include +# ^ @keyword.import diff --git a/tests/query/highlights/python/pattern_matching.py b/tests/query/highlights/python/pattern_matching.py index cd359a48f..2762781b0 100644 --- a/tests/query/highlights/python/pattern_matching.py +++ b/tests/query/highlights/python/pattern_matching.py @@ -1,29 +1,29 @@ match command.split(): -# ^ @conditional +# ^ @keyword.conditional case ["quit"]: - # ^ @conditional + # ^ @keyword.conditional print("Goodbye!") quit_game() case ["look"]: - # ^ @conditional + # ^ @keyword.conditional current_room.describe() case ["get", obj]: - # ^ @conditional + # ^ @keyword.conditional character.get(obj, current_room) case ["go", direction]: - # ^ @conditional + # ^ @keyword.conditional current_room = current_room.neighbor(direction) # The rest of your commands go here match command.split(): -# ^ @conditional +# ^ @keyword.conditional case ["drop", *objects]: - # ^ @conditional + # ^ @keyword.conditional for obj in objects: character.drop(obj, current_room) match command.split(): -# ^ @conditional +# ^ @keyword.conditional case ["quit"]: ... # Code omitted for brevity case ["go", direction]: pass case ["drop", *objects]: pass @@ -32,12 +32,12 @@ match command.split(): # ^^ @@function.macro match command.split(): -# ^ @conditional +# ^ @keyword.conditional case ["north"] | ["go", "north"]: - # ^ @conditional + # ^ @keyword.conditional current_room = current_room.neighbor("north") case ["get", obj] | ["pick", "up", obj] | ["pick", obj, "up"]: - # ^ @conditional + # ^ @keyword.conditional pass match = 2 diff --git a/tests/query/highlights/python/raise_from.py b/tests/query/highlights/python/raise_from.py index 8a48a222b..fb30f4252 100644 --- a/tests/query/highlights/python/raise_from.py +++ b/tests/query/highlights/python/raise_from.py @@ -2,5 +2,5 @@ try: print(1 / 0) except Exception: raise RuntimeError from None - # ^ @exception - # ^ @exception + # ^ @keyword.exception + # ^ @keyword.exception diff --git a/tests/query/highlights/python/yield_from.py b/tests/query/highlights/python/yield_from.py index 2f3238379..6ada002c6 100644 --- a/tests/query/highlights/python/yield_from.py +++ b/tests/query/highlights/python/yield_from.py @@ -1,6 +1,6 @@ from foo import bar -# ^ @include -# ^ @include +# ^ @keyword.import +# ^ @keyword.import def generator(): yield from bar(42) # ^ @keyword.return -- cgit v1.2.3-70-g09d2