Stuck on an issue?
Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.
And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.
How to enforce docs on Typescript interface and its properties using EsLint?
See original GitHub issueI am looking to enforce documentation on the interfaces and all of its properties using eslint. I have installed eslint-plugin-tsdoc package in my project. Is there a rule to enforce it?
Thanks
Issue Analytics
- State:
- Created 4 years ago
- Reactions:21
- Comments:12
Top Results From Across the Web
How to use ESLint with TypeScript | Khalil Stemmler
ESLint is a JavaScript linter that enables you to enforce a set ... Run the following commands to setup ESLint in your TypeScript...
Read more >Require documentation for Typescript interfaces, enums ...
Your issue is solved here, you should: Add the AST types to the contexts option to the rule. You'll have to consult a...
Read more >Rules - ESLint - Pluggable JavaScript Linter
The "extends": "eslint:recommended" property in a configuration file enables this rule ... Enforce return statements in callbacks of array methods.
Read more >Linting in TypeScript using ESLint and Prettier - LogRocket Blog
Similar to Typescript compiler settings, you can either use the command line to generate a configuration file using the --init flag from ESLint...
Read more >Overview | typescript-eslint
Enforce type definitions to consistently use either interface or type,, ... Disallow the use of parameter properties in class constructors.
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Such a rule would be highly desirable.
tsdoc looks very promising but not having ‘require’ rules is a show stopper for me It means developers can go about writing logic which is undocumented and eslint will not complain about it
https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-jsdoc