GithubHelp home page GithubHelp logo

Comments (5)

onury avatar onury commented on June 27, 2024 2
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.

onury avatar onury commented on June 27, 2024 1

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.

dannyrb avatar dannyrb commented on June 27, 2024

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.

dannyrb avatar dannyrb commented on June 27, 2024

@onury, out of curiosity, what does your typical dev setup look like for enforcing valid JSDoc?

from docma.

onury avatar onury commented on June 27, 2024

Fixed with Docma v3.0.0.

from docma.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.