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

Shared ESLint config and plugin for Widen.
https://github.com/widen/eslint-config

eslint eslint-config eslint-plugin

Last synced: about 6 hours ago
JSON representation

Shared ESLint config and plugin for Widen.

• Host: GitHub
• URL: https://github.com/widen/eslint-config
• Owner: Widen
• License: isc
• Created: 2022-01-11T20:44:23.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-15T19:38:24.000Z (4 months ago)
• Last Synced: 2024-11-06T20:20:55.322Z (12 days ago)
• Topics: eslint, eslint-config, eslint-plugin
• Language: TypeScript
• Homepage:
• Size: 2.71 MB
• Stars: 1
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Widen ESLint

[![Build](https://github.com/Widen/eslint-config/actions/workflows/build.yml/badge.svg)](https://github.com/Widen/eslint-config/actions/workflows/build.yml)

[![changesets](https://img.shields.io/badge/maintained%20with-changesets-blue)](https://github.com/atlassian/changesets)

Widen's shared ESLint config and plugins.

## Installation

```bash

yarn add -D eslint eslint-{config,plugin}-widen eslint-plugin-sort @babel/{core,eslint-parser}

# If you use TypeScript

yarn add -D typescript-eslint

# If you use React

yarn add -D eslint-plugin-{react,react-hooks,jsx-a11y}

# If you use Playwright

yarn add -D eslint-plugin-playwright

# If you use Jest

yarn add -D eslint-plugin-jest

```

## Usage

In your `eslint.config.mjs` file, add the following four entries to your extends

list. If you don't need a specific configuration, simply remove it from the

list.

```js

import { base, react, jest, playwright, typescript } from 'eslint-config-widen'

export default [

  ...base,

  ...typescript,

  ...react,

  ...[

    // you can specify what to ignore by using the `ignores` key before any other rule

    // this will filter out things we dont want this to run on

    { ignores: ['*.test.*'] },

    ...jest,

    // you can also override rules by specifying the rule and the new value

    { files: ['*.spec.js'], rules: { 'jest/expect-expect': 'off' } },

  ],

  ...[{ files: ['e2e/**'] }, ...playwright],

]

```