Comments (5)
Language | Linter | Rule | VSCode |
---|---|---|---|
JavaScript | ESLint | valid-jsdoc |
extension |
TypeScript | TSLint | jsdoc-format |
extension |
I use VSCode for editor and use/install proper extensions for linting while I write.
I include .eslintrc.json
or tslint.json
with the project's root. In the npm scripts
section of the package.json
, I make sure also my build command is preceded with the proper lint command.
from docma.
Thanks for reporting.
Well that's actually invalid JSDoc but still we should watch for it. But shouldn't give warnings which would bloat the code too much. It'd be best to validate/lint jsdoc while writing it (via editors, plugins, etc) anyway..
I'm adding conditionals to watch out for this. I'll let you know shortly.
from docma.
I'm able to fix this issue by doing a find and replace for all instances of:
find:
@returns Object
replace:
@returns {Object}
We should probably emit a warning if no type
is specified for @returns
?
from docma.
@onury, out of curiosity, what does your typical dev setup look like for enforcing valid JSDoc?
from docma.
Fixed with Docma v3.0.0.
from docma.
Related Issues (20)
- Docma Not Rendering Documentation
- Relative README links do not redirect HOT 3
- Incorrect rendering of tree in the navigation menu HOT 3
- HTML comments in markdown are rendered as plaintext
- New version compatibility and performance issuesγ HOT 3
- Has maintenance of this project stopped? HOT 2
- The term 'docma' is not recognized as the name of a cmdlet. HOT 1
- update deprecated dependencies (or mark this tool itself as deprecated?)
- π₯π₯π₯ I forked a new project and maximized the resolution of dependency issues π₯π₯π₯ HOT 1
- HELP: How do I render my docs with GitHub Pages?
- Strange parsing issue(?) HOT 5
- extends @external types does not work HOT 1
- option to put API docs for each file on a separate page? HOT 4
- navigate/search across all pages HOT 1
- Prevent "parent" description being used for properties when empty
- Support linking to built-in types, all lowercase HOT 1
- Getting 404 page when query params are present and routing is set to path on root route HOT 5
- Support importing typedefs HOT 1
- Show typedef? HOT 1
- Folding symbols seems broken on the latest version
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. πππ
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google β€οΈ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from docma.