This repository has been archived by the owner on Jul 15, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 198
new rule: add config parameters to missing-jsdoc rule #162
Labels
Microsoft Internal
Issues related to closed source Microsoft code.
Milestone
Comments
Thanks for the idea. This is very similar to #33. I will close that one as a duplicate.
|
HamletDRC
changed the title
new rule: jsdoc-completion
new rule: add config parameters to missing-jsdoc rule
Jun 29, 2016
HamletDRC
added
feature-request
Microsoft Internal
Issues related to closed source Microsoft code.
labels
Jul 9, 2016
From a limited TSLint knowledge and reading https://github.com/Microsoft/TypeScript/wiki/Using-the-Compiler-API, I think this requires the type checker for |
@JoshuaKGoldberg I am pretty sure you can get the comments without using the type checker... but if you use the type checker then you probably get a much more structured object and would not have to use RegEx to pick apart the comment. Your suggestion is probably the way to go. |
nchen63
pushed a commit
to palantir/tslint
that referenced
this issue
Nov 12, 2016
Fixes microsoft/tslint-microsoft-contrib#162. Enforces non-blank comments for any or all of classes, functions, methods, and/or properties.
@ian-craig I think this issue is resolved? |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
While
jsdoc-format
is enough to require correct formatting of docs, there’s no rule that I know of to ensure the docs exist in the first place. It would be useful to have a rule that requires they exist and not be blank for a configurable list of major items (default to everything?), such as:The text was updated successfully, but these errors were encountered: