(work in progress) Add support for write-good linter#811
Conversation
|
If the options are to be configured the same for every instances of write-good at once, then create a single option for |
You can do that. |
w0rp
left a comment
There was a problem hiding this comment.
This is looking pretty good. See my comments here.
Now you can go and write the tests for the functions.
|
|
||
|
|
||
| ------------------------------------------------------------------------------- | ||
| 3.2. Options for write-good Linter *ale-write-good-options* |
There was a problem hiding this comment.
You should either write "options for write-good," or "options for the write-good linter." The latter sounds weird without the definite article. The former sounds better.
| 3.2. Options for write-good Linter *ale-write-good-options* | ||
|
|
||
| The options for the write-good linter are global because it does not make | ||
| sense to have them specified on a per-language basis. |
There was a problem hiding this comment.
This explanation doesn't quite sound right. Instead of making excuses for why this is different, explain the advantages of configuring everything in one place instead.
| \ . ' %t' | ||
| endfunction | ||
|
|
||
| function! s:HandleWriteGoodFormat(buffer, lines, type) abort |
There was a problem hiding this comment.
You can move the contents of this function into the one below.
|
I just rebased this, squashed it, added tests for it, slapped your name on it, and merged it. It's now finally in there. 👍 |
|
@w0rp , sorry. Thanks for picking this up. I started this over the summer and then school hit. :) |
Resolves #643.
This is a work in progress, but I wanted some feedback on what I have so far, and I wanted to get an answer to a question (below).
Things that I know still need to be done:
Question:
Just like with
proselint, thewrite-goodlinter can be applied to many file types. The problem is that, unlikeproselint, thewrite-goodlinter allows the user to specify some options (more along the lines of theeslintlinter).Looking at the documentation, it appears that if a linter exposes options to the user, it needs to be documented in the Integration Documentation under the appropriate language(s). This is a problem, since
write-goodapplies to multiple languages but does not have any configuration that changes across languages (this is unlikegcc, for example, which has different options for C/C++).Should I duplicate the documentation for all of the languages for which the
write-goodlinter applies? It seems messy (if anyone changes anything in the future, they'd have to edit multiple files), but at the same time, it seems to be most consistent with the current documentation structure.