@northern-devs/eslint-config-base
v1.0.1
Published
Northern Devs base eslint configuration
Downloads
5
Readme
ESLint Config - Base
The base ESLint configuration we use at Northern Devs for all of our projects. These rules could be considered harsh, but the code standards they create are well worth it. This configuration abides by our style guide, however, if you find yourself constantly working against a few of the rules, feel free to override them!
For this configuration and some of our other ESLint configurations, we include two configurations, the default and one specifically for coding styles. The default configuration worries about the real important rules such as uselessness, return statements, variable standards, etc. The coding styles configuration is where rules regarding white space, arrow styles, and logic preferences (among other rules) are defined.
Installation
npm i --save-dev @northern-devs/eslint-config-base
Ensure you have eslint installed as well, more information can be found here.
Usage
Modify your file .eslintrc.js
(or wherever your ESLint configuration is stored) to include this extension:
module.exports = {
extends: [
// The default configuration
'@northern-devs/eslint-config-base',
// The separate coding style configuartion
'@northern-devs/eslint-config-base/coding-style',
]
}
You may need to restart your IDE for the changes to take effect.
Framework-Specific Configurations
Northern Devs has an ever-growing list of framework-specific eslint configurations that we use!
| Framework or Library | Link | | -------------------- | ------------------------------------------------------------------------------- | | Typescript | link | | React | link | | React Native | link |