Package Exports

standard
standard/bin/cmd
standard/bin/cmd.js
standard/package.json

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (standard) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

JavaScript Standard Style

One Style to Rule Them All

No decisions to make, no .jshintrc or .jscs files to manage. It just works.

Install

npm install standard

Rules

2 spaces for indentation
Single quotes for strings
- Except to avoid escaping like "in this lil' string"
Unix line breaks (LF)
No semicolons
- It's totally fine. Really!
Never start a line with ( or [:
- This is the one gotcha with omitting semicolons – automatically checked for you!
- Always prefix with ; like this ;[1, 2, 3].join(' ')
Spaces after keywords:
- if (condition) { ... }
Spaces before/after function definitions:, like this:
- function name (arg1, arg2) { ... }
Always name the context variable self:
- var self = this
Always use === instead of ==
Dozens of sanity checks to catch bugs (unused variables, typos, etc.)

To get a better idea, take a look at a sample file written in JavaScript Standard Style.

Usage

The easiest way to use standard 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):

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:
  /Users/feross/code/webtorrent/lib/torrent.js:950:11: Expected '===' and instead saw '=='.

The paths node_modules/, .git/, *.min.js, and bundle.js are automatically excluded when looking for .js files to style check.

What you might do if you're clever

Add it to package.json

{
  "name": "my-cool-package",
  "devDependencies": {
    "standard": "*"
  },
  "scripts": {
    "test": "standard && node my-normal-tests.js"
  }
}

Check style automatically when you run npm test

$ npm test
Error: Code style check failed:
  /Users/feross/code/webtorrent/lib/torrent.js:950:11: Expected '===' and instead saw '=='.

Never give style feedback on a pull request again!

standard