This package provides BridgeU'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 Vue guidelines.
It requires eslint
, eslint-plugin-import
and eslint-plugin-vue
.
If you don't need Vue, you should use eslint-config-bridgeu/base
- Install (likely as devDependencies) the correct versions of each package, which are listed by:
npm info "eslint-config-bridgeu@latest" peerDependencies
- Add
"extends": "bridgeu"
to your .eslintrc
For more details or how to setup proper ESLint packages and READMEs,
check the inspiration for this project at eslint-config-airbnb
.
Our base export contains only our general JavaScript guidelines, without
any framework or tool dependency.
It requires eslint
and eslint-plugin-import
.
Our Vue-specific export contains our Vue guidelines, based on the recommended
Vue settings from the community.
It requires eslint-plugin-vue
.
Following Airbnb’s example, it would be great to start
adding tests to these configurations so we have examples of the good practices
and don’t break them unintentionally. One day we’ll run npm test
and check
that everything is safe and sound.
The same thing with npm run lint
, we’ll probably add that feature in a near future.