semi-4standard

7.0.7 • Public • Published

JavaScript Semi-4-Standard Style

travis npm downloads bitHound Dependencies

One Semicolon and two (2) unnecessary spaces for the Dark Lord on his dark throne

All the goodness of feross/standard with semicolons and 4 space tabs sprinkled on top.

Install

npm install semi-4standard

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-semi-4standard-style

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

js-semi-4standard-style

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

Usage

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

npm install semi-4standard -g

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

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

Formatting code to Semistandard

What you might do if you're clever

  1. Add it to package.json
{
  "name": "my-cool-package",
  "devDependencies": {
    "semi-4standard": "*"
  },
  "scripts": {
    "test": "semi-4standard && node my-normal-tests-littered-with-semicolons.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:

{
  "semi-4standard": {
    "parser": "babel-eslint"
  }
}

Vim

Install Syntastic and add these lines to .vimrc:

let g:syntastic_javascript_checkers=['standard']
let g:syntastic_javascript_standard_exec = 'semi-4standard'

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

autocmd bufwritepost *.js silent !semi-4standard % --format
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 semi-4standard.ignore property to package.json:

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

Make it look snazzy

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

$ semi-4standard --verbose | snazzy

See feross/standard for more information.

Package Sidebar

Install

npm i semi-4standard

Weekly Downloads

7

Version

7.0.7

License

MIT

Last publish

Collaborators

  • brodrigu
  • sterpe