JavaScript Standard Style
npm install sane-standard[travis-image]: https://travis-ci.org/feross/standard.svg?branch=master
[travis-url]: https://travis-ci.org/feross/standard
[npm-image]: https://img.shields.io/npm/v/standard.svg
[npm-url]: https://npmjs.org/package/standard
[downloads-image]: https://img.shields.io/npm/dm/standard.svg
[downloads-url]: https://npmjs.org/package/standard
No decisions to make. No .eslintrc, .jshintrc, or .jscsrc files to manage. It just
works.
This module saves you (and others!) time in two ways:
- No configuration. The easiest way to enforce consistent style in your project. Just
drop it in.
- 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 standard
- 2 spaces – for indentation
- Single quotes for strings – except to avoid escaping
- No unused variables – this one catches tons of bugs!
- No semicolons – [It's][1] [fine.][2] [Really!][3]
- Never start a line with ( or [
- This is the only gotcha with omitting semicolons – automatically checked for you!
- [More details][4]
- Space after keywords if (condition) { ... }
- Space after function name
- Always use instead of == – but obj == null is allowed to check null || undefined.err
- Always handle the node.js function parameterwindow
- Always prefix browser globals with – except document and navigator are okayopen
- Prevents accidental use of poorly-named browser globals like , length,event
, and name.standard
- And [more goodness][5] – give a try today!
[1]: http://blog.izs.me/post/2353458699/an-open-letter-to-javascript-leaders-regarding
[2]: http://inimino.org/~inimino/blog/javascript_semicolons
[3]: https://www.youtube.com/watch?v=gsfbh17Ax9I
[4]: RULES.md#semicolons
[5]: RULES.md#javascript-standard-style
To get a better idea, take a look at
a sample file written
in JavaScript Standard Style, or check out some of
the repositories that use
standard.
Use this in one of your projects? Include one of these badges in your readme to
let people know that your code is using the standard style.
`markdown`
`markdown`
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:
`bash`
$ standard
Error: Use JavaScript Standard Style
lib/torrent.js:950:11: Expected '===' and instead saw '=='.
You can optionally pass in a directory using the glob pattern:
`bash`
$ standard src/util/*/.js
Note: by default standard will look for all files matching the patterns: /.js, /.jsx.
First, install standard. Then, install the appropriate plugin for your editor:
#### Sublime Text
Using [Package Control][sublime-1], install [SublimeLinter][sublime-2] and
[SublimeLinter-contrib-standard][sublime-3].
For automatic formatting on save, install [StandardFormat][sublime-4].
[sublime-1]: https://packagecontrol.io/
[sublime-2]: http://www.sublimelinter.com/en/latest/
[sublime-3]: https://packagecontrol.io/packages/SublimeLinter-contrib-standard
[sublime-4]: https://packagecontrol.io/packages/StandardFormat
#### Atom
Install [linter-js-standard][atom-1].
For automatic formatting, install [standard-formatter][atom-2].
For snippets, install [standardjs-snippets][atom-3].
[atom-1]: https://atom.io/packages/linter-js-standard
[atom-2]: https://atom.io/packages/standard-formatter
[atom-3]: https://atom.io/packages/standardjs-snippets
#### Vim
Install [Syntastic][vim-1] and add this line to .vimrc:
`vim`
let g:syntastic_javascript_checkers = ['standard']
For automatic formatting on save, add these two lines to .vimrc:
`vim`
autocmd bufwritepost *.js silent !standard % --format
set autoread
[vim-1]: https://github.com/scrooloose/syntastic
#### Emacs
Install [Flycheck][emacs-1] and check out the [manual][emacs-2] to learn how to
enable it in your projects.
[emacs-1]: http://www.flycheck.org
[emacs-2]: http://www.flycheck.org/manual/latest/index.html
#### Brackets
Search the extension registry for ["Standard Code Style"][brackets-1].
[brackets-1]: https://github.com/ishamf/brackets-standard/
#### Visual Studio Code
Install [vscode-standardjs][vscode-1].
For automatic formatting, install [vscode-standard-format][vscode-2].
[vscode-1]: https://marketplace.visualstudio.com/items/chenxsan.vscode-standardjs
[vscode-2]: https://marketplace.visualstudio.com/items/chenxsan.vscode-standard-format
#### [WebStorm/PhpStorm][webstorm-1]
Both WebStorm and PhpStorm can be [configured for Standard Style][webstorm-2].
[webstorm-1]: https://www.jetbrains.com/webstorm/
[webstorm-2]: docs/webstorm.md
1. Add it to package.json
`json`
{
"name": "my-cool-package",
"devDependencies": {
"standard": "^3.0.0"
},
"scripts": {
"test": "standard && node my-tests.js"
}
}
2. Check style automatically when you run npm test
`
$ npm test
Error: Use JavaScript Standard Style
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 style configuration files for every module/project they work on.
Enough of this madness!
This module saves you time in two ways:
- No configuration. The easiest way to enforce consistent style in your project. Just
drop it in.
- Catch style errors before they're submitted in PRs. Saves precious code review time
by eliminating back-and-forth between maintainer and contributor.
Adopting standard style means ranking the importance of code clarity and community
conventions higher than personal style. This might not make sense for 100% of projects and
development cultures, however open source can be a hostile place for newbies. Setting up
clear, automated contributor expectations makes a project healthier.
No. The whole point of standard is to avoid [bikeshedding][bikeshedding] aboutstandard
style. There are lots of debates online about tabs vs. spaces, etc. that will never be
resolved. These debates just distract from getting stuff done. At the end of the day you
have to 'just pick something', and that's the whole philosophy of -- its a
bunch of sensible 'just pick something' opinions. Hopefully, users see the value in that
over defending their own opinions.
[bikeshedding]: https://www.freebsd.org/doc/en/books/faq/misc.html#bikeshed-painting
Of course it's not! The style laid out here is not affiliated with any official web
standards groups, which is why this repo is called feross/standard and notECMA/standard.
The word "standard" has more meanings than just "web standard" :-) For example:
- This module helps hold our code to a high standard of quality.
- This module ensures that new contributors follow some basic style standards.
Yes! Just run standard --format filename.js. This usesstandard-format
[Max Ogden][max]'s automatic formatter
[][standard-format], which can automatically
fix most code issues.
While most issues can be fixed, some, like not handling errors in node-style callbacks,
must be fixed manually.
[max]: https://github.com/maxogden
[standard-format]: https://github.com/maxogden/standard-format
The paths node_modules/, *.min.js, bundle.js, coverage/, hidden files/folders.
(beginning with ), and all patterns in a project's root .gitignore file are
automatically ignored.
Sometimes you need to ignore additional folders or specific minified files. To do that, add
a standard.ignore property to package.json:
`json`
"standard": {
"ignore": [
"**/out/",
"/lib/select2/",
"/lib/ckeditor/",
"tmp.js"
]
}
In rare cases, you'll need to break a rule and hide the warning generated by standard.
JavaScript Standard Style uses eslint under-the-hood and you can
hide warnings as you normally would if you used eslint directly.
To get verbose output (so you can find the particular rule name to ignore), run:
`bash`
$ standard --verbose
Error: Use JavaScript Standard Style
routes/error.js:20:36: 'file' was used before it was defined. (no-use-before-define)
Disable all rules on a specific line:
`js`
file = 'I know what I am doing' // eslint-disable-line
Or, disable only the "no-use-before-define" rule:
`js`
file = 'I know what I am doing' // eslint-disable-line no-use-before-define
Or, disable the "no-use-before-define" rule for multiple lines:
`js`
/eslint-disable no-use-before-define /
// offending code here...
// offending code here...
// offending code here...
/eslint-enable no-use-before-define /
Some packages (e.g. mocha) put their functions (e.g. describe, it) on the globalrequire
object (poor form!). Since these functions are not defined or d anywhere in yourstandard
code, will warn that you're using a variable that is not defined (usually, this
rule is really useful for catching typos!). But we want to disable it for these global
variables.
To let standard (as well as humans reading your code) know that certain variables are
global in your code, add this to the top of your file:
`
/ global myVar1, myVar2 /
If you have hundreds of files, adding comments to every file can be tedious. In these
cases, you can add this to package.json:
`json`
{
"standard": {
"globals": [ "myVar1", "myVar2" ]
}
}
standard supports custom JS parsers. To use a custom parser, install it from npmnpm install babel-eslint
(example: ) and add this to your package.json:
`json`
{
"standard": {
"parser": "babel-eslint"
}
}
If you're using standard globally (you installed it with -g), then you also need tobabel-eslint
install globally with npm install babel-eslint -g.
No. The point of standard is to save you time by picking reasonable rules so you caneslint
spend your time solving actual problems. If you really do want to configure hundreds of
eslint rules individually, you can always use directly.
If you just want to tweak a couple rules, consider using
this shareable config and layering
your changes on top.
Pro tip: Just use standard and move on. There are actual real problems that you could
spend your time solving! :P
Add this to the top of your files:
`js`
/ eslint-env serviceworker /
This lets standard (as well as humans reading your code) know that self is a global
in web worker code.
To support mocha in your test files, add this to the beginning of your test files:
`js`
/ eslint-env mocha /
Where mocha can be one of jasmine, qunit, phantomjs, and so on. To see a full list,
check ESLint's specifying environments
documentation. For a list of what globals are available for these environments, check
the globals npm module.
Funny you should ask!
`sh`
#!/bin/shEnsure all javascript files staged for commit pass standard code style
git diff --name-only --cached --relative | grep '\.js$' | xargs standard
exit $?
Alternatively, overcommit is a Git hook
manager that includes support for running standard as a Git pre-commit hook..overcommit.yml
To enable this, add the following to your file:
`yaml`
PreCommit:
Standard:
enabled: true
The built-in output is simple and straightforward, but if you like shiny things,
install snazzy:
`
npm install snazzy
And run:
`bash`
$ standard --verbose | snazzy
There's also standard-tap, standard-json, and standard-reporter
- standard - this repo
- standard-engine - cli engine for arbitrary eslint rules
- eslint-config-standard - eslint rules for standard
- eslint-plugin-standard - custom eslint rules for standard (not part of eslint core)
- eslint - the linter that powers standard
- standard-format - automatic code formatter
- snazzy - pretty terminal output for standard
- standard-www - code for http://standardjs.com
- semistandard - standard, with semicolons (if you must)
There are also many editor plugins, a list of
npm packages that use standard, and
an awesome list of
packages in the standard ecosystem.
Lint the provided source text to enforce JavaScript Standard Style. An opts object may
be provided:
`js`
var opts = {
globals: [], // global variables to declare
parser: '' // custom js parser (e.g. babel-eslint)
}
The callback will be called with an Error and results object:
`js`
var results = {
results: [
{
filePath: '',
messages: [
{ ruleId: '', message: '', line: 0, column: 0 }
],
errorCount: 0,
warningCount: 0
}
],
errorCount: 0,
warningCount: 0
}
Lint the provided files globs. An opts object may be provided:
`js`
var opts = {
globals: [], // global variables to declare
parser: '', // custom js parser (e.g. babel-eslint)
ignore: [], // file globs to ignore (has sane defaults)
cwd: '' // current working directory (default: process.cwd())
}
The callback will be called with an Error and results object (same as above).
Join us in #standard` on freenode.
MIT. Copyright (c) Feross Aboukhadijeh.