Added quoting modes #8

MiguelRoldao · 2024-11-13T02:34:08Z

Added quoting modes, to enable different quotePairs for different files/filetypes based on user settings. Added more info the the help file. The 'repo.json' file still needs to be updated with the new version.

I hope you find my work worthy of being merged into your repo. It's my first open-source contribution :)

MiguelRoldao · 2024-11-13T02:37:01Z

This feature came to me, as I am writing my master's thesis in latex and was finding it very annoying to have to enter math mode and to quote text manually :P

niten94 · 2025-01-24T23:22:41Z

help/quoter.md

+
+## Quoting modes
+
+Depending on the type of the current file, Quoter can apply different quote and grouping symbols. For example, while in most languages backticks are usually used in pairs, as in `` `backticked` ``, to represent strings, infix operators, etc., in latex, to quote text, one would quote it with a backtick and an apostrophe, as ` ``quote'' `. Quoting modes allow to resolve these conflicting cases. 


This also applies to other lines but lines in text files are usually limited to 80 columns, so I think the lines have to be split.

niten94 · 2025-01-24T23:23:55Z

help/quoter.md

+
+`setlocal quoter.mode 'mode'`
+
+Check the file "micro-quoter/modes.lua" in the plugin folder to see the differences between the different modes. 


Paths are usually inserted in backticks instead of double quotes.

niten94

I'm sorry that I've accidentally started 2 different reviews with one comment. The commit message is long, but I think writing changes in summary and purpose in body can be done.

You can amend the commit to edit the commit message and changes done without adding another commit. If there is something you are not sure with, please feel free to ask.

niten94 · 2025-01-24T23:29:23Z

help/quoter.md

+The mode of the current file can also be changed in the command-bar with:
+


The line is not long so I think it is better if the empty line is removed.

niten94 · 2025-01-24T23:40:42Z

quoter.lua

-
 function init()
 	config.RegisterCommonOption("quoter", "enable", true)
+	config.RegisterCommonOption("quoter", "mode", "")


I think it is fine if the default value is changed to "default" because it is the default mode used, and or modes["default"] at line 22 will not be needed.

niten94 · 2025-01-24T23:42:14Z

quoter.lua

@@ -1,13 +1,12 @@
-VERSION = "1.0.2"
+VERSION = "1.1.0"


It is probably better to update repo.json in this pull request too if it will be changed in source code.

niten94 · 2025-01-24T23:51:48Z

help/quoter.md

+Once installed, enable the plugin by setting `quoter.enable` to on:



Same suggestion with removing empty line before `setlocal quoter.mode 'mode'`.

niten94 · 2025-01-25T00:02:07Z

help/quoter.md

+
+#### Extending Quoting Modes
+
+New modes can be added by extending the `modes` table. If you have sophisticated quoting requisites that fall outside the implemented modes, feel free to extend the `modes` table and do a pull request to the fork at https://github.com/MiguelRoldao/micro-quoter.


This pull request targets upstream so making a pull request at the upstream repository has to be written instead. Changes to features added in pull requests would usually be suggested in upstream issues or pull requests when the original pull request has been merged, and suggested in the pull request thread when not.

It would also be better to display URLs with a label. The URL is at the last part of the line, so I think it is fine if it exceeds 80 columns.

Suggested change

New modes can be added by extending the `modes` table. If you have sophisticated quoting requisites that fall outside the implemented modes, feel free to extend the `modes` table and do a pull request to the fork at https://github.com/MiguelRoldao/micro-quoter.

New modes can be added by extending the `modes` table. If you have sophisticated

quoting requisites that fall outside the implemented modes, feel free to extend

the `modes` table and do a pull request [here](https://github.com/sparques/micro-quoter).

MiguelRoldao · 2025-01-25T01:29:25Z

First of all thank you @niten94 for your feedback! It helps me make better PRs in the future :)

I agree with all the recommend changes. I'm just having trouble with amending the commit message to a shorter version. From what I know, the only way to do it is by amending the commit message locally, and then force push it. Is this not bad practice? Should I do it either way?

niten94 · 2025-01-25T01:42:25Z

I have only pushed commits on branches that I manage, but force pushing to a branch would only be a bad practice when there are other people pulling and working on it. Force pushing to branches only used to submit changes in GitHub is usually fine.

