Exciting news!Announcing our $4.6M Series Seed. Learn more
Socket
LoveBlogFAQ
Install
Log in

eslint-config-jimmy-guzman

Package Overview
Dependencies
10
Maintainers
1
Versions
12
Issues
File Explorer

Advanced tools

eslint-config-jimmy-guzman

An opinionated ESLint configuration that targets typescript, javascript, react, jest and testing-library

    5.0.0latest

Version published
Maintainers
1
Yearly downloads
3,581

Weekly downloads

Readme

Source

actions version downloads License semantic-release code style: prettier Code Coverage

eslint-config-jimmy-guzman

An opinionated ESLint configuration that targets typescript, javascript, react and jest and testing-library

Table of Contents

Usage

The current version of eslint-config-jimmy-guzman is fully supported on LTS versions of node, and requires at least node v12.

Installation:

This requires the peer dependencies: [email protected]^8.14.0, [email protected]^4.5.0, and [email protected]^2.4.0.

To easily install everything you can leverage install-peerdeps, i.e

forhow
yarn/npmnpx install-peerdeps --dev eslint-config-jimmy-guzman
yarn workspacesnpx install-peerdeps eslint-config-jimmy-guzman --dev -yarn -x -W
pnpmpnpm dlx install-peerdeps eslint-config-jimmy-guzman --dev -pnpm

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, typescript and testing-library that can be used such as:

rulesconfigurationnotes
baseextends: 'jimmy-guzman'
jestextends: ['jimmy-guzman', 'jimmy-guzman/jest']
typescriptextends: ['jimmy-guzman', 'jimmy-guzman/typescript']here
reactextends: ['jimmy-guzman', 'jimmy-guzman/react']here
testing-libraryextends: ['jimmy-guzman', 'jimmy-guzman/react', 'jimmy-guzman/testing-library']here

Monorepos

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

Typescript

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

React

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

Testing Library

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.

Why

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. ❤️

Keywords

FAQs

What is eslint-config-jimmy-guzman?

An opinionated ESLint configuration that targets typescript, javascript, react, jest and testing-library

Is eslint-config-jimmy-guzman popular?

The npm package eslint-config-jimmy-guzman receives a total of 126 weekly downloads. As such, eslint-config-jimmy-guzman popularity was classified as not popular.

Is eslint-config-jimmy-guzman well maintained?

We found that eslint-config-jimmy-guzman demonstrated a healthy version release cadence and project activity. It has 1 open source maintainer collaborating on the project.

Last updated on 01 May 2022
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc