From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Theodor Thornhill via "Bug reports for GNU Emacs, the Swiss army knife of text editors" Newsgroups: gmane.emacs.bugs Subject: bug#59617: 29.0.50; Add indent styles to all tree-sitter modes Date: Mon, 28 Nov 2022 17:30:27 +0100 Message-ID: <87tu2jrqho.fsf@thornhill.no> References: <87r0xp4k4p.fsf@thornhill.no> <87r0xo0xz0.fsf@thornhill.no> <87tu2jo98h.fsf@thornhill.no> <83v8mznu3b.fsf@gnu.org> <87y1rv9ruh.fsf@thornhill.no> <83k03fnrcm.fsf@gnu.org> <87v8mz9owq.fsf@thornhill.no> <83edtnnqgr.fsf@gnu.org> <874jujktsl.fsf@thornhill.no> <838rjvnmqk.fsf@gnu.org> <837czfnml5.fsf@gnu.org> Reply-To: Theodor Thornhill 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="28228"; mail-complaints-to="usenet@ciao.gmane.io" Cc: casouri@gmail.com, 59617@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Mon Nov 28 17:31:28 2022 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 1ozh2V-00079j-R2 for geb-bug-gnu-emacs@m.gmane-mx.org; Mon, 28 Nov 2022 17:31:28 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ozh28-0002m7-Kx; Mon, 28 Nov 2022 11:31:04 -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 1ozh26-0002kC-B2 for bug-gnu-emacs@gnu.org; Mon, 28 Nov 2022 11:31:02 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ozh26-000384-05 for bug-gnu-emacs@gnu.org; Mon, 28 Nov 2022 11:31:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1ozh25-0005z4-RR for bug-gnu-emacs@gnu.org; Mon, 28 Nov 2022 11:31:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Theodor Thornhill Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 28 Nov 2022 16:31:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 59617 X-GNU-PR-Package: emacs Original-Received: via spool by 59617-submit@debbugs.gnu.org id=B59617.166965304022995 (code B ref 59617); Mon, 28 Nov 2022 16:31:01 +0000 Original-Received: (at 59617) by debbugs.gnu.org; 28 Nov 2022 16:30:40 +0000 Original-Received: from localhost ([127.0.0.1]:49556 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ozh1j-0005yp-NL for submit@debbugs.gnu.org; Mon, 28 Nov 2022 11:30:40 -0500 Original-Received: from out-96.mta0.migadu.com ([91.218.175.96]:36679) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ozh1g-0005yj-6h for 59617@debbugs.gnu.org; Mon, 28 Nov 2022 11:30:37 -0500 X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=thornhill.no; s=key1; t=1669653034; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=g1cmI2Z3R3baXbFFAlPP+7HU6PGait9BnzhB4cEvKKI=; b=Zl2jmeWjAWHZCsjYmJbg9PiywUxgWyQCkyD+4OOkXXi5DDv2pGEEvmukLwDF3dBN0rhg1Y pQd0QcFvUrbdhNxgoOvxHTRRreW+0oVobCL5/BokwuAufZ8Z+TQU6Xs9yeBeEnGtI5IbRo jqwx66ZcL+LhVGin7qx14DDF98fYkRP4flhCpip4qNPAFAtaUf0ofkMWsfrIFV4ebnK4gw VCoy5cTvma9BZS3hXVghh25xgA8OeQOBNaQwkniQjUBPzmlJlbvYfPbu8UhpXOPz8GR8rY BKVXGZGnLPH0O7K1N6t9UYKutNgU4RYow/Al2BS+Yv4FU9HGciLSXMairLvvog== In-Reply-To: <837czfnml5.fsf@gnu.org> X-Migadu-Flow: FLOW_OUT 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:249321 Archived-At: --=-=-= Content-Type: text/plain Eli Zaretskii writes: >> Cc: casouri@gmail.com, 59617@debbugs.gnu.org >> Date: Mon, 28 Nov 2022 17:05:07 +0200 >> From: Eli Zaretskii >> >> > From: Theodor Thornhill >> > Cc: 59617@debbugs.gnu.org, casouri@gmail.com >> > Date: Mon, 28 Nov 2022 16:00:58 +0100 >> > >> > Hmm, I really cannot seem to find any very specific, recognized styles >> > for any of the languages. I think either we go with this like it is >> > now, or wait until later altogether. My reasoning was that _if_ some >> > people have very specific needs we can accomodate that, but IMO it's a >> > little too time-consuming looking all around after styles that noone >> > uses :-) I'd rather focus on improving what we have. >> > >> > Should we just close this? >> >> Feel free. > > But please say in the doc string that the custom function is called with no > arguments. Ok, added in this patch. Thanks! Theo --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-Add-indent-styles-to-all-tree-sitter-modes.patch >From 7480e472ffd4ec2cd22df2825f5b2c07b2fefc64 Mon Sep 17 00:00:00 2001 From: Theodor Thornhill Date: Sat, 26 Nov 2022 19:54:47 +0100 Subject: [PATCH] Add indent styles to all tree-sitter modes Enable users to provide their own function to control the indentation style. Even though we don't supply any extra styles for indentation, this should give the users an escape hatch should the provided style not suit their needs. * lisp/progmodes/c-ts-mode.el (c-ts-mode-indent-style): Fix typo. * lisp/progmodes/csharp-mode.el (csharp-ts-mode-indent-style) (csharp-ts-mode--set-indent-style, csharp-ts-mode): New defcustom and helper. * lisp/progmodes/java-ts-mode.el (java-ts-mode-indent-style) (java-ts-mode--set-indent-style, java-ts-mode): New defcustom and helper. * lisp/progmodes/js.el (js-ts-mode-indent-style) (js--treesit-set-indent-style, js-ts-mode): New defcustom and helper. * lisp/progmodes/json-ts-mode.el (json-ts-mode-indent-style) (json-ts-mode--set-indent-style, json-ts-mode): Enable custom indent style. (json-ts-mode--indent-rules): Rename from 'json-ts--indent-rules' * lisp/progmodes/typescript-ts-mode.el (typescript-ts-mode-indent-style) (typescript-ts-mode--set-indent-style, typescript-ts-mode): Enable custom indent style. * lisp/progmodes/css.el (css-ts-mode-indent-style) (css--treesit-set-indent-style, css-ts-mode): New defcustom and helper. (Bug#59617) --- lisp/progmodes/c-ts-mode.el | 2 +- lisp/progmodes/csharp-mode.el | 21 ++++++++++++++++++++- lisp/progmodes/java-ts-mode.el | 21 ++++++++++++++++++++- lisp/progmodes/js.el | 21 ++++++++++++++++++++- lisp/progmodes/json-ts-mode.el | 23 +++++++++++++++++++++-- lisp/progmodes/typescript-ts-mode.el | 21 ++++++++++++++++++++- lisp/textmodes/css-mode.el | 21 ++++++++++++++++++++- 7 files changed, 122 insertions(+), 8 deletions(-) diff --git a/lisp/progmodes/c-ts-mode.el b/lisp/progmodes/c-ts-mode.el index a79dabcd31..b72c17a8bd 100644 --- a/lisp/progmodes/c-ts-mode.el +++ b/lisp/progmodes/c-ts-mode.el @@ -52,7 +52,7 @@ c-ts-mode-indent-style The selected style could be one of GNU, K&R, LINUX or BSD. If one of the supplied styles doesn't suffice a function could be -set instead. This function is expected return a list that +set instead. This function is expected to return a list that follows the form of `treesit-simple-indent-rules'." :version "29.1" :type '(choice (symbol :tag "Gnu" 'gnu) diff --git a/lisp/progmodes/csharp-mode.el b/lisp/progmodes/csharp-mode.el index 6712fcc57e..59fc71356f 100644 --- a/lisp/progmodes/csharp-mode.el +++ b/lisp/progmodes/csharp-mode.el @@ -626,6 +626,24 @@ csharp-ts-mode-indent-offset :safe 'integerp :group 'csharp) +(defcustom csharp-ts-mode-indent-style 'csharp-ts-mode--default-style + "Style used for indentation. + +The selected style could either be the default style, or a +function could be set instead. This function takes no arguments +and is expected to return a list that follows the form of +`treesit-simple-indent-rules'." + :version "29.1" + :type '(choice (symbol :tag "Default" 'csharp-ts-mode--default-style) + (function :tag "A function for user customized style" ignore)) + :group 'csharp) + +(defun csharp-ts-mode--set-indent-style () + "Helper function to set indentation style." + (if (functionp csharp-ts-mode-indent-style) + (funcall csharp-ts-mode-indent-style) + csharp-ts-mode--indent-rules)) + (defvar csharp-ts-mode--indent-rules `((c-sharp ((parent-is "compilation_unit") parent-bol 0) @@ -898,7 +916,8 @@ csharp-ts-mode (seq (+ "*") "/"))))) ;; Indent. - (setq-local treesit-simple-indent-rules csharp-ts-mode--indent-rules) + (setq-local treesit-simple-indent-rules + (csharp-ts-mode--set-indent-style)) ;; Electric (setq-local electric-indent-chars diff --git a/lisp/progmodes/java-ts-mode.el b/lisp/progmodes/java-ts-mode.el index cf2482bb6e..9806b23d34 100644 --- a/lisp/progmodes/java-ts-mode.el +++ b/lisp/progmodes/java-ts-mode.el @@ -43,6 +43,24 @@ java-ts-mode-indent-offset :safe 'integerp :group 'java) +(defcustom java-ts-mode-indent-style 'java-ts-mode--default-style + "Style used for indentation. + +The selected style could either be the default style, or a +function could be set instead. This function takes no arguments +and is expected to return a list that follows the form of +`treesit-simple-indent-rules'." + :version "29.1" + :type '(choice (symbol :tag "Default" 'java-ts-mode--default-style) + (function :tag "A function for user customized style" ignore)) + :group 'java) + +(defun java-ts-mode--set-indent-style () + "Helper function to set indentation style." + (if (functionp java-ts-mode-indent-style) + (funcall java-ts-mode-indent-style) + java-ts-mode--indent-rules)) + (defvar java-ts-mode--syntax-table (let ((table (make-syntax-table))) ;; Taken from the cc-langs version @@ -309,7 +327,8 @@ java-ts-mode (seq (+ "*") "/"))))) ;; Indent. - (setq-local treesit-simple-indent-rules java-ts-mode--indent-rules) + (setq-local treesit-simple-indent-rules + (java-ts-mode--set-indent-style)) ;; Electric (setq-local electric-indent-chars diff --git a/lisp/progmodes/js.el b/lisp/progmodes/js.el index ad1fe62d42..1f25412796 100644 --- a/lisp/progmodes/js.el +++ b/lisp/progmodes/js.el @@ -3457,6 +3457,24 @@ js--treesit-indent-rules ((node-is "/") parent 0) ((parent-is "jsx_self_closing_element") parent js-indent-level))))) +(defcustom js-ts-mode-indent-style 'js--treesit-default-style + "Style used for indentation. + +The selected style could either be the default style, or a +function could be set instead. This function takes no arguments +and is expected to return a list that follows the form of +`treesit-simple-indent-rules'." + :version "29.1" + :type '(choice (symbol :tag "Default" 'js--treesit-default-style) + (function :tag "A function for user customized style" ignore)) + :group 'javascript) + +(defun js--treesit-set-indent-style () + "Helper function to set indentation style." + (if (functionp js-ts-mode-indent-style) + (funcall js-ts-mode-indent-style) + js--treesit-indent-rules)) + (defvar js--treesit-keywords '("as" "async" "await" "break" "case" "catch" "class" "const" "continue" "debugger" "default" "delete" "do" "else" "export" "extends" "finally" @@ -3865,7 +3883,8 @@ js-ts-mode ;; Tree-sitter setup. (treesit-parser-create 'javascript) ;; Indent. - (setq-local treesit-simple-indent-rules js--treesit-indent-rules) + (setq-local treesit-simple-indent-rules + (js--treesit-set-indent-style)) ;; Navigation. (setq-local treesit-defun-type-regexp (rx (or "class_declaration" diff --git a/lisp/progmodes/json-ts-mode.el b/lisp/progmodes/json-ts-mode.el index 101e873cf6..0a6debf788 100644 --- a/lisp/progmodes/json-ts-mode.el +++ b/lisp/progmodes/json-ts-mode.el @@ -44,6 +44,24 @@ json-ts-mode-indent-offset :safe 'integerp :group 'json) +(defcustom json-ts-mode-indent-style 'json-ts-mode--default-style + "Style used for indentation. + +The selected style could either be the default style, or a +function could be set instead. This function takes no arguments +and is expected to return a list that follows the form of +`treesit-simple-indent-rules'." + :version "29.1" + :type '(choice (symbol :tag "Default" 'json-ts-mode--default-style) + (function :tag "A function for user customized style" ignore)) + :group 'json) + +(defun json-ts-mode--set-indent-style () + "Helper function to set indentation style." + (if (functionp json-ts-mode-indent-style) + (funcall json-ts-mode-indent-style) + json-ts-mode--indent-rules)) + (defvar json-ts-mode--syntax-table (let ((table (make-syntax-table))) ;; Taken from the cc-langs version @@ -64,7 +82,7 @@ json-ts-mode--syntax-table "Syntax table for `json-ts-mode'.") -(defvar json-ts--indent-rules +(defvar json-ts-mode--indent-rules `((json ((node-is "}") parent-bol 0) ((node-is ")") parent-bol 0) @@ -147,7 +165,8 @@ json-ts-mode (append "{}():;," electric-indent-chars)) ;; Indent. - (setq-local treesit-simple-indent-rules json-ts--indent-rules) + (setq-local treesit-simple-indent-rules + (json-ts-mode--set-indent-style)) ;; Navigation. (setq-local treesit-defun-type-regexp diff --git a/lisp/progmodes/typescript-ts-mode.el b/lisp/progmodes/typescript-ts-mode.el index bf483a31d3..5790959e3f 100644 --- a/lisp/progmodes/typescript-ts-mode.el +++ b/lisp/progmodes/typescript-ts-mode.el @@ -37,6 +37,24 @@ typescript-ts-mode-indent-offset :safe 'integerp :group 'typescript) +(defcustom typescript-ts-mode-indent-style 'typescript-ts-mode--default-style + "Style used for indentation. + +The selected style could either be the default style, or a +function could be set instead. This function takes no arguments +and is expected to return a list that follows the form of +`treesit-simple-indent-rules'." + :version "29.1" + :type '(choice (symbol :tag "Default" 'typescript-ts-mode--default-style) + (function :tag "A function for user customized style" ignore)) + :group 'typescript) + +(defun typescript-ts-mode--set-indent-style () + "Helper function to set indentation style." + (if (functionp typescript-ts-mode-indent-style) + (funcall typescript-ts-mode-indent-style) + typescript-ts-mode--indent-rules)) + (defvar typescript-ts-mode--syntax-table (let ((table (make-syntax-table))) ;; Taken from the cc-langs version @@ -307,7 +325,8 @@ typescript-ts-mode (append "{}():;," electric-indent-chars)) ;; Indent. - (setq-local treesit-simple-indent-rules typescript-ts-mode--indent-rules) + (setq-local treesit-simple-indent-rules + (typescript-ts-mode--set-indent-style)) ;; Navigation. (setq-local treesit-defun-type-regexp diff --git a/lisp/textmodes/css-mode.el b/lisp/textmodes/css-mode.el index 734252ee66..5ac456b02f 100644 --- a/lisp/textmodes/css-mode.el +++ b/lisp/textmodes/css-mode.el @@ -1343,6 +1343,24 @@ css--treesit-indent-rules ((match nil "declaration" nil 3) (nth-sibling 2) 0))) "Tree-sitter indentation rules for `css-ts-mode'.") +(defcustom css-ts-mode-indent-style 'css--treesit-default-style + "Style used for indentation. + +The selected style could either be the default style, or a +function could be set instead. This function takes no arguments +and is expected to return a list that follows the form of +`treesit-simple-indent-rules'." + :version "29.1" + :type '(choice (symbol :tag "Default" 'css--treesit-default-style) + (function :tag "A function for user customized style" ignore)) + :group 'css) + +(defun css--treesit-set-indent-style () + "Helper function to set indentation style." + (if (functionp css-ts-mode-indent-style) + (funcall css-ts-mode-indent-style) + css--treesit-indent-rules)) + (defvar css--treesit-settings (treesit-font-lock-rules :feature 'comment @@ -1804,7 +1822,8 @@ css-ts-mode ;; Tree-sitter specific setup. (treesit-parser-create 'css) - (setq-local treesit-simple-indent-rules css--treesit-indent-rules) + (setq-local treesit-simple-indent-rules + (css--treesit-set-indent-style)) (setq-local treesit-defun-type-regexp "rule_set") (setq-local treesit-font-lock-settings css--treesit-settings) (setq-local treesit-font-lock-feature-list -- 2.34.1 --=-=-=--