Added support for multi-cursor comments to the comment plugin (V1.1.0) #3543
Conversation
There was a problem hiding this comment.
I played around with this a bit and everything seems to work alright even in weird edge cases like multiple cursors on the same line, selections with comments inside them etc. It's really nice that the cursor position is now updated accordingly when a line gets commented.
The only slight annoyance I found is that if the selection ends in a newline, the line immediately after the selection gets commented too. This is not how it used to work, and not how I would like it to work. To reproduce:
- Open a file like the one below
# some comment
print("hello")
print("world")- Select the first two lines by holding shift and pressing arrow down twice.
- Comment selection. Before this PR you would get comments only on the first two lines, but now you get a
#on the empty line too.
runtime/plugins/comment/comment.lua
Outdated
| @@ -19,6 +19,7 @@ ft["dart"] = "// %s" | |||
| ft["dockerfile"] = "# %s" | |||
| ft["elm"] = "-- %s" | |||
| ft["fish"] = "# %s" | |||
| ft["freest"] = "-- %s" | |||
There was a problem hiding this comment.
This seems unrelated to the content of this PR. What's freest? Micro doesn't have built-in support for a file type called "freest". If it gets special treatment in the comment plugin it should probably have a file type (syntax file under micro/runtime/syntax/) as well. Whether or not it's popular enough to warrant built-in support could be a separate PR and discussion.
There was a problem hiding this comment.
Because the end of a selection happens to be on the new empty line it would be commented as well.
I agree that what you commented should be the correct behavior. In the last commit I added a fix for this. I added an exception to not comment the last line of a selection, if it is an empty line.
Regarding FreeST, you're right. I removed the changes. May add full language support in another PR at some point ;)
There was a problem hiding this comment.
The latest changes introduced some bugs. I opened a PR in your fork with suggested fixes that you may use if you wish.
runtime/plugins/comment/comment.lua
Outdated
| @@ -191,7 +206,7 @@ function string.starts(String,Start) | |||
| return string.sub(String,1,string.len(Start))==Start | |||
| end | |||
|
|
|||
| function init() | |||
| functioninit() | |||
There was a problem hiding this comment.
To be honest, I have no idea how I didn't see this.
runtime/plugins/comment/comment.lua
Outdated
| if cursor.CurSelection[endSel].X == 0 then | ||
| lines[cursor.CurSelection[endSel].Y] = nil | ||
| staticEnd = true | ||
| end |
There was a problem hiding this comment.
This can end up overwriting lines that were already set to true by another cursor.
There was a problem hiding this comment.
Well caught! I have merged your suggestions. It solves the bug, and didn't seem to change any other behavior.
fix bug when commenting selected lines that have and end of selection in new line + syntactic error
To add multi-cursor support I had to re-engineer the algorithm of the plug-in quite a bit. I tried to reuse as much code that was already implemented as possible to avoid introducing new bugs. I've tested some use cases and I haven't detected any problems so far.
The new algorithm has the following workings:
Note: All cursor logic is now contained in comment().
I also sneakily added a comment type for the language I'm developing in my master's thesis :P (https://freest-lang.github.io/)