This package provides Big Youth's .eslintrc as an extensible shared config.
We export three ESLint configurations for your usage.
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
. If you don't need React, see eslint-config-bigyouth-base.
If you use yarn, run npm info "eslint-config-bigyouth@latest" peerDependencies
to list the peer dependencies and versions, then run yarn add --dev <dependency>@<version>
for each listed peer dependency. See below for npm instructions.
- Install the correct versions of each package, which are listed by the command:
npm info "eslint-config-bigyouth@latest" peerDependencies
Linux/OSX users can run
(
export PKG=eslint-config-bigyouth;
npm info "$PKG@latest" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm install --save-dev "$PKG@latest"
)
Which produces and runs a command like:
npm install --save-dev eslint-config-bigyouth eslint@^#.#.# eslint-plugin-jsx-a11y@^#.#.# eslint-plugin-import@^#.#.# eslint-plugin-react@^#.#.#
Windows users can either install all the peer dependencies manually, or use the install-peerdeps cli tool.
npm install -g install-peerdeps
install-peerdeps --dev eslint-config-bigyouth
The cli will produce and run a command like:
npm install --save-dev eslint-config-bigyouth eslint@^#.#.# eslint-plugin-jsx-a11y@^#.#.# eslint-plugin-import@^#.#.# eslint-plugin-react@^#.#.#
- Add
"extends": "bigyouth"
to your .eslintrc
This entry point is deprecated. See eslint-config-bigyouth-base.
This entry point is deprecated. See eslint-config-bigyouth-base.
See Big Youth's Javascript styleguide and the ESlint config docs for more information.
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
.