GNU bug report logs - #59617
29.0.50; Add indent styles to all tree-sitter modes

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 59617 in the body.
You can then email your comments to 59617 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Theodor Thornhill <theo <at> thornhill.no>
To: bug-gnu-emacs <at> gnu.org
Subject: 29.0.50; Add indent styles to all tree-sitter modes
Date: Sat, 26 Nov 2022 19:59:34 +0100

[Message part 1 (text/plain, inline)]

Hi Yuan and others!

I've added in the ability for users to set their own indentation style
should that be needed.

I just followed what I already did in c-ts-mode and c++-ts-mode, so I
believe this shouldn't be too controversial :-)

Theo

[0001-Add-indent-styles-to-all-tree-sitter-modes.patch (text/x-diff, attachment)]

Message #8 received at 59617 <at> debbugs.gnu.org (full text, mbox):

From: Theodor Thornhill <theo <at> thornhill.no>
To: 59617 <at> debbugs.gnu.org
Cc: eliz <at> gnu.org, larsi <at> gnus.org
Subject: 29.0.50; Add indent styles to all tree-sitter modes
Date: Sun, 27 Nov 2022 12:50:19 +0100

Hi Eli and Lars :-)

I have some other ideas and improvements I'm planning in the tree-sitter
modes, and it would be really nice to be able to do this myself.  I know
we've discussed this already, but do you still think it's premature
giving me write access?  Building commits on top of eachother, then
splitting up and so on is a hassle while waiting for things to be
committed for me.  And it causes extra work for you guys.

If you still think so that's ok, but I'd like to still get some more
stuff in before the split!

Theo

Message #11 received at 59617 <at> debbugs.gnu.org (full text, mbox):

From: Theodor Thornhill <theo <at> thornhill.no>
To: 59617 <at> debbugs.gnu.org
Subject: 29.0.50; Add indent styles to all tree-sitter modes
Date: Mon, 28 Nov 2022 00:38:43 +0100

[Message part 1 (text/plain, inline)]

Fixed a typo - see this patch:

Theo

[0001-Add-indent-styles-to-all-tree-sitter-modes.patch (text/x-diff, attachment)]

Message #14 received at 59617 <at> debbugs.gnu.org (full text, mbox):

From: Theodor Thornhill <theo <at> thornhill.no>
To: 59617 <at> debbugs.gnu.org
Cc: Yuan Fu <casouri <at> gmail.com>
Subject: Re: 29.0.50; Add indent styles to all tree-sitter modes
Date: Mon, 28 Nov 2022 07:59:10 +0100

[Message part 1 (text/plain, inline)]

Theodor Thornhill <theo <at> thornhill.no> writes:

> Fixed a typo - see this patch:
>

Rebased the patch on top of origin/master:

What do you think, Yuan?

[0001-Add-indent-styles-to-all-tree-sitter-modes.patch (text/x-diff, attachment)]

Message #17 received at 59617 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Theodor Thornhill <theo <at> thornhill.no>
Cc: casouri <at> gmail.com, 59617 <at> debbugs.gnu.org
Subject: Re: bug#59617: 29.0.50; Add indent styles to all tree-sitter modes
Date: Mon, 28 Nov 2022 14:26:16 +0200

> Cc: Yuan Fu <casouri <at> gmail.com>
> Date: Mon, 28 Nov 2022 07:59:10 +0100
> From:  Theodor Thornhill via "Bug reports for GNU Emacs,
>  the Swiss army knife of text editors" <bug-gnu-emacs <at> gnu.org>
> 
> Theodor Thornhill <theo <at> thornhill.no> writes:
> 
> > Fixed a typo - see this patch:
> >
> 
> Rebased the patch on top of origin/master:
> 
> What do you think, Yuan?

FWIW, I consider user options that require functions as values not a good
UI.  Many users, especially newbies, will not be able to use such options,
because they cannot come up with functions that do what they want.

It is okay to have a function value as one of N alternatives, where N > 5,
say, so that such users could still choose from "simpler" values, where the
"function" was pre-arranged by us for them.  But having just the default and
a function is definitely not good enough IMO.

Cannot we come up with a couple of popular styles for each language, and
have those styles ready to be selected by simple atom values in the
defcustom?

Thanks.

P.S. Btw, what about other indentation-related facilities, like "C-c C-q" in
CC Mode?

Message #20 received at 59617 <at> debbugs.gnu.org (full text, mbox):

From: Theodor Thornhill <theo <at> thornhill.no>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: casouri <at> gmail.com, 59617 <at> debbugs.gnu.org
Subject: Re: bug#59617: 29.0.50; Add indent styles to all tree-sitter modes
Date: Mon, 28 Nov 2022 13:38:30 +0100

Eli Zaretskii <eliz <at> gnu.org> writes:

>> Cc: Yuan Fu <casouri <at> gmail.com>
>> Date: Mon, 28 Nov 2022 07:59:10 +0100
>> From:  Theodor Thornhill via "Bug reports for GNU Emacs,
>>  the Swiss army knife of text editors" <bug-gnu-emacs <at> gnu.org>
>> 
>> Theodor Thornhill <theo <at> thornhill.no> writes:
>> 
>> > Fixed a typo - see this patch:
>> >
>> 
>> Rebased the patch on top of origin/master:
>> 
>> What do you think, Yuan?
>
> FWIW, I consider user options that require functions as values not a good
> UI.  Many users, especially newbies, will not be able to use such options,
> because they cannot come up with functions that do what they want.
>
> It is okay to have a function value as one of N alternatives, where N > 5,
> say, so that such users could still choose from "simpler" values, where the
> "function" was pre-arranged by us for them.  But having just the default and
> a function is definitely not good enough IMO.
>
> Cannot we come up with a couple of popular styles for each language, and
> have those styles ready to be selected by simple atom values in the
> defcustom?
>

I guess we could, but most other languages provided here have a pretty
standard coding style, IIRC.  Not saying it's not any variations.  This
is meant mostly as an escape hatch if needed, so that a user _can_
provide their own indentation style should they need it.

>
> P.S. Btw, what about other indentation-related facilities, like "C-c C-q" in
> CC Mode?

I'm planning on making those, yes

Message #23 received at 59617 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Theodor Thornhill <theo <at> thornhill.no>
Cc: casouri <at> gmail.com, 59617 <at> debbugs.gnu.org
Subject: Re: bug#59617: 29.0.50; Add indent styles to all tree-sitter modes
Date: Mon, 28 Nov 2022 15:25:29 +0200

> From: Theodor Thornhill <theo <at> thornhill.no>
> Cc: 59617 <at> debbugs.gnu.org, casouri <at> gmail.com
> Date: Mon, 28 Nov 2022 13:38:30 +0100
> 
> > Cannot we come up with a couple of popular styles for each language, and
> > have those styles ready to be selected by simple atom values in the
> > defcustom?
> >
> 
> I guess we could, but most other languages provided here have a pretty
> standard coding style, IIRC.

Only one standard style?  I'm surprised.  Even if the variations are much
less popular, they still deserve to be supported OOTB, IMO.

> Not saying it's not any variations.  This is meant mostly as an escape
> hatch if needed, so that a user _can_ provide their own indentation style
> should they need it.

If we don't expect anyone reasonable to try that, fine.  But if we do (and
a defcustom seems to say we do), then I'd provide a couple of other styles,
even if they are used much more rarely.

> > P.S. Btw, what about other indentation-related facilities, like "C-c C-q" in
> > CC Mode?
> 
> I'm planning on making those, yes

Thanks!

Message #26 received at 59617 <at> debbugs.gnu.org (full text, mbox):

From: Theodor Thornhill <theo <at> thornhill.no>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: casouri <at> gmail.com, 59617 <at> debbugs.gnu.org
Subject: Re: bug#59617: 29.0.50; Add indent styles to all tree-sitter modes
Date: Mon, 28 Nov 2022 14:41:57 +0100

Eli Zaretskii <eliz <at> gnu.org> writes:

>> From: Theodor Thornhill <theo <at> thornhill.no>
>> Cc: 59617 <at> debbugs.gnu.org, casouri <at> gmail.com
>> Date: Mon, 28 Nov 2022 13:38:30 +0100
>> 
>> > Cannot we come up with a couple of popular styles for each language, and
>> > have those styles ready to be selected by simple atom values in the
>> > defcustom?
>> >
>> 
>> I guess we could, but most other languages provided here have a pretty
>> standard coding style, IIRC.
>
> Only one standard style?  I'm surprised.  Even if the variations are much
> less popular, they still deserve to be supported OOTB, IMO.
>
>> Not saying it's not any variations.  This is meant mostly as an escape
>> hatch if needed, so that a user _can_ provide their own indentation style
>> should they need it.
>
> If we don't expect anyone reasonable to try that, fine.  But if we do (and
> a defcustom seems to say we do), then I'd provide a couple of other styles,
> even if they are used much more rarely.
>

