semistandard

To use semistandard in your project, install it as a dependency using npm:

npm install semistandard

To install it globally as a command line program on your system, use the -g flag:

npm install semistandard -g

You can use the following plugins for real-time linting in your editor:

• Sublime Text: SublimeLinter-contrib-semistandard
• Atom: linter-js-standard
• VSCode: vscode-standardjs

To use semistandard with Vim, install Syntastic and add the following to your .vimrc to enable linting:

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

To enable automatic formatting on save, add these lines to your .vimrc:

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

If you need to use a custom parser (for example, babel-eslint), install the parser via npm and specify it in your package.json under the semistandard key.

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

By default, semistandard automatically excludes:

• node_modules/**
• *.min.js
• bundle.js
• coverage/**
• Hidden files/folders (starting with . )
• All patterns in your project's root .gitignore file.

To ignore additional specific files or folders, add a semistandard.ignore array to your package.json.

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

You can integrate semistandard into your project workflow by adding it to your package.json scripts and configuration. This allows you to run style checks automatically during tests (e.g., via npm test).

Example package.json configuration:

{
  "name": "my-cool-package",
  "devDependencies": {
    "semistandard": "*"
  },
  "scripts": {
    "test": "semistandard && node my-normal-tests-littered-with-semicolons.js"
  }
}

For prettier terminal output, you can pipe the semistandard output to the snazzy package.

$ semistandard --verbose | snazzy

Once installed, you can run the semistandard command in your terminal to check the style of all JavaScript files in the current working directory. It will report errors if the code does not adhere to the semi-standard style (which includes all standard/standard rules plus mandatory semicolons).

$ semistandard