jscs-jsdoc

jscs-jsdoc copied to clipboard

Ref #92

qfox

Currently, enforce-existence only enforces the existence of jsdoc comments for functions, but not for classes. I.e. in the following `constructor` is required to have a jsdoc comment, but the class...

AlexanderZeilmann

Add a rule that allows to set a variable maximum width of comment. This rule is designed to prevent silly long comments, e.g. ``` js /** * aaabbbcccaaabbbcccaaabbbcccaaabbbcccaaabbbcccaaabbbcccaaabbbcccaaabbbcccaaabbbcccaaabbbcccaaabbbccc */ ```...

gajus

Provide rule names with `--verbose` option

1

With `verbose` flag, jscs will show `jsDoc: ...`, which is not very useful, this is probably jscs issue but creating issue here just in case

markelog

checkAnnotation: use several tag sets per config

1

Instead of true/false it should have explicit checking type. True and false should be deprecated values in future and left as is for now. upd: To use jsdoc3/jsduck5 as a...

qfox

Smarty type testing for params and returns

1

For example: ``` js /** * Shouldn't report * @param {String} a * @returns {String} */ function (a) { if (a.indexOf('x')) { return '?'; } return a + 'b'; }...

qfox

Parameter type validation for JSDuck should allow '/' as well as '|' as a value seperator

3

Per the [JSDuck documentation](https://github.com/senchalabs/jsduck/wiki/Type-Definitions#type-names), values can be separated by either '`|`' or '`/`'. However, only the first of these works.

jdforrester

Parameter type validation for JSDuck should allow all primitive literals

2

Per the [JSDuck documentation](https://github.com/senchalabs/jsduck/wiki/Type-Definitions#type-names), values can be literals of booleans, numbers or strings. However, only the first of these works. ### Literals which work - `{true}` - `{false}` - `{true|false}`...

jdforrester

[Question] easiest way to give number as an option

1

I am making the new rule for description style for params and basically I want them to either put a string or an object that contains a number. ex: validTagDescription:...

dtracers

- Should check `@throws` declarations for methods with `throw`s statements; - Should check types (as well as returns do); - Should check throws only in current scope (as well as...

qfox