Sane Standard - ESLint Shareable Config
This module is for advanced users. You probably want to use js-sane-standard
instead :)
Install
npm install eslint-config-sane-standard
Usage
Shareable configs are designed to work with the extends
feature of .eslintrc
files.
You can learn more about
Shareable Configs on the
official ESLint website.
To use the JavaScript Happiness Style shareable config, first run this:
npm install eslint-config-sane-standard eslint-plugin-promise
Then, add this to your .eslintrc file:
{
"extends": "sane-standard"
}
Note: We omitted the eslint-config-
prefix since it is automatically assumed by ESLint.
You can override settings from the shareable config by adding them directly into your
.eslintrc
file.
Looking for something easier than this?
The easiest way to use JavaScript Sane Standard Style to check your code is to use the
js-sane-standard
package. This comes with a global
Node command line program (sane-standard
) that you can run or add to your npm test
script
to quickly check your style.
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 sane-standard style.
[![js-sane-standard-style](https://cdn.rawgit.com/hanakin/sane-standard/master/badge.svg)](https://github.com/hanakin/js-sane-standard)
[![js-sane-standard-style](https://img.shields.io/badge/code%20style-js-sane-standard-brightgreen.svg)](https://github.com/hanakin/js-sane-standard)
Learn more
For the full listing of rules
JavaScript Sane Standard Style repo.
License
MIT. Copyright (c) Michael Miday.