Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mobilereality/eslint-config
ESLint's configuration of Mobile Reality Team
https://github.com/mobilereality/eslint-config
eslint prettier react react-native typescript
Last synced: about 1 month ago
JSON representation
ESLint's configuration of Mobile Reality Team
- Host: GitHub
- URL: https://github.com/mobilereality/eslint-config
- Owner: MobileReality
- License: mit
- Created: 2022-02-09T15:32:26.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-01-23T11:59:29.000Z (11 months ago)
- Last Synced: 2024-11-15T20:46:16.153Z (about 1 month ago)
- Topics: eslint, prettier, react, react-native, typescript
- Language: JavaScript
- Homepage:
- Size: 394 KB
- Stars: 13
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# @mobile-reality/eslint-config
[](https://www.npmjs.com/package/@mobile-reality/eslint-config)
[](https://github.com/MobileReality/react-native-select-pro/stargazers)
[](https://www.npmjs.com/package/@mobile-reality/eslint-config)
[](https://www.npmjs.com/package/@mobile-reality/eslint-config)
[](https://github.com/MobileReality/eslint-config/commits/master)
[](https://github.com/MobileReality/eslint-config/blob/master/LICENSE.md)
---
ESLint's configuration of [Mobile Reality](https://themobilereality.com) team.
---
## Table of Contents
- [Requirements](#requirements)
- [Installation and usage for a new project](#installation-and-usage-for-a-new-project)
- [Installation and usage for an existing project](#installation-and-usage-for-an-existing-project)
- [Override](#override)
- [Used packages](#used-packages)
- [License](#license)
## Requirements
- `node: ^16.13 || ^18.15.0`
- `eslint: ^8.37.0`
- `eslint-plugin-prettier: ^4.2.0`
## Installation and usage for a new project
1. Install `@mobile-reality/eslint-config`, `eslint`, `prettier` and `eslint-plugin-prettier`:
```sh
yarn add -D @mobile-reality/eslint-config eslint@^8.37.0 prettier eslint-plugin-prettier
```
or
```sh
npm i -D @mobile-reality/eslint-config eslint@^8.37.0 prettier eslint-plugin-prettier
```
2. Add to your root `.eslintrc.js` file:
```javascript
module.exports = {
root: true,
env: {}, // env config is based on project scope eg is it only node or node+browser
extends: [
'@mobile-reality/eslint-config/XXX', // base config based on project scope, XXX described below
'plugin:prettier/recommended', // to include prettier rules in eslint
],
// if jest is used jest config should be added to overrides section
overrides: [
{
files: ['test/**/*.test.ts'], // glob pattern has to match test files
extends: ['@mobile-reality/eslint-config/configs/jest'],
},
],
};
```
XXX is a preconfigured eslint config for MR projects. Supported configs with required peerDependencies (which must be installed in project):
- node-javascript
- node-typescript (@typescript-eslint/eslint-plugin@~5.31.0 @typescript-eslint/parser@~5.31.0)
- react-javascript (eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-jsx-a11y eslint-plugin-simple-import-sort)
- react-typescript (@typescript-eslint/eslint-plugin@~5.31.0 @typescript-eslint/parser@~5.31.0 eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-jsx-a11y eslint-plugin-simple-import-sort)
- react-native (@typescript-eslint/eslint-plugin@~5.31.0 @typescript-eslint/parser@~5.31.0 eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-jsx-a11y eslint-plugin-simple-import-sort eslint-plugin-react-native)
## Installation and usage for an existing project
1. Remove all `ESLint` and `prettier` dependencies (e.g. `eslint`, `prettier`, `eslint-plugin-prettier`, `@typescript-eslint/eslint-plugin` etc.) from package.json
2. Reinstall `node_modules` (so remove them and install with `npm i` or `yarn install`)
3. Go to the [installation step](#installation-and-usage-for-a-new-project)
## Override
You can override rules by adding a rule to the rules section e.g.:
```javascript
module.exports = {
root: true,
extends: ['@mobile-reality'],
rules: {
'no-console': 'off',
},
};
```
## Used packages
- [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/eslint-plugin)
- [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/parser)
- [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier)
- [eslint-plugin-flowtype](https://github.com/gajus/eslint-plugin-flowtype)
- [eslint-plugin-jest](https://github.com/jest-community/eslint-plugin-jest)
- [eslint-plugin-jsx-a11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y)
- [eslint-plugin-react](https://github.com/yannickcr/eslint-plugin-react)
- [eslint-plugin-react-hooks](https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks)
- [eslint-plugin-react-native](https://github.com/intellicode/eslint-plugin-react-native)
- [eslint-plugin-simple-import-sort](https://github.com/lydell/eslint-plugin-simple-import-sort)
- [eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn)
## License
[MIT](LICENSE.md)