Package Exports
- eslint-config-airbnb
- eslint-config-airbnb/base
- eslint-config-airbnb/index
- eslint-config-airbnb/legacy
- eslint-config-airbnb/rules/react
- eslint-config-airbnb/rules/react-a11y
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (eslint-config-airbnb) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
eslint-config-airbnb
This package provides Airbnb's .eslintrc as an extensible shared config.
Usage
We export three ESLint configurations for your usage.
eslint-config-airbnb
Our default export contains all of our ESLint rules, including ECMAScript 6+ and React. It requires eslint, eslint-plugin-import, eslint-plugin-react, and eslint-plugin-jsx-a11y.
- Ensure packages are installed with correct version numbers by running:
(
export PKG=eslint-config-airbnb;
npm info "$PKG" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm install --save-dev "$PKG"
)Which produces and runs a command like:
npm install --save-dev eslint-config-airbnb eslint@^#.#.# eslint-plugin-jsx-a11y@^#.#.# eslint-plugin-import@^#.#.# eslint-plugin-react@^#.#.#- Add
"extends": "airbnb"to your .eslintrc
eslint-config-airbnb/base
This entry point is deprecated. See eslint-config-airbnb-base.
eslint-config-airbnb/legacy
This entry point is deprecated. See eslint-config-airbnb-base.
See Airbnb's Javascript styleguide and the ESlint config docs for more information.
Improving this config
Consider adding test cases if you're making complicated rules changes, like anything involving regexes. Perhaps in a distant future, we could use literate programming to structure our README as test cases for our .eslintrc?
You can run tests with npm test.
You can make sure this module lints with itself using npm run lint.