Skip to content

Latest commit

 

History

History
105 lines (68 loc) · 2.62 KB

README.md

File metadata and controls

105 lines (68 loc) · 2.62 KB
Raw

ESLint Config

About

This repository includes a collection of eslint configs that can be combined to lint just about any project, and a default config for all projects that follow our recent patterns.

Install

Install a specific version of the eslint config with NPM. You can see a full list of versions here.

npm install eslint-config-dabapps --save-dev

Configuration

NPM Scripts

Add the following scripts to your package.json

{
  "scripts": {
    "lint": "eslint src/ tests/"
  }
}

Default Config

Create an .eslintrc.json in the route of the project. For most projects you can use the default config like so:

{
  "extends": ["dabapps"]
}

Explanation of the default config below:

Custom Config

But if you want to customise the project because, for example, this project is using a different ECMA version, module system, or framework, you can use a combination of the other configs available in this module. To replicate the default config for example, you could use the following:

{
  "extends": [
    "dabapps/commonjs",
    "dabapps/browser",
    "dabapps/es6",
    "dabapps/react"
  ]
}

There's no need to extend the base config as all other configs extend the base anyway.

React Native

Simply extend the base config, and the react-native config.

{
  "extends": [
    "dabapps",
    "dabapps/react-native"
  ]
}

Test Config

Although it is possible to run eslint with different configs for tests, we have decided to instead use a single config, and globals defined at the top of files for tests.

This decision was made to avoid errors in our apps when accidentally using test globals, and to prevent people's editors from complaining about undefined globals when multiple configs are present (as it'd only use the main one, and not the tests one).

Code of conduct

For guidelines regarding the code of conduct when contributing to this repository please review https://www.dabapps.com/open-source/code-of-conduct/

Import resolvers

If your project uses a custom module resolver (e.g. aliasing ^ to the project root) that is not webpack or the typescript compiler, you will need to define a rule for the import plugin to tell it how to resolve modules.

See https://github.com/benmosher/eslint-plugin-import#resolvers

{
  "import/resolver": "./my-resolver"
}

For instance older projects using webpack should have the following in their .eslintrc.json file:

  "settings": {
    "import/resolver": "webpack"
  },