feat: add FormatToggle keymap (#750)

[Groveer]

No description provided.

[CharlesChiuGit]

Functionally this should works, but I'm not sure how to feel about this.

[Groveer]

I'm a C/C++ developer, I do't need format on save by default, it will modify my source file all. so, I set format on save to false, but sometimes when I edit html or md file, I need it auto format, so, I need a keymap to toggle it.

[CharlesChiuGit]

have u consider just put your project path in the disable formatting settings? check lua\settings.lua

i think this is just simpler.

[CharlesChiuGit]

i don't think everything needs to be send to upstreams. in fact, most of the maintainers of this repo keeps their own forks/repos to cater their needs.

u can fork this repo, create another branch, and cherry-pick the commits then merge into your own branch.

[CharlesChiuGit]

i'm leaning towards to close this pr.

[Groveer]

This settings means that every project I need to disable auto format must add it‘s directory here, which is far less convenient than keymap.

[Groveer]

i don't think everything needs to be send to upstreams. in fact, most of the maintainers of this repo keeps their own forks/repos to cater their needs.

u can fork this repo, create another branch, and cherry-pick the commits then merge into your own branch.

I agree with you, but I think this feature is more user-friendly.

[CharlesChiuGit]

This settings means that every project I need to disable auto format must add it‘s directory here, which is far less convenient than keymap.

Personally I just put all my projects in a folder called Workspace. If I were u, I could just add ~/Workspace to the list.

But I'm fine with new keymaps.

[ayamir]

Set a keymap for FormatToggle is fine, but why need to modify formatting.lua?

[Groveer]

Because this is a bug, when I toggle to disable, nvim will not send a notification(toggle to enable wiil do this). modify formatting.lua will fix it.

[ayamir]

Because this is a bug, when I toggle to disable, nvim will not send a notification(toggle to enable wiil do this). modify formatting.lua will fix it.

Just add keymap works for me, never bug encountered.

[Jint-lzxy]

Because this is a bug, when I toggle to disable, nvim will not send a notification(toggle to enable wiil do this). modify formatting.lua will fix it.

In fact this is intentional. If one disables a config entry (such as format_on_save) in settings.lua, we would assume he has blocked that feature (just like supplying -U<feature_macro_name> during compilation). We do not expect users to use that feature in any way in the future, so there is no guarantee for any related behaviors.

[Jint-lzxy]

I'm also leaning towards closing this pr -

I'm a C/C++ developer, I do't need format on save by default, it will modify my source file all. so, I set format on save to false, but sometimes when I edit html or md file, I need it auto format, so, I need a keymap to toggle it.

u might be interested in Clang-Format Style Options, and if you really want to disable code formatting for c/cpp, you can remove the corresponding formatter(s):

nvimdots/lua/modules/configs/completion/null-ls.lua

Lines 12 to 15 in 0f79d01

	btns.formatting.clang_format.with({
	filetypes = { "c", "cpp" },
	extra_args = require("completion.formatters.clang_format"),
	}),

FWIW adding too many keymaps that are "seemingly" rare can make the config too cumbersome and further limit customizability. For features that have strong practicality for specific groups of users, they should be left to the users to implement those features themselves, which is also one of the reasons why we use neovim 😄

[Groveer]

Because this is a bug, when I toggle to disable, nvim will not send a notification(toggle to enable wiil do this). modify formatting.lua will fix it.

In fact this is intentional. If one disables a config entry (such as format_on_save) in settings.lua, we would assume he has blocked that feature (just like supplying -U<feature_macro_name> during compilation). We do not expect users to use that feature in any way in the future, so there is no guarantee for any related behaviors.

Thank you for explaining, it's up to you to merge the PR or not.

[ayamir]

Format functionality is related with formatter in fact, some lsp server support it but others not. So this note should be remove.