Ok, I can supply some more styles.  This bug or a subsequent bug?


>> > P.S. Btw, what about other indentation-related facilities, like "C-c C-q" in
>> > CC Mode?
>> 
>> I'm planning on making those, yes
>
> Thanks!

No problem.

Theo

Message #29 received at 59617 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Theodor Thornhill <theo <at> thornhill.no>
Cc: casouri <at> gmail.com, 59617 <at> debbugs.gnu.org
Subject: Re: bug#59617: 29.0.50; Add indent styles to all tree-sitter modes
Date: Mon, 28 Nov 2022 15:44:36 +0200

> From: Theodor Thornhill <theo <at> thornhill.no>
> Cc: 59617 <at> debbugs.gnu.org, casouri <at> gmail.com
> Date: Mon, 28 Nov 2022 14:41:57 +0100
> 
> Eli Zaretskii <eliz <at> gnu.org> writes:
> 
> > If we don't expect anyone reasonable to try that, fine.  But if we do (and
> > a defcustom seems to say we do), then I'd provide a couple of other styles,
> > even if they are used much more rarely.
> >
> 
> Ok, I can supply some more styles.  This bug or a subsequent bug?

This one, I think.  It's the same issue.

Message #32 received at 59617 <at> debbugs.gnu.org (full text, mbox):

From: Theodor Thornhill <theo <at> thornhill.no>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: casouri <at> gmail.com, 59617 <at> debbugs.gnu.org
Subject: Re: bug#59617: 29.0.50; Add indent styles to all tree-sitter modes
Date: Mon, 28 Nov 2022 16:00:58 +0100

Eli Zaretskii <eliz <at> gnu.org> writes:

>> From: Theodor Thornhill <theo <at> thornhill.no>
>> Cc: 59617 <at> debbugs.gnu.org, casouri <at> gmail.com
>> Date: Mon, 28 Nov 2022 14:41:57 +0100
>> 
>> Eli Zaretskii <eliz <at> gnu.org> writes:
>> 
>> > If we don't expect anyone reasonable to try that, fine.  But if we do (and
>> > a defcustom seems to say we do), then I'd provide a couple of other styles,
>> > even if they are used much more rarely.
>> >
>> 
>> Ok, I can supply some more styles.  This bug or a subsequent bug?
>
> This one, I think.  It's the same issue.


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?  I'm fine either way.

Theo

Message #35 received at 59617 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Theodor Thornhill <theo <at> thornhill.no>
Cc: casouri <at> gmail.com, 59617 <at> debbugs.gnu.org
Subject: Re: bug#59617: 29.0.50; Add indent styles to all tree-sitter modes
Date: Mon, 28 Nov 2022 17:05:07 +0200

> From: Theodor Thornhill <theo <at> thornhill.no>
> Cc: 59617 <at> debbugs.gnu.org, casouri <at> 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.

Message #38 received at 59617 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: theo <at> thornhill.no
Cc: casouri <at> gmail.com, 59617 <at> debbugs.gnu.org
Subject: Re: bug#59617: 29.0.50; Add indent styles to all tree-sitter modes
Date: Mon, 28 Nov 2022 17:08:22 +0200

> Cc: casouri <at> gmail.com, 59617 <at> debbugs.gnu.org
> Date: Mon, 28 Nov 2022 17:05:07 +0200
> From: Eli Zaretskii <eliz <at> gnu.org>
> 
> > From: Theodor Thornhill <theo <at> thornhill.no>
> > Cc: 59617 <at> debbugs.gnu.org, casouri <at> 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.

Message #41 received at 59617 <at> debbugs.gnu.org (full text, mbox):

From: Theodor Thornhill <theo <at> thornhill.no>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: casouri <at> gmail.com, 59617 <at> debbugs.gnu.org
Subject: Re: bug#59617: 29.0.50; Add indent styles to all tree-sitter modes
Date: Mon, 28 Nov 2022 17:30:27 +0100

[Message part 1 (text/plain, inline)]

Eli Zaretskii <eliz <at> gnu.org> writes:

