diff options
author | Randy Taylor <dev@rjt.dev> | 2022-12-13 09:41:01 -0500 |
---|---|---|
committer | Yuan Fu <casouri@gmail.com> | 2022-12-16 14:55:02 -0800 |
commit | 4f9bccef556d57590444e384b16d94c81e5323c9 (patch) | |
tree | df179c98ff56f6bd1a1620e2192d0c201f501b56 /lisp/textmodes | |
parent | f9cb144d45a9ff64f57edd1f93b7ac2ae0efdd34 (diff) | |
download | emacs-4f9bccef556d57590444e384b16d94c81e5323c9.tar.gz emacs-4f9bccef556d57590444e384b16d94c81e5323c9.tar.bz2 emacs-4f9bccef556d57590444e384b16d94c81e5323c9.zip |
Add yaml-ts-mode (Bug#60105)
* admin/notes/tree-sitter/build-module/batch.sh:
* admin/notes/tree-sitter/build-module/build.sh: Add yaml support.
* etc/NEWS: Mention it.
* lisp/textmodes/yaml-ts-mode.el: New major mode with
tree-sitter support.
* lisp/progmodes/eglot.el (eglot-server-programs): Add it.
Diffstat (limited to 'lisp/textmodes')
-rw-r--r-- | lisp/textmodes/yaml-ts-mode.el | 151 |
1 files changed, 151 insertions, 0 deletions
diff --git a/lisp/textmodes/yaml-ts-mode.el b/lisp/textmodes/yaml-ts-mode.el new file mode 100644 index 00000000000..6ef6dabb3a6 --- /dev/null +++ b/lisp/textmodes/yaml-ts-mode.el @@ -0,0 +1,151 @@ +;;; yaml-ts-mode.el --- tree-sitter support for YAML -*- lexical-binding: t; -*- + +;; Copyright (C) 2022 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") + +(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-face))) + (block_mapping_pair + key: (flow_node + [(double_quote_scalar) (single_quote_scalar)] @font-lock-property-face)) + (flow_mapping + (_ key: (flow_node (plain_scalar (string_scalar) @font-lock-property-face)))) + (flow_mapping + (_ key: + (flow_node + [(double_quote_scalar) (single_quote_scalar)] @font-lock-property-face))) + (flow_sequence + (_ key: (flow_node (plain_scalar (string_scalar) @font-lock-property-face)))) + (flow_sequence + (_ key: + (flow_node + [(double_quote_scalar) (single_quote_scalar)] @font-lock-property-face)))) + + :language 'yaml + :feature 'error + :override t + '((ERROR) @font-lock-warning-face)) + "Tree-sitter font-lock settings for `yaml-ts-mode'.") + +;;;###autoload +(add-to-list 'auto-mode-alist '("\\.ya?ml\\'" . yaml-ts-mode)) + +;;;###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))) + + (treesit-major-mode-setup))) + +(provide 'yaml-ts-mode) + +;;; yaml-ts-mode.el ends here |