Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

substandard

2.0.2 • Public • Published

JavaScript Substandard Style

npm downloads

The Great Tabulator

Substituting tabs for spaces. Because every war has two sides.

Install

npm install substandard

Rules

Importantly:

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-substandard-style

[![js-substandard-style](https://cdn.rawgit.com/zaventh/substandard/master/badge.svg)](https://github.com/zaventh/substandard)

js-substandard-style

[![js-substandard-style](https://img.shields.io/badge/code%20style-substandard-brightgreen.svg?style=flat-square)](https://github.com/zaventh/substandard)

Usage

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

npm install substandard -g

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

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

What you might do if you're clever

  1. Add it to package.json
{
  "name": "my-cool-package",
  "devDependencies": {
    "substandard": "*"
  },
  "scripts": {
    "test": "substandard && node my-normal-tests-littered-with-tabs.js"
  }
}
  1. Check style automatically when you run npm test
$ npm test
Error: Code style check failed:
  lib/torrent.js:950:11: Expected '===' and instead saw '=='.
  1. Never give style feedback on a pull request again! (unless it's about semicolons)

Custom Parser

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

{
  "substandard": {
    "parser": "babel-eslint"
  }
}

Vim

Install Syntastic and add these lines to .vimrc:

let g:syntastic_javascript_checkers=['standard']
let g:syntastic_javascript_standard_exec = 'substandard'

For automatic formatting on save, add these two lines to .vimrc:

autocmd bufwritepost *.js silent !substandard % --fix
set autoread

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 substandard.ignore property to package.json:

"substandard"{
  "ignore": [
    "**/out/",
    "/lib/select2/",
    "/lib/ckeditor/",
    "tmp.js"
  ]
}

Make it look snazzy

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

$ substandard --verbose | snazzy

See feross/standard for more information.

Install

npm i substandard

DownloadsWeekly Downloads

3

Version

2.0.2

License

MIT

Last publish

Collaborators

  • avatar