>> Cc: casouri <at> gmail.com, 59617 <at> debbugs.gnu.org
>> Date: Mon, 28 Nov 2022 17:05:07 +0200
>> From: Eli Zaretskii <eliz <at> gnu.org>
>> 
>> > From: Theodor Thornhill <theo <at> thornhill.no>
>> > Cc: 59617 <at> debbugs.gnu.org, casouri <at> 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

[0001-Add-indent-styles-to-all-tree-sitter-modes.patch (text/x-diff, attachment)]

Message #44 received at 59617 <at> debbugs.gnu.org (full text, mbox):

From: Theodor Thornhill <theo <at> thornhill.no>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: casouri <at> gmail.com, 59617 <at> debbugs.gnu.org
Subject: Re: bug#59617: 29.0.50; Add indent styles to all tree-sitter modes
Date: Tue, 29 Nov 2022 07:11:45 +0100

[Message part 1 (text/plain, inline)]

Rebased on emacs-29.

Theo

[0001-Add-indent-styles-to-all-tree-sitter-modes.patch (text/x-diff, attachment)]

Message #47 received at 59617 <at> debbugs.gnu.org (full text, mbox):

From: Theodor Thornhill <theo <at> thornhill.no>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: casouri <at> gmail.com, 59617 <at> debbugs.gnu.org
Subject: Re: bug#59617: 29.0.50; Add indent styles to all tree-sitter modes
Date: Tue, 29 Nov 2022 16:19:26 +0100

Theodor Thornhill <theo <at> thornhill.no> writes:

> Rebased on emacs-29.
>

Is this good to go or should I change something here?

Theo

Message #50 received at 59617 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Theodor Thornhill <theo <at> thornhill.no>
Cc: casouri <at> gmail.com, 59617 <at> debbugs.gnu.org
Subject: Re: bug#59617: 29.0.50; Add indent styles to all tree-sitter modes
Date: Tue, 29 Nov 2022 17:44:21 +0200

> From: Theodor Thornhill <theo <at> thornhill.no>
> Cc: casouri <at> gmail.com, 59617 <at> debbugs.gnu.org
> Date: Tue, 29 Nov 2022 16:19:26 +0100
> 
> Theodor Thornhill <theo <at> thornhill.no> writes:
> 
> > Rebased on emacs-29.
> >
> 
> Is this good to go or should I change something here?

Good to go from my POV, but I wanted also to hear from Yuan.

Thanks.

Message #53 received at 59617 <at> debbugs.gnu.org (full text, mbox):

From: Yuan Fu <casouri <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: Theodor Thornhill <theo <at> thornhill.no>, 59617 <at> debbugs.gnu.org
Subject: Re: bug#59617: 29.0.50; Add indent styles to all tree-sitter modes
Date: Wed, 30 Nov 2022 13:44:39 -0800

Eli Zaretskii <eliz <at> gnu.org> writes:

>> From: Theodor Thornhill <theo <at> thornhill.no>
>> Cc: casouri <at> gmail.com, 59617 <at> debbugs.gnu.org
>> Date: Tue, 29 Nov 2022 16:19:26 +0100
>> 
>> Theodor Thornhill <theo <at> thornhill.no> writes:
>> 
>> > Rebased on emacs-29.
>> >
>> 
>> Is this good to go or should I change something here?
>
> Good to go from my POV, but I wanted also to hear from Yuan.
>
> Thanks.

Hey sorry, I was busy with some other things. I’ve looked at the patch,
it seems adding a hook that sets treesit-simple-indent-rules would have
the same effect, no? (Ie, user already can set a custom indent style)
Like instead of

(defvar my-personal-csharp-mode-indent-rules (...))

(setq csharp-ts-mode-indent-style
      (lambda () my-personal-csharp-mode-indent-rules))

you can just do

(defvar my-personal-csharp-mode-indent-rules (...))

(add-hook 'csharp-mode-hook
          (lambda ()
           (setq treesit-simple-indent-rules
                 my-personal-csharp-mode-indent-rules)))

This way there is no need to define a custom option and a function for
each mode. And users can use the same variable
treesit-simple-indent-rules, just in different major mode hooks.

Yuan

Message #56 received at 59617 <at> debbugs.gnu.org (full text, mbox):

