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: Thu, 21 Nov 2024 07:49:35 -0300 Message-ID: <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="35091"; mail-complaints-to="usenet@ciao.gmane.io" To: 74461@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Thu Nov 21 14:59:32 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 1tE7iW-0008zA-7X for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 21 Nov 2024 14:59:32 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tE7i8-00021w-JU; Thu, 21 Nov 2024 08:59:09 -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 1tE7i4-00021E-Ma for bug-gnu-emacs@gnu.org; Thu, 21 Nov 2024 08:59:04 -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 1tE7i3-000623-Dk for bug-gnu-emacs@gnu.org; Thu, 21 Nov 2024 08:59:03 -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:Subject; bh=B9KJHjzfEs1VdTC1mo++pSvPejwc+ob9ZVnncTK0P68=; b=Fd9DMcunYY71/sPS2dBIuglzeG3hY6anM2ASSGaDeIyS7p6auOupyGHqXauGSA3YHezTLXbP2auTW4AsSJIH7itwROjWr0nnCZ1/ga18UQT9iAtxn1Hxf08dpoRC9Uxly9zi47qj3Qtdr/AKXtlR1O/kyOlZydOW/RCq1J6ro0AsmjOa2rV/sTJXlrADrtEm2PLGhOhnIFnHHIGFIpgMcSXHGk60eB3yD8RTgNy+M6Mqgok24FjgD3DpoVggqIqXVcqOJneGkARsIuuOp50UfWlX/waolmvVS5KyfPdPz9fhBuJUoA/dyiGoCGTb6cdP1SPcw5SATUNt7GDLGDjr2g==; Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1tE7i2-0003pJ-8X for bug-gnu-emacs@gnu.org; Thu, 21 Nov 2024 08:59:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Gabriel Santos Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 21 Nov 2024 13:59:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 74461 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.173219752714675 (code B ref -1); Thu, 21 Nov 2024 13:59:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 21 Nov 2024 13:58:47 +0000 Original-Received: from localhost ([127.0.0.1]:49587 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1tE7hm-0003oa-1b for submit@debbugs.gnu.org; Thu, 21 Nov 2024 08:58:47 -0500 Original-Received: from lists.gnu.org ([209.51.188.17]:36106) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1tE4kv-0003eN-OT for submit@debbugs.gnu.org; Thu, 21 Nov 2024 05:49:50 -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 1tE4kv-0005Lt-8l for bug-gnu-emacs@gnu.org; Thu, 21 Nov 2024 05:49:49 -0500 Original-Received: from layka.disroot.org ([178.21.23.139]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1tE4ks-0006Yk-Nb for bug-gnu-emacs@gnu.org; Thu, 21 Nov 2024 05:49:48 -0500 Original-Received: from mail01.disroot.lan (localhost [127.0.0.1]) by disroot.org (Postfix) with ESMTP id 52D652529D for ; Thu, 21 Nov 2024 11:49:44 +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 rvAAXjPc_IkF for ; Thu, 21 Nov 2024 11:49:40 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=disroot.org; s=mail; t=1732186179; bh=eZ7ASEBp7sIgx1mM5gg9GULrpby15/i7STmDRivGFeU=; h=From:To:Subject:Date; b=SBs6F9cnC91iANV4b9ZbPWnIXxqbosUj52Tdg4zhRedGtCWj8c9D7iZxvh1F4f/8F RF+o8ojqQ2OHSRFZUdEG+vtbPln9OISUs6FYzAzVxFI4DQNxy4Xh1ZwvckckD6zD5L 0R1XstQT5Oww06phc6rn1HPoSRQLiPDdoxbXIOK+4qx1WpTmkWc2vdnsoUpcdTQWVK uRua+bmVyhIvoimIcnCYok2Mpl2huOwUkrTP1mSLjzIIjlrB7h8L2Cc2tG/hc8J5F1 sSJQKs1EGlzIXK723QNTxduLhYmByud+klofHNzmoEqppwhWlxjZKdhx8h07KKu3fI Us2/AhqmFEr0A== Received-SPF: pass client-ip=178.21.23.139; envelope-from=gabrielsantosdesouza@disroot.org; helo=layka.disroot.org X-Spam_score_int: 0 X-Spam_score: -0.1 X-Spam_bar: / X-Spam_report: (-0.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, PDS_OTHER_BAD_TLD=1.999, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action X-Mailman-Approved-At: Thu, 21 Nov 2024 08:58:45 -0500 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:295730 Archived-At: --=-=-= Content-Type: text/plain Greetings, I wrote a tree-sitter mode after founding there wasn't one for Go Workspace files. I'd like to say thanks to Randy Taylor on his work to the Go tree-sitter mode, helped me a lot in this process. Commit message: * 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. The parser can be found here: https://github.com/omertuc/tree-sitter-go-work And I tested changes locally with a package: https://github.com/gs-101/go-work-ts-mode Issues that could be found: - Some syntax highlighting might be unecessary (ERROR face) - The grammar might be outdated (I found no issues when testing) - Eglot addition might be unecessary - Grammar elements could be missing (I checked both grammar.js and - grammar.json, and only found the keywords added here) I will mail my copyright assignment to the FSF still today. Regards, -- Gabriel Santos --=-=-= 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 3f05a09083411b8a849bf4ce8e622081873503c1 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. --- admin/notes/tree-sitter/build-module/batch.sh | 1 + admin/notes/tree-sitter/build-module/build.sh | 5 + etc/NEWS | 5 + lisp/progmodes/eglot.el | 2 +- lisp/progmodes/go-ts-mode.el | 96 +++++++++++++++++++ 5 files changed, 108 insertions(+), 1 deletion(-) 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..263de388b00 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="gomod" + org="omertuc" + ;; "heex") org="phoenixframework" ;; diff --git a/etc/NEWS b/etc/NEWS index b6c21018779..e7f753fcda1 100644 --- a/etc/NEWS +++ b/etc/NEWS @@ -925,6 +925,11 @@ 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. It is auto-enabled for files which are 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..605fa324e7a 100644 --- a/lisp/progmodes/go-ts-mode.el +++ b/lisp/progmodes/go-ts-mode.el @@ -565,6 +565,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 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-warning-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 -- 2.47.0 --=-=-=--