Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codfish/eslint-config-codfish
ESList configuration I use in personal and work projects. Airbnb w/ prettier, supports react & non-react, docker & dApps.
https://github.com/codfish/eslint-config-codfish
eslint eslint-config eslint-config-airbnb linter-config linting prettier react
Last synced: 3 months ago
JSON representation
ESList configuration I use in personal and work projects. Airbnb w/ prettier, supports react & non-react, docker & dApps.
- Host: GitHub
- URL: https://github.com/codfish/eslint-config-codfish
- Owner: codfish
- License: mit
- Created: 2018-12-16T05:02:15.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2022-08-12T18:42:14.000Z (over 2 years ago)
- Last Synced: 2024-09-19T09:09:40.441Z (5 months ago)
- Topics: eslint, eslint-config, eslint-config-airbnb, linter-config, linting, prettier, react
- Language: JavaScript
- Homepage:
- Size: 80.1 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-config-codfish
> Opinionated ESLint configuration that extends airbnb to not conflict with prettier.
[](http://npm.im/eslint-config-codfish)
[](http://npm-stat.com/charts.html?package=eslint-config-codfish&from=2015-08-01)
[](http://opensource.org/licenses/MIT)
[](https://github.com/semantic-release/semantic-release)
[](http://commitizen.github.io/cz-cli/)
## Features
- Uses [Airbnb's config](https://github.com/airbnb/javascript/tree/master/packages) as the
foundation.
- Leverages [prettier's eslint plugin](https://github.com/prettier/eslint-plugin-prettier), which
run's prettier within ESLint, and overrides ESLint/Airbnb rules that may conflict with Prettier.
- Supports both React & non-React applications dynamically based on your project's dependencies.
- Supports linting TypeScript (`.ts` and `.tsx` files) dynamically based on your project's
dependencies.
- Extends
[Kent C Dodd's Jest config](https://github.com/kentcdodds/eslint-config-kentcdodds/blob/main/jest.js)
dynamically based on your project's dependencies.
- Enforces js instead of jsx files.
- Turns off `import/no-unresolved` errors for node modules in projects using Docker, to avoid false
positives.
- Helpful opt-in config for dApp's.
## Usage
Install by running:
```sh
npx install-peerdeps eslint-config-codfish
```
[My preferred setup](https://gist.github.com/codfish/91ef26f3a56a5c5ca0912aa8c0c5c020) includes
tools like husky, lint-staged & commitlint in addition to prettier & eslint. However that's
optional.
Then add the extends to your .eslintrc:
```js
module.exports = {
extends: ['codfish'],
rules: {
// your overrides here
},
};
```
Optionally add a .prettierrc.js configuration file:
```js
module.exports = {
printWidth: 100,
tabWidth: 2,
useTabs: false,
semi: true,
singleQuote: true,
trailingComma: 'all',
bracketSpacing: true,
jsxBracketSameLine: false,
proseWrap: 'always',
};
```
### With dApps
Similar to the issues with docker, there may be rules you want to adjust for dApp's. This config
will set some globals as well as ignore missing build artifact imports. While you obviously need
those to run your app, sometimes you might want to run the linter in a ci/cd environment and build
artifacts might not be present.
**Note**: The dApp config also includes the `import/no-unresolved` rule found in the docker config.
```js
module.exports = {
extends: ['codfish', 'codfish/dapp'],
rules: {
// your overrides here
},
};
```