Added location, type, and privacy to completed-docs

[JoshuaKGoldberg]

Also adds interfaces, enums, types, and a few other doc-able contructs.

Fixes #1713.
Lays the groundwork for #1921.

[nchen63]

isn't typeof Rule.ARGUMENT_CLASSES "string"? In my IDE, DocType resolves to string

[JoshuaKGoldberg]

What version of TypeScript are you on? For me (VS Code, TypeScript 2.1.X) typeof Rule.ARGUMENT_CLASSES correctly resolves to the "classes" literal.

Historically, before support for discriminated literal types, I liked having this explicit typing - both to inform the user and for future-proofing the type declarations.

[nchen63]

I'm using VS Code, TS 2.1.4. So you're saying that const a: Visibility = "s"; causes a compilation error for you?

[nchen63]

Did you meant to use const instead of public static? In that case, I see the string literal type.

[JoshuaKGoldberg]

Oh, you're totally right. Thanks for the catch! I've switched them to const.

[nchen63]

I think you need to rebase

[JoshuaKGoldberg]

Rebase should be good to go.

[nchen63]

I think this may be considered a breaking change if someone already specifies "all" because they'll see new errors. Thoughts?

[JoshuaKGoldberg]

Agreed. Changed it to use the current default, so that the new locations are opt-in. For the next TSLint release we could consider expanding default coverage.

[nchen63]

lgtm

[FDiskas]

🎽 when it will be released?

[adidahiya]

@FDiskas it's available since v4.5. you can find out by yourself by clicking through to the squashed commit:

and look at the tags list:

[Viktor-Bredihin]

what's the status? I still can't get it work

[JoshuaKGoldberg]

@Viktor-Bredihin what is your tslint.json config, and what are you trying to lint? Can you post a minimum reproduction we can take a look at? What problems are you seeing?

[Viktor-Bredihin]

@JoshuaKGoldberg
I'm trying to make this rule work '"completed-docs": true', it's not showing any errors in webstorm, however works fine when I use tslint in the console

[JoshuaKGoldberg]

Ah - that's not an issue with this rule. That's an issue with the Webstorm TSLint extension.

completed-docs is a "type checked" rule (link to docs). That means it uses more expensive APIs from TypeScript. Many extensions don't support this kind of rule for performance reasons.