semistandard-4i

1.0.0 • Public • Published

JS Semistandard 4I Style

npm downloads

One Semicolon for the Dark Lord on his dark throne

All the goodness of JS Standard Style with semicolons and 4 spaces indentation.

Install

npm install semistandard-4i

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 this code style.

js-semistandard-4i-style

[![js-semistandard-4i-style](https://img.shields.io/badge/JS%20Code%20Style-Semistandard%204I-brightgreen.svg)](https://github.com/DimasDMM/semistandard-4i)

Usage

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

npm install semistandard-4i -g

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

$ semistandard-4i
Error: Use JS Semistandard 4I 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": {
    "semistandard-4i": "*"
  },
  "scripts": {
    "test": "semistandard-4i && node file-with-this-style.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:

{
  "semistandard-4i": {
    "parser": "babel-eslint"
  }
}

Vim

Install Syntastic and add these lines to .vimrc:

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

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

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

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

Make it look snazzy

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

$ semistandard --verbose | snazzy

Future work

  • Add tests with files following this code style.

Useful links

Package Sidebar

Install

npm i semistandard-4i

Weekly Downloads

2

Version

1.0.0

License

MIT

Unpacked Size

7.64 kB

Total Files

7

Last publish

Collaborators

  • dimasdmm