https://github.com/mskelton/eslint-config

Simple and sensible ESLint config.
https://github.com/mskelton/eslint-config

eslint eslint-config eslint-react eslint-typescript

Last synced: 3 months ago
JSON representation

Simple and sensible ESLint config.

• Host: GitHub
• URL: https://github.com/mskelton/eslint-config
• Owner: mskelton
• License: isc
• Created: 2019-11-15T01:50:36.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-11T12:11:44.000Z (9 months ago)
• Last Synced: 2024-10-07T14:52:23.635Z (3 months ago)
• Topics: eslint, eslint-config, eslint-react, eslint-typescript
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/@mskelton/eslint-config
• Size: 21.7 MB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @mskelton/eslint-config

[![Build status](https://github.com/mskelton/eslint-config/workflows/Release/badge.svg)](https://github.com/mskelton/eslint-config/actions)

[![package version](https://img.shields.io/npm/v/@mskelton/eslint-config)](https://www.npmjs.com/package/@mskelton/eslint-config)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

> 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](https://github.com/typescript-eslint/typescript-eslint)

and [Prettier](https://prettier.io).

## Installation

```sh

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.

```sh

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.

```sh

npm install -D eslint-plugin-vitest

```

### Jest

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

above.

```sh

npm install -D eslint-plugin-jest

```

## Usage

In your `.eslintrc` file, add the following content including the configs you

want for your project.

```json

{

  "extends": [

    "@mskelton",

    "@mskelton/eslint-config/react",

    "@mskelton/eslint-config/vitest",

    "@mskelton/eslint-config/jest",

    "@mskelton/eslint-config/playwright"

  ]

}

```