JavaScript Standard Style for Yodlr
npm install yodlr-standardNo decisions to make. No .eslintrc, .jscsrc, or .jscsrc files to manage. It just
works.
This module saves you time in two ways:
- No configuration. Just drop it in. The easiest way to enforce consistent style in
your module/project.
- Catch style errors before they're submitted in PRs. Saves precious code review time
by eliminating back-and-forth between maintainer and contributor.
``bash`
npm install yodlr-standard
- 2 spaces for indentation
- Single quotes for strings
- Except to avoid escaping like "in this lil' string"
- Unix line breaks (LF)
- No unused variables (this one catches so many bugs and typos!)
- No semicolons
- [It's totally][1] [fine.][2] [Really!][3]
- Never start a line with or [
- This is the only gotcha with omitting semicolons – automatically checked for you!
- Always prefix with like this ;[1, 2, 3].join(' ')
- Spaces after keywords
-
- Spaces before/after function definitions
-
- Always name the context variable
-
- Checks for accidental use of [][4] when var self = this is omitted===
- Always use instead of ==
- is allowed for succinctness (obj === null || obj === undefined)err
- Always handle the node.js function parameter
[1]: http://blog.izs.me/post/2353458699/an-open-letter-to-javascript-leaders-regarding
[2]: http://inimino.org/~inimino/blog/javascript_semicolons
[3]: https://github.com/maxogden/messages/issues/18
[4]: https://developer.mozilla.org/en-US/docs/Web/API/Window.self
To get a better idea, take a look at
a sample file written
in JavaScript Standard Style.
The easiest way to use JavaScript Standard Style to check your code is to install it
globally as a Node command line program. To do so, simply run the following command in
your terminal (flag -g installs standard globally on your system, omit it if you want
to install in the current working directory):
`bash`
npm install standard -g
After you've done that you should be able to use the standard program. The simplest use
case would be checking the style of all JavaScript files in the current working directory:
`
$ standard
Error: Code style check failed:
lib/torrent.js:950:11: Expected '===' and instead saw '=='.
Sublime Text users can also install Sublimelinter-contrib-standard via package control to enable standard checking.
1. Add it to package.json
`json`
{
"name": "my-cool-package",
"devDependencies": {
"standard": "*"
},
"scripts": {
"test": "standard && node my-normal-tests.js"
}
}
2. Check style automatically when you run npm test
`
$ npm test
Error: Code style check failed:
lib/torrent.js:950:11: Expected '===' and instead saw '=='.
3. Never give style feedback on a pull request again!
The beauty of JavaScript Standard Style is that it's simple. No one wants to maintain
multiple hundred-line .jshintrc and .jscsrc for every module/project they work on.
Enough of this madness!
This module saves you time in two ways:
- No configuration. Just drop it in. The easiest way to enforce consistent style in
your module/project.
- Catch style errors before they're submitted in PRs. Saves precious code review time
by eliminating back-and-forth between maintainer and contributor.
The paths node_modules/, .git/, *.min.js, and bundle.js are automatically excluded.js
when looking for files to style check.
Sometimes you need to ignore additional folders or specific minfied files. To do that, add
a standard.ignore property to package.json:
`json`
"standard": {
"ignore": [
"/out/",
"/lib/select2/",
"/lib/ckeditor/"
]
}
Yes, try using Max Ogden's experimental auto formatter
standard-format to fix the easier
cases.
In rare cases, you'll need to break a rule and hide the warning generated by standard.
JavaScript Standard Style uses eslint and
jscs under-the-hood and you can hide their warnings as you normally
would if you used each linter directly.
To get verbose output (so you can find the particular rule name to ignore), run:
`bash`
$ standard --verbose
Error: Code style check failed:
routes/error.js:20:36: 'file' was used before it was defined. (eslint/no-use-before-define)
routes/submit.js:85:2: Expected indentation of 2 characters (jscs/validateIndentation)
The first error is from eslint. In this case, the rule name is "no-use-before-define"./eslint-disable no-use-before-define /
You can hide it with a comment. Re-enable with/eslint-enable no-use-before-define /
a comment.
Example:
`js`
/eslint-disable no-use-before-define /
// offending code here...
/eslint-enable no-use-before-define /
The second error is from jscs. In this case, the rule name is "validateIndentation".// jscs:disable validateIndentation
You can hide it with a comment. Re-enable with a// jscs:enable validateIndentation comment.
No. Use eslint or jscs directly if you want that.
Pro tip: Just use standard` and move on. There are actual real problems that you could
spend your time solving :p
MIT. Copyright (c) Feross Aboukhadijeh.