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

Sharable eslint config with reasonable defaults
https://github.com/imccausl/eslint-config

eslint eslint-config eslintrc react testing-library vitest

Last synced: 4 months ago
JSON representation

Sharable eslint config with reasonable defaults

• Host: GitHub
• URL: https://github.com/imccausl/eslint-config
• Owner: imccausl
• License: mit
• Created: 2024-02-12T02:49:25.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-09-23T20:29:47.000Z (5 months ago)
• Last Synced: 2024-09-29T01:20:16.368Z (5 months ago)
• Topics: eslint, eslint-config, eslintrc, react, testing-library, vitest
• Language: TypeScript
• Homepage:
• Size: 1.28 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# eslint-config

[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

[![CI](https://github.com/imccausl/eslint-config/actions/workflows/ci.yml/badge.svg)](https://github.com/imccausl/eslint-config/actions/workflows/ci.yml)

A sharable eslint configuration with react and testing defaults.

## Usage

Includes a base config and configs for react and testing with @testing-library/react and vitest.

To use the base config, install the config as well as it's dependencies:

```bash

yarn add -D \

  @imccausl/eslint-config \

  eslint \ 

  prettier \

  eslint-config-prettier \

  eslint-plugin-prettier \

  eslint-plugin-import \ 

  eslint-import-resolver-typescript \

  eslint-import-resolver-node \

  @typescript-eslint/eslint-plugin \

  @typescript-eslint/parser

```

If you'd like to use the react config, include the following dependencies:

```bash

yarn add -D \

  @tanstack\eslint-plugin-query \

  eslint-plugin-react \

  eslint-plugin-react-hooks

```

And for the testing config, include these dependencies:

```bash

yarn add -D \

  eslint-plugin-vitest \

  eslint-plugin-testing-library

```

With dependencies installed, your eslint config can be extended like this:

```json

{

  "extends": [

    "@imccausl/eslint-config"

  ],

  "parserOptions": {

    "project": "./tsconfig.json"

  }

}

```