Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jimmy-guzman/eslint-config-jimmy-guzman
🚨 An opinionated ESLint configuration that targets typescript, javascript, react and jest/vitest and testing-library
https://github.com/jimmy-guzman/eslint-config-jimmy-guzman
eslint eslint-rules eslintconfig jest react testing-library typescript vitest
Last synced: 23 days ago
JSON representation
🚨 An opinionated ESLint configuration that targets typescript, javascript, react and jest/vitest and testing-library
- Host: GitHub
- URL: https://github.com/jimmy-guzman/eslint-config-jimmy-guzman
- Owner: jimmy-guzman
- License: mit
- Created: 2021-10-16T00:28:04.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T17:47:54.000Z (7 months ago)
- Last Synced: 2024-04-14T07:49:35.695Z (7 months ago)
- Topics: eslint, eslint-rules, eslintconfig, jest, react, testing-library, typescript, vitest
- Language: TypeScript
- Homepage:
- Size: 992 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
**This is now deprecated in favor of [@jimmy.codes/eslint-config](https://github.com/jimmy-guzman/eslint-config)**
# eslint-config-jimmy-guzman
![actions][actions-badge]
[![version][version-badge]][package] [![downloads][downloads-badge]][npmtrends]
[![semantic-release][semantic-release-badge]][semantic-release]
[![code style: prettier][prettier-badge]][prettier]
[![Code Coverage][coverage-badge]][coverage]
> An opinionated ESLint configuration that targets typescript, javascript, react, jest vitest and testing-library
# Usage
> The current version of `eslint-config-jimmy-guzman` is fully supported on [LTS and current versions of node][node-lts-versions], and requires at least node v20.
## Installation
```
pnpm add -D eslint-config-jimmy-guzman
```
## Configuration
Add `extends: ['jimmy-guzman']` to your `.eslintrc` to get all the rules that enforce code style, enforce best practices and prevent errors.
This package also includes rules for `jest`, `vitest`, `react`, `typescript` and `testing-library` that can be used such as:
| rules | configuration | notes |
| --------------- | --------------------------------------------------------------------------------- | ------------------------ |
| base | `extends: ['jimmy-guzman']` | |
| jest | `extends: ['jimmy-guzman', 'jimmy-guzman/jest']` | |
| vitest | `extends: ['jimmy-guzman', 'jimmy-guzman/vitest']` | |
| typescript | `extends: ['jimmy-guzman', 'jimmy-guzman/typescript']` | [here](#typescript) |
| react | `extends: ['jimmy-guzman', 'jimmy-guzman/react']` | [here](#react) |
| testing-library | `extends: ['jimmy-guzman', 'jimmy-guzman/react', 'jimmy-guzman/testing-library']` | [here](#testing-library) |
### Monorepos
The following rules don't support some monorepo setups so you might need to turned them off:
```js filename=".eslintrc.cjs"
/** @type {import('eslint').Linter.Config} */
module.exports = {
extends: ['jimmy-guzman'],
rules: {
'import/no-extraneous-dependencies': 'off',
'react/jsx-uses-react': 'error',
},
}
```
### Typescript
`jimmy-guzman/typescript` ruleset requires type information that needs further configuration:
```js filename=".eslintrc.cjs"
/** @type {import('eslint').Linter.Config} */
module.exports = {
extends: ['jimmy-guzman', 'jimmy-guzman/typescript'],
parserOptions: {
project: ['./tsconfig.json'],
},
}
```
You can read more about linting with type information [here][typed-linting]
### React
`jimmy-guzman/react` favors [React 17's new jsx transform][react-17-new-jsx-transform] so a couple of rules are turned off by default. If you are not using the new jsx transform, it's recommended to add this configuration:
```js filename=".eslintrc.cjs"
/** @type {import('eslint').Linter.Config} */
module.exports = {
extends: ['jimmy-guzman', 'jimmy-guzman/react'],
parserOptions: {
ecmaFeatures: {
jsx: true,
pragma: 'React',
},
},
rules: {
'react/react-in-jsx-scope': 'error',
'react/jsx-uses-react': 'error',
},
}
```
### Testing Library
`jimmy-guzman/testing-library` makes an assumption that a suite of Testing Library packages are being used such as [@testing-library/react](https://github.com/testing-library/react-testing-library#readme), [@testing-library/jest-dom](https://github.com/testing-library/jest-dom#readme) and [@testing-library/user-event](https://github.com/testing-library/user-event#readme).
[actions-badge]: https://img.shields.io/github/actions/workflow/status/jimmy-guzman/eslint-config-jimmy-guzman/release.yml?style=flat-square&logo=github-actions
[version-badge]: https://img.shields.io/npm/v/eslint-config-jimmy-guzman.svg?logo=npm&style=flat-square
[package]: https://www.npmjs.com/package/eslint-config-jimmy-guzman
[downloads-badge]: https://img.shields.io/npm/dm/eslint-config-jimmy-guzman.svg?logo=npm&style=flat-square
[npmtrends]: http://www.npmtrends.com/eslint-config-jimmy-guzman
[semantic-release]: https://github.com/semantic-release/semantic-release
[semantic-release-badge]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square
[prettier-badge]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square&logo=prettier
[prettier]: https://github.com/prettier/prettier
[coverage-badge]: https://img.shields.io/codecov/c/github/jimmy-guzman/eslint-config-jimmy-guzman.svg?style=flat-square&logo=codecov
[coverage]: https://codecov.io/github/jimmy-guzman/eslint-config-jimmy-guzman
[typed-linting]: https://github.com/typescript-eslint/typescript-eslint/blob/main/docs/getting-started/Typed_Linting.mdx
[node-lts-versions]: https://nodejs.org/en/about/releases/#releases
[react-17-new-jsx-transform]: https://reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html