eslint-config-jimmy-guzman
Advanced tools
Changelog
Readme
An opinionated ESLint configuration that targets typescript, javascript, react and jest and testing-library
The current version of
eslint-config-jimmy-guzmanis fully supported on LTS versions of node, and requires at least node v12.
This requires the peer dependencies: eslint@^8.14.0, typescript@^4.5.0, and prettier@^2.4.0.
To easily install everything you can leverage install-peerdeps, i.e
| for | how |
|---|---|
| yarn/npm | npx install-peerdeps --dev eslint-config-jimmy-guzman |
| yarn workspaces | npx install-peerdeps eslint-config-jimmy-guzman --dev -yarn -x -W |
| pnpm | pnpm dlx install-peerdeps eslint-config-jimmy-guzman --dev -pnpm |
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, typescript and testing-library that can be used such as:
| rules | configuration | notes |
|---|---|---|
| base | extends: 'jimmy-guzman' | |
| jest | extends: ['jimmy-guzman', 'jimmy-guzman/jest'] | |
| typescript | extends: ['jimmy-guzman', 'jimmy-guzman/typescript'] | here |
| react | extends: ['jimmy-guzman', 'jimmy-guzman/react'] | here |
| testing-library | extends: ['jimmy-guzman', 'jimmy-guzman/react', 'jimmy-guzman/testing-library'] | here |
The following rules don't support some monorepo setups so you might need to turned them off:
# .eslintrc.yml
rules:
import/no-extraneous-dependencies: off
jimmy-guzman/typescript ruleset requires type information that needs further configuration:
# .eslintrc.yml
parserOptions:
project: ['./tsconfig.json']
You can read more about linting with type information here
jimmy-guzman/react favors React 17's 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:
parserOptions:
ecmaFeatures:
jsx: true
pragma: React
rules:
react/react-in-jsx-scope: error
react/jsx-uses-react: error
jimmy-guzman/testing-library makes an assumption that a suite of Testing Library packages are being used such as @testing-library/react, @testing-library/jest-dom and @testing-library/user-event.
I wanted a one-stop shop for the ESLint rules across my projects to help keep up with ESLint upgrades across different plugins and to have consistency. Feel free to use this if it fits your needs. ❤️
FAQs
An opinionated ESLint configuration that targets typescript, javascript, react, jest and testing-library
The npm package eslint-config-jimmy-guzman receives a total of 4 weekly downloads. As such, eslint-config-jimmy-guzman popularity was classified as not popular.
We found that eslint-config-jimmy-guzman demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.