nvim-treesitter/tests/query/highlights/hocon/test.conf
Christian Clason 1ae9b0e455 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"
  (3f44b89685/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`
2024-01-19 16:58:37 +01:00

59 lines
1.7 KiB
Text

HOCON = Human-Optimized Config Object Notation
// ^ @variable.member
// ^ @string
// ^ @string
// ^ @string
// ^ @string
"it's": "a JSON\nsuperset",
// ^ @string
// ^ @string.escape
// ^ @punctuation.delimiter
features: [
// ^ @operator
// ^ @punctuation.bracket
less noisy / less pedantic syntax
// ^ @string
ability to refer to another part of the configuration
import/include another configuration file into the current file
a mapping to a flat properties list such as Java's system properties
ability to get values from environment variables
# ability to write comments
// ^@ comment
// ^ @comment
// this is also a comment
// ^ @comment
// ^ @comment
]
specs url: "https://github.com/lightbend/config/blob/master/HOCON.md"
includes: {
include required(file("~/prog/tree-sitter-hocon/grammar.js"))
// ^ @keyword
//^ @keyword.import
// ^ @punctuation.bracket
// ^ @punctuation.bracket
override = true
// ^ @boolean
}
it's: ${it's}. A ${HOCON}
// ^ @punctuation.special
// ^ @punctuation.special
// ^ @punctuation.special
// ^ @string
// ^ @string
// ^ @punctuation.special
// ^ @punctuation.special
this.is.a."long.key" = null,
// ^ @punctuation.delimiter
// ^ @punctuation.delimiter
// ^ @punctuation.delimiter
// ^ @constant.builtin
week = 7 days
// ^ @number
// ^ @keyword