@cospired/eslint-config-base
v7.0.2
Published
Slightly opinionated eslint config based on airbnb's config
Downloads
24
Readme
@cospired/eslint-config-base
This package provides cospired's base JS .eslintrc (without React plugins) as an extensible shared config.
Usage
We export one ESLint configurations for your usage.
@cospired/eslint-config-base
Our default export contains all of our ESLint rules, including ECMAScript 6+. It requires eslint
, eslint-plugin-eslint-comment
, eslint-plugin-import
and @hapi/eslint-plugin-hapi
.
If you use yarn, run npm info "@cospired/eslint-config-base@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 "@cospired/eslint-config-base@latest" peerDependencies
If using npm 5+, use this shortcut
npx install-peerdeps --dev @cospired/eslint-config-base
If using npm < 5, Linux/OSX users can run
(
export PKG=@cospired/eslint-config-base;
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 @cospired/eslint-config-base eslint@^#.#.# eslint-plugin-import@^#.#.#
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 @cospired/eslint-config-base
The cli will produce and run a command like:
npm install --save-dev @cospired/eslint-config-base eslint@^#.#.# eslint-plugin-import@^#.#.#
- Add
"extends": "@cospired/eslint-config-base"
to your .eslintrc.
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
.
Acknowledgment
This package is based on the airbnb javascript styleguide and eslint packages.