Better documentation for JSLint configuration files

reid / node-jslint

The JavaScript Code Quality Tool — for Node.js.

http://jslint.com/

Other

491 stars 101 forks source link

Better documentation for JSLint configuration files #112

Open mcandre opened 9 years ago

mcandre commented 9 years ago

I'm not exactly sure how to configure CLI JSLint rules. Could we please add more explicit usage examples for this in the README, answering questions like:

Is there a convention for the JSLint configuration filename, like .jslintrc or jslint.conf?
Does jslint automatically load configuration on a per-project (./.jslintrc)or per-user ($HOME/.jslintrc) basis? Or do users have to manually specify --conf .jslintrc or this to happen?

smikes commented 9 years ago

Both are supported (.jslintrc and .jslint.conf)
node-jslint will first read settings from the home directory (~/.jslint.conf or ~/.jslintrc) and then from the current directory (./jslint.conf or ./jslintrc).

Note that it looks for a leading dot in the home directory and no leading dot in the current directory.

masi commented 9 years ago

Any chance for a jslintConfig section in package.jason? I quite like the feature os jshint and eslint to put their config into package.json. It makes your root diretory less polluted.