helix-editor · poliorcetics · Dec 17, 2022 · Dec 17, 2022
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -101,10 +101,12 @@ jobs:
       - name: Generate docs
         run: cargo xtask docgen
 
+      - name: All highlight queries keys are statically known
+        run: cargo xtask theme-keys-check
+
       - name: Check uncommitted documentation changes
         run: |
           git diff
           git diff-files --quiet \
             || (echo "Run 'cargo xtask docgen', commit the changes and push again" \
             && exit 1)
-
diff --git a/book/src/generated/theme-table.md b/book/src/generated/theme-table.md
diff --git a/book/src/themes.md b/book/src/themes.md
@@ -150,173 +150,10 @@ We use a similar set of scopes as
 [Sublime Text](https://www.sublimetext.com/docs/scope_naming.html). See also
 [TextMate](https://macromates.com/manual/en/language_grammars) scopes.
 
-- `attribute` - Class attributes, HTML tag attributes
-
-- `type` - Types
-  - `builtin` - Primitive types provided by the language (`int`, `usize`)
-  - `enum`
-    - `variant`
-- `constructor`
-
-- `constant` (TODO: constant.other.placeholder for `%v`)
-  - `builtin` Special constants provided by the language (`true`, `false`, `nil` etc)
-    - `boolean`
-  - `character`
-    - `escape`
-  - `numeric` (numbers)
-    - `integer`
-    - `float`
-
-- `string` (TODO: string.quoted.{single, double}, string.raw/.unquoted)?
-  - `regexp` - Regular expressions
-  - `special`
-    - `path`
-    - `url`
-    - `symbol` - Erlang/Elixir atoms, Ruby symbols, Clojure keywords
-
-- `comment` - Code comments
-  - `line` - Single line comments (`//`)
-  - `block` - Block comments (e.g. (`/* */`)
-    - `documentation` - Documentation comments (e.g. `///` in Rust)
-
-- `variable` - Variables
-  - `builtin` - Reserved language variables (`self`, `this`, `super`, etc.)
-  - `parameter` - Function parameters
-  - `other`
-    - `member` - Fields of composite data types (e.g. structs, unions)
-
-- `label`
-
-- `punctuation`
-  - `delimiter` - Commas, colons
-  - `bracket` - Parentheses, angle brackets, etc.
-  - `special` - String interpolation brackets.
-
-- `keyword`
-  - `control`
-    - `conditional` - `if`, `else`
-    - `repeat` - `for`, `while`, `loop`
-    - `import` - `import`, `export`
-    - `return`
-    - `exception`
-  - `operator` - `or`, `in`
-  - `directive` - Preprocessor directives (`#if` in C)
-  - `function` - `fn`, `func`
-  - `storage` - Keywords describing how things are stored
-    - `type` - The type of something, `class`, `function`, `var`, `let`, etc.
-    - `modifier` - Storage modifiers like `static`, `mut`, `const`, `ref`, etc.
-
-- `operator` - `||`, `+=`, `>`
-
-- `function`
-  - `builtin`
-  - `method`
-  - `macro`
-  - `special` (preprocessor in C)
-
-- `tag` - Tags (e.g. `<body>` in HTML)
-  - `builtin`
-
-- `namespace`
-
-- `special`
-
-- `markup`
-  - `heading`
-    - `marker`
-    - `1`, `2`, `3`, `4`, `5`, `6` - heading text for h1 through h6
-  - `list`
-    - `unnumbered`
-    - `numbered`
-  - `bold`
-  - `italic`
-  - `link`
-    - `url` - URLs pointed to by links
-    - `label` - non-URL link references
-    - `text` - URL and image descriptions in links
-  - `quote`
-  - `raw`
-    - `inline`
-    - `block`
-
-- `diff` - version control changes
-  - `plus` - additions
-  - `minus` - deletions
-  - `delta` - modifications
-    - `moved` - renamed or moved files/changes
-
-#### Interface
-
-These scopes are used for theming the editor interface:
-
-- `markup`
-  - `normal`
-    - `completion` - for completion doc popup UI
-    - `hover` - for hover popup UI
-  - `heading`
-    - `completion` - for completion doc popup UI
-    - `hover` - for hover popup UI
-  - `raw`
-    - `inline`
-      - `completion` - for completion doc popup UI
-      - `hover` - for hover popup UI
-
-
-| Key                               | Notes                                                                                          |
-| ---                               | ---                                                                                            |
-| `ui.background`                   |                                                                                                |
-| `ui.background.separator`         | Picker separator below input line                                                              |
-| `ui.cursor`                       |                                                                                                |
-| `ui.cursor.normal`                |                                                                                                |
-| `ui.cursor.insert`                |                                                                                                |
-| `ui.cursor.select`                |                                                                                                |
-| `ui.cursor.match`                 | Matching bracket etc.                                                                          |
-| `ui.cursor.primary`               | Cursor with primary selection                                                                  |
-| `ui.cursor.primary.normal`        |                                                                                                |
-| `ui.cursor.primary.insert`        |                                                                                                |
-| `ui.cursor.primary.select`        |                                                                                                |
-| `ui.gutter`                       | Gutter                                                                                         |
-| `ui.gutter.selected`              | Gutter for the line the cursor is on                                                           |
-| `ui.linenr`                       | Line numbers                                                                                   |
-| `ui.linenr.selected`              | Line number for the line the cursor is on                                                      |
-| `ui.statusline`                   | Statusline                                                                                     |
-| `ui.statusline.inactive`          | Statusline (unfocused document)                                                                |
-| `ui.statusline.normal`            | Statusline mode during normal mode ([only if `editor.color-modes` is enabled][editor-section]) |
-| `ui.statusline.insert`            | Statusline mode during insert mode ([only if `editor.color-modes` is enabled][editor-section]) |
-| `ui.statusline.select`            | Statusline mode during select mode ([only if `editor.color-modes` is enabled][editor-section]) |
-| `ui.statusline.separator`         | Separator character in statusline                                                              |
-| `ui.popup`                        | Documentation popups (e.g. Space + k)                                                          |
-| `ui.popup.info`                   | Prompt for multiple key options                                                                |
-| `ui.window`                       | Borderlines separating splits                                                                  |
-| `ui.help`                         | Description box for commands                                                                   |
-| `ui.text`                         | Command prompts, popup text, etc.                                                              |
-| `ui.text.focus`                   |                                                                                                |
-| `ui.text.inactive`                | Same as `ui.text` but when the text is inactive (e.g. suggestions)                             |
-| `ui.text.info`                    | The key: command text in `ui.popup.info` boxes                                                 |
-| `ui.virtual.ruler`                | Ruler columns (see the [`editor.rulers` config][editor-section])                               |
-| `ui.virtual.whitespace`           | Visible whitespace characters                                                                  |
-| `ui.virtual.indent-guide`         | Vertical indent width guides                                                                   |
+**Note**: not all language keys are applicable to all languages, you can have a look at the `runtime/queries/*/highlights.scm` files to see what is defined or not for your language of choice.
+
 | `ui.virtual.inlay-hint`           | Default style for inlay hints of all kinds                                                     |
 | `ui.virtual.inlay-hint.parameter` | Style for inlay hints of kind `parameter` (LSPs are not required to set a kind)                |
 | `ui.virtual.inlay-hint.type`      | Style for inlay hints of kind `type` (LSPs are not required to set a kind)                     |
-| `ui.virtual.wrap`                 | Soft-wrap indicator (see the [`editor.soft-wrap` config][editor-section])                      |
-| `ui.menu`                         | Code and command completion menus                                                              |
-| `ui.menu.selected`                | Selected autocomplete item                                                                     |
-| `ui.menu.scroll`                  | `fg` sets thumb color, `bg` sets track color of scrollbar                                      |
-| `ui.selection`                    | For selections in the editing area                                                             |
-| `ui.selection.primary`            |                                                                                                |
-| `ui.cursorline.primary`           | The line of the primary cursor ([if cursorline is enabled][editor-section])                    |
-| `ui.cursorline.secondary`         | The lines of any other cursors ([if cursorline is enabled][editor-section])                    |
-| `ui.cursorcolumn.primary`         | The column of the primary cursor ([if cursorcolumn is enabled][editor-section])                |
-| `ui.cursorcolumn.secondary`       | The columns of any other cursors ([if cursorcolumn is enabled][editor-section])                |
-| `warning`                         | Diagnostics warning (gutter)                                                                   |
-| `error`                           | Diagnostics error (gutter)                                                                     |
-| `info`                            | Diagnostics info (gutter)                                                                      |
-| `hint`                            | Diagnostics hint (gutter)                                                                      |
-| `diagnostic`                      | Diagnostics fallback style (editing area)                                                      |
-| `diagnostic.hint`                 | Diagnostics hint (editing area)                                                                |
-| `diagnostic.info`                 | Diagnostics info (editing area)                                                                |
-| `diagnostic.warning`              | Diagnostics warning (editing area)                                                             |
-| `diagnostic.error`                | Diagnostics error (editing area)                                                               |
-
-[editor-section]: ./configuration.md#editor-section
+
+{{#include generated/theme-table.md}}
diff --git a/runtime/queries/bass/highlights.scm b/runtime/queries/bass/highlights.scm
@@ -58,8 +58,8 @@
 (list . (symbol) @function.macro (#match? @function.macro "^(op|fn|current-scope|quote|let|provide|module|or|and|->|curryfn|for|\\$|linux)$"))
 (cons . (symbol) @function.macro (#match? @function.macro "^(op|fn|current-scope|quote|let|provide|module|or|and|->|curryfn|for|\\$|linux)$"))
 
-(list . (symbol) @keyword.builtin (#match? @keyword.builtin "^(do|doc)$"))
-(cons . (symbol) @keyword.builtin (#match? @keyword.builtin "^(do|doc)$"))
+(list . (symbol) @keyword (#match? @keyword "^(do|doc)$"))
+(cons . (symbol) @keyword (#match? @keyword "^(do|doc)$"))
 
 (list . (symbol) @keyword.control.import (#match? @keyword.control.import "^(use|import|load)$"))
 (cons . (symbol) @keyword.control.import (#match? @keyword.control.import "^(use|import|load)$"))

diff --git a/runtime/queries/c-sharp/highlights.scm b/runtime/queries/c-sharp/highlights.scm
@@ -321,7 +321,7 @@
 
 (parameter_list
   (parameter
-    name: (identifier) @parameter))
+    name: (identifier) @variable.parameter))
 
 (parameter_list
   (parameter

diff --git a/runtime/queries/cairo/highlights.scm b/runtime/queries/cairo/highlights.scm
@@ -25,7 +25,7 @@
 
 (comment) @comment
 
-"*" @special
+"*" @punctuation.special
 (type) @type
 
 [

diff --git a/runtime/queries/dhall/highlights.scm b/runtime/queries/dhall/highlights.scm
@@ -13,7 +13,7 @@
 
 ;; Imports
 (local_import) @string.special.path
-(http_import) @string.special.url
+(http_import) @string.special.uri.url
 (env_import) @keyword
 (env_variable) @string.special
 (import_hash) @string.special

diff --git a/runtime/queries/gdscript/highlights.scm b/runtime/queries/gdscript/highlights.scm
@@ -90,7 +90,7 @@
 
 [
   "func"
-] @keyword.control.function
+] @keyword.function
 
 [
   "export"

diff --git a/runtime/queries/graphql/highlights.scm b/runtime/queries/graphql/highlights.scm
@@ -100,11 +100,11 @@
 
 (string_value) @string
 
-(int_value) @constants.numeric.integer
+(int_value) @constant.numeric.integer
 
-(float_value) @constants.numeric.float
+(float_value) @constant.numeric.float
 
-(boolean_value) @constants.builtin.boolean
+(boolean_value) @constant.builtin.boolean
 
 ; Literals
 ;---------

diff --git a/runtime/queries/hare/highlights.scm b/runtime/queries/hare/highlights.scm
@@ -125,7 +125,7 @@
   ";"
 ] @punctuation.delimiter
 
-"..." @special 
+"..." @punctuation.special 
 
 (comment) @comment
 

diff --git a/runtime/queries/kotlin/highlights.scm b/runtime/queries/kotlin/highlights.scm
@@ -6,7 +6,7 @@
 (multi_line_string_literal
 	"${" @punctuation
 	(interpolated_expression) @none
-	"}" @punctuation.)
+	"}" @punctuation)
 
 ; NOTE: `interpolated_identifier`s can be highlighted in any way
 (line_string_literal

diff --git a/runtime/queries/latex/highlights.scm b/runtime/queries/latex/highlights.scm
@@ -231,7 +231,7 @@
   path: (curly_group_path) @string)
 (biblatex_include
   "\\addbibresource" @include
-  glob: (curly_group_glob_pattern) @string.regex)
+  glob: (curly_group_glob_pattern) @string.regexp)
 
 (graphics_include
   command: _ @keyword.control.import

diff --git a/runtime/queries/lean/highlights.scm b/runtime/queries/lean/highlights.scm
@@ -175,7 +175,7 @@
   "catch"
   "finally"
   "try"
-] @exception
+] @keyword.control.exception
 
 ((apply
   name: (identifier) @exception)
@@ -186,13 +186,13 @@
   "mut"
 ] @keyword
 
-[(true) (false)] @boolean
+[(true) (false)] @constant.builtin.boolean
 
 (number) @constant.numeric.integer
 (float) @constant.numeric.float
 
 (comment) @comment
-(char) @character
+(char) @constant.character
 (string) @string
 (interpolated_string) @string
 ; (escape_sequence) @string.escape

diff --git a/runtime/queries/matlab/highlights.scm b/runtime/queries/matlab/highlights.scm
@@ -29,7 +29,7 @@ function_name: (identifier) @function
 
 (function_definition end: (end) @keyword)
 
-["return" "break" "continue"] @keyword.return
+["return" "break" "continue"] @keyword.control.return
 
 (
 (identifier) @constant.builtin

diff --git a/runtime/queries/python/highlights.scm b/runtime/queries/python/highlights.scm
@@ -190,8 +190,8 @@
   "try"
   "except"
   "finally"
-] @keyword.control.except
-(raise_statement "from" @keyword.control.except)
+] @keyword.control.exception
+(raise_statement "from" @keyword.control.exception)
 "import" @keyword.control.import
 
 (for_statement "in" @keyword.control)

diff --git a/runtime/queries/rust/highlights.scm b/runtime/queries/rust/highlights.scm
@@ -372,7 +372,7 @@
 ; Remaining Identifiers
 ; -------
 
-"?" @special
+"?" @punctuation.special
 
 (type_identifier) @type
 (identifier) @variable

diff --git a/runtime/queries/scheme/highlights.scm b/runtime/queries/scheme/highlights.scm
@@ -19,8 +19,8 @@
 
 (list
   .
-  ((symbol) @keyword.conditional
-   (#match? @keyword.conditional "^(if|cond|case|when|unless)$"
+  ((symbol) @keyword.control.conditional
+   (#match? @keyword.control.conditional "^(if|cond|case|when|unless)$"
   )))
 
 (list
@@ -67,7 +67,7 @@
 (list
  .
  (symbol) @_f
- (#eq? @_f "quote")) @string.symbol
+ (#eq? @_f "quote")) @string.special.symbol
 
 ; library
 

diff --git a/runtime/queries/svelte/highlights.scm b/runtime/queries/svelte/highlights.scm
@@ -52,7 +52,7 @@
 [
   "{"
   "}"
-] @punctuation.brackets
+] @punctuation.bracket
 
 "=" @operator
 

diff --git a/runtime/queries/swift/highlights.scm b/runtime/queries/swift/highlights.scm
@@ -92,7 +92,7 @@
 (switch_entry "case" @keyword)
 (switch_entry "fallthrough" @keyword)
 (switch_entry (default_keyword) @keyword)
-"return" @keyword.return
+"return" @keyword.control.return
 (ternary_expression
   ["?" ":"] @keyword.control.conditional)
 

diff --git a/xtask/src/docgen.rs b/xtask/src/docgen.rs
@@ -8,6 +8,7 @@ use std::fs;
 
 pub const TYPABLE_COMMANDS_MD_OUTPUT: &str = "typable-cmd.md";
 pub const LANG_SUPPORT_MD_OUTPUT: &str = "lang-support.md";
+pub const THEME_TABLE_MD_OUTPUT: &str = "theme-table.md";
 
 fn md_table_heading(cols: &[String]) -> String {
     let mut header = String::new();
-Original file line number
+Diff line change
@@ Expand Up / @@ -90,7 +90,7 @@ @@
     [
       "func"
-    ] @keyword.control.function
+    ] @keyword.function
     [
       "export"
@@ Expand Down @@