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

Shared ESLint config for Wunderwerk
https://github.com/wunderwerkio/eslint-config

Last synced: 18 minutes ago
JSON representation

Shared ESLint config for Wunderwerk

• Host: GitHub
• URL: https://github.com/wunderwerkio/eslint-config
• Owner: wunderwerkio
• Created: 2023-09-07T13:38:49.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-26T09:33:02.000Z (6 months ago)
• Last Synced: 2024-11-07T20:35:34.725Z (about 2 months ago)
• Language: JavaScript
• Size: 52.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# @wunderwerk/eslint-config

> Support for ESLint v9 was added in version v2!

ESLint config with support for the following:

- React

- React Hooks

- ES6 Imports

- JSDoc

- **Optional:** TypeScript

## Usage

Install the NPM package `npm install -D @wunderwerk/eslint-config` and then

reference the config in your `.eslintrc.js`:

```json

{

  "extends": [

    "@wunderwerk/eslint-config"

  ]

}

```

The module provides config variants for JavaScript and one for TypeScript.

The default config shown in the example above is for JavaScript.

To use the TypeScript config, extend the config as follows:

```json

{

  "parser": "@typescript-eslint/parser",

  "extends": [

    "@wunderwerk/eslint-config/typescript"

  ]

}

```

### React

You can add react specific rules by extending the `react` config:

```json

{

  "extends": [

    "@wunderwerk/eslint-config/react"

  ]

}

```

### Peer Dependencies

This config references other eslint plugins. These plugins must be installed in

your project and are defined as peer dependencies in this package:

```bash

npm install -D \

  eslint \

  eslint-plugin-import \

  eslint-plugin-jsdoc \

  eslint-plugin-react \

  eslint-plugin-react-hooks \

  @typescript-eslint/eslint-plugin

```