1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
|
;;; yaml-ts-mode.el --- tree-sitter support for YAML -*- lexical-binding: t; -*-
;; Copyright (C) 2022-2025 Free Software Foundation, Inc.
;; Author : Randy Taylor <dev@rjt.dev>
;; Maintainer : Randy Taylor <dev@rjt.dev>
;; Created : December 2022
;; Keywords : yaml languages tree-sitter
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;;
;;; Code:
(require 'treesit)
(declare-function treesit-parser-create "treesit.c")
(declare-function treesit-node-start "treesit.c")
(declare-function treesit-node-end "treesit.c")
(declare-function treesit-node-type "treesit.c")
(defvar yaml-ts-mode--syntax-table
(let ((table (make-syntax-table)))
(modify-syntax-entry ?# "<" table)
(modify-syntax-entry ?\n ">" table)
(modify-syntax-entry ?& "." table)
(modify-syntax-entry ?* "." table)
(modify-syntax-entry ?\( "." table)
(modify-syntax-entry ?\) "." table)
(modify-syntax-entry ?\' "\"" table)
table)
"Syntax table for `yaml-ts-mode'.")
(defvar yaml-ts-mode--font-lock-settings
(treesit-font-lock-rules
:language 'yaml
:feature 'bracket
'((["[" "]" "{" "}"]) @font-lock-bracket-face)
:language 'yaml
:feature 'comment
'((comment) @font-lock-comment-face)
:language 'yaml
:feature 'constant
'([(boolean_scalar)
(null_scalar)
(reserved_directive)
(tag_directive)
(yaml_directive)] @font-lock-constant-face)
:language 'yaml
:feature 'delimiter
'((["," ":" "-" ">" "?" "|"]) @font-lock-delimiter-face)
:language 'yaml
:feature 'misc-punctuation
'((["---" "..." "&" "*"]) @font-lock-misc-punctuation-face)
:language 'yaml
:feature 'number
'([(float_scalar) (integer_scalar)] @font-lock-number-face)
:language 'yaml
:feature 'type
'([(alias_name) (anchor_name) (tag)] @font-lock-type-face)
:language 'yaml
:feature 'string
:override t
'([(block_scalar)
(double_quote_scalar)
(single_quote_scalar)
(string_scalar)] @font-lock-string-face)
:language 'yaml
:feature 'escape-sequence
:override t
'((escape_sequence) @font-lock-escape-face)
:language 'yaml
:feature 'property
:override t
'((block_mapping_pair
key: (flow_node (plain_scalar (string_scalar) @font-lock-property-use-face)))
(block_mapping_pair
key: (flow_node
[(double_quote_scalar) (single_quote_scalar)] @font-lock-property-use-face))
(flow_mapping
(_ key: (flow_node (plain_scalar (string_scalar) @font-lock-property-use-face))))
(flow_mapping
(_ key:
(flow_node
[(double_quote_scalar) (single_quote_scalar)] @font-lock-property-use-face)))
(flow_sequence
(_ key: (flow_node (plain_scalar (string_scalar) @font-lock-property-use-face))))
(flow_sequence
(_ key:
(flow_node
[(double_quote_scalar) (single_quote_scalar)] @font-lock-property-use-face))))
:language 'yaml
:feature 'error
:override t
'((ERROR) @font-lock-warning-face))
"Tree-sitter font-lock settings for `yaml-ts-mode'.")
(defun yaml-ts-mode--fill-paragraph (&optional justify)
"Fill paragraph.
Behaves like `fill-paragraph', but respects block node
boundaries. JUSTIFY is passed to `fill-paragraph'."
(interactive "*P")
(save-restriction
(widen)
(let ((node (treesit-node-at (point))))
(if (member (treesit-node-type node) '("block_scalar" "comment"))
(let* ((start (treesit-node-start node))
(end (treesit-node-end node))
(start-marker (point-marker))
(fill-paragraph-function nil))
(save-excursion
(goto-char start)
(forward-line)
(move-marker start-marker (point))
(narrow-to-region (point) end))
(fill-region start-marker end justify))
t))))
;;;###autoload
(define-derived-mode yaml-ts-mode text-mode "YAML"
"Major mode for editing YAML, powered by tree-sitter."
:group 'yaml
:syntax-table yaml-ts-mode--syntax-table
(when (treesit-ready-p 'yaml)
(treesit-parser-create 'yaml)
;; Comments.
(setq-local comment-start "# ")
(setq-local comment-end "")
;; Indentation.
(setq-local indent-tabs-mode nil)
;; Font-lock.
(setq-local treesit-font-lock-settings yaml-ts-mode--font-lock-settings)
(setq-local treesit-font-lock-feature-list
'((comment)
(string type)
(constant escape-sequence number property)
(bracket delimiter error misc-punctuation)))
(setq-local fill-paragraph-function #'yaml-ts-mode--fill-paragraph)
(treesit-major-mode-setup)))
(derived-mode-add-parents 'yaml-ts-mode '(yaml-mode))
(if (treesit-ready-p 'yaml)
(add-to-list 'auto-mode-alist '("\\.ya?ml\\'" . yaml-ts-mode)))
(provide 'yaml-ts-mode)
;;; yaml-ts-mode.el ends here
|