Globally installed jscs-jsdoc doesn't work about jscs-jsdoc

[qfox]

@Rantanen It's more like a feature request to node-jscs.
Did you mean both globally installed node-jscs and jscs-jsdoc didn't work together? Right?
Please provide additionalRules config block.

[Rantanen]

Yeah, saw jscs-dev/node-jscs#312 at node-jscs where they requested this as an external package.

Running globally installed node-jscs and globally installed jscs-jsdoc. Config block was copied from the README.md:

{
    "additionalRules": [
        "node_modules/jscs-jsdoc/lib/rules/*.js"
    ],
    "jsDoc": {
    }
}

The issue is in the jscs checker.js. additionalRules are resolved with...

(config.additionalRules || []).forEach(function(pattern) {
    glob.sync(path.resolve(cwd, pattern)).map(function(path) {
        var Rule = require(path);
        this.registerRule(new Rule());
    }, this);
}, this);

• pattern here is the configured string from the config: node_modules/jscs-jsdoc/lib/rules/*.js
• cwd is either configuration directory (The directory in which .jscsrc resides) or the current process directory if no configuration file exists.
• path.resolve just concatenates these together resulting in absolute path.

At least I can't figure out how it would be possible to configure this globally without changing the jscs logic in resolving additionalRules.

(And mentioning jscs-dev/node-jscs#321 here to link this to upstream)

[qfox]

Thanks for widely described configuration and bug report.
I'll fix it in several hours. If it is possible ofc ;-)

[qfox]

@Rantanen Yeah. All is right, but didn't work because glob can't search in all directories in NODE_PATH.
We can prepend and look up for a file in each place and resolve the closest module path and load rules from it. E.g. replace /^node_modules\// to each of them and try to resolve. But I think it is too complicated.

> require.resolve('jscs-jsdoc')
'/usr/local/lib/node_modules/jscs-jsdoc/lib/index.js'
> process.env.NODE_PATH
':/usr/local/lib/node_modules'
> module.constructor.globalPaths
[ '',
  '/usr/local/lib/node_modules',
  '/home/alex/.node_modules',
  '/home/alex/.node_libraries',
  '/opt/node-v0.10.26-linux-x86/lib/node' ]

We will have a problem with different versions of the same module placed in several places. We should filter them manually. Etc.
I think we should left this functionality to load custom project rules. But also we need another functionality to load plugin-extension packages via npm. With require or require.resolve.

Anyway, we can't do it on the plugin level. ;-(

[qfox]

Oh, sorry. You can temporary use the simple solution npm ln jscs-jsdoc.
It will find your globally installed module and symlink it to your local env: ./node_modules/jscs-jsdoc

[Rantanen]

Yeah, symlink works - but at that point I could just do a full local installation as well. My need for a global installation was a plan to introduce jscs in a .NET company.

Thanks to jshint, browserify, jscs, etc. node is becoming an important tool platform for all JavaScript development development. But this depends greatly on the ability to install these tools globally.

Unfortunately node-jscs still has a bit to go until it is mature enough to set up conveniently in global fashion.

So for my personal use I'm happy to use a local installation and I'm going to wait until node-jscs solves these issues until including it in the toolchain at the said company.

[qfox]

@Rantanen Got it. I hope that maintainers will respond asap to make true plugins works. I'll do my best to release this. Don't like unfinished projects ;-)