GNU bug report logs - #72489
29.4.50; forward-comment not working as expected in toml-ts-mode

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 72489 in the body.
You can then email your comments to 72489 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: Yang Yingchao <yang.yingchao <at> qq.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 29.4.50; forward-comment not working as expected in toml-ts-mode
Date: Tue, 06 Aug 2024 13:57:28 +0800

Steps to reproduce:

1. Open a new buffer in `toml-ts-mode`.
2. Insert the following simple snippets:
```
# (forward-comment 1)
# [[keyboard.bindings]]
# chars = "a"
# key = "Tab"
# mods = "Alt"
```
3. Move the cursor to the first line and call `eval-last-sexp`.

This should move the cursor to the beginning of the line "chars = a", but actually it moves the cursor to the end of the whole block.

This might be an issue with `toml-ts-mode--syntax-table`.

Making a change in https://github.com/emacs-mirror/emacs/blob/e993e479c324bb720bca3f1cf194e55e32f01ccd/lisp/textmodes/toml-ts-mode.el#L53 can fix this issue:

```
-    (modify-syntax-entry ?\n "> b"  table)
+    (modify-syntax-entry ?\n ">"  table)
```


Regards

yang

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Yang Yingchao <yang.yingchao <at> qq.com>,
 Jostein Kjønigsen <jostein <at> kjonigsen.net>
Cc: 72489 <at> debbugs.gnu.org
Subject: Re: bug#72489: 29.4.50;
 forward-comment not working as expected in toml-ts-mode
Date: Tue, 06 Aug 2024 14:50:45 +0300

> Date: Tue, 06 Aug 2024 13:57:28 +0800
> From:  Yang Yingchao via "Bug reports for GNU Emacs,
>  the Swiss army knife of text editors" <bug-gnu-emacs <at> gnu.org>
> 
> 
> 
> Steps to reproduce:
> 
> 1. Open a new buffer in `toml-ts-mode`.
> 2. Insert the following simple snippets:
> ```
> # (forward-comment 1)
> # [[keyboard.bindings]]
> # chars = "a"
> # key = "Tab"
> # mods = "Alt"
> ```
> 3. Move the cursor to the first line and call `eval-last-sexp`.
> 
> This should move the cursor to the beginning of the line "chars = a", but actually it moves the cursor to the end of the whole block.
> 
> This might be an issue with `toml-ts-mode--syntax-table`.
> 
> Making a change in https://github.com/emacs-mirror/emacs/blob/e993e479c324bb720bca3f1cf194e55e32f01ccd/lisp/textmodes/toml-ts-mode.el#L53 can fix this issue:
> 
> ```
> -    (modify-syntax-entry ?\n "> b"  table)
> +    (modify-syntax-entry ?\n ">"  table)
> ```

Thanks.

Jostein, could you please look into this?

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

From: Jostein Kjønigsen <jostein <at> secure.kjonigsen.net>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: Yang Yingchao <yang.yingchao <at> qq.com>,
 "Mr. Jostein Kjønigsen" <jostein <at> kjonigsen.net>,
 72489 <at> debbugs.gnu.org
Subject: Re: bug#72489: 29.4.50; forward-comment not working as expected in
 toml-ts-mode
Date: Tue, 6 Aug 2024 15:06:03 +0200

> On 6 Aug 2024, at 13:50, Eli Zaretskii <eliz <at> gnu.org> wrote:
> 
>> Date: Tue, 06 Aug 2024 13:57:28 +0800
>> From:  Yang Yingchao via "Bug reports for GNU Emacs,
>> the Swiss army knife of text editors" <bug-gnu-emacs <at> gnu.org>
>> 
>> 
>> 
>> Steps to reproduce:
>> 
>> 1. Open a new buffer in `toml-ts-mode`.
>> 2. Insert the following simple snippets:
>> ```
>> # (forward-comment 1)
>> # [[keyboard.bindings]]
>> # chars = "a"
>> # key = "Tab"
>> # mods = "Alt"
>> ```
>> 3. Move the cursor to the first line and call `eval-last-sexp`.
>> 
>> This should move the cursor to the beginning of the line "chars = a", but actually it moves the cursor to the end of the whole block.
>> 
>> This might be an issue with `toml-ts-mode--syntax-table`.
>> 
>> Making a change in https://github.com/emacs-mirror/emacs/blob/e993e479c324bb720bca3f1cf194e55e32f01ccd/lisp/textmodes/toml-ts-mode.el#L53 can fix this issue:
>> 
>> ```
>> -    (modify-syntax-entry ?\n "> b"  table)
>> +    (modify-syntax-entry ?\n ">"  table)
>> ```
> 
> Thanks.
> 
> Jostein, could you please look into this?

Hey there. Let me see if I can help.

Just to be clear I understand the issue and how to reproduce it:

1. you create an empty buffer and activate toml-ts-mode
2. you paste in the supplied text, which is all comments according to TOML syntax
3. first line is actually a commented out emacs-lisp command.
4. you use (eval-last-sexp) to invoke the command emacs-lisp (forward-comment 1)

And once you do that, the expected outcome would be to jump to next comment-line (ie each commented line is considered its own comment-block)?

I ask, because if I do that, I get an *error* about reaching the end of file, so it seems like whatever I'm doing I'm getting slightly different results than you are. Applying the suggested fix does not seem to change behaviour either?

Yang: Have you loaded/compiled/provided the toml typescript-grammar before using this mode?

The *-ts-modes depends on external grammar in order to properly initialize the major-mode and provide correct highlighting and indentation.

--
Jostein

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

