jscs-jsdoc icon indicating copy to clipboard operation
jscs-jsdoc copied to clipboard

JsDoc validation rules for jscs

Results 45 jscs-jsdoc issues
Sort by recently updated
recently updated
newest added

``` js typeof true "boolean" ``` OK ``` js typeof 1 "number" ``` OK ``` js typeof 'foo' "string" ``` OK ``` js typeof {} "object" ``` NOT OK ```...

enhancement
beginner-friendly

The equivalent of https://github.com/jscs-dev/jscs-jsdoc#requiredescriptioncompletesentence for `@returns` statement.

beginner-friendly
new rule

https://github.com/apidoc/apidoc/ Blocked by #69

tag sets

Have a rule that forces user to use either `@return` tag or `@returns`.

beginner-friendly
new rule value

I would love to see `trailingUnderscoreAccess` option implemented, since in our project we write private methods `likeThis_`. I expect the option to do the same things as `leadingUnderscoreAccess` currently does....

beginner-friendly
new rule value

See how `eslint-plugin-jsdoc` `README.md` document is generated: - https://github.com/gajus/eslint-plugin-jsdoc/tree/master/.README - https://github.com/gajus/eslint-plugin-jsdoc/blob/dca8ddc83aa10290db04ab47567512b363649630/package.json#L33 The current `jscs-jsdoc` `README.md` is hard to read/navigate.

docs

I only want to make sure that when type is native it is one of the following: boolean, number, string, Object, Array, Date, RegExp. I do want to allow types...

question

I use jscs 2.1.0 with `{"esnext": true, "jsDoc": {"checkRedundantParams": true}}` in WebStorm for inline linting. Jscs highlights param definitions for destructured params (except first) as redundant: ``` javascript class ServerResponsePage...

bug
esnext

this is an extension of #106 and #99 Which is that a summary description is required with a new line and a complete sentence. This actually a stricter version of...

beginner-friendly
new rule

One thing, which came to my mind while thinking about #96, is the checking of default values. The following snippet should raise an error: ``` js /** * Function with...

enhancement
beginner-friendly
esnext