@paysera/eslint-config
v1.2.0
Published
Paysera's ESLint config, following our styleguide
Downloads
333
Readme
@paysera/eslint-config
This package provides Paysera's .eslintrc as an extensible shared config.
Usage
We export three ESLint configurations for your usage.
@paysera/eslint-config
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 @paysera/eslint-config-base.
If you use yarn, run npm info "@paysera/eslint-config@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 "@paysera/eslint-config@latest" peerDependencies
If using npm 5+, use this shortcut
npx install-peerdeps --dev @paysera/eslint-config
If using yarn, you can also use the shortcut described above if you have npm 5+ installed on your machine, as the command will detect that you are using yarn and will act accordingly.
Otherwise, run npm info "@paysera/eslint-config@latest" peerDependencies
to list the peer dependencies and versions, then run yarn add --dev <dependency>@<version>
for each listed peer dependency.
If using npm < 5, Linux/OSX users can run
(
export PKG=@paysera/eslint-config;
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 @paysera/eslint-config eslint@^#.#.# eslint-plugin-jsx-a11y@^#.#.# eslint-plugin-import@^#.#.# eslint-plugin-react@^#.#.#
If using npm < 5, 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 @paysera/eslint-config
The cli will produce and run a command like:
npm install --save-dev @paysera/eslint-config eslint@^#.#.# eslint-plugin-jsx-a11y@^#.#.# eslint-plugin-import@^#.#.# eslint-plugin-react@^#.#.#
- Add
"extends": "@paysera"
to your .eslintrc
See Paysera'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
.