From: Yang Yingchao <yang.yingchao <at> qq.com>
To: Jostein Kjønigsen <jostein <at> secure.kjonigsen.net>
Cc: Eli Zaretskii <eliz <at> gnu.org>,
 Mr. Jostein Kjønigsen <jostein <at> kjonigsen.net>,
 72489 <at> debbugs.gnu.org
Subject: Re: bug#72489: 29.4.50; forward-comment not working as expected in
 toml-ts-mode
Date: Wed, 07 Aug 2024 09:02:31 +0800

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

> Just to be clear I understand the issue and how to reproduce it:
>
> 1. you create an empty buffer and activate toml-ts-mode
> 2. you paste in the supplied text, which is all comments according to TOML syntax
> 3. first line is actually a commented out emacs-lisp command.
> 4. you use (eval-last-sexp) to invoke the command emacs-lisp (forward-comment 1)
>
> And once you do that, the expected outcome would be to jump to next comment-line (ie each commented line is considered its own comment-block)?
>
> I ask, because if I do that, I get an *error* about reaching the end of file, so it seems like
> whatever I'm doing I'm getting slightly different results than you are. Applying the suggested fix
> does not seem to change behaviour either?

I think the error in your case also proves the misbehavior of forward-comment, and it breaks `uncomment-region' in my case. And with the suggested fix applied, and then recompile/evaluate, `uncomment-region' works as expected.

> Yang: Have you loaded/compiled/provided the toml typescript-grammar before using this mode?
>
> The *-ts-modes depends on external grammar in order to properly initialize the major-mode and provide correct highlighting and indentation.

I only have the required shared libraries (libtree-sitter.so & libtree-sitter-toml.so) installed. This should be enough, right? At least `treesit-explore-mode' works fine in toml buffer.

Regards,

-- *Yang Yingchao*

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

From: Jostein Kjønigsen <jostein <at> secure.kjonigsen.net>
To: Yang Yingchao <yang.yingchao <at> qq.com>
Cc: Eli Zaretskii <eliz <at> gnu.org>,
 "Mr. Jostein Kjønigsen" <jostein <at> kjonigsen.net>,
 72489 <at> debbugs.gnu.org
Subject: Re: bug#72489: 29.4.50; forward-comment not working as expected in
 toml-ts-mode
Date: Thu, 15 Aug 2024 12:10:46 +0200

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

> On 7 Aug 2024, at 03:02, Yang Yingchao <yang.yingchao <at> qq.com> wrote:
> 
> I think the error in your case also proves the misbehavior of forward-comment, and it breaks `uncomment-region' in my case. And with the suggested fix applied, and then recompile/evaluate, `uncomment-region' works as expected.
> 
>> Yang: Have you loaded/compiled/provided the toml typescript-grammar before using this mode?
>> 
>> The *-ts-modes depends on external grammar in order to properly initialize the major-mode and provide correct highlighting and indentation.
> 
> I only have the required shared libraries (libtree-sitter.so & libtree-sitter-toml.so) installed. This should be enough, right? At least `treesit-explore-mode' works fine in toml buffer.
> 
> Regards,
> 
> -- *Yang Yingchao*

I've recompiled from scratch and confirm this indeed fixes all issues mentioned.

Eli: Feel free to apply the supplied patch. I still don't have commit access :)

https://github.com/emacs-mirror/emacs/blob/e993e479c324bb720bca3f1cf194e55e32f01ccd/lisp/textmodes/toml-ts-mode.el#L53
> ```
> -    (modify-syntax-entry ?\n "> b"  table)
> +    (modify-syntax-entry ?\n ">"  table)
> ```

[Message part 2 (text/html, inline)]

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Jostein Kjønigsen <jostein <at> secure.kjonigsen.net>
Cc: yang.yingchao <at> qq.com, 72489-done <at> debbugs.gnu.org, jostein <at> kjonigsen.net
Subject: Re: bug#72489: 29.4.50; forward-comment not working as expected in
 toml-ts-mode
Date: Sat, 17 Aug 2024 12:31:00 +0300

> From: Jostein Kjønigsen <jostein <at> secure.kjonigsen.net>
> Date: Thu, 15 Aug 2024 12:10:46 +0200
> Cc: Eli Zaretskii <eliz <at> gnu.org>,
>  "Mr. Jostein Kjønigsen" <jostein <at> kjonigsen.net>,
>  72489 <at> debbugs.gnu.org
> 
>  On 7 Aug 2024, at 03:02, Yang Yingchao <yang.yingchao <at> qq.com> wrote:
> 
>  I think the error in your case also proves the misbehavior of forward-comment, and it breaks
>  `uncomment-region' in my case. And with the suggested fix applied, and then recompile/evaluate,
>  `uncomment-region' works as expected.
> 
>  Yang: Have you loaded/compiled/provided the toml typescript-grammar before using this mode?
> 
>  The *-ts-modes depends on external grammar in order to properly initialize the major-mode and
>  provide correct highlighting and indentation.
> 
>  I only have the required shared libraries (libtree-sitter.so & libtree-sitter-toml.so) installed. This should
>  be enough, right? At least `treesit-explore-mode' works fine in toml buffer.
> 
>  Regards,
> 
>  -- *Yang Yingchao*
> 
> I've recompiled from scratch and confirm this indeed fixes all issues mentioned.
> 
> Eli: Feel free to apply the supplied patch. I still don't have commit access :)
> 
> https://github.com/emacs-mirror/emacs/blob/e993e479c324bb720bca3f1cf194e55e32f01ccd/lisp/textmodes/toml-ts-mode.el#L53
> 
> 
>  ```
>  -    (modify-syntax-entry ?\n "> b"  table)
>  +    (modify-syntax-entry ?\n ">"  table)
>  ```

Thanks, installed on the emacs-30 branch, and closing the bug.

Previous Next

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