* bug#65672: [PATCH emacs 1/1] Add lua-ts-mode
2023-08-31 22:55 bug#65673: [PATCH emacs 0/1] Add lua-ts-mode ~johnmuhl
@ 2023-08-31 21:32 ` ~johnmuhl
2023-09-02 12:14 ` bug#65673: [PATCH emacs 0/1] " Philip Kaludercic
` (2 more replies)
2023-09-01 22:46 ` bug#65673: [PATCH emacs 0/1] " Mauro Aranda
` (2 subsequent siblings)
3 siblings, 3 replies; 16+ messages in thread
From: ~johnmuhl @ 2023-08-31 21:32 UTC (permalink / raw)
To: 65672; +Cc: ~emacs/emacs-devel
From: john muhl <jm@pub.pink>
* test/lisp/progmodes/lua-ts-mode-tests.el:
* test/lisp/progmodes/lua-ts-mode-resources/indent.ert:
* lisp/progmodes/lua-ts-mode.el: New file.
* lisp/progmodes/eglot.el (eglot-server-programs):
* lisp/progmodes/hideshow.el (hs-special-modes-alist):
Add support for lua-ts-mode.
* admin/notes/tree-sitter/build-module/batch.sh:
* admin/notes/tree-sitter/build-module/build.sh: Add Lua grammar.
* test/infra/Dockerfile.emba:
* test/infra/test-jobs.yml: Add lua-ts-mode tests.
---
admin/notes/tree-sitter/build-module/batch.sh | 1 +
admin/notes/tree-sitter/build-module/build.sh | 3 +
etc/NEWS | 4 +
lisp/progmodes/eglot.el | 2 +-
lisp/progmodes/hideshow.el | 1 +
lisp/progmodes/lua-ts-mode.el | 457 ++++++++++++++++++
test/infra/Dockerfile.emba | 1 +
test/infra/test-jobs.yml | 1 +
.../lua-ts-mode-resources/indent.erts | 152 ++++++
test/lisp/progmodes/lua-ts-mode-tests.el | 32 ++
10 files changed, 653 insertions(+), 1 deletion(-)
create mode 100644 lisp/progmodes/lua-ts-mode.el
create mode 100644 test/lisp/progmodes/lua-ts-mode-resources/indent.erts
create mode 100644 test/lisp/progmodes/lua-ts-mode-tests.el
diff --git a/admin/notes/tree-sitter/build-module/batch.sh b/admin/notes/tree-sitter/build-module/batch.sh
index 1d4076564dc..685a35c269d 100755
--- a/admin/notes/tree-sitter/build-module/batch.sh
+++ b/admin/notes/tree-sitter/build-module/batch.sh
@@ -15,6 +15,7 @@ languages=(
'html'
'javascript'
'json'
+ 'lua'
'python'
'rust'
'toml'
diff --git a/admin/notes/tree-sitter/build-module/build.sh b/admin/notes/tree-sitter/build-module/build.sh
index 0832875168b..969187b7f92 100755
--- a/admin/notes/tree-sitter/build-module/build.sh
+++ b/admin/notes/tree-sitter/build-module/build.sh
@@ -42,6 +42,9 @@ case "${lang}" in
"heex")
org="phoenixframework"
;;
+ "lua")
+ org="MunifTanjim"
+ ;;
"typescript")
sourcedir="tree-sitter-typescript/typescript/src"
grammardir="tree-sitter-typescript/typescript"
diff --git a/etc/NEWS b/etc/NEWS
index 9a98db8c83a..1a40a62615b 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -730,6 +730,10 @@ A major mode based on the tree-sitter library for editing HEEx files.
A major mode based on the tree-sitter library for editing Elixir
files.
+---
+*** New major mode 'lua-ts-mode'.
+A major mode based on the tree-sitter library for editing Lua files.
+
---
** The highly accessible Modus themes collection has eight items.
The 'modus-operandi' and 'modus-vivendi' are the main themes that have
diff --git a/lisp/progmodes/eglot.el b/lisp/progmodes/eglot.el
index 65daa0941d5..f249e3c81b4 100644
--- a/lisp/progmodes/eglot.el
+++ b/lisp/progmodes/eglot.el
@@ -237,7 +237,7 @@ chosen (interactively or automatically)."
(gdscript-mode . ("localhost" 6008))
((fortran-mode f90-mode) . ("fortls"))
(futhark-mode . ("futhark" "lsp"))
- (lua-mode . ,(eglot-alternatives
+ ((lua-mode lua-ts-mode) . ,(eglot-alternatives
'("lua-language-server" "lua-lsp")))
(zig-mode . ("zls"))
((css-mode css-ts-mode)
diff --git a/lisp/progmodes/hideshow.el b/lisp/progmodes/hideshow.el
index b878986d7a4..78e39fad740 100644
--- a/lisp/progmodes/hideshow.el
+++ b/lisp/progmodes/hideshow.el
@@ -264,6 +264,7 @@ This has effect only if `search-invisible' is set to `open'."
(java-ts-mode "{" "}" "/[*/]" nil nil)
(js-mode "{" "}" "/[*/]" nil)
(js-ts-mode "{" "}" "/[*/]" nil)
+ (lua-ts-mode "{\\|\\[\\[" "}\\|\\]\\]" "--" nil)
(mhtml-mode "{\\|<[^/>]*?" "}\\|</[^/>]*[^/]>" "<!--" mhtml-forward nil)
;; Add more support here.
))
diff --git a/lisp/progmodes/lua-ts-mode.el b/lisp/progmodes/lua-ts-mode.el
new file mode 100644
index 00000000000..76d1781b30e
--- /dev/null
+++ b/lisp/progmodes/lua-ts-mode.el
@@ -0,0 +1,457 @@
+;;; lua-ts-mode.el --- Major mode for editing Lua files -*- lexical-binding: t -*-
+
+;; Copyright (C) 2023 Free Software Foundation, Inc.
+
+;; Author: John Muhl <jm@pub.pink>
+;; Created: June 27, 2023
+;; Keywords: lua 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:
+
+;; This package provides `lua-ts-mode' which is a major mode for Lua
+;; files that uses Tree Sitter to parse the language.
+;;
+;; This package is compatible with and tested against the grammar
+;; for Lua found at https://github.com/MunifTanjim/tree-sitter-lua
+
+;;; Code:
+
+(require 'comint)
+(require 'treesit)
+
+(eval-when-compile
+ (require 'cl-lib)
+ (require 'rx))
+
+(defcustom lua-ts-indent-offset 4
+ "Number of spaces for each indentation step in `lua-ts-mode'."
+ :type 'integer
+ :safe 'integerp
+ :group 'lua
+ :version "30.1")
+
+(defcustom lua-ts-luacheck-program "luacheck"
+ "Location of the Luacheck program."
+ :type 'string
+ :group 'lua
+ :version "30.1")
+
+(defcustom lua-ts-lua-manual
+ (if (file-readable-p "/usr/share/doc/lua/manual.html")
+ "file:///usr/share/doc/lua/manual.html" "")
+ "Location of the Lua `manual.html' file."
+ :type 'string
+ :safe 'stringp
+ :group 'lua
+ :version "30.1")
+
+(defcustom inferior-lua-buffer "*Lua*"
+ "Name of the inferior Lua buffer."
+ :type 'string
+ :safe 'stringp
+ :group 'lua
+ :version "30.1")
+
+(defcustom inferior-lua-interpreter "lua"
+ "Program to run in the inferior Lua process."
+ :type 'string
+ :safe 'stringp
+ :group 'lua
+ :version "30.1")
+
+(defcustom inferior-lua-switches "-i"
+ "Command line options for the inferior Lua process."
+ :type 'string
+ :safe 'stringp
+ :group 'lua
+ :version "30.1")
+
+(defcustom inferior-lua-startfile ""
+ "File to load into the inferior Lua process at startup."
+ :type 'string
+ :safe 'stringp
+ :group 'lua
+ :version "30.1")
+
+(defcustom inferior-lua-prompt-regexp "^>>?[[:blank:]]"
+ "Regular expression matching the prompt of the inferior Lua process."
+ :type 'regexp
+ :group 'lua
+ :version "30.1")
+
+(defvar lua-ts--builtins
+ '("assert" "collectgarbage" "coroutine" "debug" "dofile"
+ "error" "getmetatable" "io" "ipairs" "load" "loadfile"
+ "math" "next" "os" "package" "pairs" "pcall" "print"
+ "rawequal" "rawget" "rawlen" "rawset" "require" "select"
+ "setmetatable" "string" "table" "tonumber" "tostring"
+ "type" "utf8" "warn" "xpcall"
+ ;; methods for file handlers
+ "close" "flush" "lines" "read" "seek" "setvbuf" "write")
+ "Lua built-in functions for tree-sitter font-locking.")
+
+(defvar lua-ts--font-lock-settings
+ (treesit-font-lock-rules
+ :language 'lua
+ :feature 'bracket
+ '(["(" ")" "[" "]" "{" "}"] @font-lock-bracket-face)
+
+ :language 'lua
+ :feature 'delimiter
+ '(["," ";"] @font-lock-delimiter-face)
+
+ :language 'lua
+ :feature 'escape
+ '((escape_sequence) @font-lock-escape-face)
+
+ :language 'lua
+ :feature 'constant
+ '((variable_list
+ attribute: (attribute (["<" ">"] (identifier))))
+ @font-lock-constant-face)
+
+ :language 'lua
+ :feature 'operator
+ '(["and" "not" "or" "+" "-" "*" "/" "%" "^"
+ "#" "==" "~=" "<=" ">=" "<" ">" "=" "&"
+ "~" "|" "<<" ">>" "//" ".."]
+ @font-lock-operator-face
+ (vararg_expression) @font-lock-operator-face)
+
+ :language 'lua
+ :feature 'property
+ '((field name: (identifier) @font-lock-property-name-face)
+ (dot_index_expression
+ field: (identifier) @font-lock-property-use-face))
+
+ :language 'lua
+ :feature 'builtin
+ `(((identifier) @font-lock-builtin-face
+ (:match ,(regexp-opt lua-ts--builtins 'symbols)
+ @font-lock-builtin-face)))
+
+ :language 'lua
+ :feature 'function
+ '((function_call name: (identifier) @font-lock-function-call-face)
+ (function_call
+ name: (method_index_expression
+ method: (identifier) @font-lock-function-call-face))
+ (function_call
+ name: (dot_index_expression
+ table: (identifier) @font-lock-function-call-face)))
+
+ :language 'lua
+ :feature 'punctuation
+ '(["." ":"] @font-lock-punctuation-face)
+
+ :language 'lua
+ :feature 'variable
+ '((function_call
+ arguments: (arguments (identifier))
+ @font-lock-variable-use-face)
+ (function_call
+ name: (method_index_expression
+ table: (identifier) @font-lock-variable-use-face))
+ (goto_statement (identifier) @font-lock-variable-use-face))
+
+ :language 'lua
+ :feature 'assignment
+ '((variable_list (identifier) @font-lock-variable-name-face))
+
+ :language 'lua
+ :feature 'number
+ '((number) @font-lock-number-face)
+
+ :language 'lua
+ :feature 'keyword
+ '((break_statement) @font-lock-keyword-face
+ (true) @font-lock-constant-face
+ (false) @font-lock-constant-face
+ (nil) @font-lock-constant-face
+ ["and" "do" "else" "elseif" "end" "for" "function"
+ "goto" "if" "in" "local" "not" "or" "repeat"
+ "return" "then" "until" "while"]
+ @font-lock-keyword-face)
+
+ :language 'lua
+ :feature 'string
+ '((string) @font-lock-string-face)
+
+ :language 'lua
+ :feature 'comment
+ '((comment) @font-lock-comment-face
+ (hash_bang_line) @font-lock-comment-face)
+
+ :language 'lua
+ :feature 'definition
+ '((function_declaration
+ name: (identifier) @font-lock-function-name-face)
+ (parameters
+ name: (identifier) @font-lock-variable-name-face)
+ (label_statement) @font-lock-variable-name-face)
+
+ :language 'lua
+ :feature 'error
+ :override t
+ '((ERROR) @font-lock-warning-face))
+ "Tree-sitter font-lock settings for `lua-ts-mode'.")
+
+(defvar lua-ts--simple-indent-rules
+ `((lua
+ ((parent-is "chunk") column-0 0)
+ ((node-is "comment_end") column-0 0)
+ ((parent-is "block") parent-bol 0)
+ ((node-is "}") parent-bol 0)
+ ((node-is ")") parent-bol 0)
+ ((node-is "else_statement") parent-bol 0)
+ ((node-is "elseif_statement") parent-bol 0)
+ ((node-is "end") parent-bol 0)
+ ((node-is "until") parent-bol 0)
+ ((parent-is "for_statement") parent-bol lua-ts-indent-offset)
+ ((parent-is "function_declaration") parent-bol lua-ts-indent-offset)
+ ((parent-is "function_definition") parent-bol lua-ts-indent-offset)
+ ((parent-is "if_statement") parent-bol lua-ts-indent-offset)
+ ((parent-is "else_statement") parent-bol lua-ts-indent-offset)
+ ((parent-is "repeat_statement") parent-bol lua-ts-indent-offset)
+ ((parent-is "while_statement") parent-bol lua-ts-indent-offset)
+ ((parent-is "table_constructor") parent-bol lua-ts-indent-offset)
+ ((parent-is "arguments") parent-bol lua-ts-indent-offset)
+ ((parent-is "parameters") parent-bol lua-ts-indent-offset)
+ ((parent-is "ERROR") no-indent 0))))
+
+(defvar lua-ts--syntax-table
+ (let ((table (make-syntax-table)))
+ (modify-syntax-entry ?+ "." table)
+ (modify-syntax-entry ?- ". 12" table)
+ (modify-syntax-entry ?= "." table)
+ (modify-syntax-entry ?% "." table)
+ (modify-syntax-entry ?^ "." table)
+ (modify-syntax-entry ?~ "." table)
+ (modify-syntax-entry ?< "." table)
+ (modify-syntax-entry ?> "." table)
+ (modify-syntax-entry ?/ "." table)
+ (modify-syntax-entry ?* "." table)
+ (modify-syntax-entry ?\n ">" table)
+ (modify-syntax-entry ?\' "\"" table)
+ (modify-syntax-entry ?\" "\"" table)
+ table)
+ "Syntax table for `lua-ts-mode'.")
+
+(defun lua-ts--defun-name-function (node)
+ "Return the defun name of NODE.
+Return nil if there is no name or if NODE is not a defun node."
+ (let ((child (treesit-node-child-by-field-name node "name")))
+ (pcase (treesit-node-type node)
+ ((or "function_declaration" "function_definition")
+ (treesit-node-text child t))
+ ("variable_declaration"
+ (if child
+ (treesit-node-text child t)
+ (treesit-node-text
+ (treesit-node-child-by-field-name
+ (treesit-search-subtree node "assignment_statement" nil nil 1)
+ "name"))))
+ ("field"
+ (and (treesit-search-subtree node "function_definition" nil nil 1)
+ (treesit-node-text child t))))))
+
+(defun lua-ts--builtin-p (node)
+ "Return t if the NODE is a builtin or nil if not."
+ (let ((name (pcase (treesit-node-type node)
+ ("dot_index_expression"
+ (car (string-split (treesit-node-text node t) "\\." t)))
+ ("function_call"
+ (let* ((child (treesit-node-child-by-field-name node "name"))
+ (text (treesit-node-text child t)))
+ (if (string-match-p ":" text)
+ (cadr (string-split text ":" t))
+ text))))))
+ (and name (string-match-p (regexp-opt lua-ts--builtins 'words) name))))
+
+(defvar-local lua-ts--flymake-process nil)
+
+(defun lua-ts-flymake-luacheck (report-fn &rest _args)
+ "Luacheck backend for Flymake.
+Calls REPORT-FN directly."
+ (when (process-live-p lua-ts--flymake-process)
+ (kill-process lua-ts--flymake-process))
+ (let ((source (current-buffer)))
+ (save-restriction
+ (widen)
+ (setq lua-ts--flymake-process
+ (make-process
+ :name "lua-ts-flymake-luacheck"
+ :noquery t
+ :connection-type 'pipe
+ :buffer (generate-new-buffer " *lua-ts-flymake-luacheck*")
+ :command `(,lua-ts-luacheck-program
+ "--codes" "--ranges" "--formatter" "plain" "-")
+ :sentinel
+ (lambda (proc _event)
+ (when (eq 'exit (process-status proc))
+ (unwind-protect
+ (if (with-current-buffer source
+ (eq proc lua-ts--flymake-process))
+ (with-current-buffer (process-buffer proc)
+ (goto-char (point-min))
+ (cl-loop
+ while (search-forward-regexp
+ (rx (seq bol
+ (0+ alnum) ":"
+ (group (1+ digit)) ":"
+ (group (1+ digit)) "-"
+ (group (1+ digit)) ": "
+ (group (0+ nonl))
+ eol))
+ nil t)
+ for line = (string-to-number (match-string 1))
+ for beg = (string-to-number (match-string 2))
+ for end = (string-to-number (match-string 3))
+ for msg = (match-string 4)
+ for type = (if (string-match "^(W" msg)
+ :warning
+ :error)
+ when (and beg end)
+ collect (flymake-make-diagnostic source
+ (cons line beg)
+ (cons line (1+ end))
+ type
+ msg)
+ into diags
+ finally (funcall report-fn diags)))
+ (flymake-log :warning "Canceling obsolete check %s" proc))
+ (kill-buffer (process-buffer proc)))))))
+ (process-send-region lua-ts--flymake-process (point-min) (point-max))
+ (process-send-eof lua-ts--flymake-process))))
+
+(defun lua-ts-documentation-at-point ()
+ "Show documentation of function at point in Lua manual."
+ (interactive)
+ (unless (string-blank-p lua-ts-lua-manual)
+ (let ((character-before (char-to-string (char-before)))
+ id)
+ (save-excursion
+ ;; When point is mid-word `treesit-thing-at-point'
+ ;; may return the parent node of the thing at point.
+ (unless (or (bolp)
+ (not (string-match-p "[[:alnum:]]" character-before)))
+ (backward-word))
+ (let ((node (treesit-thing-at-point 'builtin nil)))
+ (setq id (pcase (treesit-node-type node)
+ ("dot_index_expression" (treesit-node-text node t))
+ ("function_call"
+ (let* ((child (treesit-node-child-by-field-name node "name"))
+ (name (treesit-node-text child t)))
+ (if (string-match-p ":" name)
+ (replace-regexp-in-string "^.*:" "file:" name)
+ name)))))))
+ (when id (browse-url (concat lua-ts-lua-manual "#pdf-" id))))))
+
+;;;###autoload
+(defun inferior-lua ()
+ "Run the Lua interpreter in an inferior process."
+ (interactive)
+ (let ((buffer (get-buffer-create inferior-lua-buffer))
+ (program inferior-lua-interpreter)
+ (switches inferior-lua-switches)
+ (startfile (unless (string-blank-p inferior-lua-startfile)
+ (expand-file-name inferior-lua-startfile))))
+ (make-comint-in-buffer program buffer program startfile switches)
+ (with-current-buffer buffer
+ (setq-local comint-input-ignoredups t
+ comint-prompt-read-only t
+ comint-prompt-regexp inferior-lua-prompt-regexp
+ comint-use-prompt-regexp t))
+ (pop-to-buffer buffer)))
+
+;;;###autoload
+(define-derived-mode lua-ts-mode prog-mode "Lua"
+ "Major mode for editing Lua files, powered by tree-sitter."
+ :group 'lua
+ :syntax-table lua-ts--syntax-table
+
+ (when (treesit-ready-p 'lua)
+ (treesit-parser-create 'lua)
+
+ (setq-local treesit-thing-settings
+ '((lua . ((builtin lua-ts--builtin-p)))))
+
+ ;; Comments.
+ (setq-local comment-start "--")
+ (setq-local comment-start-skip "--\\s-*")
+ (setq-local comment-end "")
+
+ ;; Font-lock.
+ (setq-local treesit-font-lock-settings lua-ts--font-lock-settings)
+
+ (setq-local treesit-font-lock-feature-list
+ '((comment definition)
+ (keyword property string)
+ (assignment builtin constant number)
+ (bracket
+ delimiter
+ escape
+ function
+ operator
+ punctuation
+ variable)))
+
+ ;; Indent.
+ (setq-local treesit-simple-indent-rules lua-ts--simple-indent-rules)
+
+ ;; Navigation.
+ (setq-local treesit-defun-name-function #'lua-ts--defun-name-function)
+
+ (setq-local treesit-defun-type-regexp
+ (rx (or "function_declaration" "function_definition")))
+
+ (setq-local treesit-sentence-type-regexp
+ (rx (or "do_statement" "while_statement" "repeat_statement"
+ "if_statement" "for_statement" "variable_declaration")))
+
+ (setq-local treesit-sexp-type-regexp
+ (rx (or "arguments" "comment" "string" "table_constructor")))
+
+ ;; Imenu.
+ (setq-local treesit-simple-imenu-settings
+ `(("Variable" ,(rx bos "variable_declaration" eos) nil nil)
+ ("Function" ,(rx bos
+ (or "function_declaration"
+ "function_definition"
+ "field")
+ eos)
+ nil nil)))
+
+ ;; Which-function.
+ (setq-local which-func-functions (treesit-defun-at-point))
+
+ ;; Outline.
+ (setq-local outline-regexp
+ (rx (or "--[[" "do" "for" "if" "repeat" "while"
+ (seq (** 0 1 "local ") "function"))))
+
+ (treesit-major-mode-setup))
+
+ (add-hook 'flymake-diagnostic-functions #'lua-ts-flymake-luacheck nil 'local))
+
+(if (treesit-ready-p 'lua)
+ (add-to-list 'auto-mode-alist '("\\.lua\\'" . lua-ts-mode)))
+
+(provide 'lua-ts-mode)
+
+;;; lua-ts-mode.el ends here
diff --git a/test/infra/Dockerfile.emba b/test/infra/Dockerfile.emba
index 584e4444dc1..e29098ec270 100644
--- a/test/infra/Dockerfile.emba
+++ b/test/infra/Dockerfile.emba
@@ -126,6 +126,7 @@ RUN src/emacs -Q --batch \
(java "https://github.com/tree-sitter/tree-sitter-java") \
(javascript "https://github.com/tree-sitter/tree-sitter-javascript") \
(json "https://github.com/tree-sitter/tree-sitter-json") \
+ (lua "https://github.com/MunifTanjim/tree-sitter-lua") \
(python "https://github.com/tree-sitter/tree-sitter-python") \
(ruby "https://github.com/tree-sitter/tree-sitter-ruby") \
(tsx "https://github.com/tree-sitter/tree-sitter-typescript" "master" "tsx/src") \
diff --git a/test/infra/test-jobs.yml b/test/infra/test-jobs.yml
index 2f6e0dab4d5..1f5d607eda4 100644
--- a/test/infra/test-jobs.yml
+++ b/test/infra/test-jobs.yml
@@ -580,6 +580,7 @@ test-src-inotify:
lisp/progmodes/go-ts-mode-tests.log
lisp/progmodes/heex-ts-mode-tests.log
lisp/progmodes/java-ts-mode-tests.log
+ lisp/progmodes/lua-ts-mode-tests.log
lisp/progmodes/ruby-ts-mode-tests.log
lisp/progmodes/typescript-ts-mode-tests.log
src/treesit-tests.log
diff --git a/test/lisp/progmodes/lua-ts-mode-resources/indent.erts b/test/lisp/progmodes/lua-ts-mode-resources/indent.erts
new file mode 100644
index 00000000000..040225c8580
--- /dev/null
+++ b/test/lisp/progmodes/lua-ts-mode-resources/indent.erts
@@ -0,0 +1,152 @@
+Code:
+ (lambda ()
+ (setq indent-tabs-mode nil)
+ (setq lua-ts-indent-offset 2)
+ (lua-ts-mode)
+ (indent-region (point-min) (point-max)))
+
+Name: Basic Indent
+
+=-=
+ print(
+0,
+ 1
+)
+
+local function f(o)
+ if o.x > o.y then
+ return o.x
+elseif o.y > o.z then
+ return o.y
+ else
+return o.z
+ end
+end
+
+f({
+ x = 1,
+ y = 2,
+ z = 3,
+})
+
+;(function()
+return false
+)()
+=-=
+print(
+ 0,
+ 1
+)
+
+local function f(o)
+ if o.x > o.y then
+ return o.x
+ elseif o.y > o.z then
+ return o.y
+ else
+ return o.z
+ end
+end
+
+f({
+ x = 1,
+ y = 2,
+ z = 3,
+})
+
+;(function()
+ return false
+)()
+=-=-=
+
+Name: Argument Indent
+
+=-=
+function h(
+string,
+number,
+options)
+print(string, number, options)
+end
+
+local p = h(
+"sring",
+ 1000,
+ {
+cost = 2,
+length = 8,
+ parallelism = 4,
+})
+=-=
+function h(
+ string,
+ number,
+ options)
+ print(string, number, options)
+end
+
+local p = h(
+ "sring",
+ 1000,
+ {
+ cost = 2,
+ length = 8,
+ parallelism = 4,
+ })
+=-=-=
+
+Name: Continuation Indent
+
+=-=
+function f()
+ local str = [[
+ multi-line
+ string
+ ]]
+--[[
+multi-line
+comment
+ ]]
+return true
+end
+=-=
+function f()
+ local str = [[
+ multi-line
+ string
+ ]]
+ --[[
+multi-line
+comment
+ ]]
+ return true
+end
+=-=-=
+
+Name: Loop Indent
+
+=-=
+for k, v in pairs({}) do
+ print(k, v)
+end
+
+while n < 10 do
+n = n + 1
+end
+
+repeat
+z = z * 2
+ until z > 12
+=-=
+for k, v in pairs({}) do
+ print(k, v)
+end
+
+while n < 10 do
+ n = n + 1
+end
+
+repeat
+ z = z * 2
+until z > 12
+=-=-=
diff --git a/test/lisp/progmodes/lua-ts-mode-tests.el b/test/lisp/progmodes/lua-ts-mode-tests.el
new file mode 100644
index 00000000000..62ec2652ba8
--- /dev/null
+++ b/test/lisp/progmodes/lua-ts-mode-tests.el
@@ -0,0 +1,32 @@
+;;; lua-ts-mode-tests.el --- Tests for lua-ts-mode -*- lexical-binding: t; -*-
+
+;; Copyright (C) 2023 Free Software Foundation, Inc.
+
+;; 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/>.
+
+;;; Code:
+
+(require 'ert)
+(require 'ert-x)
+(require 'treesit)
+
+(ert-deftest lua-ts-mode-test-indentation ()
+ (skip-unless (treesit-ready-p 'lua))
+ (ert-test-erts-file (ert-resource-file "indent.erts")))
+
+(provide 'lua-ts-mode-tests)
+
+;;; lua-ts-mode-tests.el ends here
--
2.38.5
^ permalink raw reply related [flat|nested] 16+ messages in thread
* bug#65673: [PATCH emacs 0/1] Add lua-ts-mode
@ 2023-08-31 22:55 ~johnmuhl
2023-08-31 21:32 ` bug#65672: [PATCH emacs 1/1] " ~johnmuhl
` (3 more replies)
0 siblings, 4 replies; 16+ messages in thread
From: ~johnmuhl @ 2023-08-31 22:55 UTC (permalink / raw)
To: 65673; +Cc: ~emacs/emacs-devel
This email and patch were generated and sent using the web based
“Prepare a patchset” feature of Sourcehut. I hope it will be a useful
POC for how Emacs could integrate a forge based pull request style
workflow for occasional contributors with (hopefully) minimal hassle
for those with push access. If it causes too much annoyance I’m happy
to resend it the preferred way.
I’ve also CC’d a Sourcehut mailing list to test the patch review
feature so if this experiment continues it’d be good if we could keep
“~emacs/emacs-devel@lists.sr.ht” included in any replies. Other than
that just do the usual patch review/handling.
The sr.ht hosted version of the Sourcehut forge is considered “Good
enough to recommend” by the GNU Ethical Repository Criteria in case
anyone wonders about that.
https://www.gnu.org/software/repo-criteria-evaluation.html
Discussion or questions about Sourcehut or the workflow should
probably go somewhere else but please CC me in that case.
Thanks.
////
This patch adds a lua-ts-mode for editing Lua files in Emacs >= 29.1.
It is comparable in features to the NonGNU ELPA lua-mode. Shortcomings
in the partially supported features are mentioned below.
| Feature | lua-mode | lua-ts-mode |
|------------------------+----------+-------------|
| indentation ¹ | Yes | Yes |
| highlighting | Yes | Yes |
| documentation lookup ² | Yes | Yes |
| imenu support ³ | Yes | Partial |
| hideshow support | Yes | Yes |
| outline support | No | Yes |
| flymake support ⁴ | Yes | Yes |
| which-func support | No | Yes |
| inferior Lua ⁵ | Yes | Partial |
1. Indentation tries to follow the default EmmyLua style. This is the
same formatter used by lua-ls so out of the box eglot-format and
automatic indentation should agree about indents.
2. Both modes implement this feature by calling browse-url for the
manual.html file that is normally distributed with Lua. lua-mode
has a fallback that uses an online version, lua-ts-mode has no
fallback but works with the online docs if customized.
3. I tried to follow the model used in other ts modes but it doesn’t
seem like the results are very useful compared to Eglot/lua-ls. I’d
like it to improve eventually but it’s low priority personally and
wouldn’t oppose removing it for now.
4. Both modes require the Luacheck program to be installed.
5. The comint integration is the most basic. lua-mode supports things
like "Send {buffer,region} to process" which I’d like to add but
haven’t had time. Currently lua-ts-mode only supports starting an
inferior Lua process and interacting with it directly.
The patch file is also available from:
https://git.sr.ht/~johnmuhl/emacs/commit/391699e.patch
Thanks again.
john muhl (1):
Add lua-ts-mode
admin/notes/tree-sitter/build-module/batch.sh | 1 +
admin/notes/tree-sitter/build-module/build.sh | 3 +
etc/NEWS | 4 +
lisp/progmodes/eglot.el | 2 +-
lisp/progmodes/hideshow.el | 1 +
lisp/progmodes/lua-ts-mode.el | 457 ++++++++++++++++++
test/infra/Dockerfile.emba | 1 +
test/infra/test-jobs.yml | 1 +
.../lua-ts-mode-resources/indent.erts | 152 ++++++
test/lisp/progmodes/lua-ts-mode-tests.el | 32 ++
10 files changed, 653 insertions(+), 1 deletion(-)
create mode 100644 lisp/progmodes/lua-ts-mode.el
create mode 100644 test/lisp/progmodes/lua-ts-mode-resources/indent.erts
create mode 100644 test/lisp/progmodes/lua-ts-mode-tests.el
--
2.38.5
^ permalink raw reply [flat|nested] 16+ messages in thread
* bug#65673: [PATCH emacs 0/1] Add lua-ts-mode
2023-08-31 22:55 bug#65673: [PATCH emacs 0/1] Add lua-ts-mode ~johnmuhl
2023-08-31 21:32 ` bug#65672: [PATCH emacs 1/1] " ~johnmuhl
@ 2023-09-01 22:46 ` Mauro Aranda
2023-09-09 15:17 ` bug#65673: [PATCH emacs 1/1 v2] " john muhl via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-11 15:03 ` john muhl via Bug reports for GNU Emacs, the Swiss army knife of text editors
3 siblings, 0 replies; 16+ messages in thread
From: Mauro Aranda @ 2023-09-01 22:46 UTC (permalink / raw)
To: ~johnmuhl; +Cc: 65673, ~emacs/emacs-devel
~johnmuhl <johnmuhl@git.sr.ht> writes:
I just have some comments/questions about the defcustoms:
> +(defcustom lua-ts-indent-offset 4
> + "Number of spaces for each indentation step in `lua-ts-mode'."
> + :type 'integer
> + :safe 'integerp
> + :group 'lua
> + :version "30.1")
Does :type 'natnum fit better here?
> +(defcustom lua-ts-luacheck-program "luacheck"
> + "Location of the Luacheck program."
> + :type 'string
> + :group 'lua
> + :version "30.1")
I think :type 'file is better.
> +(defcustom inferior-lua-interpreter "lua"
> + "Program to run in the inferior Lua process."
> + :type 'string
> + :safe 'stringp
> + :group 'lua
> + :version "30.1")
Same as above.
> +(defcustom inferior-lua-startfile ""
> + "File to load into the inferior Lua process at startup."
> + :type 'string
> + :safe 'stringp
> + :group 'lua
> + :version "30.1")
Same as above, but maybe the default value should be changed to nil, to
indicate no startfile?
^ permalink raw reply [flat|nested] 16+ messages in thread
* bug#65673: [PATCH emacs 0/1] Add lua-ts-mode
2023-08-31 21:32 ` bug#65672: [PATCH emacs 1/1] " ~johnmuhl
@ 2023-09-02 12:14 ` Philip Kaludercic
2023-09-02 14:10 ` bug#65672: [PATCH emacs 1/1] " Augusto Stoffel
[not found] ` <handler.65672.B.169354983214451.ack@debbugs.gnu.org>
2 siblings, 0 replies; 16+ messages in thread
From: Philip Kaludercic @ 2023-09-02 12:14 UTC (permalink / raw)
To: ~johnmuhl; +Cc: ~johnmuhl, ~emacs/emacs-devel, 65673, 65672
~johnmuhl <johnmuhl@git.sr.ht> writes:
> From: john muhl <jm@pub.pink>
>
> * test/lisp/progmodes/lua-ts-mode-tests.el:
> * test/lisp/progmodes/lua-ts-mode-resources/indent.ert:
> * lisp/progmodes/lua-ts-mode.el: New file.
> * lisp/progmodes/eglot.el (eglot-server-programs):
> * lisp/progmodes/hideshow.el (hs-special-modes-alist):
> Add support for lua-ts-mode.
> * admin/notes/tree-sitter/build-module/batch.sh:
> * admin/notes/tree-sitter/build-module/build.sh: Add Lua grammar.
> * test/infra/Dockerfile.emba:
> * test/infra/test-jobs.yml: Add lua-ts-mode tests.
> ---
> admin/notes/tree-sitter/build-module/batch.sh | 1 +
> admin/notes/tree-sitter/build-module/build.sh | 3 +
> etc/NEWS | 4 +
> lisp/progmodes/eglot.el | 2 +-
> lisp/progmodes/hideshow.el | 1 +
> lisp/progmodes/lua-ts-mode.el | 457 ++++++++++++++++++
> test/infra/Dockerfile.emba | 1 +
> test/infra/test-jobs.yml | 1 +
> .../lua-ts-mode-resources/indent.erts | 152 ++++++
> test/lisp/progmodes/lua-ts-mode-tests.el | 32 ++
> 10 files changed, 653 insertions(+), 1 deletion(-)
> create mode 100644 lisp/progmodes/lua-ts-mode.el
> create mode 100644 test/lisp/progmodes/lua-ts-mode-resources/indent.erts
> create mode 100644 test/lisp/progmodes/lua-ts-mode-tests.el
>
> diff --git a/admin/notes/tree-sitter/build-module/batch.sh b/admin/notes/tree-sitter/build-module/batch.sh
> index 1d4076564dc..685a35c269d 100755
> --- a/admin/notes/tree-sitter/build-module/batch.sh
> +++ b/admin/notes/tree-sitter/build-module/batch.sh
> @@ -15,6 +15,7 @@ languages=(
> 'html'
> 'javascript'
> 'json'
> + 'lua'
> 'python'
> 'rust'
> 'toml'
> diff --git a/admin/notes/tree-sitter/build-module/build.sh b/admin/notes/tree-sitter/build-module/build.sh
> index 0832875168b..969187b7f92 100755
> --- a/admin/notes/tree-sitter/build-module/build.sh
> +++ b/admin/notes/tree-sitter/build-module/build.sh
> @@ -42,6 +42,9 @@ case "${lang}" in
> "heex")
> org="phoenixframework"
> ;;
> + "lua")
> + org="MunifTanjim"
> + ;;
> "typescript")
> sourcedir="tree-sitter-typescript/typescript/src"
> grammardir="tree-sitter-typescript/typescript"
> diff --git a/etc/NEWS b/etc/NEWS
> index 9a98db8c83a..1a40a62615b 100644
> --- a/etc/NEWS
> +++ b/etc/NEWS
> @@ -730,6 +730,10 @@ A major mode based on the tree-sitter library for editing HEEx files.
> A major mode based on the tree-sitter library for editing Elixir
> files.
>
> +---
> +*** New major mode 'lua-ts-mode'.
> +A major mode based on the tree-sitter library for editing Lua files.
> +
> ---
> ** The highly accessible Modus themes collection has eight items.
> The 'modus-operandi' and 'modus-vivendi' are the main themes that have
> diff --git a/lisp/progmodes/eglot.el b/lisp/progmodes/eglot.el
> index 65daa0941d5..f249e3c81b4 100644
> --- a/lisp/progmodes/eglot.el
> +++ b/lisp/progmodes/eglot.el
> @@ -237,7 +237,7 @@ chosen (interactively or automatically)."
> (gdscript-mode . ("localhost" 6008))
> ((fortran-mode f90-mode) . ("fortls"))
> (futhark-mode . ("futhark" "lsp"))
> - (lua-mode . ,(eglot-alternatives
> + ((lua-mode lua-ts-mode) . ,(eglot-alternatives
> '("lua-language-server" "lua-lsp")))
> (zig-mode . ("zls"))
> ((css-mode css-ts-mode)
> diff --git a/lisp/progmodes/hideshow.el b/lisp/progmodes/hideshow.el
> index b878986d7a4..78e39fad740 100644
> --- a/lisp/progmodes/hideshow.el
> +++ b/lisp/progmodes/hideshow.el
> @@ -264,6 +264,7 @@ This has effect only if `search-invisible' is set to `open'."
> (java-ts-mode "{" "}" "/[*/]" nil nil)
> (js-mode "{" "}" "/[*/]" nil)
> (js-ts-mode "{" "}" "/[*/]" nil)
> + (lua-ts-mode "{\\|\\[\\[" "}\\|\\]\\]" "--" nil)
> (mhtml-mode "{\\|<[^/>]*?" "}\\|</[^/>]*[^/]>" "<!--" mhtml-forward nil)
> ;; Add more support here.
> ))
> diff --git a/lisp/progmodes/lua-ts-mode.el b/lisp/progmodes/lua-ts-mode.el
> new file mode 100644
> index 00000000000..76d1781b30e
> --- /dev/null
> +++ b/lisp/progmodes/lua-ts-mode.el
> @@ -0,0 +1,457 @@
> +;;; lua-ts-mode.el --- Major mode for editing Lua files -*- lexical-binding: t -*-
> +
> +;; Copyright (C) 2023 Free Software Foundation, Inc.
> +
> +;; Author: John Muhl <jm@pub.pink>
> +;; Created: June 27, 2023
> +;; Keywords: lua 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:
> +
> +;; This package provides `lua-ts-mode' which is a major mode for Lua
> +;; files that uses Tree Sitter to parse the language.
> +;;
> +;; This package is compatible with and tested against the grammar
> +;; for Lua found at https://github.com/MunifTanjim/tree-sitter-lua
> +
> +;;; Code:
> +
> +(require 'comint)
> +(require 'treesit)
> +
> +(eval-when-compile
> + (require 'cl-lib)
> + (require 'rx))
> +
> +(defcustom lua-ts-indent-offset 4
> + "Number of spaces for each indentation step in `lua-ts-mode'."
> + :type 'integer
> + :safe 'integerp
> + :group 'lua
> + :version "30.1")
> +
> +(defcustom lua-ts-luacheck-program "luacheck"
> + "Location of the Luacheck program."
> + :type 'string
> + :group 'lua
> + :version "30.1")
> +
> +(defcustom lua-ts-lua-manual
> + (if (file-readable-p "/usr/share/doc/lua/manual.html")
> + "file:///usr/share/doc/lua/manual.html" "")
> + "Location of the Lua `manual.html' file."
> + :type 'string
> + :safe 'stringp
> + :group 'lua
> + :version "30.1")
Could this fall back to some online manual?
> +
> +(defcustom inferior-lua-buffer "*Lua*"
> + "Name of the inferior Lua buffer."
> + :type 'string
> + :safe 'stringp
> + :group 'lua
> + :version "30.1")
> +
> +(defcustom inferior-lua-interpreter "lua"
> + "Program to run in the inferior Lua process."
> + :type 'string
> + :safe 'stringp
> + :group 'lua
> + :version "30.1")
Are you sure that any string is safe? That would include "rm -rf ~".
> +(defcustom inferior-lua-switches "-i"
> + "Command line options for the inferior Lua process."
> + :type 'string
> + :safe 'stringp
> + :group 'lua
> + :version "30.1")
> +
> +(defcustom inferior-lua-startfile ""
> + "File to load into the inferior Lua process at startup."
> + :type 'string
> + :safe 'stringp
> + :group 'lua
> + :version "30.1")
> +
> +(defcustom inferior-lua-prompt-regexp "^>>?[[:blank:]]"
> + "Regular expression matching the prompt of the inferior Lua process."
> + :type 'regexp
> + :group 'lua
> + :version "30.1")
> +
> +(defvar lua-ts--builtins
> + '("assert" "collectgarbage" "coroutine" "debug" "dofile"
> + "error" "getmetatable" "io" "ipairs" "load" "loadfile"
> + "math" "next" "os" "package" "pairs" "pcall" "print"
> + "rawequal" "rawget" "rawlen" "rawset" "require" "select"
> + "setmetatable" "string" "table" "tonumber" "tostring"
> + "type" "utf8" "warn" "xpcall"
> + ;; methods for file handlers
> + "close" "flush" "lines" "read" "seek" "setvbuf" "write")
> + "Lua built-in functions for tree-sitter font-locking.")
> +
> +(defvar lua-ts--font-lock-settings
> + (treesit-font-lock-rules
> + :language 'lua
> + :feature 'bracket
> + '(["(" ")" "[" "]" "{" "}"] @font-lock-bracket-face)
> +
> + :language 'lua
> + :feature 'delimiter
> + '(["," ";"] @font-lock-delimiter-face)
> +
> + :language 'lua
> + :feature 'escape
> + '((escape_sequence) @font-lock-escape-face)
> +
> + :language 'lua
> + :feature 'constant
> + '((variable_list
> + attribute: (attribute (["<" ">"] (identifier))))
> + @font-lock-constant-face)
> +
> + :language 'lua
> + :feature 'operator
> + '(["and" "not" "or" "+" "-" "*" "/" "%" "^"
> + "#" "==" "~=" "<=" ">=" "<" ">" "=" "&"
> + "~" "|" "<<" ">>" "//" ".."]
> + @font-lock-operator-face
> + (vararg_expression) @font-lock-operator-face)
> +
> + :language 'lua
> + :feature 'property
> + '((field name: (identifier) @font-lock-property-name-face)
> + (dot_index_expression
> + field: (identifier) @font-lock-property-use-face))
> +
> + :language 'lua
> + :feature 'builtin
> + `(((identifier) @font-lock-builtin-face
> + (:match ,(regexp-opt lua-ts--builtins 'symbols)
> + @font-lock-builtin-face)))
> +
> + :language 'lua
> + :feature 'function
> + '((function_call name: (identifier) @font-lock-function-call-face)
> + (function_call
> + name: (method_index_expression
> + method: (identifier) @font-lock-function-call-face))
> + (function_call
> + name: (dot_index_expression
> + table: (identifier) @font-lock-function-call-face)))
> +
> + :language 'lua
> + :feature 'punctuation
> + '(["." ":"] @font-lock-punctuation-face)
> +
> + :language 'lua
> + :feature 'variable
> + '((function_call
> + arguments: (arguments (identifier))
> + @font-lock-variable-use-face)
> + (function_call
> + name: (method_index_expression
> + table: (identifier) @font-lock-variable-use-face))
> + (goto_statement (identifier) @font-lock-variable-use-face))
> +
> + :language 'lua
> + :feature 'assignment
> + '((variable_list (identifier) @font-lock-variable-name-face))
> +
> + :language 'lua
> + :feature 'number
> + '((number) @font-lock-number-face)
> +
> + :language 'lua
> + :feature 'keyword
> + '((break_statement) @font-lock-keyword-face
> + (true) @font-lock-constant-face
> + (false) @font-lock-constant-face
> + (nil) @font-lock-constant-face
> + ["and" "do" "else" "elseif" "end" "for" "function"
> + "goto" "if" "in" "local" "not" "or" "repeat"
> + "return" "then" "until" "while"]
> + @font-lock-keyword-face)
> +
> + :language 'lua
> + :feature 'string
> + '((string) @font-lock-string-face)
> +
> + :language 'lua
> + :feature 'comment
> + '((comment) @font-lock-comment-face
> + (hash_bang_line) @font-lock-comment-face)
> +
> + :language 'lua
> + :feature 'definition
> + '((function_declaration
> + name: (identifier) @font-lock-function-name-face)
> + (parameters
> + name: (identifier) @font-lock-variable-name-face)
> + (label_statement) @font-lock-variable-name-face)
> +
> + :language 'lua
> + :feature 'error
> + :override t
> + '((ERROR) @font-lock-warning-face))
> + "Tree-sitter font-lock settings for `lua-ts-mode'.")
> +
> +(defvar lua-ts--simple-indent-rules
> + `((lua
> + ((parent-is "chunk") column-0 0)
> + ((node-is "comment_end") column-0 0)
> + ((parent-is "block") parent-bol 0)
> + ((node-is "}") parent-bol 0)
> + ((node-is ")") parent-bol 0)
> + ((node-is "else_statement") parent-bol 0)
> + ((node-is "elseif_statement") parent-bol 0)
> + ((node-is "end") parent-bol 0)
> + ((node-is "until") parent-bol 0)
> + ((parent-is "for_statement") parent-bol lua-ts-indent-offset)
> + ((parent-is "function_declaration") parent-bol lua-ts-indent-offset)
> + ((parent-is "function_definition") parent-bol lua-ts-indent-offset)
> + ((parent-is "if_statement") parent-bol lua-ts-indent-offset)
> + ((parent-is "else_statement") parent-bol lua-ts-indent-offset)
> + ((parent-is "repeat_statement") parent-bol lua-ts-indent-offset)
> + ((parent-is "while_statement") parent-bol lua-ts-indent-offset)
> + ((parent-is "table_constructor") parent-bol lua-ts-indent-offset)
> + ((parent-is "arguments") parent-bol lua-ts-indent-offset)
> + ((parent-is "parameters") parent-bol lua-ts-indent-offset)
> + ((parent-is "ERROR") no-indent 0))))
> +
> +(defvar lua-ts--syntax-table
> + (let ((table (make-syntax-table)))
> + (modify-syntax-entry ?+ "." table)
> + (modify-syntax-entry ?- ". 12" table)
> + (modify-syntax-entry ?= "." table)
> + (modify-syntax-entry ?% "." table)
> + (modify-syntax-entry ?^ "." table)
> + (modify-syntax-entry ?~ "." table)
> + (modify-syntax-entry ?< "." table)
> + (modify-syntax-entry ?> "." table)
> + (modify-syntax-entry ?/ "." table)
> + (modify-syntax-entry ?* "." table)
> + (modify-syntax-entry ?\n ">" table)
> + (modify-syntax-entry ?\' "\"" table)
> + (modify-syntax-entry ?\" "\"" table)
> + table)
> + "Syntax table for `lua-ts-mode'.")
> +
> +(defun lua-ts--defun-name-function (node)
> + "Return the defun name of NODE.
> +Return nil if there is no name or if NODE is not a defun node."
> + (let ((child (treesit-node-child-by-field-name node "name")))
> + (pcase (treesit-node-type node)
> + ((or "function_declaration" "function_definition")
> + (treesit-node-text child t))
> + ("variable_declaration"
> + (if child
> + (treesit-node-text child t)
> + (treesit-node-text
> + (treesit-node-child-by-field-name
> + (treesit-search-subtree node "assignment_statement" nil nil 1)
> + "name"))))
> + ("field"
> + (and (treesit-search-subtree node "function_definition" nil nil 1)
> + (treesit-node-text child t))))))
> +
> +(defun lua-ts--builtin-p (node)
> + "Return t if the NODE is a builtin or nil if not."
> + (let ((name (pcase (treesit-node-type node)
> + ("dot_index_expression"
> + (car (string-split (treesit-node-text node t) "\\." t)))
> + ("function_call"
> + (let* ((child (treesit-node-child-by-field-name node "name"))
> + (text (treesit-node-text child t)))
> + (if (string-match-p ":" text)
> + (cadr (string-split text ":" t))
> + text))))))
> + (and name (string-match-p (regexp-opt lua-ts--builtins 'words) name))))
> +
> +(defvar-local lua-ts--flymake-process nil)
> +
> +(defun lua-ts-flymake-luacheck (report-fn &rest _args)
> + "Luacheck backend for Flymake.
> +Calls REPORT-FN directly."
> + (when (process-live-p lua-ts--flymake-process)
> + (kill-process lua-ts--flymake-process))
> + (let ((source (current-buffer)))
> + (save-restriction
> + (widen)
> + (setq lua-ts--flymake-process
> + (make-process
> + :name "lua-ts-flymake-luacheck"
> + :noquery t
> + :connection-type 'pipe
> + :buffer (generate-new-buffer " *lua-ts-flymake-luacheck*")
> + :command `(,lua-ts-luacheck-program
> + "--codes" "--ranges" "--formatter" "plain" "-")
> + :sentinel
> + (lambda (proc _event)
> + (when (eq 'exit (process-status proc))
> + (unwind-protect
> + (if (with-current-buffer source
> + (eq proc lua-ts--flymake-process))
> + (with-current-buffer (process-buffer proc)
> + (goto-char (point-min))
> + (cl-loop
> + while (search-forward-regexp
> + (rx (seq bol
> + (0+ alnum) ":"
> + (group (1+ digit)) ":"
> + (group (1+ digit)) "-"
> + (group (1+ digit)) ": "
> + (group (0+ nonl))
> + eol))
> + nil t)
> + for line = (string-to-number (match-string 1))
> + for beg = (string-to-number (match-string 2))
> + for end = (string-to-number (match-string 3))
> + for msg = (match-string 4)
> + for type = (if (string-match "^(W" msg)
> + :warning
> + :error)
> + when (and beg end)
> + collect (flymake-make-diagnostic source
> + (cons line beg)
> + (cons line (1+ end))
> + type
> + msg)
> + into diags
> + finally (funcall report-fn diags)))
> + (flymake-log :warning "Canceling obsolete check %s" proc))
> + (kill-buffer (process-buffer proc)))))))
> + (process-send-region lua-ts--flymake-process (point-min) (point-max))
> + (process-send-eof lua-ts--flymake-process))))
> +
> +(defun lua-ts-documentation-at-point ()
> + "Show documentation of function at point in Lua manual."
> + (interactive)
> + (unless (string-blank-p lua-ts-lua-manual)
> + (let ((character-before (char-to-string (char-before)))
> + id)
> + (save-excursion
> + ;; When point is mid-word `treesit-thing-at-point'
> + ;; may return the parent node of the thing at point.
> + (unless (or (bolp)
> + (not (string-match-p "[[:alnum:]]" character-before)))
> + (backward-word))
> + (let ((node (treesit-thing-at-point 'builtin nil)))
> + (setq id (pcase (treesit-node-type node)
> + ("dot_index_expression" (treesit-node-text node t))
> + ("function_call"
> + (let* ((child (treesit-node-child-by-field-name node "name"))
> + (name (treesit-node-text child t)))
> + (if (string-match-p ":" name)
> + (replace-regexp-in-string "^.*:" "file:" name)
> + name)))))))
> + (when id (browse-url (concat lua-ts-lua-manual "#pdf-" id))))))
> +
> +;;;###autoload
> +(defun inferior-lua ()
> + "Run the Lua interpreter in an inferior process."
> + (interactive)
> + (let ((buffer (get-buffer-create inferior-lua-buffer))
> + (program inferior-lua-interpreter)
> + (switches inferior-lua-switches)
> + (startfile (unless (string-blank-p inferior-lua-startfile)
> + (expand-file-name inferior-lua-startfile))))
> + (make-comint-in-buffer program buffer program startfile switches)
> + (with-current-buffer buffer
> + (setq-local comint-input-ignoredups t
> + comint-prompt-read-only t
> + comint-prompt-regexp inferior-lua-prompt-regexp
> + comint-use-prompt-regexp t))
> + (pop-to-buffer buffer)))
> +
> +;;;###autoload
> +(define-derived-mode lua-ts-mode prog-mode "Lua"
> + "Major mode for editing Lua files, powered by tree-sitter."
> + :group 'lua
The :group is redundant here, it will automatically use the last
defgroup defined in the file.
> + :syntax-table lua-ts--syntax-table
> +
> + (when (treesit-ready-p 'lua)
> + (treesit-parser-create 'lua)
> +
> + (setq-local treesit-thing-settings
> + '((lua . ((builtin lua-ts--builtin-p)))))
> +
> + ;; Comments.
> + (setq-local comment-start "--")
> + (setq-local comment-start-skip "--\\s-*")
> + (setq-local comment-end "")
> +
> + ;; Font-lock.
> + (setq-local treesit-font-lock-settings lua-ts--font-lock-settings)
> +
> + (setq-local treesit-font-lock-feature-list
> + '((comment definition)
> + (keyword property string)
> + (assignment builtin constant number)
> + (bracket
> + delimiter
> + escape
> + function
> + operator
> + punctuation
> + variable)))
> +
> + ;; Indent.
> + (setq-local treesit-simple-indent-rules lua-ts--simple-indent-rules)
> +
> + ;; Navigation.
> + (setq-local treesit-defun-name-function #'lua-ts--defun-name-function)
> +
> + (setq-local treesit-defun-type-regexp
> + (rx (or "function_declaration" "function_definition")))
> +
> + (setq-local treesit-sentence-type-regexp
> + (rx (or "do_statement" "while_statement" "repeat_statement"
> + "if_statement" "for_statement" "variable_declaration")))
> +
> + (setq-local treesit-sexp-type-regexp
> + (rx (or "arguments" "comment" "string" "table_constructor")))
> +
> + ;; Imenu.
> + (setq-local treesit-simple-imenu-settings
> + `(("Variable" ,(rx bos "variable_declaration" eos) nil nil)
> + ("Function" ,(rx bos
> + (or "function_declaration"
> + "function_definition"
> + "field")
> + eos)
> + nil nil)))
> +
> + ;; Which-function.
> + (setq-local which-func-functions (treesit-defun-at-point))
> +
> + ;; Outline.
> + (setq-local outline-regexp
> + (rx (or "--[[" "do" "for" "if" "repeat" "while"
> + (seq (** 0 1 "local ") "function"))))
> +
> + (treesit-major-mode-setup))
> +
> + (add-hook 'flymake-diagnostic-functions #'lua-ts-flymake-luacheck nil 'local))
> +
> +(if (treesit-ready-p 'lua)
> + (add-to-list 'auto-mode-alist '("\\.lua\\'" . lua-ts-mode)))
> +
> +(provide 'lua-ts-mode)
> +
> +;;; lua-ts-mode.el ends here
> diff --git a/test/infra/Dockerfile.emba b/test/infra/Dockerfile.emba
> index 584e4444dc1..e29098ec270 100644
> --- a/test/infra/Dockerfile.emba
> +++ b/test/infra/Dockerfile.emba
> @@ -126,6 +126,7 @@ RUN src/emacs -Q --batch \
> (java "https://github.com/tree-sitter/tree-sitter-java") \
> (javascript "https://github.com/tree-sitter/tree-sitter-javascript") \
> (json "https://github.com/tree-sitter/tree-sitter-json") \
> + (lua "https://github.com/MunifTanjim/tree-sitter-lua") \
> (python "https://github.com/tree-sitter/tree-sitter-python") \
> (ruby "https://github.com/tree-sitter/tree-sitter-ruby") \
> (tsx "https://github.com/tree-sitter/tree-sitter-typescript" "master" "tsx/src") \
> diff --git a/test/infra/test-jobs.yml b/test/infra/test-jobs.yml
> index 2f6e0dab4d5..1f5d607eda4 100644
> --- a/test/infra/test-jobs.yml
> +++ b/test/infra/test-jobs.yml
> @@ -580,6 +580,7 @@ test-src-inotify:
> lisp/progmodes/go-ts-mode-tests.log
> lisp/progmodes/heex-ts-mode-tests.log
> lisp/progmodes/java-ts-mode-tests.log
> + lisp/progmodes/lua-ts-mode-tests.log
> lisp/progmodes/ruby-ts-mode-tests.log
> lisp/progmodes/typescript-ts-mode-tests.log
> src/treesit-tests.log
> diff --git a/test/lisp/progmodes/lua-ts-mode-resources/indent.erts b/test/lisp/progmodes/lua-ts-mode-resources/indent.erts
> new file mode 100644
> index 00000000000..040225c8580
> --- /dev/null
> +++ b/test/lisp/progmodes/lua-ts-mode-resources/indent.erts
> @@ -0,0 +1,152 @@
> +Code:
> + (lambda ()
> + (setq indent-tabs-mode nil)
> + (setq lua-ts-indent-offset 2)
> + (lua-ts-mode)
> + (indent-region (point-min) (point-max)))
> +
> +Name: Basic Indent
> +
> +=-=
> + print(
> +0,
> + 1
> +)
> +
> +local function f(o)
> + if o.x > o.y then
> + return o.x
> +elseif o.y > o.z then
> + return o.y
> + else
> +return o.z
> + end
> +end
> +
> +f({
> + x = 1,
> + y = 2,
> + z = 3,
> +})
> +
> +;(function()
> +return false
> +)()
> +=-=
> +print(
> + 0,
> + 1
> +)
> +
> +local function f(o)
> + if o.x > o.y then
> + return o.x
> + elseif o.y > o.z then
> + return o.y
> + else
> + return o.z
> + end
> +end
> +
> +f({
> + x = 1,
> + y = 2,
> + z = 3,
> +})
> +
> +;(function()
> + return false
> +)()
> +=-=-=
> +
> +Name: Argument Indent
> +
> +=-=
> +function h(
> +string,
> +number,
> +options)
> +print(string, number, options)
> +end
> +
> +local p = h(
> +"sring",
> + 1000,
> + {
> +cost = 2,
> +length = 8,
> + parallelism = 4,
> +})
> +=-=
> +function h(
> + string,
> + number,
> + options)
> + print(string, number, options)
> +end
> +
> +local p = h(
> + "sring",
> + 1000,
> + {
> + cost = 2,
> + length = 8,
> + parallelism = 4,
> + })
> +=-=-=
> +
> +Name: Continuation Indent
> +
> +=-=
> +function f()
> + local str = [[
> + multi-line
> + string
> + ]]
> +--[[
> +multi-line
> +comment
> + ]]
> +return true
> +end
> +=-=
> +function f()
> + local str = [[
> + multi-line
> + string
> + ]]
> + --[[
> +multi-line
> +comment
> + ]]
> + return true
> +end
> +=-=-=
> +
> +Name: Loop Indent
> +
> +=-=
> +for k, v in pairs({}) do
> + print(k, v)
> +end
> +
> +while n < 10 do
> +n = n + 1
> +end
> +
> +repeat
> +z = z * 2
> + until z > 12
> +=-=
> +for k, v in pairs({}) do
> + print(k, v)
> +end
> +
> +while n < 10 do
> + n = n + 1
> +end
> +
> +repeat
> + z = z * 2
> +until z > 12
> +=-=-=
> diff --git a/test/lisp/progmodes/lua-ts-mode-tests.el b/test/lisp/progmodes/lua-ts-mode-tests.el
> new file mode 100644
> index 00000000000..62ec2652ba8
> --- /dev/null
> +++ b/test/lisp/progmodes/lua-ts-mode-tests.el
> @@ -0,0 +1,32 @@
> +;;; lua-ts-mode-tests.el --- Tests for lua-ts-mode -*- lexical-binding: t; -*-
> +
> +;; Copyright (C) 2023 Free Software Foundation, Inc.
> +
> +;; 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/>.
> +
> +;;; Code:
> +
> +(require 'ert)
> +(require 'ert-x)
> +(require 'treesit)
> +
> +(ert-deftest lua-ts-mode-test-indentation ()
> + (skip-unless (treesit-ready-p 'lua))
> + (ert-test-erts-file (ert-resource-file "indent.erts")))
> +
> +(provide 'lua-ts-mode-tests)
> +
> +;;; lua-ts-mode-tests.el ends here
^ permalink raw reply [flat|nested] 16+ messages in thread
* bug#65672: [PATCH emacs 1/1] Add lua-ts-mode
2023-08-31 21:32 ` bug#65672: [PATCH emacs 1/1] " ~johnmuhl
2023-09-02 12:14 ` bug#65673: [PATCH emacs 0/1] " Philip Kaludercic
@ 2023-09-02 14:10 ` Augusto Stoffel
[not found] ` <handler.65672.B.169354983214451.ack@debbugs.gnu.org>
2 siblings, 0 replies; 16+ messages in thread
From: Augusto Stoffel @ 2023-09-02 14:10 UTC (permalink / raw)
To: ~johnmuhl; +Cc: ~johnmuhl, ~emacs/emacs-devel, 65672
On Thu, 31 Aug 2023 at 16:32, ~johnmuhl wrote:
> +(defcustom inferior-lua-switches "-i"
> + "Command line options for the inferior Lua process."
> + :type 'string
> + :safe 'stringp
> + :group 'lua
> + :version "30.1")
This should be given as a list of strings rather a string that you later
need to call split-string-shell-command on.
Also, I think it's probably best to use the same lua-ts- prefix for the
Lua shell variables and command. If you're really fond of a
`inferior-lua' or `run-lua' command, it could be an alias (but then one
might need to think about what to do about name clashes when one of the
other Lua modes is installed).
> +(defcustom inferior-lua-startfile ""
> + "File to load into the inferior Lua process at startup."
> + :type 'string
> + :safe 'stringp
> + :group 'lua
> + :version "30.1")
This should be nil by default.
> +(defun lua-ts-documentation-at-point ()
> + "Show documentation of function at point in Lua manual."
> + (interactive)
> + (unless (string-blank-p lua-ts-lua-manual)
> + (let ((character-before (char-to-string (char-before)))
> + id)
> + (save-excursion
> + ;; When point is mid-word `treesit-thing-at-point'
> + ;; may return the parent node of the thing at point.
> + (unless (or (bolp)
> + (not (string-match-p "[[:alnum:]]" character-before)))
> + (backward-word))
> + (let ((node (treesit-thing-at-point 'builtin nil)))
> + (setq id (pcase (treesit-node-type node)
> + ("dot_index_expression" (treesit-node-text node t))
> + ("function_call"
> + (let* ((child (treesit-node-child-by-field-name node "name"))
> + (name (treesit-node-text child t)))
> + (if (string-match-p ":" name)
> + (replace-regexp-in-string "^.*:" "file:" name)
> + name)))))))
> + (when id (browse-url (concat lua-ts-lua-manual "#pdf-" id))))))
I wouldn't add this command. It's not polished enough and too ad-hoc in
the sense that this functionality is (or should be) covered by other
mechanisms: Info, Eldoc, etc.
> + ;; Outline.
> + (setq-local outline-regexp
> + (rx (or "--[[" "do" "for" "if" "repeat" "while"
> + (seq (** 0 1 "local ") "function"))))
What is the idea behind "--[["? Should one allow whitespace in front of
these strings (also inferring the outline level from that)? Also, one
should allow arbitrary whitespace after "local" (I'd say "local\\s-+")
and enclose the keywords with "\\_<...\\_>".
In general, this looks nice, thanks!
^ permalink raw reply [flat|nested] 16+ messages in thread
* bug#65672: [PATCH emacs 1/1] Add lua-ts-mode
[not found] ` <handler.65672.B.169354983214451.ack@debbugs.gnu.org>
@ 2023-09-04 14:36 ` john muhl via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-04 15:18 ` Eli Zaretskii
2023-09-04 15:54 ` Philip Kaludercic
0 siblings, 2 replies; 16+ messages in thread
From: john muhl via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2023-09-04 14:36 UTC (permalink / raw)
To: 65672; +Cc: Philip Kaludercic, Augusto Stoffel, Mauro Aranda
Thanks everyone for the comments. Is it easier for review to send just
the changed parts or resend the complete patch?
^ permalink raw reply [flat|nested] 16+ messages in thread
* bug#65672: [PATCH emacs 1/1] Add lua-ts-mode
2023-09-04 14:36 ` john muhl via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2023-09-04 15:18 ` Eli Zaretskii
2023-09-04 15:54 ` Philip Kaludercic
1 sibling, 0 replies; 16+ messages in thread
From: Eli Zaretskii @ 2023-09-04 15:18 UTC (permalink / raw)
To: john muhl; +Cc: philipk, arstoffel, maurooaranda, 65672
> Cc: Philip Kaludercic <philipk@posteo.net>,
> Augusto Stoffel <arstoffel@gmail.com>, Mauro Aranda <maurooaranda@gmail.com>
> Date: Mon, 04 Sep 2023 09:36:10 -0500
> From: john muhl via "Bug reports for GNU Emacs,
> the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
>
> Thanks everyone for the comments. Is it easier for review to send just
> the changed parts or resend the complete patch?
Please send a complete patch with all the changes.
Thanks.
^ permalink raw reply [flat|nested] 16+ messages in thread
* bug#65672: [PATCH emacs 1/1] Add lua-ts-mode
2023-09-04 14:36 ` john muhl via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-04 15:18 ` Eli Zaretskii
@ 2023-09-04 15:54 ` Philip Kaludercic
1 sibling, 0 replies; 16+ messages in thread
From: Philip Kaludercic @ 2023-09-04 15:54 UTC (permalink / raw)
To: john muhl; +Cc: Augusto Stoffel, Mauro Aranda, 65672
john muhl <jm@pub.pink> writes:
> Thanks everyone for the comments. Is it easier for review to send just
> the changed parts or resend the complete patch?
If possible, it would be nice if you could send your next patch using
git send-patch or by attaching a patch created using git format-patch,
because it seems the Sourcehut interface sends the message from an
address I cannot respond to, causing me to receive multiple "message not
delivered" notifications from my mail provider.
^ permalink raw reply [flat|nested] 16+ messages in thread
* bug#65673: [PATCH emacs 1/1 v2] Add lua-ts-mode
2023-08-31 22:55 bug#65673: [PATCH emacs 0/1] Add lua-ts-mode ~johnmuhl
2023-08-31 21:32 ` bug#65672: [PATCH emacs 1/1] " ~johnmuhl
2023-09-01 22:46 ` bug#65673: [PATCH emacs 0/1] " Mauro Aranda
@ 2023-09-09 15:17 ` john muhl via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-09 15:17 ` bug#65673: [PATCH] " john muhl via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-11 15:03 ` john muhl via Bug reports for GNU Emacs, the Swiss army knife of text editors
3 siblings, 1 reply; 16+ messages in thread
From: john muhl via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2023-09-09 15:17 UTC (permalink / raw)
To: 65673; +Cc: philipk, arstoffel, maurooaranda, ~emacs/emacs-devel
Mauro Aranda <maurooaranda@gmail.com> writes:
> I just have some comments/questions about the defcustoms:
Fixed.
Philip Kaludercic <philipk@posteo.net> writes:
> ~johnmuhl <johnmuhl@git.sr.ht> writes:
>
>> +(defcustom lua-ts-lua-manual
>> + (if (file-readable-p "/usr/share/doc/lua/manual.html")
>> + "file:///usr/share/doc/lua/manual.html" "")
>> + "Location of the Lua `manual.html' file."
>> + :type 'string
>> + :safe 'stringp
>> + :group 'lua
>> + :version "30.1")
>
> Could this fall back to some online manual?
I went with Augusto’s suggestion and removed the documentation
command.
>> +(defcustom inferior-lua-interpreter "lua"
>> + "Program to run in the inferior Lua process."
>> + :type 'string
>> + :safe 'stringp
>> + :group 'lua
>> + :version "30.1")
>
> Are you sure that any string is safe? That would include "rm -rf ~".
Fixed here and for the startfile and command line options.
>> +;;;###autoload
>> +(define-derived-mode lua-ts-mode prog-mode "Lua"
>> + "Major mode for editing Lua files, powered by tree-sitter."
>> + :group 'lua
>
> The :group is redundant here, it will automatically use the last
> defgroup defined in the file.
Fixed.
Augusto Stoffel <arstoffel@gmail.com> writes:
> On Thu, 31 Aug 2023 at 16:32, ~johnmuhl wrote:
>
>> +(defcustom inferior-lua-switches "-i"
>> + "Command line options for the inferior Lua process."
>> + :type 'string
>> + :safe 'stringp
>> + :group 'lua
>> + :version "30.1")
>
> This should be given as a list of strings rather a string that you later
> need to call split-string-shell-command on.
Fixed.
> Also, I think it's probably best to use the same lua-ts- prefix
Changed to lua-ts-inferior-*
>> +(defun lua-ts-documentation-at-point ()
>> + "Show documentation of function at point in Lua manual."
>> + (interactive)
>> + (unless (string-blank-p lua-ts-lua-manual)
>> + (let ((character-before (char-to-string (char-before)))
>> + id)
>> + (save-excursion
>> + ;; When point is mid-word `treesit-thing-at-point'
>> + ;; may return the parent node of the thing at point.
>> + (unless (or (bolp)
>> + (not (string-match-p "[[:alnum:]]" character-before)))
>> + (backward-word))
>> + (let ((node (treesit-thing-at-point 'builtin nil)))
>> + (setq id (pcase (treesit-node-type node)
>> + ("dot_index_expression" (treesit-node-text node t))
>> + ("function_call"
>> + (let* ((child (treesit-node-child-by-field-name node "name"))
>> + (name (treesit-node-text child t)))
>> + (if (string-match-p ":" name)
>> + (replace-regexp-in-string "^.*:" "file:" name)
>> + name)))))))
>> + (when id (browse-url (concat lua-ts-lua-manual "#pdf-" id))))))
>
> I wouldn't add this command. It's not polished enough and too ad-hoc in
> the sense that this functionality is (or should be) covered by other
> mechanisms: Info, Eldoc, etc.
Removed.
>> + ;; Outline.
>> + (setq-local outline-regexp
>> + (rx (or "--[[" "do" "for" "if" "repeat" "while"
>> + (seq (** 0 1 "local ") "function"))))
>
> What is the idea behind "--[["?
I like the way o-m-m folds the header sections of elisp files and
since my lua files often start with a multi-line comment containing
similar information I added it to get that effect in lua too.
> Should one allow whitespace in front of these strings (also inferring
> the outline level from that)?
Done.
> Also, one should allow arbitrary whitespace after "local" (I'd say
> "local\\s-+") and enclose the keywords with "\\_<...\\_>".
Fixed.
^ permalink raw reply [flat|nested] 16+ messages in thread
* bug#65673: [PATCH] Add lua-ts-mode
2023-09-09 15:17 ` bug#65673: [PATCH emacs 1/1 v2] " john muhl via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2023-09-09 15:17 ` john muhl via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-10 11:12 ` Philip Kaludercic
0 siblings, 1 reply; 16+ messages in thread
From: john muhl via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2023-09-09 15:17 UTC (permalink / raw)
To: 65673; +Cc: philipk, john muhl, arstoffel, maurooaranda, ~emacs/emacs-devel
* lisp/progmodes/lua-ts-mode.el:
* test/lisp/progmodes/lua-ts-mode-resources/indent.erts:
* test/lisp/progmodes/lua-ts-mode-tests.el: New file.
* etc/NEWS: Mention new mode.
* lisp/progmodes/eglot.el (eglot-server-programs):
* lisp/progmodes/hideshow.el (hs-special-modes-alist): Support
lua-ts-mode.
* admin/notes/tree-sitter/build-module/batch.sh:
* admin/notes/tree-sitter/build-module/build.sh: Add Lua.
* test/infra/Dockerfile.emba:
* test/infra/test-jobs.yml: Include lua-ts-mode tests.
---
admin/notes/tree-sitter/build-module/batch.sh | 1 +
admin/notes/tree-sitter/build-module/build.sh | 3 +
etc/NEWS | 4 +
lisp/progmodes/eglot.el | 4 +-
lisp/progmodes/hideshow.el | 1 +
lisp/progmodes/lua-ts-mode.el | 419 +++++++++++++
test/infra/Dockerfile.emba | 1 +
test/infra/test-jobs.yml | 1 +
.../lua-ts-mode-resources/indent.erts | 152 +++++
.../lua-ts-mode-resources/movement.erts | 553 ++++++++++++++++++
test/lisp/progmodes/lua-ts-mode-tests.el | 36 ++
11 files changed, 1173 insertions(+), 2 deletions(-)
create mode 100644 lisp/progmodes/lua-ts-mode.el
create mode 100644 test/lisp/progmodes/lua-ts-mode-resources/indent.erts
create mode 100644 test/lisp/progmodes/lua-ts-mode-resources/movement.erts
create mode 100644 test/lisp/progmodes/lua-ts-mode-tests.el
diff --git a/admin/notes/tree-sitter/build-module/batch.sh b/admin/notes/tree-sitter/build-module/batch.sh
index 3c4e1472c89..9988d1eae4e 100755
--- a/admin/notes/tree-sitter/build-module/batch.sh
+++ b/admin/notes/tree-sitter/build-module/batch.sh
@@ -16,6 +16,7 @@ languages=
'java'
'javascript'
'json'
+ 'lua'
'python'
'rust'
'toml'
diff --git a/admin/notes/tree-sitter/build-module/build.sh b/admin/notes/tree-sitter/build-module/build.sh
index 0832875168b..969187b7f92 100755
--- a/admin/notes/tree-sitter/build-module/build.sh
+++ b/admin/notes/tree-sitter/build-module/build.sh
@@ -42,6 +42,9 @@ grammardir=
"heex")
org="phoenixframework"
;;
+ "lua")
+ org="MunifTanjim"
+ ;;
"typescript")
sourcedir="tree-sitter-typescript/typescript/src"
grammardir="tree-sitter-typescript/typescript"
diff --git a/etc/NEWS b/etc/NEWS
index 51e89fc96dd..0b7da8b392c 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -782,6 +782,10 @@ It highlight parens via ‘show-paren-mode’ and ‘blink-matching-paren’ in
a user-friendly way, avoids reporting alleged paren mismatches and makes
sexp navigation more intuitive.
+---
+*** New major mode 'lua-ts-mode'.
+A major mode based on the tree-sitter library for editing Lua files.
+
---
** The highly accessible Modus themes collection has eight items.
The 'modus-operandi' and 'modus-vivendi' are the main themes that have
diff --git a/lisp/progmodes/eglot.el b/lisp/progmodes/eglot.el
index f7c7c29c094..e2f663998d3 100644
--- a/lisp/progmodes/eglot.el
+++ b/lisp/progmodes/eglot.el
@@ -268,8 +268,8 @@ eglot-server-programs
(gdscript-mode . ("localhost" 6008))
((fortran-mode f90-mode) . ("fortls"))
(futhark-mode . ("futhark" "lsp"))
- (lua-mode . ,(eglot-alternatives
- '("lua-language-server" "lua-lsp")))
+ ((lua-mode lua-ts-mode) . ,(eglot-alternatives
+ '("lua-language-server" "lua-lsp")))
(zig-mode . ("zls"))
((css-mode css-ts-mode)
. ,(eglot-alternatives '(("vscode-css-language-server" "--stdio")
diff --git a/lisp/progmodes/hideshow.el b/lisp/progmodes/hideshow.el
index b878986d7a4..78e39fad740 100644
--- a/lisp/progmodes/hideshow.el
+++ b/lisp/progmodes/hideshow.el
@@ -264,6 +264,7 @@ hs-special-modes-alist
(java-ts-mode "{" "}" "/[*/]" nil nil)
(js-mode "{" "}" "/[*/]" nil)
(js-ts-mode "{" "}" "/[*/]" nil)
+ (lua-ts-mode "{\\|\\[\\[" "}\\|\\]\\]" "--" nil)
(mhtml-mode "{\\|<[^/>]*?" "}\\|</[^/>]*[^/]>" "<!--" mhtml-forward nil)
;; Add more support here.
))
diff --git a/lisp/progmodes/lua-ts-mode.el b/lisp/progmodes/lua-ts-mode.el
new file mode 100644
index 00000000000..b7fe71c5fe2
--- /dev/null
+++ b/lisp/progmodes/lua-ts-mode.el
@@ -0,0 +1,419 @@
+;;; lua-ts-mode.el --- Major mode for editing Lua files -*- lexical-binding: t -*-
+
+;; Copyright (C) 2023 Free Software Foundation, Inc.
+
+;; Author: John Muhl <jm@pub.pink>
+;; Created: June 27, 2023
+;; Keywords: lua 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:
+
+;; This package provides `lua-ts-mode' which is a major mode for Lua
+;; files that uses Tree Sitter to parse the language.
+;;
+;; This package is compatible with and tested against the grammar
+;; for Lua found at https://github.com/MunifTanjim/tree-sitter-lua
+
+;;; Code:
+
+(require 'comint)
+(require 'treesit)
+
+(eval-when-compile
+ (require 'cl-lib)
+ (require 'rx))
+
+(defcustom lua-ts-indent-offset 4
+ "Number of spaces for each indentation step in `lua-ts-mode'."
+ :type 'natnum
+ :safe 'natnump
+ :group 'lua
+ :version "30.1")
+
+(defcustom lua-ts-luacheck-program (executable-find "luacheck")
+ "Location of the Luacheck program."
+ :type '(choice (const nil) (file :must-match t))
+ :group 'lua
+ :version "30.1")
+
+(defcustom lua-ts-inferior-buffer "Lua"
+ "Name of the inferior Lua buffer."
+ :type 'string
+ :safe 'stringp
+ :group 'lua
+ :version "30.1")
+
+(defcustom lua-ts-inferior-program (executable-find "lua")
+ "Program to run in the inferior Lua process."
+ :type '(choice (const nil) (file :must-match t))
+ :group 'lua
+ :version "30.1")
+
+(defcustom lua-ts-inferior-options '("-i")
+ "Command line options for the inferior Lua process."
+ :type '(repeat string)
+ :group 'lua
+ :version "30.1")
+
+(defcustom lua-ts-inferior-startfile nil
+ "File to load into the inferior Lua process at startup."
+ :type '(choice (const nil) (file :must-match t))
+ :group 'lua
+ :version "30.1")
+
+(defcustom lua-ts-inferior-prompt-regexp "^>>?[[:blank:]]"
+ "Regular expression matching the prompt of the inferior Lua process."
+ :type 'regexp
+ :group 'lua
+ :version "30.1")
+
+(defvar lua-ts--builtins
+ '("assert" "bit32" "collectgarbage" "coroutine" "debug" "dofile"
+ "error" "getmetatable" "io" "ipairs" "load" "loadfile"
+ "math" "next" "os" "package" "pairs" "pcall" "print"
+ "rawequal" "rawget" "rawlen" "rawset" "require" "select"
+ "setmetatable" "string" "table" "tonumber" "tostring"
+ "type" "utf8" "warn" "xpcall" "_G" "_VERSION"
+ ;; methods for file handlers
+ "close" "flush" "lines" "read" "seek" "setvbuf" "write")
+ "Lua built-in functions for tree-sitter font-locking.")
+
+(defvar lua-ts--font-lock-settings
+ (treesit-font-lock-rules
+ :language 'lua
+ :feature 'bracket
+ '(["(" ")" "[" "]" "{" "}"] @font-lock-bracket-face)
+
+ :language 'lua
+ :feature 'delimiter
+ '(["," ";"] @font-lock-delimiter-face)
+
+ :language 'lua
+ :feature 'escape
+ '((escape_sequence) @font-lock-escape-face)
+
+ :language 'lua
+ :feature 'constant
+ '((variable_list
+ attribute: (attribute (["<" ">"] (identifier))))
+ @font-lock-constant-face)
+
+ :language 'lua
+ :feature 'operator
+ '(["and" "not" "or" "+" "-" "*" "/" "%" "^"
+ "#" "==" "~=" "<=" ">=" "<" ">" "=" "&"
+ "~" "|" "<<" ">>" "//" ".."]
+ @font-lock-operator-face
+ (vararg_expression) @font-lock-operator-face)
+
+ :language 'lua
+ :feature 'property
+ '((field name: (identifier) @font-lock-property-name-face)
+ (dot_index_expression
+ field: (identifier) @font-lock-property-use-face))
+
+ :language 'lua
+ :feature 'builtin
+ `(((identifier) @font-lock-builtin-face
+ (:match ,(regexp-opt lua-ts--builtins 'symbols)
+ @font-lock-builtin-face)))
+
+ :language 'lua
+ :feature 'function
+ '((function_call name: (identifier) @font-lock-function-call-face)
+ (function_call
+ name: (method_index_expression
+ method: (identifier) @font-lock-function-call-face))
+ (function_call
+ name: (dot_index_expression
+ table: (identifier) @font-lock-function-call-face)))
+
+ :language 'lua
+ :feature 'punctuation
+ '(["." ":"] @font-lock-punctuation-face)
+
+ :language 'lua
+ :feature 'variable
+ '((function_call
+ arguments: (arguments (identifier))
+ @font-lock-variable-use-face)
+ (function_call
+ name: (method_index_expression
+ table: (identifier) @font-lock-variable-use-face))
+ (goto_statement (identifier) @font-lock-variable-use-face))
+
+ :language 'lua
+ :feature 'assignment
+ '((variable_list (identifier) @font-lock-variable-name-face))
+
+ :language 'lua
+ :feature 'number
+ '((number) @font-lock-number-face)
+
+ :language 'lua
+ :feature 'keyword
+ '((break_statement) @font-lock-keyword-face
+ (true) @font-lock-constant-face
+ (false) @font-lock-constant-face
+ (nil) @font-lock-constant-face
+ ["and" "do" "else" "elseif" "end" "for" "function"
+ "goto" "if" "in" "local" "not" "or" "repeat"
+ "return" "then" "until" "while"]
+ @font-lock-keyword-face)
+
+ :language 'lua
+ :feature 'string
+ '((string) @font-lock-string-face)
+
+ :language 'lua
+ :feature 'comment
+ '((comment) @font-lock-comment-face
+ (hash_bang_line) @font-lock-comment-face)
+
+ :language 'lua
+ :feature 'definition
+ '((function_declaration
+ name: (identifier) @font-lock-function-name-face)
+ (parameters
+ name: (identifier) @font-lock-variable-name-face)
+ (label_statement) @font-lock-variable-name-face)
+
+ :language 'lua
+ :feature 'error
+ :override t
+ '((ERROR) @font-lock-warning-face))
+ "Tree-sitter font-lock settings for `lua-ts-mode'.")
+
+(defvar lua-ts--simple-indent-rules
+ `((lua
+ ((parent-is "chunk") column-0 0)
+ ((node-is "comment_end") column-0 0)
+ ((parent-is "block") parent-bol 0)
+ ((node-is "}") parent-bol 0)
+ ((node-is ")") parent-bol 0)
+ ((node-is "else_statement") parent-bol 0)
+ ((node-is "elseif_statement") parent-bol 0)
+ ((node-is "end") parent-bol 0)
+ ((node-is "until") parent-bol 0)
+ ((parent-is "for_statement") parent-bol lua-ts-indent-offset)
+ ((parent-is "function_declaration") parent-bol lua-ts-indent-offset)
+ ((parent-is "function_definition") parent-bol lua-ts-indent-offset)
+ ((parent-is "if_statement") parent-bol lua-ts-indent-offset)
+ ((parent-is "else_statement") parent-bol lua-ts-indent-offset)
+ ((parent-is "repeat_statement") parent-bol lua-ts-indent-offset)
+ ((parent-is "while_statement") parent-bol lua-ts-indent-offset)
+ ((parent-is "table_constructor") parent-bol lua-ts-indent-offset)
+ ((parent-is "arguments") parent-bol lua-ts-indent-offset)
+ ((parent-is "parameters") parent-bol lua-ts-indent-offset)
+ ((parent-is "ERROR") no-indent 0))))
+
+(defvar lua-ts--syntax-table
+ (let ((table (make-syntax-table)))
+ (modify-syntax-entry ?+ "." table)
+ (modify-syntax-entry ?- ". 12" table)
+ (modify-syntax-entry ?= "." table)
+ (modify-syntax-entry ?% "." table)
+ (modify-syntax-entry ?^ "." table)
+ (modify-syntax-entry ?~ "." table)
+ (modify-syntax-entry ?< "." table)
+ (modify-syntax-entry ?> "." table)
+ (modify-syntax-entry ?/ "." table)
+ (modify-syntax-entry ?* "." table)
+ (modify-syntax-entry ?\n ">" table)
+ (modify-syntax-entry ?\' "\"" table)
+ (modify-syntax-entry ?\" "\"" table)
+ table)
+ "Syntax table for `lua-ts-mode'.")
+
+(defun lua-ts--defun-name-function (node)
+ "Return the defun name of NODE.
+Return nil if there is no name or if NODE is not a defun node."
+ (let ((child (treesit-node-child-by-field-name node "name")))
+ (pcase (treesit-node-type node)
+ ((or "function_declaration" "function_definition")
+ (treesit-node-text child t))
+ ("variable_declaration"
+ (if child
+ (treesit-node-text child t)
+ (treesit-node-text
+ (treesit-node-child-by-field-name
+ (treesit-search-subtree node "assignment_statement" nil nil 1)
+ "name"))))
+ ("field"
+ (and (treesit-search-subtree node "function_definition" nil nil 1)
+ (treesit-node-text child t))))))
+
+(defvar-local lua-ts--flymake-process nil)
+
+(defun lua-ts-flymake-luacheck (report-fn &rest _args)
+ "Luacheck backend for Flymake.
+Calls REPORT-FN directly."
+ (when (process-live-p lua-ts--flymake-process)
+ (kill-process lua-ts--flymake-process))
+ (let ((source (current-buffer)))
+ (save-restriction
+ (widen)
+ (setq lua-ts--flymake-process
+ (make-process
+ :name "lua-ts-flymake-luacheck"
+ :noquery t
+ :connection-type 'pipe
+ :buffer (generate-new-buffer " *lua-ts-flymake-luacheck*")
+ :command `(,lua-ts-luacheck-program
+ "--codes" "--ranges" "--formatter" "plain" "-")
+ :sentinel
+ (lambda (proc _event)
+ (when (eq 'exit (process-status proc))
+ (unwind-protect
+ (if (with-current-buffer source
+ (eq proc lua-ts--flymake-process))
+ (with-current-buffer (process-buffer proc)
+ (goto-char (point-min))
+ (cl-loop
+ while (search-forward-regexp
+ (rx (seq bol
+ (0+ alnum) ":"
+ (group (1+ digit)) ":"
+ (group (1+ digit)) "-"
+ (group (1+ digit)) ": "
+ (group (0+ nonl))
+ eol))
+ nil t)
+ for line = (string-to-number (match-string 1))
+ for beg = (string-to-number (match-string 2))
+ for end = (string-to-number (match-string 3))
+ for msg = (match-string 4)
+ for type = (if (string-match "^(W" msg)
+ :warning
+ :error)
+ when (and beg end)
+ collect (flymake-make-diagnostic source
+ (cons line beg)
+ (cons line (1+ end))
+ type
+ msg)
+ into diags
+ finally (funcall report-fn diags)))
+ (flymake-log :warning "Canceling obsolete check %s" proc))
+ (kill-buffer (process-buffer proc)))))))
+ (process-send-region lua-ts--flymake-process (point-min) (point-max))
+ (process-send-eof lua-ts--flymake-process))))
+
+;;;###autoload
+(defun lua-ts-inferior-lua ()
+ "Run a Lua interpreter in an inferior process."
+ (interactive)
+ (let* ((name lua-ts-inferior-buffer)
+ (buffer (concat "*" name "*"))
+ (program lua-ts-inferior-program)
+ (prompt-regexp lua-ts-inferior-prompt-regexp)
+ (switches lua-ts-inferior-options)
+ (startfile lua-ts-inferior-startfile))
+ (unless (comint-check-proc buffer)
+ (set-buffer (apply (function make-comint) name program startfile switches))
+ (setq-local comint-input-ignoredups t
+ comint-prompt-read-only t
+ comint-prompt-regexp prompt-regexp
+ comint-use-prompt-regexp t))
+ (pop-to-buffer buffer)))
+
+;;;###autoload
+(define-derived-mode lua-ts-mode prog-mode "Lua"
+ "Major mode for editing Lua files, powered by tree-sitter."
+ :syntax-table lua-ts--syntax-table
+
+ (when (treesit-ready-p 'lua)
+ (treesit-parser-create 'lua)
+
+ ;; Comments.
+ (setq-local comment-start "--")
+ (setq-local comment-start-skip "--\\s-*")
+ (setq-local comment-end "")
+
+ ;; Font-lock.
+ (setq-local treesit-font-lock-settings lua-ts--font-lock-settings)
+ (setq-local treesit-font-lock-feature-list
+ '((comment definition)
+ (keyword property string)
+ (assignment builtin constant number)
+ (bracket
+ delimiter
+ escape
+ function
+ operator
+ punctuation
+ variable)))
+
+ ;; Indent.
+ (setq-local treesit-simple-indent-rules lua-ts--simple-indent-rules)
+
+ ;; Navigation.
+ (setq-local treesit-defun-name-function #'lua-ts--defun-name-function)
+ (setq-local treesit-defun-type-regexp
+ (rx (or "function_declaration" "function_definition")))
+ (setq-local treesit-thing-settings
+ `((lua
+ (sentence ,(rx (or "do_statement"
+ "field"
+ "for_statement"
+ "function_call"
+ "if_statement"
+ "repeat_statement"
+ "return_statement"
+ "variable_declaration"
+ "while_statement")))
+ (sexp ,(rx (or "arguments"
+ "block"
+ "parameters"
+ "string"
+ "table_constructor")))
+ (text "comment"))))
+
+ ;; Imenu.
+ (setq-local treesit-simple-imenu-settings
+ `(("Variable" ,(rx bos "variable_declaration" eos) nil nil)
+ ("Function" ,(rx bos
+ (or "function_declaration"
+ "function_definition"
+ "field")
+ eos)
+ nil nil)))
+
+ ;; Which-function.
+ (setq-local which-func-functions (treesit-defun-at-point))
+
+ ;; Outline.
+ (setq-local outline-regexp
+ (rx (seq (0+ space)
+ (or (seq "--[[" (0+ space) eol)
+ (seq symbol-start
+ (or "do" "for" "if" "repeat" "while"
+ (seq (** 0 1 (seq "local" (1+ space)))
+ "function"))
+ symbol-end)))))
+
+ (treesit-major-mode-setup))
+
+ (add-hook 'flymake-diagnostic-functions #'lua-ts-flymake-luacheck nil 'local))
+
+(if (treesit-ready-p 'lua)
+ (add-to-list 'auto-mode-alist '("\\.lua\\'" . lua-ts-mode)))
+
+(provide 'lua-ts-mode)
+
+;;; lua-ts-mode.el ends here
diff --git a/test/infra/Dockerfile.emba b/test/infra/Dockerfile.emba
index 584e4444dc1..e29098ec270 100644
--- a/test/infra/Dockerfile.emba
+++ b/test/infra/Dockerfile.emba
@@ -126,6 +126,7 @@ RUN src/emacs -Q --batch \
(java "https://github.com/tree-sitter/tree-sitter-java") \
(javascript "https://github.com/tree-sitter/tree-sitter-javascript") \
(json "https://github.com/tree-sitter/tree-sitter-json") \
+ (lua "https://github.com/MunifTanjim/tree-sitter-lua") \
(python "https://github.com/tree-sitter/tree-sitter-python") \
(ruby "https://github.com/tree-sitter/tree-sitter-ruby") \
(tsx "https://github.com/tree-sitter/tree-sitter-typescript" "master" "tsx/src") \
diff --git a/test/infra/test-jobs.yml b/test/infra/test-jobs.yml
index 2f6e0dab4d5..1f5d607eda4 100644
--- a/test/infra/test-jobs.yml
+++ b/test/infra/test-jobs.yml
@@ -580,6 +580,7 @@ test-src-inotify:
lisp/progmodes/go-ts-mode-tests.log
lisp/progmodes/heex-ts-mode-tests.log
lisp/progmodes/java-ts-mode-tests.log
+ lisp/progmodes/lua-ts-mode-tests.log
lisp/progmodes/ruby-ts-mode-tests.log
lisp/progmodes/typescript-ts-mode-tests.log
src/treesit-tests.log
diff --git a/test/lisp/progmodes/lua-ts-mode-resources/indent.erts b/test/lisp/progmodes/lua-ts-mode-resources/indent.erts
new file mode 100644
index 00000000000..040225c8580
--- /dev/null
+++ b/test/lisp/progmodes/lua-ts-mode-resources/indent.erts
@@ -0,0 +1,152 @@
+Code:
+ (lambda ()
+ (setq indent-tabs-mode nil)
+ (setq lua-ts-indent-offset 2)
+ (lua-ts-mode)
+ (indent-region (point-min) (point-max)))
+
+Name: Basic Indent
+
+=-=
+ print(
+0,
+ 1
+)
+
+local function f(o)
+ if o.x > o.y then
+ return o.x
+elseif o.y > o.z then
+ return o.y
+ else
+return o.z
+ end
+end
+
+f({
+ x = 1,
+ y = 2,
+ z = 3,
+})
+
+;(function()
+return false
+)()
+=-=
+print(
+ 0,
+ 1
+)
+
+local function f(o)
+ if o.x > o.y then
+ return o.x
+ elseif o.y > o.z then
+ return o.y
+ else
+ return o.z
+ end
+end
+
+f({
+ x = 1,
+ y = 2,
+ z = 3,
+})
+
+;(function()
+ return false
+)()
+=-=-=
+
+Name: Argument Indent
+
+=-=
+function h(
+string,
+number,
+options)
+print(string, number, options)
+end
+
+local p = h(
+"sring",
+ 1000,
+ {
+cost = 2,
+length = 8,
+ parallelism = 4,
+})
+=-=
+function h(
+ string,
+ number,
+ options)
+ print(string, number, options)
+end
+
+local p = h(
+ "sring",
+ 1000,
+ {
+ cost = 2,
+ length = 8,
+ parallelism = 4,
+ })
+=-=-=
+
+Name: Continuation Indent
+
+=-=
+function f()
+ local str = [[
+ multi-line
+ string
+ ]]
+--[[
+multi-line
+comment
+ ]]
+return true
+end
+=-=
+function f()
+ local str = [[
+ multi-line
+ string
+ ]]
+ --[[
+multi-line
+comment
+ ]]
+ return true
+end
+=-=-=
+
+Name: Loop Indent
+
+=-=
+for k, v in pairs({}) do
+ print(k, v)
+end
+
+while n < 10 do
+n = n + 1
+end
+
+repeat
+z = z * 2
+ until z > 12
+=-=
+for k, v in pairs({}) do
+ print(k, v)
+end
+
+while n < 10 do
+ n = n + 1
+end
+
+repeat
+ z = z * 2
+until z > 12
+=-=-=
diff --git a/test/lisp/progmodes/lua-ts-mode-resources/movement.erts b/test/lisp/progmodes/lua-ts-mode-resources/movement.erts
new file mode 100644
index 00000000000..770aa23b18d
--- /dev/null
+++ b/test/lisp/progmodes/lua-ts-mode-resources/movement.erts
@@ -0,0 +1,553 @@
+Code:
+ (lambda ()
+ (lua-ts-mode)
+ (beginning-of-defun 1))
+
+Point-Char: |
+
+Name: beginning-of-defun moves to start of function declaration
+
+=-=
+local function Test()
+ if true then
+ print(1)
+ else
+ print(0)
+ end|
+end
+=-=
+|local function Test()
+ if true then
+ print(1)
+ else
+ print(0)
+ end
+end
+=-=-=
+
+Name: beginning-of-defun moves to start of function definition
+
+=-=
+local t = {
+ f = function()
+ return true
+ end,
+}|
+=-=
+local t = {
+| f = function()
+ return true
+ end,
+}
+=-=-=
+
+Code:
+ (lambda ()
+ (lua-ts-mode)
+ (end-of-defun 1))
+
+Point-Char: |
+
+Name: end-of-defun moves to end of function declaration
+
+=-=
+local function Test()
+ if true then
+ pr|int(1)
+ else
+ print(0)
+ end
+end
+
+local t = Test()
+=-=
+local function Test()
+ if true then
+ print(1)
+ else
+ print(0)
+ end
+end
+|
+local t = Test()
+=-=-=
+
+Name: end-of-defun moves to end of function definition
+
+=-=
+local t = {
+ f = function()
+ re|turn true
+ end,
+}
+=-=
+local t = {
+ f = function()
+ return true
+ end|,
+}
+=-=-=
+
+Code:
+ (lambda ()
+ (lua-ts-mode)
+ (forward-sentence 1))
+
+Point-Char: |
+
+Name: forward-sentence moves over if statements
+
+=-=
+function f()
+ |if true then
+ print(1)
+ elseif false then
+ print(0)
+ else
+ print(2)
+ end
+end
+=-=
+function f()
+ if true then
+ print(1)
+ elseif false then
+ print(0)
+ else
+ print(2)
+ end|
+end
+=-=-=
+
+Name: forward-sentence moves over variable declaration
+
+=-=
+|local n = 1
+
+print(n)
+=-=
+local n = 1|
+
+print(n)
+=-=-=
+
+Name: forward-sentence moves over for statements
+
+=-=
+|for k, v in pairs({}) do
+ print(k, v)
+end
+
+print(1)
+=-=
+for k, v in pairs({}) do
+ print(k, v)
+end|
+
+print(1)
+=-=-=
+
+Name: forward-sentence moves over for statements
+
+=-=
+|do
+ local x = 1
+ local y = 2
+
+ print(x, y)
+end
+
+print(1)
+=-=
+do
+ local x = 1
+ local y = 2
+
+ print(x, y)
+end|
+
+print(1)
+=-=-=
+
+Name: forward-sentence moves over while statements
+
+=-=
+local i = 0
+|while i < 9 do
+ print(i)
+ i = i + 1
+end
+
+print(1)
+=-=
+local i = 0
+while i < 9 do
+ print(i)
+ i = i + 1
+end|
+
+print(1)
+=-=-=
+
+Name: forward-sentence moves over repeat statements
+
+=-=
+local i = 0
+|repeat
+ print(i)
+ i = i + 1
+until i > 9
+
+print(1)
+=-=
+local i = 0
+repeat
+ print(i)
+ i = i + 1
+until i > 9|
+
+print(1)
+=-=-=
+
+Name: forward-sentence moves over function calls
+
+=-=
+|print(1)
+=-=
+print(1)|
+=-=-=
+
+Name: forward-sentence moves over return statements
+
+=-=
+function f()
+ |return math.random()
+end
+=-=
+function f()
+ return math.random()|
+end
+=-=-=
+
+Code:
+ (lambda ()
+ (lua-ts-mode)
+ (forward-sentence 2))
+
+Name: forward-sentence moves over table fields
+
+=-=
+local t = {
+ |a = 1,
+ b = 2,
+}
+=-=
+local t = {
+ a = 1,
+ b = 2|,
+}
+=-=-=
+
+Code:
+ (lambda ()
+ (lua-ts-mode)
+ (backward-sentence 1))
+
+Point-Char: |
+
+Name: backward-sentence moves over if statements
+
+=-=
+function f()
+ if true then
+ print(1)
+ elseif false then
+ print(0)
+ else
+ print(2)
+ end|
+end
+=-=
+function f()
+ |if true then
+ print(1)
+ elseif false then
+ print(0)
+ else
+ print(2)
+ end
+end
+=-=-=
+
+Name: backward-sentence moves over variable declaration
+
+=-=
+local n = 1|
+
+print(n)
+=-=
+|local n = 1
+
+print(n)
+=-=-=
+
+Name: backward-sentence moves over for statements
+
+=-=
+for k, v in pairs({}) do
+ print(k, v)
+end|
+
+print(1)
+=-=
+|for k, v in pairs({}) do
+ print(k, v)
+end
+
+print(1)
+=-=-=
+
+Name: backward-sentence moves over for statements
+
+=-=
+do
+ local x = 1
+ local y = 2
+
+ print(x, y)
+end|
+
+print(1)
+=-=
+|do
+ local x = 1
+ local y = 2
+
+ print(x, y)
+end
+
+print(1)
+=-=-=
+
+Name: backward-sentence moves over while statements
+
+=-=
+local i = 0
+while i < 9 do
+ print(i)
+ i = i + 1
+end|
+
+print(1)
+=-=
+local i = 0
+|while i < 9 do
+ print(i)
+ i = i + 1
+end
+
+print(1)
+=-=-=
+
+Name: backward-sentence moves over repeat statements
+
+=-=
+local i = 0
+repeat
+ print(i)
+ i = i + 1
+until i > 9|
+
+print(1)
+=-=
+local i = 0
+|repeat
+ print(i)
+ i = i + 1
+until i > 9
+
+print(1)
+=-=-=
+
+Name: backward-sentence moves over function calls
+
+=-=
+print(1)|
+=-=
+|print(1)
+=-=-=
+
+Name: backward-sentence moves over return statements
+
+=-=
+function f()
+ return math.random()|
+end
+=-=
+function f()
+ |return math.random()
+end
+=-=-=
+
+Code:
+ (lambda ()
+ (lua-ts-mode)
+ (backward-sentence 2))
+
+Point-Char: |
+
+Name: backward-sentence moves over table fields
+
+=-=
+local t = {
+ a = 1,
+ b = 2|,
+}
+=-=
+local t = {
+ |a = 1,
+ b = 2,
+}
+=-=-=
+
+Code:
+ (lambda ()
+ (lua-ts-mode)
+ (forward-sexp 1))
+
+Point-Char: |
+
+Name: forward-sexp moves over blocks
+
+=-=
+local function Test()
+ |local t = {
+ a = 1,
+ }
+
+ if true then
+ print(1)
+ else
+ print(0)
+ end
+end
+=-=
+local function Test()
+ local t = {
+ a = 1,
+ }
+
+ if true then
+ print(1)
+ else
+ print(0)
+ end|
+end
+=-=-=
+
+Name: forward-sexp moves over arguments
+
+=-=
+print|(1, 2, 3)
+=-=
+print(1, 2, 3)|
+=-=-=
+
+Name: forward-sexp moves over parameters
+
+=-=
+function f|(a, b) end
+=-=
+function f(a, b)| end
+=-=-=
+
+Name: forward-sexp moves over strings
+
+=-=
+print("|1, 2, 3")
+=-=
+print("1, 2, 3|")
+=-=-=
+
+Name: forward-sexp moves over tables
+
+=-=
+local t = |{ 1,
+ 2,
+ 3 }
+=-=
+local t = { 1,
+ 2,
+ 3 }|
+=-=-=
+
+Code:
+ (lambda ()
+ (lua-ts-mode)
+ (backward-sexp 1))
+
+Point-Char: |
+
+Name: backward-sexp moves over blocks
+
+=-=
+local function Test()
+ local t = {
+ a = 1,
+ }
+
+ if true then
+ print(1)
+ else
+ print(0)
+ end|
+end
+=-=
+local function Test()
+ |local t = {
+ a = 1,
+ }
+
+ if true then
+ print(1)
+ else
+ print(0)
+ end
+end
+=-=-=
+
+Name: backward-sexp moves over arguments
+
+=-=
+print(1, 2, 3)|
+=-=
+print|(1, 2, 3)
+=-=-=
+
+Name: backward-sexp moves over parameters
+
+=-=
+function f(a, b)| end
+=-=
+function f|(a, b) end
+=-=-=
+
+Name: backward-sexp moves over strings
+
+=-=
+print("1, 2, 3|")
+=-=
+print("|1, 2, 3")
+=-=-=
+
+Name: backward-sexp moves over tables
+
+=-=
+local t = { 1,
+ 2,
+ 3 }|
+=-=
+local t = |{ 1,
+ 2,
+ 3 }
+=-=-=
diff --git a/test/lisp/progmodes/lua-ts-mode-tests.el b/test/lisp/progmodes/lua-ts-mode-tests.el
new file mode 100644
index 00000000000..d2105b66f6d
--- /dev/null
+++ b/test/lisp/progmodes/lua-ts-mode-tests.el
@@ -0,0 +1,36 @@
+;;; lua-ts-mode-tests.el --- Tests for lua-ts-mode -*- lexical-binding: t; -*-
+
+;; Copyright (C) 2023 Free Software Foundation, Inc.
+
+;; 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/>.
+
+;;; Code:
+
+(require 'ert)
+(require 'ert-x)
+(require 'treesit)
+
+(ert-deftest lua-ts-mode-test-indentation ()
+ (skip-unless (treesit-ready-p 'lua))
+ (ert-test-erts-file (ert-resource-file "indent.erts")))
+
+(ert-deftest lua-ts-mode-test-movement ()
+ (skip-unless (treesit-ready-p 'lua))
+ (ert-test-erts-file (ert-resource-file "movement.erts")))
+
+(provide 'lua-ts-mode-tests)
+
+;;; lua-ts-mode-tests.el ends here
--
2.41.0
^ permalink raw reply related [flat|nested] 16+ messages in thread
* bug#65673: [PATCH] Add lua-ts-mode
2023-09-09 15:17 ` bug#65673: [PATCH] " john muhl via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2023-09-10 11:12 ` Philip Kaludercic
2023-09-10 12:57 ` Augusto Stoffel
0 siblings, 1 reply; 16+ messages in thread
From: Philip Kaludercic @ 2023-09-10 11:12 UTC (permalink / raw)
To: john muhl; +Cc: arstoffel, maurooaranda, 65673, ~emacs/emacs-devel
john muhl <jm@pub.pink> writes:
> * lisp/progmodes/lua-ts-mode.el:
> * test/lisp/progmodes/lua-ts-mode-resources/indent.erts:
> * test/lisp/progmodes/lua-ts-mode-tests.el: New file.
> * etc/NEWS: Mention new mode.
> * lisp/progmodes/eglot.el (eglot-server-programs):
> * lisp/progmodes/hideshow.el (hs-special-modes-alist): Support
> lua-ts-mode.
> * admin/notes/tree-sitter/build-module/batch.sh:
> * admin/notes/tree-sitter/build-module/build.sh: Add Lua.
> * test/infra/Dockerfile.emba:
> * test/infra/test-jobs.yml: Include lua-ts-mode tests.
> ---
> admin/notes/tree-sitter/build-module/batch.sh | 1 +
> admin/notes/tree-sitter/build-module/build.sh | 3 +
> etc/NEWS | 4 +
> lisp/progmodes/eglot.el | 4 +-
> lisp/progmodes/hideshow.el | 1 +
> lisp/progmodes/lua-ts-mode.el | 419 +++++++++++++
> test/infra/Dockerfile.emba | 1 +
> test/infra/test-jobs.yml | 1 +
> .../lua-ts-mode-resources/indent.erts | 152 +++++
> .../lua-ts-mode-resources/movement.erts | 553 ++++++++++++++++++
> test/lisp/progmodes/lua-ts-mode-tests.el | 36 ++
> 11 files changed, 1173 insertions(+), 2 deletions(-)
> create mode 100644 lisp/progmodes/lua-ts-mode.el
> create mode 100644 test/lisp/progmodes/lua-ts-mode-resources/indent.erts
> create mode 100644 test/lisp/progmodes/lua-ts-mode-resources/movement.erts
> create mode 100644 test/lisp/progmodes/lua-ts-mode-tests.el
>
> diff --git a/admin/notes/tree-sitter/build-module/batch.sh b/admin/notes/tree-sitter/build-module/batch.sh
> index 3c4e1472c89..9988d1eae4e 100755
> --- a/admin/notes/tree-sitter/build-module/batch.sh
> +++ b/admin/notes/tree-sitter/build-module/batch.sh
> @@ -16,6 +16,7 @@ languages=
> 'java'
> 'javascript'
> 'json'
> + 'lua'
> 'python'
> 'rust'
> 'toml'
> diff --git a/admin/notes/tree-sitter/build-module/build.sh b/admin/notes/tree-sitter/build-module/build.sh
> index 0832875168b..969187b7f92 100755
> --- a/admin/notes/tree-sitter/build-module/build.sh
> +++ b/admin/notes/tree-sitter/build-module/build.sh
> @@ -42,6 +42,9 @@ grammardir=
> "heex")
> org="phoenixframework"
> ;;
> + "lua")
> + org="MunifTanjim"
> + ;;
> "typescript")
> sourcedir="tree-sitter-typescript/typescript/src"
> grammardir="tree-sitter-typescript/typescript"
> diff --git a/etc/NEWS b/etc/NEWS
> index 51e89fc96dd..0b7da8b392c 100644
> --- a/etc/NEWS
> +++ b/etc/NEWS
> @@ -782,6 +782,10 @@ It highlight parens via ‘show-paren-mode’ and ‘blink-matching-paren’ in
> a user-friendly way, avoids reporting alleged paren mismatches and makes
> sexp navigation more intuitive.
>
> +---
> +*** New major mode 'lua-ts-mode'.
> +A major mode based on the tree-sitter library for editing Lua files.
> +
> ---
> ** The highly accessible Modus themes collection has eight items.
> The 'modus-operandi' and 'modus-vivendi' are the main themes that have
> diff --git a/lisp/progmodes/eglot.el b/lisp/progmodes/eglot.el
> index f7c7c29c094..e2f663998d3 100644
> --- a/lisp/progmodes/eglot.el
> +++ b/lisp/progmodes/eglot.el
> @@ -268,8 +268,8 @@ eglot-server-programs
> (gdscript-mode . ("localhost" 6008))
> ((fortran-mode f90-mode) . ("fortls"))
> (futhark-mode . ("futhark" "lsp"))
> - (lua-mode . ,(eglot-alternatives
> - '("lua-language-server" "lua-lsp")))
> + ((lua-mode lua-ts-mode) . ,(eglot-alternatives
> + '("lua-language-server" "lua-lsp")))
> (zig-mode . ("zls"))
> ((css-mode css-ts-mode)
> . ,(eglot-alternatives '(("vscode-css-language-server" "--stdio")
> diff --git a/lisp/progmodes/hideshow.el b/lisp/progmodes/hideshow.el
> index b878986d7a4..78e39fad740 100644
> --- a/lisp/progmodes/hideshow.el
> +++ b/lisp/progmodes/hideshow.el
> @@ -264,6 +264,7 @@ hs-special-modes-alist
> (java-ts-mode "{" "}" "/[*/]" nil nil)
> (js-mode "{" "}" "/[*/]" nil)
> (js-ts-mode "{" "}" "/[*/]" nil)
> + (lua-ts-mode "{\\|\\[\\[" "}\\|\\]\\]" "--" nil)
> (mhtml-mode "{\\|<[^/>]*?" "}\\|</[^/>]*[^/]>" "<!--" mhtml-forward nil)
> ;; Add more support here.
> ))
> diff --git a/lisp/progmodes/lua-ts-mode.el b/lisp/progmodes/lua-ts-mode.el
> new file mode 100644
> index 00000000000..b7fe71c5fe2
> --- /dev/null
> +++ b/lisp/progmodes/lua-ts-mode.el
> @@ -0,0 +1,419 @@
> +;;; lua-ts-mode.el --- Major mode for editing Lua files -*- lexical-binding: t -*-
> +
> +;; Copyright (C) 2023 Free Software Foundation, Inc.
> +
> +;; Author: John Muhl <jm@pub.pink>
> +;; Created: June 27, 2023
> +;; Keywords: lua 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:
> +
> +;; This package provides `lua-ts-mode' which is a major mode for Lua
> +;; files that uses Tree Sitter to parse the language.
> +;;
> +;; This package is compatible with and tested against the grammar
> +;; for Lua found at https://github.com/MunifTanjim/tree-sitter-lua
> +
> +;;; Code:
> +
> +(require 'comint)
> +(require 'treesit)
> +
> +(eval-when-compile
> + (require 'cl-lib)
> + (require 'rx))
> +
> +(defcustom lua-ts-indent-offset 4
> + "Number of spaces for each indentation step in `lua-ts-mode'."
> + :type 'natnum
> + :safe 'natnump
> + :group 'lua
You still need a defgroup for the package.
> + :version "30.1")
> +
> +(defcustom lua-ts-luacheck-program (executable-find "luacheck")
It is better not to hard-code the path to lua during loading, in case
the executable is moved around, since you will basically always still be
querying PATH when starting a new process.
> + "Location of the Luacheck program."
> + :type '(choice (const nil) (file :must-match t))
Which is why I think that this shouldn't be a file.
> + :group 'lua
> + :version "30.1")
> +
> +(defcustom lua-ts-inferior-buffer "Lua"
How about "*Lua*"?
> + "Name of the inferior Lua buffer."
> + :type 'string
> + :safe 'stringp
> + :group 'lua
> + :version "30.1")
> +
> +(defcustom lua-ts-inferior-program (executable-find "lua")
Same here.
> + "Program to run in the inferior Lua process."
> + :type '(choice (const nil) (file :must-match t))
> + :group 'lua
> + :version "30.1")
> +
> +(defcustom lua-ts-inferior-options '("-i")
> + "Command line options for the inferior Lua process."
> + :type '(repeat string)
> + :group 'lua
> + :version "30.1")
> +
> +(defcustom lua-ts-inferior-startfile nil
> + "File to load into the inferior Lua process at startup."
> + :type '(choice (const nil) (file :must-match t))
> + :group 'lua
> + :version "30.1")
> +
> +(defcustom lua-ts-inferior-prompt-regexp "^>>?[[:blank:]]"
> + "Regular expression matching the prompt of the inferior Lua process."
> + :type 'regexp
> + :group 'lua
> + :version "30.1")
> +
> +(defvar lua-ts--builtins
> + '("assert" "bit32" "collectgarbage" "coroutine" "debug" "dofile"
> + "error" "getmetatable" "io" "ipairs" "load" "loadfile"
> + "math" "next" "os" "package" "pairs" "pcall" "print"
> + "rawequal" "rawget" "rawlen" "rawset" "require" "select"
> + "setmetatable" "string" "table" "tonumber" "tostring"
> + "type" "utf8" "warn" "xpcall" "_G" "_VERSION"
> + ;; methods for file handlers
> + "close" "flush" "lines" "read" "seek" "setvbuf" "write")
> + "Lua built-in functions for tree-sitter font-locking.")
> +
> +(defvar lua-ts--font-lock-settings
> + (treesit-font-lock-rules
> + :language 'lua
> + :feature 'bracket
> + '(["(" ")" "[" "]" "{" "}"] @font-lock-bracket-face)
> +
> + :language 'lua
> + :feature 'delimiter
> + '(["," ";"] @font-lock-delimiter-face)
> +
> + :language 'lua
> + :feature 'escape
> + '((escape_sequence) @font-lock-escape-face)
> +
> + :language 'lua
> + :feature 'constant
> + '((variable_list
> + attribute: (attribute (["<" ">"] (identifier))))
> + @font-lock-constant-face)
> +
> + :language 'lua
> + :feature 'operator
> + '(["and" "not" "or" "+" "-" "*" "/" "%" "^"
> + "#" "==" "~=" "<=" ">=" "<" ">" "=" "&"
> + "~" "|" "<<" ">>" "//" ".."]
> + @font-lock-operator-face
> + (vararg_expression) @font-lock-operator-face)
> +
> + :language 'lua
> + :feature 'property
> + '((field name: (identifier) @font-lock-property-name-face)
> + (dot_index_expression
> + field: (identifier) @font-lock-property-use-face))
> +
> + :language 'lua
> + :feature 'builtin
> + `(((identifier) @font-lock-builtin-face
> + (:match ,(regexp-opt lua-ts--builtins 'symbols)
> + @font-lock-builtin-face)))
> +
> + :language 'lua
> + :feature 'function
> + '((function_call name: (identifier) @font-lock-function-call-face)
> + (function_call
> + name: (method_index_expression
> + method: (identifier) @font-lock-function-call-face))
> + (function_call
> + name: (dot_index_expression
> + table: (identifier) @font-lock-function-call-face)))
> +
> + :language 'lua
> + :feature 'punctuation
> + '(["." ":"] @font-lock-punctuation-face)
> +
> + :language 'lua
> + :feature 'variable
> + '((function_call
> + arguments: (arguments (identifier))
> + @font-lock-variable-use-face)
> + (function_call
> + name: (method_index_expression
> + table: (identifier) @font-lock-variable-use-face))
> + (goto_statement (identifier) @font-lock-variable-use-face))
> +
> + :language 'lua
> + :feature 'assignment
> + '((variable_list (identifier) @font-lock-variable-name-face))
> +
> + :language 'lua
> + :feature 'number
> + '((number) @font-lock-number-face)
> +
> + :language 'lua
> + :feature 'keyword
> + '((break_statement) @font-lock-keyword-face
> + (true) @font-lock-constant-face
> + (false) @font-lock-constant-face
> + (nil) @font-lock-constant-face
> + ["and" "do" "else" "elseif" "end" "for" "function"
> + "goto" "if" "in" "local" "not" "or" "repeat"
> + "return" "then" "until" "while"]
> + @font-lock-keyword-face)
> +
> + :language 'lua
> + :feature 'string
> + '((string) @font-lock-string-face)
> +
> + :language 'lua
> + :feature 'comment
> + '((comment) @font-lock-comment-face
> + (hash_bang_line) @font-lock-comment-face)
> +
> + :language 'lua
> + :feature 'definition
> + '((function_declaration
> + name: (identifier) @font-lock-function-name-face)
> + (parameters
> + name: (identifier) @font-lock-variable-name-face)
> + (label_statement) @font-lock-variable-name-face)
> +
> + :language 'lua
> + :feature 'error
> + :override t
> + '((ERROR) @font-lock-warning-face))
> + "Tree-sitter font-lock settings for `lua-ts-mode'.")
> +
> +(defvar lua-ts--simple-indent-rules
> + `((lua
> + ((parent-is "chunk") column-0 0)
> + ((node-is "comment_end") column-0 0)
> + ((parent-is "block") parent-bol 0)
> + ((node-is "}") parent-bol 0)
> + ((node-is ")") parent-bol 0)
> + ((node-is "else_statement") parent-bol 0)
> + ((node-is "elseif_statement") parent-bol 0)
> + ((node-is "end") parent-bol 0)
> + ((node-is "until") parent-bol 0)
> + ((parent-is "for_statement") parent-bol lua-ts-indent-offset)
> + ((parent-is "function_declaration") parent-bol lua-ts-indent-offset)
> + ((parent-is "function_definition") parent-bol lua-ts-indent-offset)
> + ((parent-is "if_statement") parent-bol lua-ts-indent-offset)
> + ((parent-is "else_statement") parent-bol lua-ts-indent-offset)
> + ((parent-is "repeat_statement") parent-bol lua-ts-indent-offset)
> + ((parent-is "while_statement") parent-bol lua-ts-indent-offset)
> + ((parent-is "table_constructor") parent-bol lua-ts-indent-offset)
> + ((parent-is "arguments") parent-bol lua-ts-indent-offset)
> + ((parent-is "parameters") parent-bol lua-ts-indent-offset)
> + ((parent-is "ERROR") no-indent 0))))
> +
> +(defvar lua-ts--syntax-table
> + (let ((table (make-syntax-table)))
> + (modify-syntax-entry ?+ "." table)
> + (modify-syntax-entry ?- ". 12" table)
> + (modify-syntax-entry ?= "." table)
> + (modify-syntax-entry ?% "." table)
> + (modify-syntax-entry ?^ "." table)
> + (modify-syntax-entry ?~ "." table)
> + (modify-syntax-entry ?< "." table)
> + (modify-syntax-entry ?> "." table)
> + (modify-syntax-entry ?/ "." table)
> + (modify-syntax-entry ?* "." table)
> + (modify-syntax-entry ?\n ">" table)
> + (modify-syntax-entry ?\' "\"" table)
> + (modify-syntax-entry ?\" "\"" table)
> + table)
> + "Syntax table for `lua-ts-mode'.")
> +
> +(defun lua-ts--defun-name-function (node)
> + "Return the defun name of NODE.
> +Return nil if there is no name or if NODE is not a defun node."
> + (let ((child (treesit-node-child-by-field-name node "name")))
> + (pcase (treesit-node-type node)
> + ((or "function_declaration" "function_definition")
> + (treesit-node-text child t))
> + ("variable_declaration"
> + (if child
> + (treesit-node-text child t)
> + (treesit-node-text
> + (treesit-node-child-by-field-name
> + (treesit-search-subtree node "assignment_statement" nil nil 1)
> + "name"))))
> + ("field"
> + (and (treesit-search-subtree node "function_definition" nil nil 1)
> + (treesit-node-text child t))))))
> +
> +(defvar-local lua-ts--flymake-process nil)
> +
> +(defun lua-ts-flymake-luacheck (report-fn &rest _args)
> + "Luacheck backend for Flymake.
> +Calls REPORT-FN directly."
> + (when (process-live-p lua-ts--flymake-process)
> + (kill-process lua-ts--flymake-process))
> + (let ((source (current-buffer)))
> + (save-restriction
> + (widen)
> + (setq lua-ts--flymake-process
> + (make-process
> + :name "lua-ts-flymake-luacheck"
> + :noquery t
> + :connection-type 'pipe
> + :buffer (generate-new-buffer " *lua-ts-flymake-luacheck*")
> + :command `(,lua-ts-luacheck-program
> + "--codes" "--ranges" "--formatter" "plain" "-")
> + :sentinel
> + (lambda (proc _event)
> + (when (eq 'exit (process-status proc))
> + (unwind-protect
> + (if (with-current-buffer source
> + (eq proc lua-ts--flymake-process))
> + (with-current-buffer (process-buffer proc)
> + (goto-char (point-min))
> + (cl-loop
> + while (search-forward-regexp
> + (rx (seq bol
> + (0+ alnum) ":"
> + (group (1+ digit)) ":"
> + (group (1+ digit)) "-"
> + (group (1+ digit)) ": "
> + (group (0+ nonl))
> + eol))
> + nil t)
> + for line = (string-to-number (match-string 1))
> + for beg = (string-to-number (match-string 2))
> + for end = (string-to-number (match-string 3))
> + for msg = (match-string 4)
> + for type = (if (string-match "^(W" msg)
> + :warning
> + :error)
> + when (and beg end)
> + collect (flymake-make-diagnostic source
> + (cons line beg)
> + (cons line (1+ end))
> + type
> + msg)
> + into diags
> + finally (funcall report-fn diags)))
> + (flymake-log :warning "Canceling obsolete check %s" proc))
> + (kill-buffer (process-buffer proc)))))))
> + (process-send-region lua-ts--flymake-process (point-min) (point-max))
> + (process-send-eof lua-ts--flymake-process))))
> +
> +;;;###autoload
> +(defun lua-ts-inferior-lua ()
> + "Run a Lua interpreter in an inferior process."
> + (interactive)
> + (let* ((name lua-ts-inferior-buffer)
> + (buffer (concat "*" name "*"))
> + (program lua-ts-inferior-program)
> + (prompt-regexp lua-ts-inferior-prompt-regexp)
> + (switches lua-ts-inferior-options)
> + (startfile lua-ts-inferior-startfile))
> + (unless (comint-check-proc buffer)
> + (set-buffer (apply (function make-comint) name program startfile switches))
> + (setq-local comint-input-ignoredups t
> + comint-prompt-read-only t
> + comint-prompt-regexp prompt-regexp
> + comint-use-prompt-regexp t))
> + (pop-to-buffer buffer)))
I believe that `display-buffer-pop-up-frame' is the preferred alternative
to `pop-to-buffer' these days.
> +
> +;;;###autoload
> +(define-derived-mode lua-ts-mode prog-mode "Lua"
> + "Major mode for editing Lua files, powered by tree-sitter."
> + :syntax-table lua-ts--syntax-table
> +
> + (when (treesit-ready-p 'lua)
> + (treesit-parser-create 'lua)
> +
> + ;; Comments.
> + (setq-local comment-start "--")
> + (setq-local comment-start-skip "--\\s-*")
> + (setq-local comment-end "")
> +
> + ;; Font-lock.
> + (setq-local treesit-font-lock-settings lua-ts--font-lock-settings)
> + (setq-local treesit-font-lock-feature-list
> + '((comment definition)
> + (keyword property string)
> + (assignment builtin constant number)
> + (bracket
> + delimiter
> + escape
> + function
> + operator
> + punctuation
> + variable)))
> +
> + ;; Indent.
> + (setq-local treesit-simple-indent-rules lua-ts--simple-indent-rules)
> +
> + ;; Navigation.
> + (setq-local treesit-defun-name-function #'lua-ts--defun-name-function)
> + (setq-local treesit-defun-type-regexp
> + (rx (or "function_declaration" "function_definition")))
> + (setq-local treesit-thing-settings
> + `((lua
> + (sentence ,(rx (or "do_statement"
> + "field"
> + "for_statement"
> + "function_call"
> + "if_statement"
> + "repeat_statement"
> + "return_statement"
> + "variable_declaration"
> + "while_statement")))
> + (sexp ,(rx (or "arguments"
> + "block"
> + "parameters"
> + "string"
> + "table_constructor")))
> + (text "comment"))))
> +
> + ;; Imenu.
> + (setq-local treesit-simple-imenu-settings
> + `(("Variable" ,(rx bos "variable_declaration" eos) nil nil)
> + ("Function" ,(rx bos
> + (or "function_declaration"
> + "function_definition"
> + "field")
> + eos)
> + nil nil)))
> +
> + ;; Which-function.
> + (setq-local which-func-functions (treesit-defun-at-point))
> +
> + ;; Outline.
> + (setq-local outline-regexp
> + (rx (seq (0+ space)
> + (or (seq "--[[" (0+ space) eol)
> + (seq symbol-start
> + (or "do" "for" "if" "repeat" "while"
> + (seq (** 0 1 (seq "local" (1+ space)))
aka (? (seq "local" (1+ space))), right?
> + "function"))
> + symbol-end)))))
> +
> + (treesit-major-mode-setup))
> +
> + (add-hook 'flymake-diagnostic-functions #'lua-ts-flymake-luacheck nil 'local))
> +
> +(if (treesit-ready-p 'lua)
I would say writing this with `when' would be cleaner.
> + (add-to-list 'auto-mode-alist '("\\.lua\\'" . lua-ts-mode)))
> +
> +(provide 'lua-ts-mode)
> +
> +;;; lua-ts-mode.el ends here
> diff --git a/test/infra/Dockerfile.emba b/test/infra/Dockerfile.emba
> index 584e4444dc1..e29098ec270 100644
> --- a/test/infra/Dockerfile.emba
> +++ b/test/infra/Dockerfile.emba
> @@ -126,6 +126,7 @@ RUN src/emacs -Q --batch \
> (java "https://github.com/tree-sitter/tree-sitter-java") \
> (javascript "https://github.com/tree-sitter/tree-sitter-javascript") \
> (json "https://github.com/tree-sitter/tree-sitter-json") \
> + (lua "https://github.com/MunifTanjim/tree-sitter-lua") \
> (python "https://github.com/tree-sitter/tree-sitter-python") \
> (ruby "https://github.com/tree-sitter/tree-sitter-ruby") \
> (tsx "https://github.com/tree-sitter/tree-sitter-typescript" "master" "tsx/src") \
> diff --git a/test/infra/test-jobs.yml b/test/infra/test-jobs.yml
> index 2f6e0dab4d5..1f5d607eda4 100644
> --- a/test/infra/test-jobs.yml
> +++ b/test/infra/test-jobs.yml
> @@ -580,6 +580,7 @@ test-src-inotify:
> lisp/progmodes/go-ts-mode-tests.log
> lisp/progmodes/heex-ts-mode-tests.log
> lisp/progmodes/java-ts-mode-tests.log
> + lisp/progmodes/lua-ts-mode-tests.log
> lisp/progmodes/ruby-ts-mode-tests.log
> lisp/progmodes/typescript-ts-mode-tests.log
> src/treesit-tests.log
> diff --git a/test/lisp/progmodes/lua-ts-mode-resources/indent.erts b/test/lisp/progmodes/lua-ts-mode-resources/indent.erts
> new file mode 100644
> index 00000000000..040225c8580
> --- /dev/null
> +++ b/test/lisp/progmodes/lua-ts-mode-resources/indent.erts
> @@ -0,0 +1,152 @@
> +Code:
> + (lambda ()
> + (setq indent-tabs-mode nil)
> + (setq lua-ts-indent-offset 2)
> + (lua-ts-mode)
> + (indent-region (point-min) (point-max)))
> +
> +Name: Basic Indent
> +
> +=-=
> + print(
> +0,
> + 1
> +)
> +
> +local function f(o)
> + if o.x > o.y then
> + return o.x
> +elseif o.y > o.z then
> + return o.y
> + else
> +return o.z
> + end
> +end
> +
> +f({
> + x = 1,
> + y = 2,
> + z = 3,
> +})
> +
> +;(function()
> +return false
> +)()
> +=-=
> +print(
> + 0,
> + 1
> +)
> +
> +local function f(o)
> + if o.x > o.y then
> + return o.x
> + elseif o.y > o.z then
> + return o.y
> + else
> + return o.z
> + end
> +end
> +
> +f({
> + x = 1,
> + y = 2,
> + z = 3,
> +})
> +
> +;(function()
> + return false
> +)()
> +=-=-=
> +
> +Name: Argument Indent
> +
> +=-=
> +function h(
> +string,
> +number,
> +options)
> +print(string, number, options)
> +end
> +
> +local p = h(
> +"sring",
> + 1000,
> + {
> +cost = 2,
> +length = 8,
> + parallelism = 4,
> +})
> +=-=
> +function h(
> + string,
> + number,
> + options)
> + print(string, number, options)
> +end
> +
> +local p = h(
> + "sring",
> + 1000,
> + {
> + cost = 2,
> + length = 8,
> + parallelism = 4,
> + })
> +=-=-=
> +
> +Name: Continuation Indent
> +
> +=-=
> +function f()
> + local str = [[
> + multi-line
> + string
> + ]]
> +--[[
> +multi-line
> +comment
> + ]]
> +return true
> +end
> +=-=
> +function f()
> + local str = [[
> + multi-line
> + string
> + ]]
> + --[[
> +multi-line
> +comment
> + ]]
> + return true
> +end
> +=-=-=
> +
> +Name: Loop Indent
> +
> +=-=
> +for k, v in pairs({}) do
> + print(k, v)
> +end
> +
> +while n < 10 do
> +n = n + 1
> +end
> +
> +repeat
> +z = z * 2
> + until z > 12
> +=-=
> +for k, v in pairs({}) do
> + print(k, v)
> +end
> +
> +while n < 10 do
> + n = n + 1
> +end
> +
> +repeat
> + z = z * 2
> +until z > 12
> +=-=-=
> diff --git a/test/lisp/progmodes/lua-ts-mode-resources/movement.erts b/test/lisp/progmodes/lua-ts-mode-resources/movement.erts
> new file mode 100644
> index 00000000000..770aa23b18d
> --- /dev/null
> +++ b/test/lisp/progmodes/lua-ts-mode-resources/movement.erts
> @@ -0,0 +1,553 @@
> +Code:
> + (lambda ()
> + (lua-ts-mode)
> + (beginning-of-defun 1))
> +
> +Point-Char: |
> +
> +Name: beginning-of-defun moves to start of function declaration
> +
> +=-=
> +local function Test()
> + if true then
> + print(1)
> + else
> + print(0)
> + end|
> +end
> +=-=
> +|local function Test()
> + if true then
> + print(1)
> + else
> + print(0)
> + end
> +end
> +=-=-=
> +
> +Name: beginning-of-defun moves to start of function definition
> +
> +=-=
> +local t = {
> + f = function()
> + return true
> + end,
> +}|
> +=-=
> +local t = {
> +| f = function()
> + return true
> + end,
> +}
> +=-=-=
> +
> +Code:
> + (lambda ()
> + (lua-ts-mode)
> + (end-of-defun 1))
> +
> +Point-Char: |
> +
> +Name: end-of-defun moves to end of function declaration
> +
> +=-=
> +local function Test()
> + if true then
> + pr|int(1)
> + else
> + print(0)
> + end
> +end
> +
> +local t = Test()
> +=-=
> +local function Test()
> + if true then
> + print(1)
> + else
> + print(0)
> + end
> +end
> +|
> +local t = Test()
> +=-=-=
> +
> +Name: end-of-defun moves to end of function definition
> +
> +=-=
> +local t = {
> + f = function()
> + re|turn true
> + end,
> +}
> +=-=
> +local t = {
> + f = function()
> + return true
> + end|,
> +}
> +=-=-=
> +
> +Code:
> + (lambda ()
> + (lua-ts-mode)
> + (forward-sentence 1))
> +
> +Point-Char: |
> +
> +Name: forward-sentence moves over if statements
> +
> +=-=
> +function f()
> + |if true then
> + print(1)
> + elseif false then
> + print(0)
> + else
> + print(2)
> + end
> +end
> +=-=
> +function f()
> + if true then
> + print(1)
> + elseif false then
> + print(0)
> + else
> + print(2)
> + end|
> +end
> +=-=-=
> +
> +Name: forward-sentence moves over variable declaration
> +
> +=-=
> +|local n = 1
> +
> +print(n)
> +=-=
> +local n = 1|
> +
> +print(n)
> +=-=-=
> +
> +Name: forward-sentence moves over for statements
> +
> +=-=
> +|for k, v in pairs({}) do
> + print(k, v)
> +end
> +
> +print(1)
> +=-=
> +for k, v in pairs({}) do
> + print(k, v)
> +end|
> +
> +print(1)
> +=-=-=
> +
> +Name: forward-sentence moves over for statements
> +
> +=-=
> +|do
> + local x = 1
> + local y = 2
> +
> + print(x, y)
> +end
> +
> +print(1)
> +=-=
> +do
> + local x = 1
> + local y = 2
> +
> + print(x, y)
> +end|
> +
> +print(1)
> +=-=-=
> +
> +Name: forward-sentence moves over while statements
> +
> +=-=
> +local i = 0
> +|while i < 9 do
> + print(i)
> + i = i + 1
> +end
> +
> +print(1)
> +=-=
> +local i = 0
> +while i < 9 do
> + print(i)
> + i = i + 1
> +end|
> +
> +print(1)
> +=-=-=
> +
> +Name: forward-sentence moves over repeat statements
> +
> +=-=
> +local i = 0
> +|repeat
> + print(i)
> + i = i + 1
> +until i > 9
> +
> +print(1)
> +=-=
> +local i = 0
> +repeat
> + print(i)
> + i = i + 1
> +until i > 9|
> +
> +print(1)
> +=-=-=
> +
> +Name: forward-sentence moves over function calls
> +
> +=-=
> +|print(1)
> +=-=
> +print(1)|
> +=-=-=
> +
> +Name: forward-sentence moves over return statements
> +
> +=-=
> +function f()
> + |return math.random()
> +end
> +=-=
> +function f()
> + return math.random()|
> +end
> +=-=-=
> +
> +Code:
> + (lambda ()
> + (lua-ts-mode)
> + (forward-sentence 2))
> +
> +Name: forward-sentence moves over table fields
> +
> +=-=
> +local t = {
> + |a = 1,
> + b = 2,
> +}
> +=-=
> +local t = {
> + a = 1,
> + b = 2|,
> +}
> +=-=-=
> +
> +Code:
> + (lambda ()
> + (lua-ts-mode)
> + (backward-sentence 1))
> +
> +Point-Char: |
> +
> +Name: backward-sentence moves over if statements
> +
> +=-=
> +function f()
> + if true then
> + print(1)
> + elseif false then
> + print(0)
> + else
> + print(2)
> + end|
> +end
> +=-=
> +function f()
> + |if true then
> + print(1)
> + elseif false then
> + print(0)
> + else
> + print(2)
> + end
> +end
> +=-=-=
> +
> +Name: backward-sentence moves over variable declaration
> +
> +=-=
> +local n = 1|
> +
> +print(n)
> +=-=
> +|local n = 1
> +
> +print(n)
> +=-=-=
> +
> +Name: backward-sentence moves over for statements
> +
> +=-=
> +for k, v in pairs({}) do
> + print(k, v)
> +end|
> +
> +print(1)
> +=-=
> +|for k, v in pairs({}) do
> + print(k, v)
> +end
> +
> +print(1)
> +=-=-=
> +
> +Name: backward-sentence moves over for statements
> +
> +=-=
> +do
> + local x = 1
> + local y = 2
> +
> + print(x, y)
> +end|
> +
> +print(1)
> +=-=
> +|do
> + local x = 1
> + local y = 2
> +
> + print(x, y)
> +end
> +
> +print(1)
> +=-=-=
> +
> +Name: backward-sentence moves over while statements
> +
> +=-=
> +local i = 0
> +while i < 9 do
> + print(i)
> + i = i + 1
> +end|
> +
> +print(1)
> +=-=
> +local i = 0
> +|while i < 9 do
> + print(i)
> + i = i + 1
> +end
> +
> +print(1)
> +=-=-=
> +
> +Name: backward-sentence moves over repeat statements
> +
> +=-=
> +local i = 0
> +repeat
> + print(i)
> + i = i + 1
> +until i > 9|
> +
> +print(1)
> +=-=
> +local i = 0
> +|repeat
> + print(i)
> + i = i + 1
> +until i > 9
> +
> +print(1)
> +=-=-=
> +
> +Name: backward-sentence moves over function calls
> +
> +=-=
> +print(1)|
> +=-=
> +|print(1)
> +=-=-=
> +
> +Name: backward-sentence moves over return statements
> +
> +=-=
> +function f()
> + return math.random()|
> +end
> +=-=
> +function f()
> + |return math.random()
> +end
> +=-=-=
> +
> +Code:
> + (lambda ()
> + (lua-ts-mode)
> + (backward-sentence 2))
> +
> +Point-Char: |
> +
> +Name: backward-sentence moves over table fields
> +
> +=-=
> +local t = {
> + a = 1,
> + b = 2|,
> +}
> +=-=
> +local t = {
> + |a = 1,
> + b = 2,
> +}
> +=-=-=
> +
> +Code:
> + (lambda ()
> + (lua-ts-mode)
> + (forward-sexp 1))
> +
> +Point-Char: |
> +
> +Name: forward-sexp moves over blocks
> +
> +=-=
> +local function Test()
> + |local t = {
> + a = 1,
> + }
> +
> + if true then
> + print(1)
> + else
> + print(0)
> + end
> +end
> +=-=
> +local function Test()
> + local t = {
> + a = 1,
> + }
> +
> + if true then
> + print(1)
> + else
> + print(0)
> + end|
> +end
> +=-=-=
> +
> +Name: forward-sexp moves over arguments
> +
> +=-=
> +print|(1, 2, 3)
> +=-=
> +print(1, 2, 3)|
> +=-=-=
> +
> +Name: forward-sexp moves over parameters
> +
> +=-=
> +function f|(a, b) end
> +=-=
> +function f(a, b)| end
> +=-=-=
> +
> +Name: forward-sexp moves over strings
> +
> +=-=
> +print("|1, 2, 3")
> +=-=
> +print("1, 2, 3|")
> +=-=-=
> +
> +Name: forward-sexp moves over tables
> +
> +=-=
> +local t = |{ 1,
> + 2,
> + 3 }
> +=-=
> +local t = { 1,
> + 2,
> + 3 }|
> +=-=-=
> +
> +Code:
> + (lambda ()
> + (lua-ts-mode)
> + (backward-sexp 1))
> +
> +Point-Char: |
> +
> +Name: backward-sexp moves over blocks
> +
> +=-=
> +local function Test()
> + local t = {
> + a = 1,
> + }
> +
> + if true then
> + print(1)
> + else
> + print(0)
> + end|
> +end
> +=-=
> +local function Test()
> + |local t = {
> + a = 1,
> + }
> +
> + if true then
> + print(1)
> + else
> + print(0)
> + end
> +end
> +=-=-=
> +
> +Name: backward-sexp moves over arguments
> +
> +=-=
> +print(1, 2, 3)|
> +=-=
> +print|(1, 2, 3)
> +=-=-=
> +
> +Name: backward-sexp moves over parameters
> +
> +=-=
> +function f(a, b)| end
> +=-=
> +function f|(a, b) end
> +=-=-=
> +
> +Name: backward-sexp moves over strings
> +
> +=-=
> +print("1, 2, 3|")
> +=-=
> +print("|1, 2, 3")
> +=-=-=
> +
> +Name: backward-sexp moves over tables
> +
> +=-=
> +local t = { 1,
> + 2,
> + 3 }|
> +=-=
> +local t = |{ 1,
> + 2,
> + 3 }
> +=-=-=
> diff --git a/test/lisp/progmodes/lua-ts-mode-tests.el b/test/lisp/progmodes/lua-ts-mode-tests.el
> new file mode 100644
> index 00000000000..d2105b66f6d
> --- /dev/null
> +++ b/test/lisp/progmodes/lua-ts-mode-tests.el
> @@ -0,0 +1,36 @@
> +;;; lua-ts-mode-tests.el --- Tests for lua-ts-mode -*- lexical-binding: t; -*-
> +
> +;; Copyright (C) 2023 Free Software Foundation, Inc.
> +
> +;; 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/>.
> +
> +;;; Code:
> +
> +(require 'ert)
> +(require 'ert-x)
> +(require 'treesit)
> +
> +(ert-deftest lua-ts-mode-test-indentation ()
> + (skip-unless (treesit-ready-p 'lua))
> + (ert-test-erts-file (ert-resource-file "indent.erts")))
> +
> +(ert-deftest lua-ts-mode-test-movement ()
> + (skip-unless (treesit-ready-p 'lua))
> + (ert-test-erts-file (ert-resource-file "movement.erts")))
> +
> +(provide 'lua-ts-mode-tests)
> +
> +;;; lua-ts-mode-tests.el ends here
^ permalink raw reply [flat|nested] 16+ messages in thread
* bug#65673: [PATCH] Add lua-ts-mode
2023-09-10 11:12 ` Philip Kaludercic
@ 2023-09-10 12:57 ` Augusto Stoffel
0 siblings, 0 replies; 16+ messages in thread
From: Augusto Stoffel @ 2023-09-10 12:57 UTC (permalink / raw)
To: Philip Kaludercic; +Cc: john muhl, maurooaranda, 65673, ~emacs/emacs-devel
On Sun, 10 Sep 2023 at 11:12, Philip Kaludercic wrote:
> john muhl <jm@pub.pink> writes:
>> +(defcustom lua-ts-luacheck-program (executable-find "luacheck")
>
> It is better not to hard-code the path to lua during loading, in case
> the executable is moved around, since you will basically always still be
> querying PATH when starting a new process.
>
>> + "Location of the Luacheck program."
>> + :type '(choice (const nil) (file :must-match t))
>
> Which is why I think that this shouldn't be a file.
>> +(defcustom lua-ts-inferior-program (executable-find "lua")
>> + "Program to run in the inferior Lua process."
>> + :type '(choice (const nil) (file :must-match t))
>> + :group 'lua
>> + :version "30.1")
> Same here.
Good point, calling `executable-find' at this stage will also preclude
working over Tramp, among other potential issues.
^ permalink raw reply [flat|nested] 16+ messages in thread
* bug#65673: [PATCH] Add lua-ts-mode
2023-08-31 22:55 bug#65673: [PATCH emacs 0/1] Add lua-ts-mode ~johnmuhl
` (2 preceding siblings ...)
2023-09-09 15:17 ` bug#65673: [PATCH emacs 1/1 v2] " john muhl via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2023-09-11 15:03 ` john muhl via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-16 10:03 ` Eli Zaretskii
3 siblings, 1 reply; 16+ messages in thread
From: john muhl via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2023-09-11 15:03 UTC (permalink / raw)
To: philipk; +Cc: john muhl, arstoffel, maurooaranda, 65673, ~emacs/emacs-devel
* lisp/progmodes/lua-ts-mode.el:
* test/lisp/progmodes/lua-ts-mode-resources/indent.erts:
* test/lisp/progmodes/lua-ts-mode-tests.el: New file.
* etc/NEWS: Mention new mode.
* lisp/progmodes/eglot.el (eglot-server-programs):
* lisp/progmodes/hideshow.el (hs-special-modes-alist): Support
lua-ts-mode.
* admin/notes/tree-sitter/build-module/batch.sh:
* admin/notes/tree-sitter/build-module/build.sh: Add Lua.
* test/infra/Dockerfile.emba:
* test/infra/test-jobs.yml: Include lua-ts-mode tests.
---
admin/notes/tree-sitter/build-module/batch.sh | 1 +
admin/notes/tree-sitter/build-module/build.sh | 3 +
etc/NEWS | 4 +
lisp/progmodes/eglot.el | 4 +-
lisp/progmodes/hideshow.el | 1 +
lisp/progmodes/lua-ts-mode.el | 431 ++++++++++++++
test/infra/Dockerfile.emba | 1 +
test/infra/test-jobs.yml | 1 +
.../lua-ts-mode-resources/indent.erts | 152 +++++
.../lua-ts-mode-resources/movement.erts | 553 ++++++++++++++++++
test/lisp/progmodes/lua-ts-mode-tests.el | 36 ++
11 files changed, 1185 insertions(+), 2 deletions(-)
create mode 100644 lisp/progmodes/lua-ts-mode.el
create mode 100644 test/lisp/progmodes/lua-ts-mode-resources/indent.erts
create mode 100644 test/lisp/progmodes/lua-ts-mode-resources/movement.erts
create mode 100644 test/lisp/progmodes/lua-ts-mode-tests.el
diff --git a/admin/notes/tree-sitter/build-module/batch.sh b/admin/notes/tree-sitter/build-module/batch.sh
index 3c4e1472c89..9988d1eae4e 100755
--- a/admin/notes/tree-sitter/build-module/batch.sh
+++ b/admin/notes/tree-sitter/build-module/batch.sh
@@ -16,6 +16,7 @@ languages=
'java'
'javascript'
'json'
+ 'lua'
'python'
'rust'
'toml'
diff --git a/admin/notes/tree-sitter/build-module/build.sh b/admin/notes/tree-sitter/build-module/build.sh
index 0832875168b..969187b7f92 100755
--- a/admin/notes/tree-sitter/build-module/build.sh
+++ b/admin/notes/tree-sitter/build-module/build.sh
@@ -42,6 +42,9 @@ grammardir=
"heex")
org="phoenixframework"
;;
+ "lua")
+ org="MunifTanjim"
+ ;;
"typescript")
sourcedir="tree-sitter-typescript/typescript/src"
grammardir="tree-sitter-typescript/typescript"
diff --git a/etc/NEWS b/etc/NEWS
index 51e89fc96dd..0b7da8b392c 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -782,6 +782,10 @@ It highlight parens via ‘show-paren-mode’ and ‘blink-matching-paren’ in
a user-friendly way, avoids reporting alleged paren mismatches and makes
sexp navigation more intuitive.
+---
+*** New major mode 'lua-ts-mode'.
+A major mode based on the tree-sitter library for editing Lua files.
+
---
** The highly accessible Modus themes collection has eight items.
The 'modus-operandi' and 'modus-vivendi' are the main themes that have
diff --git a/lisp/progmodes/eglot.el b/lisp/progmodes/eglot.el
index f7c7c29c094..e2f663998d3 100644
--- a/lisp/progmodes/eglot.el
+++ b/lisp/progmodes/eglot.el
@@ -268,8 +268,8 @@ eglot-server-programs
(gdscript-mode . ("localhost" 6008))
((fortran-mode f90-mode) . ("fortls"))
(futhark-mode . ("futhark" "lsp"))
- (lua-mode . ,(eglot-alternatives
- '("lua-language-server" "lua-lsp")))
+ ((lua-mode lua-ts-mode) . ,(eglot-alternatives
+ '("lua-language-server" "lua-lsp")))
(zig-mode . ("zls"))
((css-mode css-ts-mode)
. ,(eglot-alternatives '(("vscode-css-language-server" "--stdio")
diff --git a/lisp/progmodes/hideshow.el b/lisp/progmodes/hideshow.el
index b878986d7a4..78e39fad740 100644
--- a/lisp/progmodes/hideshow.el
+++ b/lisp/progmodes/hideshow.el
@@ -264,6 +264,7 @@ hs-special-modes-alist
(java-ts-mode "{" "}" "/[*/]" nil nil)
(js-mode "{" "}" "/[*/]" nil)
(js-ts-mode "{" "}" "/[*/]" nil)
+ (lua-ts-mode "{\\|\\[\\[" "}\\|\\]\\]" "--" nil)
(mhtml-mode "{\\|<[^/>]*?" "}\\|</[^/>]*[^/]>" "<!--" mhtml-forward nil)
;; Add more support here.
))
diff --git a/lisp/progmodes/lua-ts-mode.el b/lisp/progmodes/lua-ts-mode.el
new file mode 100644
index 00000000000..071953d3d2f
--- /dev/null
+++ b/lisp/progmodes/lua-ts-mode.el
@@ -0,0 +1,431 @@
+;;; lua-ts-mode.el --- Major mode for editing Lua files -*- lexical-binding: t -*-
+
+;; Copyright (C) 2023 Free Software Foundation, Inc.
+
+;; Author: John Muhl <jm@pub.pink>
+;; Created: June 27, 2023
+;; Keywords: lua 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:
+
+;; This package provides `lua-ts-mode' which is a major mode for Lua
+;; files that uses Tree Sitter to parse the language.
+;;
+;; This package is compatible with and tested against the grammar
+;; for Lua found at https://github.com/MunifTanjim/tree-sitter-lua
+
+;;; Code:
+
+(require 'comint)
+(require 'treesit)
+
+(eval-when-compile
+ (require 'cl-lib)
+ (require 'rx))
+
+(declare-function treesit-node-child-by-field-name "treesit.c")
+(declare-function treesit-node-type "treesit.c")
+(declare-function treesit-parser-create "treesit.c")
+(declare-function treesit-search-subtree "treesit.c")
+
+(defgroup lua-ts nil
+ "Major mode for editing Lua files."
+ :prefix "lua-ts-"
+ :group 'languages)
+
+(defcustom lua-ts-indent-offset 4
+ "Number of spaces for each indentation step in `lua-ts-mode'."
+ :type 'natnum
+ :safe 'natnump
+ :group 'lua-ts
+ :version "30.1")
+
+(defcustom lua-ts-luacheck-program "luacheck"
+ "Location of the Luacheck program."
+ :type '(choice (const nil) string)
+ :group 'lua-ts
+ :version "30.1")
+
+(defcustom lua-ts-inferior-buffer "*Lua*"
+ "Name of the inferior Lua buffer."
+ :type 'string
+ :safe 'stringp
+ :group 'lua-ts
+ :version "30.1")
+
+(defcustom lua-ts-inferior-program "lua"
+ "Program to run in the inferior Lua process."
+ :type '(choice (const nil) string)
+ :group 'lua-ts
+ :version "30.1")
+
+(defcustom lua-ts-inferior-options '("-i")
+ "Command line options for the inferior Lua process."
+ :type '(repeat string)
+ :group 'lua-ts
+ :version "30.1")
+
+(defcustom lua-ts-inferior-startfile nil
+ "File to load into the inferior Lua process at startup."
+ :type '(choice (const nil) (file :must-match t))
+ :group 'lua-ts
+ :version "30.1")
+
+(defcustom lua-ts-inferior-prompt-regexp "^>>?[[:blank:]]"
+ "Regular expression matching the prompt of the inferior Lua process."
+ :type 'regexp
+ :group 'lua-ts
+ :version "30.1")
+
+(defvar lua-ts--builtins
+ '("assert" "bit32" "collectgarbage" "coroutine" "debug" "dofile"
+ "error" "getmetatable" "io" "ipairs" "load" "loadfile"
+ "math" "next" "os" "package" "pairs" "pcall" "print"
+ "rawequal" "rawget" "rawlen" "rawset" "require" "select"
+ "setmetatable" "string" "table" "tonumber" "tostring"
+ "type" "utf8" "warn" "xpcall" "_G" "_VERSION"
+ ;; methods for file handlers
+ "close" "flush" "lines" "read" "seek" "setvbuf" "write")
+ "Lua built-in functions for tree-sitter font-locking.")
+
+(defvar lua-ts--font-lock-settings
+ (treesit-font-lock-rules
+ :language 'lua
+ :feature 'bracket
+ '(["(" ")" "[" "]" "{" "}"] @font-lock-bracket-face)
+
+ :language 'lua
+ :feature 'delimiter
+ '(["," ";"] @font-lock-delimiter-face)
+
+ :language 'lua
+ :feature 'escape
+ '((escape_sequence) @font-lock-escape-face)
+
+ :language 'lua
+ :feature 'constant
+ '((variable_list
+ attribute: (attribute (["<" ">"] (identifier))))
+ @font-lock-constant-face)
+
+ :language 'lua
+ :feature 'operator
+ '(["and" "not" "or" "+" "-" "*" "/" "%" "^"
+ "#" "==" "~=" "<=" ">=" "<" ">" "=" "&"
+ "~" "|" "<<" ">>" "//" ".."]
+ @font-lock-operator-face
+ (vararg_expression) @font-lock-operator-face)
+
+ :language 'lua
+ :feature 'property
+ '((field name: (identifier) @font-lock-property-name-face)
+ (dot_index_expression
+ field: (identifier) @font-lock-property-use-face))
+
+ :language 'lua
+ :feature 'builtin
+ `(((identifier) @font-lock-builtin-face
+ (:match ,(regexp-opt lua-ts--builtins 'symbols)
+ @font-lock-builtin-face)))
+
+ :language 'lua
+ :feature 'function
+ '((function_call name: (identifier) @font-lock-function-call-face)
+ (function_call
+ name: (method_index_expression
+ method: (identifier) @font-lock-function-call-face))
+ (function_call
+ name: (dot_index_expression
+ table: (identifier) @font-lock-function-call-face)))
+
+ :language 'lua
+ :feature 'punctuation
+ '(["." ":"] @font-lock-punctuation-face)
+
+ :language 'lua
+ :feature 'variable
+ '((function_call
+ arguments: (arguments (identifier))
+ @font-lock-variable-use-face)
+ (function_call
+ name: (method_index_expression
+ table: (identifier) @font-lock-variable-use-face))
+ (goto_statement (identifier) @font-lock-variable-use-face))
+
+ :language 'lua
+ :feature 'assignment
+ '((variable_list (identifier) @font-lock-variable-name-face))
+
+ :language 'lua
+ :feature 'number
+ '((number) @font-lock-number-face)
+
+ :language 'lua
+ :feature 'keyword
+ '((break_statement) @font-lock-keyword-face
+ (true) @font-lock-constant-face
+ (false) @font-lock-constant-face
+ (nil) @font-lock-constant-face
+ ["and" "do" "else" "elseif" "end" "for" "function"
+ "goto" "if" "in" "local" "not" "or" "repeat"
+ "return" "then" "until" "while"]
+ @font-lock-keyword-face)
+
+ :language 'lua
+ :feature 'string
+ '((string) @font-lock-string-face)
+
+ :language 'lua
+ :feature 'comment
+ '((comment) @font-lock-comment-face
+ (hash_bang_line) @font-lock-comment-face)
+
+ :language 'lua
+ :feature 'definition
+ '((function_declaration
+ name: (identifier) @font-lock-function-name-face)
+ (parameters
+ name: (identifier) @font-lock-variable-name-face)
+ (label_statement) @font-lock-variable-name-face)
+
+ :language 'lua
+ :feature 'error
+ :override t
+ '((ERROR) @font-lock-warning-face))
+ "Tree-sitter font-lock settings for `lua-ts-mode'.")
+
+(defvar lua-ts--simple-indent-rules
+ `((lua
+ ((parent-is "chunk") column-0 0)
+ ((node-is "comment_end") column-0 0)
+ ((parent-is "block") parent-bol 0)
+ ((node-is "}") parent-bol 0)
+ ((node-is ")") parent-bol 0)
+ ((node-is "else_statement") parent-bol 0)
+ ((node-is "elseif_statement") parent-bol 0)
+ ((node-is "end") parent-bol 0)
+ ((node-is "until") parent-bol 0)
+ ((parent-is "for_statement") parent-bol lua-ts-indent-offset)
+ ((parent-is "function_declaration") parent-bol lua-ts-indent-offset)
+ ((parent-is "function_definition") parent-bol lua-ts-indent-offset)
+ ((parent-is "if_statement") parent-bol lua-ts-indent-offset)
+ ((parent-is "else_statement") parent-bol lua-ts-indent-offset)
+ ((parent-is "repeat_statement") parent-bol lua-ts-indent-offset)
+ ((parent-is "while_statement") parent-bol lua-ts-indent-offset)
+ ((parent-is "table_constructor") parent-bol lua-ts-indent-offset)
+ ((parent-is "arguments") parent-bol lua-ts-indent-offset)
+ ((parent-is "parameters") parent-bol lua-ts-indent-offset)
+ ((parent-is "ERROR") no-indent 0))))
+
+(defvar lua-ts--syntax-table
+ (let ((table (make-syntax-table)))
+ (modify-syntax-entry ?+ "." table)
+ (modify-syntax-entry ?- ". 12" table)
+ (modify-syntax-entry ?= "." table)
+ (modify-syntax-entry ?% "." table)
+ (modify-syntax-entry ?^ "." table)
+ (modify-syntax-entry ?~ "." table)
+ (modify-syntax-entry ?< "." table)
+ (modify-syntax-entry ?> "." table)
+ (modify-syntax-entry ?/ "." table)
+ (modify-syntax-entry ?* "." table)
+ (modify-syntax-entry ?\n ">" table)
+ (modify-syntax-entry ?\' "\"" table)
+ (modify-syntax-entry ?\" "\"" table)
+ table)
+ "Syntax table for `lua-ts-mode'.")
+
+(defun lua-ts--defun-name-function (node)
+ "Return the defun name of NODE.
+Return nil if there is no name or if NODE is not a defun node."
+ (let ((child (treesit-node-child-by-field-name node "name")))
+ (pcase (treesit-node-type node)
+ ((or "function_declaration" "function_definition")
+ (treesit-node-text child t))
+ ("variable_declaration"
+ (if child
+ (treesit-node-text child t)
+ (treesit-node-text
+ (treesit-node-child-by-field-name
+ (treesit-search-subtree node "assignment_statement" nil nil 1)
+ "name"))))
+ ("field"
+ (and (treesit-search-subtree node "function_definition" nil nil 1)
+ (treesit-node-text child t))))))
+
+(defvar-local lua-ts--flymake-process nil)
+
+(defun lua-ts-flymake-luacheck (report-fn &rest _args)
+ "Luacheck backend for Flymake.
+Calls REPORT-FN directly."
+ (when (process-live-p lua-ts--flymake-process)
+ (kill-process lua-ts--flymake-process))
+ (let ((source (current-buffer)))
+ (save-restriction
+ (widen)
+ (setq lua-ts--flymake-process
+ (make-process
+ :name "lua-ts-flymake-luacheck"
+ :noquery t
+ :connection-type 'pipe
+ :buffer (generate-new-buffer " *lua-ts-flymake-luacheck*")
+ :command `(,lua-ts-luacheck-program
+ "--codes" "--ranges" "--formatter" "plain" "-")
+ :sentinel
+ (lambda (proc _event)
+ (when (eq 'exit (process-status proc))
+ (unwind-protect
+ (if (with-current-buffer source
+ (eq proc lua-ts--flymake-process))
+ (with-current-buffer (process-buffer proc)
+ (goto-char (point-min))
+ (cl-loop
+ while (search-forward-regexp
+ (rx (seq bol
+ (0+ alnum) ":"
+ (group (1+ digit)) ":"
+ (group (1+ digit)) "-"
+ (group (1+ digit)) ": "
+ (group (0+ nonl))
+ eol))
+ nil t)
+ for line = (string-to-number (match-string 1))
+ for beg = (string-to-number (match-string 2))
+ for end = (string-to-number (match-string 3))
+ for msg = (match-string 4)
+ for type = (if (string-match "^(W" msg)
+ :warning
+ :error)
+ when (and beg end)
+ collect (flymake-make-diagnostic source
+ (cons line beg)
+ (cons line (1+ end))
+ type
+ msg)
+ into diags
+ finally (funcall report-fn diags)))
+ (flymake-log :warning "Canceling obsolete check %s" proc))
+ (kill-buffer (process-buffer proc)))))))
+ (process-send-region lua-ts--flymake-process (point-min) (point-max))
+ (process-send-eof lua-ts--flymake-process))))
+
+;;;###autoload
+(defun lua-ts-inferior-lua ()
+ "Run a Lua interpreter in an inferior process."
+ (interactive)
+ (let* ((buffer lua-ts-inferior-buffer)
+ (name (string-replace "*" "" buffer))
+ (program lua-ts-inferior-program)
+ (prompt-regexp lua-ts-inferior-prompt-regexp)
+ (switches lua-ts-inferior-options)
+ (startfile lua-ts-inferior-startfile))
+ (unless (comint-check-proc buffer)
+ (set-buffer (apply (function make-comint) name program startfile switches))
+ (setq-local comint-input-ignoredups t
+ comint-prompt-read-only t
+ comint-prompt-regexp prompt-regexp
+ comint-use-prompt-regexp t))
+ (select-window (display-buffer buffer '((display-buffer-reuse-window
+ display-buffer-pop-up-frame)
+ (reusable-frames . t))))))
+
+;;;###autoload
+(define-derived-mode lua-ts-mode prog-mode "Lua"
+ "Major mode for editing Lua files, powered by tree-sitter."
+ :syntax-table lua-ts--syntax-table
+
+ (when (treesit-ready-p 'lua)
+ (treesit-parser-create 'lua)
+
+ ;; Comments.
+ (setq-local comment-start "--")
+ (setq-local comment-start-skip "--\\s-*")
+ (setq-local comment-end "")
+
+ ;; Font-lock.
+ (setq-local treesit-font-lock-settings lua-ts--font-lock-settings)
+ (setq-local treesit-font-lock-feature-list
+ '((comment definition)
+ (keyword property string)
+ (assignment builtin constant number)
+ (bracket
+ delimiter
+ escape
+ function
+ operator
+ punctuation
+ variable)))
+
+ ;; Indent.
+ (setq-local treesit-simple-indent-rules lua-ts--simple-indent-rules)
+
+ ;; Navigation.
+ (setq-local treesit-defun-name-function #'lua-ts--defun-name-function)
+ (setq-local treesit-defun-type-regexp
+ (rx (or "function_declaration" "function_definition")))
+ (setq-local treesit-thing-settings
+ `((lua
+ (sentence ,(rx (or "do_statement"
+ "field"
+ "for_statement"
+ "function_call"
+ "if_statement"
+ "repeat_statement"
+ "return_statement"
+ "variable_declaration"
+ "while_statement")))
+ (sexp ,(rx (or "arguments"
+ "block"
+ "parameters"
+ "string"
+ "table_constructor")))
+ (text "comment"))))
+
+ ;; Imenu.
+ (setq-local treesit-simple-imenu-settings
+ `(("Variable" ,(rx bos "variable_declaration" eos) nil nil)
+ ("Function" ,(rx bos
+ (or "function_declaration"
+ "function_definition"
+ "field")
+ eos)
+ nil nil)))
+
+ ;; Which-function.
+ (setq-local which-func-functions (treesit-defun-at-point))
+
+ ;; Outline.
+ (setq-local outline-regexp
+ (rx (seq (0+ space)
+ (or (seq "--[[" (0+ space) eol)
+ (seq symbol-start
+ (or "do" "for" "if" "repeat" "while"
+ (seq (? (seq "local" (1+ space)))
+ "function"))
+ symbol-end)))))
+
+ (treesit-major-mode-setup))
+
+ (add-hook 'flymake-diagnostic-functions #'lua-ts-flymake-luacheck nil 'local))
+
+(when (treesit-ready-p 'lua)
+ (add-to-list 'auto-mode-alist '("\\.lua\\'" . lua-ts-mode)))
+
+(provide 'lua-ts-mode)
+
+;;; lua-ts-mode.el ends here
diff --git a/test/infra/Dockerfile.emba b/test/infra/Dockerfile.emba
index 584e4444dc1..e29098ec270 100644
--- a/test/infra/Dockerfile.emba
+++ b/test/infra/Dockerfile.emba
@@ -126,6 +126,7 @@ RUN src/emacs -Q --batch \
(java "https://github.com/tree-sitter/tree-sitter-java") \
(javascript "https://github.com/tree-sitter/tree-sitter-javascript") \
(json "https://github.com/tree-sitter/tree-sitter-json") \
+ (lua "https://github.com/MunifTanjim/tree-sitter-lua") \
(python "https://github.com/tree-sitter/tree-sitter-python") \
(ruby "https://github.com/tree-sitter/tree-sitter-ruby") \
(tsx "https://github.com/tree-sitter/tree-sitter-typescript" "master" "tsx/src") \
diff --git a/test/infra/test-jobs.yml b/test/infra/test-jobs.yml
index 2f6e0dab4d5..1f5d607eda4 100644
--- a/test/infra/test-jobs.yml
+++ b/test/infra/test-jobs.yml
@@ -580,6 +580,7 @@ test-src-inotify:
lisp/progmodes/go-ts-mode-tests.log
lisp/progmodes/heex-ts-mode-tests.log
lisp/progmodes/java-ts-mode-tests.log
+ lisp/progmodes/lua-ts-mode-tests.log
lisp/progmodes/ruby-ts-mode-tests.log
lisp/progmodes/typescript-ts-mode-tests.log
src/treesit-tests.log
diff --git a/test/lisp/progmodes/lua-ts-mode-resources/indent.erts b/test/lisp/progmodes/lua-ts-mode-resources/indent.erts
new file mode 100644
index 00000000000..040225c8580
--- /dev/null
+++ b/test/lisp/progmodes/lua-ts-mode-resources/indent.erts
@@ -0,0 +1,152 @@
+Code:
+ (lambda ()
+ (setq indent-tabs-mode nil)
+ (setq lua-ts-indent-offset 2)
+ (lua-ts-mode)
+ (indent-region (point-min) (point-max)))
+
+Name: Basic Indent
+
+=-=
+ print(
+0,
+ 1
+)
+
+local function f(o)
+ if o.x > o.y then
+ return o.x
+elseif o.y > o.z then
+ return o.y
+ else
+return o.z
+ end
+end
+
+f({
+ x = 1,
+ y = 2,
+ z = 3,
+})
+
+;(function()
+return false
+)()
+=-=
+print(
+ 0,
+ 1
+)
+
+local function f(o)
+ if o.x > o.y then
+ return o.x
+ elseif o.y > o.z then
+ return o.y
+ else
+ return o.z
+ end
+end
+
+f({
+ x = 1,
+ y = 2,
+ z = 3,
+})
+
+;(function()
+ return false
+)()
+=-=-=
+
+Name: Argument Indent
+
+=-=
+function h(
+string,
+number,
+options)
+print(string, number, options)
+end
+
+local p = h(
+"sring",
+ 1000,
+ {
+cost = 2,
+length = 8,
+ parallelism = 4,
+})
+=-=
+function h(
+ string,
+ number,
+ options)
+ print(string, number, options)
+end
+
+local p = h(
+ "sring",
+ 1000,
+ {
+ cost = 2,
+ length = 8,
+ parallelism = 4,
+ })
+=-=-=
+
+Name: Continuation Indent
+
+=-=
+function f()
+ local str = [[
+ multi-line
+ string
+ ]]
+--[[
+multi-line
+comment
+ ]]
+return true
+end
+=-=
+function f()
+ local str = [[
+ multi-line
+ string
+ ]]
+ --[[
+multi-line
+comment
+ ]]
+ return true
+end
+=-=-=
+
+Name: Loop Indent
+
+=-=
+for k, v in pairs({}) do
+ print(k, v)
+end
+
+while n < 10 do
+n = n + 1
+end
+
+repeat
+z = z * 2
+ until z > 12
+=-=
+for k, v in pairs({}) do
+ print(k, v)
+end
+
+while n < 10 do
+ n = n + 1
+end
+
+repeat
+ z = z * 2
+until z > 12
+=-=-=
diff --git a/test/lisp/progmodes/lua-ts-mode-resources/movement.erts b/test/lisp/progmodes/lua-ts-mode-resources/movement.erts
new file mode 100644
index 00000000000..770aa23b18d
--- /dev/null
+++ b/test/lisp/progmodes/lua-ts-mode-resources/movement.erts
@@ -0,0 +1,553 @@
+Code:
+ (lambda ()
+ (lua-ts-mode)
+ (beginning-of-defun 1))
+
+Point-Char: |
+
+Name: beginning-of-defun moves to start of function declaration
+
+=-=
+local function Test()
+ if true then
+ print(1)
+ else
+ print(0)
+ end|
+end
+=-=
+|local function Test()
+ if true then
+ print(1)
+ else
+ print(0)
+ end
+end
+=-=-=
+
+Name: beginning-of-defun moves to start of function definition
+
+=-=
+local t = {
+ f = function()
+ return true
+ end,
+}|
+=-=
+local t = {
+| f = function()
+ return true
+ end,
+}
+=-=-=
+
+Code:
+ (lambda ()
+ (lua-ts-mode)
+ (end-of-defun 1))
+
+Point-Char: |
+
+Name: end-of-defun moves to end of function declaration
+
+=-=
+local function Test()
+ if true then
+ pr|int(1)
+ else
+ print(0)
+ end
+end
+
+local t = Test()
+=-=
+local function Test()
+ if true then
+ print(1)
+ else
+ print(0)
+ end
+end
+|
+local t = Test()
+=-=-=
+
+Name: end-of-defun moves to end of function definition
+
+=-=
+local t = {
+ f = function()
+ re|turn true
+ end,
+}
+=-=
+local t = {
+ f = function()
+ return true
+ end|,
+}
+=-=-=
+
+Code:
+ (lambda ()
+ (lua-ts-mode)
+ (forward-sentence 1))
+
+Point-Char: |
+
+Name: forward-sentence moves over if statements
+
+=-=
+function f()
+ |if true then
+ print(1)
+ elseif false then
+ print(0)
+ else
+ print(2)
+ end
+end
+=-=
+function f()
+ if true then
+ print(1)
+ elseif false then
+ print(0)
+ else
+ print(2)
+ end|
+end
+=-=-=
+
+Name: forward-sentence moves over variable declaration
+
+=-=
+|local n = 1
+
+print(n)
+=-=
+local n = 1|
+
+print(n)
+=-=-=
+
+Name: forward-sentence moves over for statements
+
+=-=
+|for k, v in pairs({}) do
+ print(k, v)
+end
+
+print(1)
+=-=
+for k, v in pairs({}) do
+ print(k, v)
+end|
+
+print(1)
+=-=-=
+
+Name: forward-sentence moves over for statements
+
+=-=
+|do
+ local x = 1
+ local y = 2
+
+ print(x, y)
+end
+
+print(1)
+=-=
+do
+ local x = 1
+ local y = 2
+
+ print(x, y)
+end|
+
+print(1)
+=-=-=
+
+Name: forward-sentence moves over while statements
+
+=-=
+local i = 0
+|while i < 9 do
+ print(i)
+ i = i + 1
+end
+
+print(1)
+=-=
+local i = 0
+while i < 9 do
+ print(i)
+ i = i + 1
+end|
+
+print(1)
+=-=-=
+
+Name: forward-sentence moves over repeat statements
+
+=-=
+local i = 0
+|repeat
+ print(i)
+ i = i + 1
+until i > 9
+
+print(1)
+=-=
+local i = 0
+repeat
+ print(i)
+ i = i + 1
+until i > 9|
+
+print(1)
+=-=-=
+
+Name: forward-sentence moves over function calls
+
+=-=
+|print(1)
+=-=
+print(1)|
+=-=-=
+
+Name: forward-sentence moves over return statements
+
+=-=
+function f()
+ |return math.random()
+end
+=-=
+function f()
+ return math.random()|
+end
+=-=-=
+
+Code:
+ (lambda ()
+ (lua-ts-mode)
+ (forward-sentence 2))
+
+Name: forward-sentence moves over table fields
+
+=-=
+local t = {
+ |a = 1,
+ b = 2,
+}
+=-=
+local t = {
+ a = 1,
+ b = 2|,
+}
+=-=-=
+
+Code:
+ (lambda ()
+ (lua-ts-mode)
+ (backward-sentence 1))
+
+Point-Char: |
+
+Name: backward-sentence moves over if statements
+
+=-=
+function f()
+ if true then
+ print(1)
+ elseif false then
+ print(0)
+ else
+ print(2)
+ end|
+end
+=-=
+function f()
+ |if true then
+ print(1)
+ elseif false then
+ print(0)
+ else
+ print(2)
+ end
+end
+=-=-=
+
+Name: backward-sentence moves over variable declaration
+
+=-=
+local n = 1|
+
+print(n)
+=-=
+|local n = 1
+
+print(n)
+=-=-=
+
+Name: backward-sentence moves over for statements
+
+=-=
+for k, v in pairs({}) do
+ print(k, v)
+end|
+
+print(1)
+=-=
+|for k, v in pairs({}) do
+ print(k, v)
+end
+
+print(1)
+=-=-=
+
+Name: backward-sentence moves over for statements
+
+=-=
+do
+ local x = 1
+ local y = 2
+
+ print(x, y)
+end|
+
+print(1)
+=-=
+|do
+ local x = 1
+ local y = 2
+
+ print(x, y)
+end
+
+print(1)
+=-=-=
+
+Name: backward-sentence moves over while statements
+
+=-=
+local i = 0
+while i < 9 do
+ print(i)
+ i = i + 1
+end|
+
+print(1)
+=-=
+local i = 0
+|while i < 9 do
+ print(i)
+ i = i + 1
+end
+
+print(1)
+=-=-=
+
+Name: backward-sentence moves over repeat statements
+
+=-=
+local i = 0
+repeat
+ print(i)
+ i = i + 1
+until i > 9|
+
+print(1)
+=-=
+local i = 0
+|repeat
+ print(i)
+ i = i + 1
+until i > 9
+
+print(1)
+=-=-=
+
+Name: backward-sentence moves over function calls
+
+=-=
+print(1)|
+=-=
+|print(1)
+=-=-=
+
+Name: backward-sentence moves over return statements
+
+=-=
+function f()
+ return math.random()|
+end
+=-=
+function f()
+ |return math.random()
+end
+=-=-=
+
+Code:
+ (lambda ()
+ (lua-ts-mode)
+ (backward-sentence 2))
+
+Point-Char: |
+
+Name: backward-sentence moves over table fields
+
+=-=
+local t = {
+ a = 1,
+ b = 2|,
+}
+=-=
+local t = {
+ |a = 1,
+ b = 2,
+}
+=-=-=
+
+Code:
+ (lambda ()
+ (lua-ts-mode)
+ (forward-sexp 1))
+
+Point-Char: |
+
+Name: forward-sexp moves over blocks
+
+=-=
+local function Test()
+ |local t = {
+ a = 1,
+ }
+
+ if true then
+ print(1)
+ else
+ print(0)
+ end
+end
+=-=
+local function Test()
+ local t = {
+ a = 1,
+ }
+
+ if true then
+ print(1)
+ else
+ print(0)
+ end|
+end
+=-=-=
+
+Name: forward-sexp moves over arguments
+
+=-=
+print|(1, 2, 3)
+=-=
+print(1, 2, 3)|
+=-=-=
+
+Name: forward-sexp moves over parameters
+
+=-=
+function f|(a, b) end
+=-=
+function f(a, b)| end
+=-=-=
+
+Name: forward-sexp moves over strings
+
+=-=
+print("|1, 2, 3")
+=-=
+print("1, 2, 3|")
+=-=-=
+
+Name: forward-sexp moves over tables
+
+=-=
+local t = |{ 1,
+ 2,
+ 3 }
+=-=
+local t = { 1,
+ 2,
+ 3 }|
+=-=-=
+
+Code:
+ (lambda ()
+ (lua-ts-mode)
+ (backward-sexp 1))
+
+Point-Char: |
+
+Name: backward-sexp moves over blocks
+
+=-=
+local function Test()
+ local t = {
+ a = 1,
+ }
+
+ if true then
+ print(1)
+ else
+ print(0)
+ end|
+end
+=-=
+local function Test()
+ |local t = {
+ a = 1,
+ }
+
+ if true then
+ print(1)
+ else
+ print(0)
+ end
+end
+=-=-=
+
+Name: backward-sexp moves over arguments
+
+=-=
+print(1, 2, 3)|
+=-=
+print|(1, 2, 3)
+=-=-=
+
+Name: backward-sexp moves over parameters
+
+=-=
+function f(a, b)| end
+=-=
+function f|(a, b) end
+=-=-=
+
+Name: backward-sexp moves over strings
+
+=-=
+print("1, 2, 3|")
+=-=
+print("|1, 2, 3")
+=-=-=
+
+Name: backward-sexp moves over tables
+
+=-=
+local t = { 1,
+ 2,
+ 3 }|
+=-=
+local t = |{ 1,
+ 2,
+ 3 }
+=-=-=
diff --git a/test/lisp/progmodes/lua-ts-mode-tests.el b/test/lisp/progmodes/lua-ts-mode-tests.el
new file mode 100644
index 00000000000..d2105b66f6d
--- /dev/null
+++ b/test/lisp/progmodes/lua-ts-mode-tests.el
@@ -0,0 +1,36 @@
+;;; lua-ts-mode-tests.el --- Tests for lua-ts-mode -*- lexical-binding: t; -*-
+
+;; Copyright (C) 2023 Free Software Foundation, Inc.
+
+;; 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/>.
+
+;;; Code:
+
+(require 'ert)
+(require 'ert-x)
+(require 'treesit)
+
+(ert-deftest lua-ts-mode-test-indentation ()
+ (skip-unless (treesit-ready-p 'lua))
+ (ert-test-erts-file (ert-resource-file "indent.erts")))
+
+(ert-deftest lua-ts-mode-test-movement ()
+ (skip-unless (treesit-ready-p 'lua))
+ (ert-test-erts-file (ert-resource-file "movement.erts")))
+
+(provide 'lua-ts-mode-tests)
+
+;;; lua-ts-mode-tests.el ends here
--
2.41.0
^ permalink raw reply related [flat|nested] 16+ messages in thread
* bug#65673: [PATCH] Add lua-ts-mode
2023-09-11 15:03 ` john muhl via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2023-09-16 10:03 ` Eli Zaretskii
2023-09-16 11:17 ` Eli Zaretskii
0 siblings, 1 reply; 16+ messages in thread
From: Eli Zaretskii @ 2023-09-16 10:03 UTC (permalink / raw)
To: john muhl
Cc: philipk, ~emacs/emacs-devel, jm, maurooaranda, 65673-done,
arstoffel
> Cc: john muhl <jm@pub.pink>, arstoffel@gmail.com, maurooaranda@gmail.com,
> 65673@debbugs.gnu.org, ~emacs/emacs-devel@lists.sr.ht
> Date: Mon, 11 Sep 2023 10:03:13 -0500
> From: john muhl via "Bug reports for GNU Emacs,
> the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
>
> * lisp/progmodes/lua-ts-mode.el:
> * test/lisp/progmodes/lua-ts-mode-resources/indent.erts:
> * test/lisp/progmodes/lua-ts-mode-tests.el: New file.
> * etc/NEWS: Mention new mode.
> * lisp/progmodes/eglot.el (eglot-server-programs):
> * lisp/progmodes/hideshow.el (hs-special-modes-alist): Support
> lua-ts-mode.
> * admin/notes/tree-sitter/build-module/batch.sh:
> * admin/notes/tree-sitter/build-module/build.sh: Add Lua.
> * test/infra/Dockerfile.emba:
> * test/infra/test-jobs.yml: Include lua-ts-mode tests.
Thanks, installed on the master branch, and closing the bug.
^ permalink raw reply [flat|nested] 16+ messages in thread
* bug#65673: [PATCH] Add lua-ts-mode
2023-09-16 10:03 ` Eli Zaretskii
@ 2023-09-16 11:17 ` Eli Zaretskii
2023-09-16 11:21 ` Eli Zaretskii
0 siblings, 1 reply; 16+ messages in thread
From: Eli Zaretskii @ 2023-09-16 11:17 UTC (permalink / raw)
To: jm; +Cc: 65673
> Resent-To: bug-gnu-emacs@gnu.org
> Cc: philipk@posteo.net, ~emacs/emacs-devel@lists.sr.ht, jm@pub.pink,
> maurooaranda@gmail.com, 65673-done@debbugs.gnu.org, arstoffel@gmail.com
> Date: Sat, 16 Sep 2023 13:03:11 +0300
> From: Eli Zaretskii <eliz@gnu.org>
>
> > Cc: john muhl <jm@pub.pink>, arstoffel@gmail.com, maurooaranda@gmail.com,
> > 65673@debbugs.gnu.org, ~emacs/emacs-devel@lists.sr.ht
> > Date: Mon, 11 Sep 2023 10:03:13 -0500
> > From: john muhl via "Bug reports for GNU Emacs,
> > the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
> >
> > * lisp/progmodes/lua-ts-mode.el:
> > * test/lisp/progmodes/lua-ts-mode-resources/indent.erts:
> > * test/lisp/progmodes/lua-ts-mode-tests.el: New file.
> > * etc/NEWS: Mention new mode.
> > * lisp/progmodes/eglot.el (eglot-server-programs):
> > * lisp/progmodes/hideshow.el (hs-special-modes-alist): Support
> > lua-ts-mode.
> > * admin/notes/tree-sitter/build-module/batch.sh:
> > * admin/notes/tree-sitter/build-module/build.sh: Add Lua.
> > * test/infra/Dockerfile.emba:
> > * test/infra/test-jobs.yml: Include lua-ts-mode tests.
>
> Thanks, installed on the master branch, and closing the bug.
However, this causes byte-compilation warnings on a system where
tree-sitter is not available:
In end of data:
progmodes/typescript-ts-mode.el:498:17: Warning: the function ‘treesit-node-end’ is not known to be defined.
progmodes/typescript-ts-mode.el:497:17: Warning: the function ‘treesit-node-start’ is not known to be defined.
progmodes/typescript-ts-mode.el:474:6: Warning: the function ‘treesit-query-compile’ is not known to be defined.
Could you please fix these warnings?
^ permalink raw reply [flat|nested] 16+ messages in thread
* bug#65673: [PATCH] Add lua-ts-mode
2023-09-16 11:17 ` Eli Zaretskii
@ 2023-09-16 11:21 ` Eli Zaretskii
0 siblings, 0 replies; 16+ messages in thread
From: Eli Zaretskii @ 2023-09-16 11:21 UTC (permalink / raw)
To: jm; +Cc: 65673
> Cc: 65673@debbugs.gnu.org
> Date: Sat, 16 Sep 2023 14:17:09 +0300
> From: Eli Zaretskii <eliz@gnu.org>
>
> However, this causes byte-compilation warnings on a system where
> tree-sitter is not available:
>
> In end of data:
> progmodes/typescript-ts-mode.el:498:17: Warning: the function ‘treesit-node-end’ is not known to be defined.
> progmodes/typescript-ts-mode.el:497:17: Warning: the function ‘treesit-node-start’ is not known to be defined.
> progmodes/typescript-ts-mode.el:474:6: Warning: the function ‘treesit-query-compile’ is not known to be defined.
>
> Could you please fix these warnings?
Sorry, please ignore me: I posted this to the wrong bug.
^ permalink raw reply [flat|nested] 16+ messages in thread
end of thread, other threads:[~2023-09-16 11:21 UTC | newest]
Thread overview: 16+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-08-31 22:55 bug#65673: [PATCH emacs 0/1] Add lua-ts-mode ~johnmuhl
2023-08-31 21:32 ` bug#65672: [PATCH emacs 1/1] " ~johnmuhl
2023-09-02 12:14 ` bug#65673: [PATCH emacs 0/1] " Philip Kaludercic
2023-09-02 14:10 ` bug#65672: [PATCH emacs 1/1] " Augusto Stoffel
[not found] ` <handler.65672.B.169354983214451.ack@debbugs.gnu.org>
2023-09-04 14:36 ` john muhl via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-04 15:18 ` Eli Zaretskii
2023-09-04 15:54 ` Philip Kaludercic
2023-09-01 22:46 ` bug#65673: [PATCH emacs 0/1] " Mauro Aranda
2023-09-09 15:17 ` bug#65673: [PATCH emacs 1/1 v2] " john muhl via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-09 15:17 ` bug#65673: [PATCH] " john muhl via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-10 11:12 ` Philip Kaludercic
2023-09-10 12:57 ` Augusto Stoffel
2023-09-11 15:03 ` john muhl via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-16 10:03 ` Eli Zaretskii
2023-09-16 11:17 ` Eli Zaretskii
2023-09-16 11:21 ` Eli Zaretskii
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).