w12t-standard

JavaScript Standard Style

All the goodness of [standard/standard] with Webkollektivet's preferences sprinkled on top.

Install

npm install w12t-standard

Rules

Importantly:

• Semicolons
• Multiline comma dangle
• JSX double quotes
• Check [standard/standard] for the rest of the rules.

Usage

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:

npm install w12t-standard -g

After you've done that you should be able to use the w12t-standard program. The simplest use case would be checking the style of all JavaScript files in the current working directory:

$ w12t-standard
Error: Use JavaScript Standard Style
  lib/torrent.js:950:11: Expected '===' and instead saw '=='.

Editor plugins

• Atom users - Install linter-js-standard-engine

Specify what linter to use using by setting standard-engine in your package.json file:

{
  "standard-engine": "w12t-standard"
}

What you might do if you're clever

1. Add it to package.json

{
  "name": "my-cool-package",
  "devDependencies": {
    "w12t-standard": "*"
  },
  "scripts": {
    "test": "w12t-standard && node my-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!

Custom Parser

To use a custom parser, install it from npm (example: npm install babel-eslint) and add this to your package.json:

{
  "w12t-standard": {
    "parser": "babel-eslint"
  }
}

Ignoring files

Just like in standard, 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 excluded when looking for .js files to check.

Sometimes you need to ignore additional folders or specific minfied files. To do that, add a w12t-standard.ignore property to package.json:

"w12t-standard": {
  "ignore": [
    "**/out/",
    "/lib/select2/",
    "tmp.js"
  ]
}

Make it look snazzy

If you want prettier output, just install the snazzy package and pipe w12t-standard to it:

$ w12t-standard --verbose | snazzy

See [standard/standard] for more information.