quick-lint-js icon indicating copy to clipboard operation
quick-lint-js copied to clipboard

Published 20 hours ago • verified publisher icon quick-lint

Complete error docs

Open strager opened this issue 2 years ago • 4 comments

We're missing docs for a bunch of error codes, especially for TypeScript errors. Make sure we have everything documented before we release 3.0.

strager avatar Jul 26 '22 09:07 strager

To make this work, we need to allow the error docs to choose between JavaScript and TypeScript.

strager avatar Jul 28 '22 02:07 strager

To make this work, we need to allow the error docs to choose between JavaScript and TypeScript.

Done in commit 409133786bce5b4970ccfbff1169c8c5a6104e81.

strager avatar Jul 28 '22 06:07 strager

I've been making good progress. Only 39 more docs to go.

As I write docs, I'm noticing issues in diagnostics (from typos to wrong lints to possible improvements). I've been fixing these issues as I go.

I think writing docs in batches, instead of writing docs as I write lint rules, is good. It gives me time away from the lint rules, so I can reevaluate them with a fresh mind.

strager avatar Sep 16 '22 07:09 strager

I finished documenting all the current diagnostics, as of commit f39a34b58fb8817c7b1a3c9c6684888ac752060a.

I will leave this task open as a reminder before shipping 3.0.

strager avatar Sep 22 '22 05:09 strager