From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Gabriel Santos via "Bug reports for GNU Emacs, the Swiss army knife of text editors" Newsgroups: gmane.emacs.bugs Subject: bug#74461: [PATCH] Add go-work-ts-mode Date: Fri, 22 Nov 2024 07:15:26 -0300 Message-ID: <87ttbzd16p.fsf@disroot.org> References: <877c8wvp34.fsf@disroot.org> Reply-To: Gabriel Santos Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="28016"; mail-complaints-to="usenet@ciao.gmane.io" Cc: eliz@gnu.org, 74461@debbugs.gnu.org To: dev@rjt.dev Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Fri Nov 22 11:16:12 2024 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1tEQhv-00076n-Lb for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 22 Nov 2024 11:16:11 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tEQhp-0004OW-0y; Fri, 22 Nov 2024 05:16:05 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tEQhm-0004OJ-6S for bug-gnu-emacs@gnu.org; Fri, 22 Nov 2024 05:16:02 -0500 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1tEQhl-0005EA-UO for bug-gnu-emacs@gnu.org; Fri, 22 Nov 2024 05:16:01 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=debbugs.gnu.org; s=debbugs-gnu-org; h=MIME-Version:Date:From:To:In-Reply-To:References:Subject; bh=cG1is/U+8Q6gEEU9KUbt1oisjOaFPWbzOhwkKVs6kd0=; b=lzQ68+iQLWMAMVuVZQrZ2C4KuXrEoYqK203fP/Pj0I0wGcFpIGQnxkIX3vzDq1x7BKEavu3gCgZO8RBIQmE88J00aB3W566NHNbX5CSgZV49uWyiwl054aJeMyyHGDJv1TLwxtbYsPEIovLj2LLh5mX5vNKvrPxNQa+lN+DoehzfAi050pREjJRCZdoQFayOjC55WRiw5/A04tyeKoDn6sKMLeNLqkd9qc7LEJLHa9/QbY3SBIR2WsDD1Rtaal0yTES6nRuXc3H9L99KeAteAQn0JPK+omaYB03hlZDWwbIDZsl/P3vLpmtmI4kt8yYXLePV3ly4voa/WdvpRLKrHg==; Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1tEQhl-0001kr-Pw for bug-gnu-emacs@gnu.org; Fri, 22 Nov 2024 05:16:01 -0500 X-Loop: help-debbugs@gnu.org In-Reply-To: <877c8wvp34.fsf@disroot.org> Resent-From: Gabriel Santos Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 22 Nov 2024 10:16:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 74461 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 74461-submit@debbugs.gnu.org id=B74461.17322705426712 (code B ref 74461); Fri, 22 Nov 2024 10:16:01 +0000 Original-Received: (at 74461) by debbugs.gnu.org; 22 Nov 2024 10:15:42 +0000 Original-Received: from localhost ([127.0.0.1]:53121 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1tEQhR-0001kB-S0 for submit@debbugs.gnu.org; Fri, 22 Nov 2024 05:15:42 -0500 Original-Received: from layka.disroot.org ([178.21.23.139]:45988) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1tEQhO-0001jz-5g for 74461@debbugs.gnu.org; Fri, 22 Nov 2024 05:15:39 -0500 Original-Received: from mail01.disroot.lan (localhost [127.0.0.1]) by disroot.org (Postfix) with ESMTP id B474B25259; Fri, 22 Nov 2024 11:15:36 +0100 (CET) X-Virus-Scanned: SPAM Filter at disroot.org Original-Received: from layka.disroot.org ([127.0.0.1]) by localhost (disroot.org [127.0.0.1]) (amavis, port 10024) with ESMTP id f7EYUlImuXLO; Fri, 22 Nov 2024 11:15:31 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=disroot.org; s=mail; t=1732270531; bh=2Ve3TfX06X4x9iq/JHJIhnZ8lyx8I0rq/McIwPFRU1E=; h=From:To:Cc:Subject:Date; b=Rk2/+OsIL2QPiD1irw4a3Bmz8u0dVvc272NEWLcjlqnB6aes2QJ7vJFVq3xVffLRh zQbqZwXF7mFdE4Vl4L1gdksaJHSva000D5fF/CGc05/QQI/ITexlhd/8mbY8awV1hA WNwmNjohsNn28zz/6V9HwQ+tjjEIhCzvjRKAAgHk8mwJ30WyJ/N9sGS95pp3zOVJQe Wm1xVVUlZ57P3GBhxjjg9rCPqpQ2jh0iAShAP8SRdeTqGYWFb752uPr0GmkTQ/1E5X Gz7zAOY6UJ/Vza+ZyKLawd/iAPcREGYxsgCFOc3PZICDCUIUF9C4ljvztaFeI4EtDl uU7y7jZJn2vIA== X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:295786 Archived-At: --=-=-= Content-Type: text/plain I fixed the mistake you pointed out in build.sh > It would be nice to have syntax highlighting and indentation tests for > this (ideally covering everything). If you're interested, take a look > at go-ts-mode-tests.el and the files it references for inspiration. I wrote some simple tests for both go-mod-ts-mode and go-work-ts-mode. For syntax highlighting, I had them both use the same file (font-lock-package.go), since they have some compatible elements, and for indentation, I made a simple test for indenting multiple lines. I also changed the face for operators (on go-work-ts-mode), as I incorrectly used font-lock-warning-face. Also, please let me know your opinion on how I layed out the grammars in the commentary section. I think I'll go through the other tree-sitter modes and add the grammar to their commentary section too, so it's nice to get some feedback before making these changes. --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-Add-go-work-ts-mode.patch Content-Description: [PATCH] Add go-work-ts-mode >From eb704432594e0ce5114184fe87152122c2b69595 Mon Sep 17 00:00:00 2001 From: Gabriel Date: Wed, 20 Nov 2024 23:07:28 -0300 Subject: [PATCH] Add go-work-ts-mode * admin/notes/tree-sitter/build-module/batch.sh: * admin/notes/tree-sitter/build-module/build.sh: Add go-work support. * etc/NEWS: Mention go-work-ts-mode. * lisp/progmodes/eglot.el (eglot-server-programs): Add go-work-ts-mode. * lisp/progmodes/go-ts-mode: Add go-work-ts-mode for working with workspace files. * lisp/progmodes/go-ts-mode: Add the repositories for the grammars to the commentary section. * lisp/progmodes/go-ts-mode (go-mod-ts-mode--in-directive-p): Be more specific on the directive location. * test/lisp/progmodes/go-ts-mode-tests: Add tests for Go module and workspace files. * test/lisp/progmodes/go-ts-mode-resources/font-lock-package: New file for both go-mod-ts-mode and go-work-ts-mode font-locking tests. * test/lisp/progmodes/go-ts-mode-resources/indent-mod.erts: * test/lisp/progmodes/go-ts-mode-resources/indent-work.erts: New files for testing indentation in Go module and workspace files. --- admin/notes/tree-sitter/build-module/batch.sh | 1 + admin/notes/tree-sitter/build-module/build.sh | 5 + etc/NEWS | 6 ++ lisp/progmodes/eglot.el | 2 +- lisp/progmodes/go-ts-mode.el | 101 +++++++++++++++++- .../go-ts-mode-resources/font-lock-package.go | 4 + .../go-ts-mode-resources/indent-mod.erts | 16 +++ .../go-ts-mode-resources/indent-work.erts | 16 +++ test/lisp/progmodes/go-ts-mode-tests.el | 24 +++++ 9 files changed, 173 insertions(+), 2 deletions(-) create mode 100644 test/lisp/progmodes/go-ts-mode-resources/font-lock-package.go create mode 100644 test/lisp/progmodes/go-ts-mode-resources/indent-mod.erts create mode 100644 test/lisp/progmodes/go-ts-mode-resources/indent-work.erts diff --git a/admin/notes/tree-sitter/build-module/batch.sh b/admin/notes/tree-sitter/build-module/batch.sh index 012b5882e83..1b5214267f5 100755 --- a/admin/notes/tree-sitter/build-module/batch.sh +++ b/admin/notes/tree-sitter/build-module/batch.sh @@ -11,6 +11,7 @@ languages=( 'elixir' 'go' 'go-mod' + 'go-work' 'heex' 'html' 'java' diff --git a/admin/notes/tree-sitter/build-module/build.sh b/admin/notes/tree-sitter/build-module/build.sh index 9a567bb094d..4f3c6da3c5f 100755 --- a/admin/notes/tree-sitter/build-module/build.sh +++ b/admin/notes/tree-sitter/build-module/build.sh @@ -39,6 +39,11 @@ case "${lang}" in lang="gomod" org="camdencheek" ;; + "go-work") + # The parser is called "gowork". + lang="gowork" + org="omertuc" + ;; "heex") org="phoenixframework" ;; diff --git a/etc/NEWS b/etc/NEWS index b6c21018779..a07d9300fe9 100644 --- a/etc/NEWS +++ b/etc/NEWS @@ -925,6 +925,12 @@ current buffer, if the major mode supports it. (Support for Transformed images are smoothed using the bilinear interpolation by means of the GDI+ library. +--- +** New major mode 'go-work-ts-mode'. +A major mode based on the tree-sitter library for editing "go.work" +files. If tree-sitter is properly set-up by the user, it can be +enabled for files named "go.work". + ---------------------------------------------------------------------- This file is part of GNU Emacs. diff --git a/lisp/progmodes/eglot.el b/lisp/progmodes/eglot.el index e5c27de81fc..4dbb0906b9e 100644 --- a/lisp/progmodes/eglot.el +++ b/lisp/progmodes/eglot.el @@ -273,7 +273,7 @@ automatically)." (elm-mode . ("elm-language-server")) (mint-mode . ("mint" "ls")) ((kotlin-mode kotlin-ts-mode) . ("kotlin-language-server")) - ((go-mode go-dot-mod-mode go-dot-work-mode go-ts-mode go-mod-ts-mode) + ((go-mode go-dot-mod-mode go-dot-work-mode go-ts-mode go-mod-ts-mode go-work-ts-mode) . ("gopls")) ((R-mode ess-r-mode) . ("R" "--slave" "-e" "languageserver::run()")) diff --git a/lisp/progmodes/go-ts-mode.el b/lisp/progmodes/go-ts-mode.el index 86e74ad58a8..8ab54a71f1b 100644 --- a/lisp/progmodes/go-ts-mode.el +++ b/lisp/progmodes/go-ts-mode.el @@ -24,6 +24,9 @@ ;;; Commentary: ;; +;; - Go grammar: https://github.com/tree-sitter/tree-sitter-go +;; - Go module grammar: https://github.com/camdencheek/tree-sitter-go-mod +;; - Go workspace grammar: https://github.com/omertuc/tree-sitter-go-work ;;; Code: @@ -483,7 +486,7 @@ be run." "Tree-sitter indent rules for `go-mod-ts-mode'.") (defun go-mod-ts-mode--in-directive-p () - "Return non-nil if point is inside a directive. + "Return non-nil if point is inside a Go module directive. When entering an empty directive or adding a new entry to one, no node will be present meaning none of the indentation rules will match, because there is no parent to match against. This function determines @@ -565,6 +568,102 @@ what the parent of the node would be if it were a node." (if (treesit-ready-p 'gomod) (add-to-list 'auto-mode-alist '("/go\\.mod\\'" . go-mod-ts-mode))) +;; go.work support. + +(defvar go-work-ts-mode--syntax-table + (let ((table (make-syntax-table))) + (modify-syntax-entry ?/ ". 124b" table) + (modify-syntax-entry ?\n "> b" table) + table) + "Syntax table for `go-work-ts-mode'.") + +(defvar go-work-ts-mode--indent-rules + `((gowork + ((node-is ")") parent-bol 0) + ((parent-is "replace_directive") parent-bol go-ts-mode-indent-offset) + ((parent-is "use_directive") parent-bol go-ts-mode-indent-offset) + ((go-work-ts-mode--in-directive-p) no-indent go-ts-mode-indent-offset) + (no-node no-indent 0))) + "Tree-sitter indent rules for `go-work-ts-mode'.") + +(defun go-work-ts-mode--in-directive-p () + "Return non-nil if point is inside a Go workspace directive. +When entering an empty directive or adding a new entry to one, no node +will be present meaning none of the indentation rules will match, +because there is no parent to match against. This function determines +what the parent of the node would be if it were a node." + (lambda (node _ _ &rest _) + (unless (treesit-node-type node) + (save-excursion + (backward-up-list) + (back-to-indentation) + (pcase (treesit-node-type (treesit-node-at (point))) + ("replace" t) + ("use" t)))))) + +(defvar go-work-ts-mode--keywords + '("go" "replace" "use") + "go.work keywords for tree-sitter font-locking.") + +(defvar go-work-ts-mode--font-lock-settings + (treesit-font-lock-rules + :language 'gowork + :feature 'bracket + '((["(" ")"]) @font-lock-bracket-face) + + :language 'gowork + :feature 'comment + '((comment) @font-lock-comment-face) + + :language 'gowork + :feature 'keyword + `([,@go-work-ts-mode--keywords] @font-lock-keyword-face) + + :language 'gowork + :feature 'number + '([(go_version) (version)] @font-lock-number-face) + + :language 'gowork + :feature 'operator + '((["=>"]) @font-lock-operator-face) + + :language 'gowork + :feature 'error + :override t + '((ERROR) @font-lock-warning-face)) + "Tree-sitter font-lock settings for `go-work-ts-mode'.") + +;;;###autoload +(define-derived-mode go-work-ts-mode prog-mode "Go Work" + "Major mode for editing go.work files, powered by tree-sitter." + :group 'go + :syntax-table go-work-ts-mode--syntax-table + + (when (treesit-ready-p 'gowork) + (setq treesit-primary-parser (treesit-parser-create 'gowork)) + + ;; Comments. + (setq-local comment-start "// ") + (setq-local comment-end "") + (setq-local comment-start-skip (rx "//" (* (syntax whitespace)))) + + ;; Indent. + (setq-local indent-tabs-mode t + treesit-simple-indent-rules go-work-ts-mode--indent-rules) + + ;; Font-lock. + (setq-local treesit-font-lock-settings go-work-ts-mode--font-lock-settings) + (setq-local treesit-font-lock-feature-list + '((comment) + (keyword) + (number) + (bracket error operator))) + + (treesit-major-mode-setup))) + +(if (treesit-ready-p 'gowork) + (add-to-list 'auto-mode-alist '("/go\\.work\\'" . go-work-ts-mode))) + (provide 'go-ts-mode) ;;; go-ts-mode.el ends here diff --git a/test/lisp/progmodes/go-ts-mode-resources/font-lock-package.go b/test/lisp/progmodes/go-ts-mode-resources/font-lock-package.go new file mode 100644 index 00000000000..7bee6848810 --- /dev/null +++ b/test/lisp/progmodes/go-ts-mode-resources/font-lock-package.go @@ -0,0 +1,4 @@ +replace gnu.org/go/package1 v1.0.0 => gnu.org/go/package2 v1.0.0 +// ^ font-lock-keyword-face +// ^ font-lock-number-face +// ^ font-lock-operator-face diff --git a/test/lisp/progmodes/go-ts-mode-resources/indent-mod.erts b/test/lisp/progmodes/go-ts-mode-resources/indent-mod.erts new file mode 100644 index 00000000000..2f7bfd9030b --- /dev/null +++ b/test/lisp/progmodes/go-ts-mode-resources/indent-mod.erts @@ -0,0 +1,16 @@ +Code: + (lambda () + (go-mod-ts-mode) + (indent-region (point-min) (point-max))) + +Point-Char: | + +Name: Basic + +=-= +require ( + gnu.org/go/package1 v1.0.0 + gnu.org/go/package2 v1.0.0 +) + +=-=-= diff --git a/test/lisp/progmodes/go-ts-mode-resources/indent-work.erts b/test/lisp/progmodes/go-ts-mode-resources/indent-work.erts new file mode 100644 index 00000000000..b210974cedc --- /dev/null +++ b/test/lisp/progmodes/go-ts-mode-resources/indent-work.erts @@ -0,0 +1,16 @@ +Code: + (lambda () + (go-work-ts-mode) + (indent-region (point-min) (point-max))) + +Point-Char: | + +Name: Basic + +=-= +use ( + ./package1 + ./package2 +) + +=-=-= diff --git a/test/lisp/progmodes/go-ts-mode-tests.el b/test/lisp/progmodes/go-ts-mode-tests.el index f36dbde5103..154c424064c 100644 --- a/test/lisp/progmodes/go-ts-mode-tests.el +++ b/test/lisp/progmodes/go-ts-mode-tests.el @@ -23,6 +23,8 @@ (require 'ert-x) (require 'treesit) +;; go-ts-mode + (ert-deftest go-ts-mode-test-indentation () (skip-unless (treesit-ready-p 'go)) (ert-test-erts-file (ert-resource-file "indent.erts"))) @@ -32,5 +34,27 @@ (let ((treesit-font-lock-level 4)) (ert-font-lock-test-file (ert-resource-file "font-lock.go") 'go-ts-mode))) +;; go-mod-ts-mode + +(ert-deftest go-work-ts-mode-test-indentation () + (skip-unless (treesit-ready-p 'gomod)) + (ert-test-erts-file (ert-resource-file "indent-mod.erts"))) + +(ert-deftest go-mod-ts-test-font-lock () + (skip-unless (treesit-ready-p 'gomod)) + (let ((treesit-font-lock-level 4)) + (ert-font-lock-test-file (ert-resource-file "font-lock-package.go") 'go-mod-ts-mode))) + +;; go-work-ts-mode + +(ert-deftest go-work-ts-mode-test-indentation () + (skip-unless (treesit-ready-p 'gowork)) + (ert-test-erts-file (ert-resource-file "indent-work.erts"))) + +(ert-deftest go-work-ts-test-font-lock () + (skip-unless (treesit-ready-p 'gowork)) + (let ((treesit-font-lock-level 4)) + (ert-font-lock-test-file (ert-resource-file "font-lock-package.go") 'go-work-ts-mode))) + (provide 'go-ts-mode-tests) ;;; go-ts-mode-tests.el ends here -- 2.47.0 --=-=-=--