jose-elias-alvarez / null-ls.nvim

Use Neovim as a language server to inject LSP diagnostics, code actions, and more via Lua.
Other
3.64k stars 791 forks source link

Please provide documentation to configure generic (non-builtin) linters and formatters #508

Closed krishnakumarg1984 closed 2 years ago

krishnakumarg1984 commented 2 years ago

First of all, thanks a lot for null-ls. This is indeed such an awesome plugin that I am migrating my previous linting and formatting setup from ALE during this winter break.

The built-in diagnostics and formatting for C++ works well. However, I'd like to know how to configure a few other useful linters and formatters such as:

jose-elias-alvarez commented 2 years ago

The documentation is a work in progress (see #364). At the moment, the best way to add a new source is to look at existing built-ins and modify them as necessary. #69 contains an implementation for clang-tidy that may work as a starting point.

Edit: I'll also mention that we strongly prefer for users to contribute sources as built-ins if there's any chance other users might be interested. Feel free to open a PR / draft PR if you're able to put something together.

krishnakumarg1984 commented 2 years ago

Okay. Thank you. It would be good to have clang-tidy to be available in the official supported list of linters at some point in the future

jose-elias-alvarez commented 2 years ago

This is essentially a duplicate of #364, so I'm closing it in favor of that issue. I'm still open to PRs to improve the documentation situation, though I'd ideally like to make some changes to the core null-ls source API before doing it myself.