search

quick-lint / quick-lint-js

quick-lint-js finds bugs in JavaScript programs
https://quick-lint-js.com
GNU General Public License v3.0
1.54k stars 192 forks source link

[doc] Add better Debian/CoC installation instructions #696

Open vegerot opened 2 years ago

vegerot commented 2 years ago

I think the Debian instructions could use some clarification https://quick-lint-js.com/install/vim/debian/

If you have a CoC plugin already then you should tell users to do :CocInstall quick-lint-js, but then they won’t need to apt install anything

Imo: since the CoC (and maybe ALE) instructions won’t change per OS, you should have the CoC link go to a specific installation page just for CoC. You can link to this page from all the different OSs

P.S. (separate issue) And the nitiest of nit-pick feature requests: It’d be cool if the OG gif for the vim installation pages showed a vim gif 😮

strager commented 2 years ago

If you have a CoC plugin already then you should tell users to do :CocInstall quick-lint-js, but then they won’t need to apt install anything

I prefer that people install quick-lint-js using apt.

What are the advantages of :CocInstall?

vegerot commented 2 years ago

I'm saying that if you're going to advertise "if you're using Debian and Vim, you can use CoC.nvim" then you should give instructions on what to do

Btw I haven't tried the current instructions. If I'm using the CoC plugin and run apt install quick-lint-JS-vim I wouldn't think this would be all you need to do

vegerot commented 2 years ago

At the very least if you don't want to give instructions for coc.nvim then the current instructions are a bit confusing. Maybe say

[link to coc] (instructions on using CoC.nvim with quick-lint-js are not provided here)

and then maybe move it below ALE

vegerot commented 2 years ago

P.S.

What are the advantages of :CocInstall?

I do think there are advantages but it's orthogonal to the point I'm making here

strager commented 2 years ago

I wouldn't think this would be all you need to do

Do the docs make you think it wouldn't work? Or is your expectation that coc.nvim only works with a new tool with manual configuration?

I'm 80% sure that following the instructions on the website is all you need to do to get quick-lint-js diagnostics with coc.nvim.