eslint-config-godaddy-flow
v6.0.2
Published
ESLint config for consistent style in node projects using Flow at GoDaddy.
Downloads
5
Readme
eslint-config-godaddy-react-flow
Configuration for JavaScript applications using Flow, officially used at GoDaddy. There are many useful features:
- Standard. No configuration. – Stop worrying about style and focus on your work.
- Modern – Uses modern linting tools like
eslint
. - Auto-fix – Auto-fix is enabled by-default through in
eslint
. Many rules will fix themselves!
This style guide is used by dozens of product teams at GoDaddy. Have a question or comment? Open an issue!
Installation
npm i eslint-config-godaddy-flow --save-dev
Usage
There are two ways to use this style guide depending on your own tooling preference: directly using pre-included binaries or running eslint
yourself with a custom .eslintrc
config.
1. Use the pre-included binaries.
These use exactly the configuration defined in this package (eslint-config-godaddy-flow
) with auto-fix enabled automatically.
{
"scripts": {
"lint": "eslint-godaddy-flow files/ you/ want-to/ lint/"
}
}
2. Define your local .eslintrc
and run eslint
yourself:
{
"root": true,
"extends": "godaddy-flow",
"rules": {
//
// Put any rules you wish to override here.
//
}
}
The --fix
option in eslint
is only available as a CLI option. Auto-fix will NOT be enabled unless you run eslint --fix
in your package.json
.
{
"scripts": {
"lint": "eslint --fix files/ you/ want-to/ lint/"
}
}