Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/funbox/eslint-config
ESLint rules that follow our style guide
https://github.com/funbox/eslint-config
eslint eslint-config
Last synced: about 2 months ago
JSON representation
ESLint rules that follow our style guide
- Host: GitHub
- URL: https://github.com/funbox/eslint-config
- Owner: funbox
- License: mit
- Created: 2020-07-07T09:42:46.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-02-28T10:25:34.000Z (10 months ago)
- Last Synced: 2024-11-15T04:27:08.478Z (about 2 months ago)
- Topics: eslint, eslint-config
- Language: JavaScript
- Homepage:
- Size: 415 KB
- Stars: 8
- Watchers: 11
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @funboxteam/eslint-config
[![npm](https://img.shields.io/npm/v/@funboxteam/eslint-config.svg)](https://www.npmjs.com/package/@funboxteam/eslint-config)
ESLint rules that follow our style guide.
Based on the well-known [Airbnb JS Style Guide](https://github.com/airbnb/javascript).
[По-русски](./README.ru.md)
## Installation
```bash
npm install --save-dev @funboxteam/eslint-config
```## Usage
Include into a project config using flag [-c](http://eslint.org/docs/user-guide/command-line-interface#-c---config),
and pass paths for files as arguments:```sh
eslint -c node_modules/@funboxteam/eslint-config/.eslintrc.js src/app src/sandbox
```To lint tests files use the separated config:
```sh
eslint -c node_modules/@funboxteam/eslint-config/.eslintrc.tests.js src/tests
```Also you can create your own `.eslintrc.js` and extend this config there:
```js
module.exports = {
extends: '@funboxteam',
env: {
browser: true
},
globals: {
fetcher: 'readonly',
System: 'readonly',
moment: 'readonly'
},
settings: {
'import/resolver': {
webpack: {
config: 'config/webpack.config.dev.js',
}
}
},
}
```Same for tests' config:
```
module.exports = {
extends: '@funboxteam/eslint-config/tests',
globals: {
__utils__: 'readonly',
}
}
```Read more about `.eslintrc.js` in [ESLint docs](https://eslint.org/docs/user-guide/configuring).
[![Sponsored by FunBox](https://funbox.ru/badges/sponsored_by_funbox_centered.svg)](https://funbox.ru)