ostandard
v0.0.14
Published
Standard + react + `.tsx` support.
Downloads
7
Maintainers
Readme
JavaScript O-Standard Style
Standard + react + .tsx
support.
Based on and inspired by Flet/semistandard
Usage
The easiest way to use JavaScript O-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 standard
globally on your system, omit it if you want
to install in the current working directory):
npm install ostandard -g
After you've done that you should be able to use the ostandard
program. The simplest use
case would be checking the style of all JavaScript files in the current working directory:
$ ostandard
Error: Use JavaScript Standard Style
lib/torrent.js:950:11: Expected '===' and instead saw '=='.
Custom Parser
To use a custom parser, install it from npm (example: npm install
babel-eslint
) and add this to your package.json:
{
"ostandard": {
"parser": "babel-eslint"
}
}
Vim
Install Syntastic and add these lines to .vimrc
:
let g:syntastic_javascript_checkers=['standard']
let g:syntastic_javascript_standard_generic = 1
let g:syntastic_javascript_standard_exec = 'ostandard'
let g:syntastic_typescript_checkers=['standard']
let g:syntastic_typescript_standard_generic = 1
let g:syntastic_typescript_standard_exec = 'ostandard'
For automatic formatting on save, add these two lines to .vimrc
:
autocmd bufwritepost *.js silent !ostandard % --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 ostandard.ignore
property to package.json
:
"ostandard": {
"ignore": [
"**/out/",
"/lib/select2/",
"/lib/ckeditor/",
"tmp.js"
]
}
Make it look snazzy
If you want prettier output, just install the snazzy
package and pipe ostandard
to it:
$ ostandard --verbose | snazzy
See airbnb/javascript for more information.
O
stands for?
O is first letter of my id. Also sound like 'all', means JavaScript and TypeScript.