Setting up the java checkstyle linter

[231tr0n]

Feature description

1. require("guard.filetype")("java"):lint("checkstyle") - There is no way to run the linter if a formatter is not configured.
2. Provide Guard lint to only lint and not format file. Also make Guard fmt to only format and not lint file.
3. Can I have a combination where linter is run asynchronously and formatter is run synchronously.
4. Provide options for configuring async nature of linters and formatters in vim.g.guard_config.

[xiaoshihou514]

There is no way to run the linter if a formatter is not configured.

You can hook into the linter logic in any way you want

Provide Guard lint to only lint and not format file.

Are there occasions where you want to do this manually? Please describe them.

Can I have a combination where linter is run asynchronously and formatter is run synchronously.

Sync stuff is not normally what people want, what's the motivation?

Provide options for configuring async nature of linters and formatters in vim.g.guard_config.

Same as above

Also a small doubt, I wanted know to why was the setup function deprecated. Most people generally expect for a setup function. Is there any chance to remove the vim.deprecate function in the setup?

You can read more about the motivation here :)

[231tr0n]

@xiaoshihou514 Thank you for responding to my queries first of all.

1. require("guard.filetype")("java"):lint("checkstyle") - For the first point what I meant was that the configured linter doesnt run and throws a message saying no configured formatters. Basically, I just configured java checkstyle for linting with no formatter and ran Guard fmt and got a error message saying formatter not configured or something of that sort.
2. I wanted this feature because at my work, there are many cases where I should not touch the formatting of files since it changes git blame to my name even though I essentially made no change. But I still need the functionality to lint without formatting. That was my intention behind Guard fmt and Guard lint change.
3. For the third point, I wanted this feature because, let us just say a formatter takes time to format and other edits happen in the buffer, they get replaced by the text from formatter. Hence, I generally run it in sync mode. Linters can be run in async mode but formatters work best for me when run in sync mode.

[xiaoshihou514]

Basically, you want to only run checkstyle manually and infrequently, but guard doesn't provide configs for events.

[231tr0n]

Basically, you want to only run checkstyle manually and infrequently, but guard doesn't provide configs for events.

No what I meant is if I configure java linter like this require("guard.filetype")("java"):lint("checkstyle") It wont run and throw error saying no formatters found.

[xiaoshihou514]

This doesn't sound right, I will take a look a bit later.

[231tr0n]

This doesn't sound right, I will take a look a bit later.

Sure

[xiaoshihou514]

Can't seem to repro (linter works standalone as in screenshot)

[231tr0n]

Can't seem to repro

Nvm I found out what the issue was! I did not push checkstyle changes to my forked repo while developing linter for checkstyle! Really sorry for making you debug this issue.

[231tr0n]

Can't seem to repro

Nvm I found out what the issue was! I did not push checkstyle changes to my forked repo while developing linter for checkstyle! Really sorry for making you debug this issue.

Ok! I am able to reproduce it. Just run Guard fmt with the following config

[xiaoshihou514]

Well... You didn't specify a formatter, so obviously Guard fmt can't do anything useful...

[231tr0n]

Well... You didn't specify a formatter, so obviously Guard fmt can't do anything useful...

Yeah But I configured a linter right. So how do I get it to lint is my doubt.

[231tr0n]

So there is no way to run a linter without configuring a formatter? Is it possible to provide a Guard lint to only lint and make Guard fmt to only format. Probably just invoking Guard can do both linting and formatting. I think this is a really good idea.

[xiaoshihou514]

Hey the linter is triggered automatically on these events

guard.nvim/lua/guard/filetype.lua

Lines 90 to 94 in d5b4a49

	local events = require('guard.events')
	local evs = { 'User GuardFmt', 'BufWritePost', 'BufEnter' }
	if config.stdin then
	table.insert(events, 'TextChanged')
	table.insert(events, 'InsertLeave')

Maybe inject a few print statements into the linter to see if your regex is working properly.

You can trigger a manual lint refresh by :lua require("guard.lint").do_lint()

Hope that helps :)

[xiaoshihou514]

I decided to add Guard lint to make the API more symmetric, probably disable-fmt and disable-lint as well. The final solution here would be providing an API for users to tinker with autocmds. (You might need to nvim_del_autocmd as a workaround for now).

But I insist no sync-ed formatting features would be implemented.

• Changing the buffer during formatting is clearly a race condition which leads to undefined behaviour.
• You can use autocmds to lock the buffer (set modifiable) instead of freezing the whole editor
• If you don't plan to do work during formatting, you might as well do it in the cmdline
• Sync-ed formatting is easy and one could easily use :! to implement their own, this is not the purpose of guard

[231tr0n]

I decided to add Guard lint to make the API more symmetric, probably disable-fmt and disable-lint as well. The final solution here would be providing an API for users to tinker with autocmds. (You might need to nvim_del_autocmd as a workaround for now).

But I insist no sync-ed formatting features would be implemented.

• Changing the buffer during formatting is clearly a race condition which leads to undefined behaviour.
• You can use autocmds to lock the buffer (set modifiable) instead of freezing the whole editor
• If you don't plan to do work during formatting, you might as well do it in the cmdline
• Sync-ed formatting is easy and one could easily use :! to implement their own, this is not the purpose of guard

Make Guard fmt run all configured formatters.
Make Guard lint run all configured linters.
Make Guard run all formatters first and linters next
Is this how the new api is going to work?

I am asking this because I dont want linter to be run when running Guard fmt.

[xiaoshihou514]

Just Guard lint, use Guard fmt | Guard lint if you want both.

Guard fmt doesn't run linters, it's just currently configured linters listen to the guard user event. (again, you can delete these autocmds if you want)

[xiaoshihou514]

Done as of 2.0.0

[231tr0n]

Awesome, I will integrate support for checkstyle editor tomorrow and raise PR for it. Thank you for considering all the changes.