jscs-dev / jscs-jsdoc

JsDoc validation rules for jscs
MIT License
99 stars 35 forks source link

Configuring requireReturnDescription is throwing "jsDoc plugin was not configured properly" #152

Closed gajus closed 8 years ago

gajus commented 8 years ago
import jscs from 'jscs';

let checker;

checker = new jscs();
checker.configure({
    "plugins": [
        "jsdoc"
    ],
    "jsDoc": {
        requireReturnDescription: true
    }
});

This produces an error "jsDoc plugin was not configured properly" using jscs-jsdoc@1.1.0.

gajus commented 8 years ago

I had a quick look at the NPM package. This rule has not been included in the bundle:

curiosity:eslint-plugin-jsdoc gajus$ cat ./node_modules/jscs-jsdoc/package.json | grep version
  "version": "1.1.0",
curiosity:eslint-plugin-jsdoc gajus$ ls -lah ./node_modules/jscs-jsdoc/lib/rules/validate-jsdoc | grep return
-rw-r--r--   1 gajus  staff   769B 11 May 21:17 check-redundant-returns.js
-rw-r--r--   1 gajus  staff   735B 11 May 21:17 check-return-types.js
-rw-r--r--   1 gajus  staff   473B 11 May 21:17 require-return-types.js
gajus commented 8 years ago

This exists only in master, but not in https://github.com/jscs-dev/jscs-jsdoc/tree/v1.1.0/lib/rules/validate-jsdoc.

When is this going to be released?

qfox commented 8 years ago

In a couple of days, I think. I'll try to work on release today's night and/or tomorrow.

gajus commented 8 years ago

@zxqfox Thank you.

qfox commented 8 years ago

@gajus Landed and published! ;-) Thanks