mskelton / eslint-config

Simple and sensible ESLint config.

@mskelton/eslint-config

Simple and sensible ESLint config.

Description

This package contains a simple and sensible ESLint config that you can use to get up and running with a TypeScript. It uses the TypeScript ESLint parser and Prettier.

Installation

npm install -D @mskelton/eslint-config eslint eslint-plugin-sort @typescript-eslint/eslint-plugin @typescript-eslint/parser

React

If using React, install the following peer dependencies in addition to the list above.

npm install -D eslint-plugin-react eslint-plugin-react-hooks

Vitest

If using Vitest, install the following peer dependencies in addition to the list above.

npm install -D eslint-plugin-vitest

Jest

If using Jest, install the following peer dependencies in addition to the list above.

npm install -D eslint-plugin-jest

Usage

In your .eslintrc file, add the following content including the configs you want for your project.

{
  "extends": [
    "@mskelton",
    "@mskelton/eslint-config/react",
    "@mskelton/eslint-config/vitest",
    "@mskelton/eslint-config/jest",
    "@mskelton/eslint-config/playwright"
  ]
}