Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dabapps/eslint-config-dabapps
DabApps ESLint Configuration
https://github.com/dabapps/eslint-config-dabapps
Last synced: 4 days ago
JSON representation
DabApps ESLint Configuration
- Host: GitHub
- URL: https://github.com/dabapps/eslint-config-dabapps
- Owner: dabapps
- License: bsd-3-clause
- Created: 2015-09-22T09:04:22.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-03-15T05:42:16.000Z (almost 2 years ago)
- Last Synced: 2024-11-27T03:35:38.890Z (about 1 month ago)
- Language: TypeScript
- Homepage:
- Size: 846 KB
- Stars: 0
- Watchers: 21
- Forks: 1
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/dabapps/eslint-config-dabapps/releases).
```shell
npm install eslint-config-dabapps --save-dev
```
## Configuration
### NPM Scripts
Add the following scripts to your package.json
```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:
```json
{
"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:
```json
{
"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/](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"
},
```