Skip to content
This repository has been archived by the owner on Mar 23, 2024. It is now read-only.

Display error on valid JSDoc syntax #59

Closed
hexode opened this issue Oct 24, 2013 · 11 comments
Closed

Display error on valid JSDoc syntax #59

hexode opened this issue Oct 24, 2013 · 11 comments
Assignees
Labels

Comments

@hexode
Copy link

hexode commented Oct 24, 2013

Invalid JSDoc @param at ./js/components/validator.userphone.js
429 | * @params {...*} [args]
---------------^
This is message is incorrect because this is syntax allowed by jsdoc.

http://usejsdoc.org/tags-param.html - search Allows a parameter to be repeated

@mdevils
Copy link
Member

mdevils commented Oct 24, 2013

I can accept pull-request for this behavior.

@qfox
Copy link
Member

qfox commented Nov 19, 2013

@mdevils I'll do it if you assign it to me ;-)

@mdevils
Copy link
Member

mdevils commented Nov 19, 2013

If you've got a good idea on implementing this, I would be glad to accept a pull-request ;-)

@qfox
Copy link
Member

qfox commented Nov 19, 2013

Actually, I think we could parse it more accurately and store result in Function* nodes. Is it possible?
Probably, using jsdoc3/jsdoc or OrgaChem/jsdoctypeparser or something else.

@mdevils
Copy link
Member

mdevils commented Nov 19, 2013

Not sure about storing in Function* nodes, but I'm totally agree that we need better JSDoc parsing approach.

Code at #75 looks messy, makes me unhappy to accept pull-request)). We need a good jsdoc parser with a good object-representation. With or without external libraries.

@qfox
Copy link
Member

qfox commented Nov 19, 2013

Okay, I'll to use some jsdoc parsers tonight. I think we should accept all kinds of jsdoc types? http://orgachem.github.io/jsdoctypeparser/

@mdevils
Copy link
Member

mdevils commented Jan 9, 2014

I'm not sure about type parsing. Do we need it?

@qfox
Copy link
Member

qfox commented Jan 9, 2014

I think it should be pretty useful to check it up as fast as possible. Afais lint-like tools pretty useful when they can check as much as they can to prevent buggy behaviour of software. Probably JSCS is not a place to check doctypes and type of resulting value but it's another question.

@mrjoelkemp
Copy link
Member

What's the verdict on this?

@mikesherov @zxqfox Should we deprecate this rule within jscs and inform users to use https://github.com/jscs-dev/jscs-jsdoc instead? I can create another issue for that task and put a PR together if you guys agree.

@mrjoelkemp mrjoelkemp self-assigned this Sep 19, 2014
@qfox
Copy link
Member

qfox commented Sep 19, 2014

@mrjoelkemp probably yes. I've fixed this in plugin and I'm looking for issues.

mrjoelkemp pushed a commit to mrjoelkemp/node-jscs that referenced this issue Sep 19, 2014
mrjoelkemp pushed a commit to mrjoelkemp/node-jscs that referenced this issue Sep 19, 2014
mrjoelkemp pushed a commit to mrjoelkemp/node-jscs that referenced this issue Sep 19, 2014
mrjoelkemp pushed a commit to mrjoelkemp/node-jscs that referenced this issue Sep 19, 2014
@mikesherov
Copy link
Contributor

yes, we should deprecate in 1.7, remove in 2.0

On Thu, Sep 18, 2014 at 11:37 PM, Alex Yaroshevich <notifications@github.com

wrote:

@mrjoelkemp https://github.com/mrjoelkemp probably yes. I've fixed this
in plugin and I'm looking for issues.

Reply to this email directly or view it on GitHub
#59 (comment).

Mike Sherov

mrjoelkemp pushed a commit to mrjoelkemp/node-jscs that referenced this issue Sep 19, 2014
mrjoelkemp pushed a commit to mrjoelkemp/node-jscs that referenced this issue Sep 19, 2014
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

5 participants