Quoting modes enable different quotePairs for different files/filetypes based on user settings.

MiguelRoldao · 2025-01-25T02:43:21Z

I think everything from my part is done. Now the only things left is to add a new tag and upload the zip. But I'm guessing that's not for me to do?

niten94 · 2025-01-25T04:03:55Z

Sorry, I was away. Yes, there are parts I just noticed now that need to be changed but only the author can add a new tag.

niten94

Sorry. I thought there might be a bug in micro so I took a while with adding one comment, but I think everything else is fine now.

quoter.lua

help/quoter.md

quoter.lua

niten94 · 2025-02-01T00:50:15Z

quoter.lua

+	if not quotePairs then
+		micro.InfoBar():Error("Unknown quoter mode: \"" .. mode .. "\". Appliying mode \"default\".")
+		-- config.SetGlobalOption("quoter.mode", "default")
+		mode = "default"
+		quotePairs = modes["default"]
+	end


There is a typo and I realized that it wouldn't probably be good if an error is always displayed, so I think these changes can be done:

Suggested change

if not quotePairs then

micro.InfoBar():Error("Unknown quoter mode: \"" .. mode .. "\". Appliying mode \"default\".")

-- config.SetGlobalOption("quoter.mode", "default")

mode = "default"

quotePairs = modes["default"]

end

if not quotePairs then

bp.Buf:SetOption("quoter.mode", "default")

quotePairs = modes["default"]

micro.InfoBar():Message("Unknown quoter mode: \"" .. mode .. "\". Mode is set to \"default\".")

end

Actually, using a different mode (default) is not expected so it's probably better to instead only display an error about changing it (like in settings.json then running reload), and returning false to not insert the character.

niten94 reviewed Jan 24, 2025

View reviewed changes

niten94 reviewed Jan 25, 2025

View reviewed changes

Added quoting modes

86851d2

Quoting modes enable different quotePairs for different files/filetypes based on user settings.

MiguelRoldao force-pushed the master branch from 94343f5 to 86851d2 Compare January 25, 2025 01:53

MiguelRoldao added 3 commits January 25, 2025 01:58

better formatting for help file

95d35b5

better plugin API usage

308ec92

update repo.json with 1.1.0 release

7a733c6

niten94 suggested changes Jan 25, 2025

View reviewed changes

quoter.lua Outdated Show resolved Hide resolved

help/quoter.md Outdated Show resolved Hide resolved

quoter.lua Show resolved Hide resolved

Default behaviour for unknown quoting modes

01ff9f5

niten94 reviewed Feb 1, 2025

View reviewed changes


		## Quoting modes

		Depending on the type of the current file, Quoter can apply different quote and grouping symbols. For example, while in most languages backticks are usually used in pairs, as in `` `backticked` ``, to represent strings, infix operators, etc., in latex, to quote text, one would quote it with a backtick and an apostrophe, as ` ``quote'' `. Quoting modes allow to resolve these conflicting cases.


		`setlocal quoter.mode 'mode'`

		Check the file "micro-quoter/modes.lua" in the plugin folder to see the differences between the different modes.

		The mode of the current file can also be changed in the command-bar with:

		Once installed, enable the plugin by setting `quoter.enable` to on:


		#### Extending Quoting Modes

		New modes can be added by extending the `modes` table. If you have sophisticated quoting requisites that fall outside the implemented modes, feel free to extend the `modes` table and do a pull request to the fork at https://github.com/MiguelRoldao/micro-quoter.

Added quoting modes #8

Are you sure you want to change the base?

Added quoting modes #8

Uh oh!

Conversation

MiguelRoldao commented Nov 13, 2024

Uh oh!

MiguelRoldao commented Nov 13, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

niten94 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MiguelRoldao commented Jan 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

niten94 commented Jan 25, 2025

Uh oh!

MiguelRoldao commented Jan 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

niten94 commented Jan 25, 2025

Uh oh!

niten94 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

niten94 Feb 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

MiguelRoldao commented Jan 25, 2025 •

edited

Loading

MiguelRoldao commented Jan 25, 2025 •

edited

Loading

niten94 left a comment •

edited

Loading

niten94 Feb 2, 2025 •

edited

Loading