https://github.com/reactway/eslint-config
Reactway's ESLint guidelines for TypeScript projects.
https://github.com/reactway/eslint-config
eslint eslint-config naming-conventions style-guide style-linter typescript
Last synced: 4 months ago
JSON representation
Reactway's ESLint guidelines for TypeScript projects.
- Host: GitHub
- URL: https://github.com/reactway/eslint-config
- Owner: reactway
- License: mit
- Created: 2019-07-23T17:02:59.000Z (almost 6 years ago)
- Default Branch: dev
- Last Pushed: 2023-01-07T04:53:49.000Z (over 2 years ago)
- Last Synced: 2025-01-11T01:29:53.010Z (6 months ago)
- Topics: eslint, eslint-config, naming-conventions, style-guide, style-linter, typescript
- Language: JavaScript
- Size: 292 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @reactway/eslint-config
[](https://www.npmjs.com/package/@reactway/eslint-config)
[](https://dev.azure.com/reactway/ReactWay/_build?definitionId=8&_a=summary)
Reactway's ESLint guidelines for TypeScript projects. Based on [@typescript-eslint/recommended](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin#supported-rules) and [prettier/@typescript-eslint](https://github.com/prettier/eslint-config-prettier).
## Get started
```sh
npm install @reactway/eslint-config -D
```
## How to use?
Create config file in project root folder `.eslintrc.json`.
### Node projects
```sh
{
"extends": ["@reactway"]
}
```
### React projects
```sh
{
"extends": ["@reactway/eslint-config/react"]
}
```
### Troubleshooting
#### 1. 'React' is defined but never used.
If you're getting errors like:
```
C:\project-path\file-name.tsx(1,8): warning @typescript-eslint/no-unused-vars : 'React' is defined but never used.
```
Most probably you're configuring a React project and extended a non-React eslint config.
## License
Released under the [MIT license](LICENSE).