A Style You Might Like

Standard customised to keep me sane.

This is a fork of Standard with two changes:

• 4 Space Soft Tabs for indentions
• Semicolons always

It is called sane-standard, because I hope that it brings you sanity the same as it does for me!

If the information you are looking for is not in this readme, you should take a look at the Standard readme, it might have what you are looking for.

Install

$ npm install js-sane-standard

Usage

The easiest way to use JavaScript Sane 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 js-sane-standard globally on your system, omit it if you want to install in the current working directory):

$ npm install js-sane-standard -g

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

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

You can optionally pass in a directory (or directories) using the glob pattern. Be sure to quote paths containing glob patterns so that they are expanded by standard instead of your shell:

$ sane-standard "src/util/**/*.js" "test/**/*.js"

Many people like to add happiness to their testing setup. To do this, save the packge as a dev dependency and add happiness to your package.json's test script:

$ npm install --save-dev sane-standard

{
  "scripts": {
    "test": "sane-standard && mocha # <- or whatever test runner you use"
  }
}

Note: by default sane-standard will look for all files matching the patterns: **/*.js, **/*.jsx.

Badge

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.

[![js-sane-standard-style](https://cdn.rawgit.com/hanakin/js-sane-standard/master/badge.svg)](https://github.com/hanakin/js-sane-standard)

[![js-sane-standard-style](https://img.shields.io/badge/code%20style-js-sane-standard-brightgreen.svg)](https://github.com/hanakin/js-sane-standard)

Text editor plugins

Coming Soon

Maintainers

• Mike Miday

I want to contribute to sane-standard. What packages should I know about?

• sane-standard - this repo
  • standard-engine - cli engine for arbitrary eslint rules
  • eslint-config-sane-standard - eslint rules for happiness
  • eslint-plugin-standard - custom eslint rules for standard (not part of eslint core)
  • eslint - the linter that powers happiness
• sane-format automatic code formatter
• snazzy - pretty terminal output for happiness

License

MIT. Copyright (c) Feross Aboukhadijeh.

Change Log

All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.

1.0.0 - 2016-09-09

• Forked!
• Modified