From: Theodor Thornhill <theo <at> thornhill.no>
To: Yuan Fu <casouri <at> gmail.com>, Eli Zaretskii <eliz <at> gnu.org>
Cc: 59617 <at> debbugs.gnu.org
Subject: Re: bug#59617: 29.0.50; Add indent styles to all tree-sitter modes
Date: Wed, 30 Nov 2022 23:24:18 +0100

On 30 November 2022 22:44:39 CET, Yuan Fu <casouri <at> gmail.com> wrote:
>
>Eli Zaretskii <eliz <at> gnu.org> writes:
>
>>> From: Theodor Thornhill <theo <at> thornhill.no>
>>> Cc: casouri <at> gmail.com, 59617 <at> debbugs.gnu.org
>>> Date: Tue, 29 Nov 2022 16:19:26 +0100
>>> 
>>> Theodor Thornhill <theo <at> thornhill.no> writes:
>>> 
>>> > Rebased on emacs-29.
>>> >
>>> 
>>> Is this good to go or should I change something here?
>>
>> Good to go from my POV, but I wanted also to hear from Yuan.
>>
>> Thanks.
>
>Hey sorry, I was busy with some other things. I’ve looked at the patch,
>it seems adding a hook that sets treesit-simple-indent-rules would have
>the same effect, no? (Ie, user already can set a custom indent style)
>Like instead of
>
>(defvar my-personal-csharp-mode-indent-rules (...))
>
>(setq csharp-ts-mode-indent-style
>      (lambda () my-personal-csharp-mode-indent-rules))
>
>you can just do
>
>(defvar my-personal-csharp-mode-indent-rules (...))
>
>(add-hook 'csharp-mode-hook
>          (lambda ()
>           (setq treesit-simple-indent-rules
>                 my-personal-csharp-mode-indent-rules)))
>
>This way there is no need to define a custom option and a function for
>each mode. And users can use the same variable
>treesit-simple-indent-rules, just in different major mode hooks.
>
>Yuan

Hmm I think you're right, and I think I agree :)

Theo

Message #61 received at 59617-done <at> debbugs.gnu.org (full text, mbox):

From: Yuan Fu <casouri <at> gmail.com>
To: Theodor Thornhill <theo <at> thornhill.no>
Cc: 59617-done <at> debbugs.gnu.org, Eli Zaretskii <eliz <at> gnu.org>
Subject: Re: bug#59617: 29.0.50; Add indent styles to all tree-sitter modes
Date: Thu, 1 Dec 2022 21:26:40 -0800

Theodor Thornhill <theo <at> thornhill.no> writes:

> On 30 November 2022 22:44:39 CET, Yuan Fu <casouri <at> gmail.com> wrote:
>>
>>Eli Zaretskii <eliz <at> gnu.org> writes:
>>
>>>> From: Theodor Thornhill <theo <at> thornhill.no>
>>>> Cc: casouri <at> gmail.com, 59617 <at> debbugs.gnu.org
>>>> Date: Tue, 29 Nov 2022 16:19:26 +0100
>>>> 
>>>> Theodor Thornhill <theo <at> thornhill.no> writes:
>>>> 
>>>> > Rebased on emacs-29.
>>>> >
>>>> 
>>>> Is this good to go or should I change something here?
>>>
>>> Good to go from my POV, but I wanted also to hear from Yuan.
>>>
>>> Thanks.
>>
>>Hey sorry, I was busy with some other things. I’ve looked at the patch,
>>it seems adding a hook that sets treesit-simple-indent-rules would have
>>the same effect, no? (Ie, user already can set a custom indent style)
>>Like instead of
>>
>>(defvar my-personal-csharp-mode-indent-rules (...))
>>
>>(setq csharp-ts-mode-indent-style
>>      (lambda () my-personal-csharp-mode-indent-rules))
>>
>>you can just do
>>
>>(defvar my-personal-csharp-mode-indent-rules (...))
>>
>>(add-hook 'csharp-mode-hook
>>          (lambda ()
>>           (setq treesit-simple-indent-rules
>>                 my-personal-csharp-mode-indent-rules)))
>>
>>This way there is no need to define a custom option and a function for
>>each mode. And users can use the same variable
>>treesit-simple-indent-rules, just in different major mode hooks.
>>
>>Yuan
>
> Hmm I think you're right, and I think I agree :)
>
> Theo

Cool :-) I’m closing this then.

Yuan

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.