https://github.com/nabla/vite-plugin-eslint

Plugs ESLint into Vite dev server
https://github.com/nabla/vite-plugin-eslint

eslint vite

Last synced: about 2 months ago
JSON representation

Plugs ESLint into Vite dev server

• Host: GitHub
• URL: https://github.com/nabla/vite-plugin-eslint
• Owner: nabla
• License: mit
• Created: 2021-06-15T18:52:38.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-17T08:19:50.000Z (5 months ago)
• Last Synced: 2024-07-19T15:31:33.091Z (2 months ago)
• Topics: eslint, vite
• Language: JavaScript
• Homepage:
• Size: 185 KB
• Stars: 118
• Watchers: 3
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @nabla/vite-plugin-eslint [![npm](https://img.shields.io/npm/v/@nabla/vite-plugin-eslint)](https://www.npmjs.com/package/@nabla/vite-plugin-eslint)

Plugs ESLint into Vite dev server.

## Differences with [vite-plugin-eslint](https://github.com/gxmari007/vite-plugin-eslint)

- Keeps HMR fast: linting is done asynchronously and doesn't block the transform process

- Reduces noise: Display results via console logs

![logs.png](logs.png)

Because of this, the plugin can't fail the build and is only applied in dev. Like typechecking, linting should be done before or in parallel of the build command.

## Install

`yarn add --dev @nabla/vite-plugin-eslint`

## Usage

```ts

import { defineConfig } from "vite";

import eslintPlugin from "@nabla/vite-plugin-eslint";

export default defineConfig({

  plugins: [eslintPlugin()],

});

```

## Options

### eslintOptions

- Type: [ESLint.Options](https://eslint.org/docs/developer-guide/nodejs-api#-new-eslintoptions)

- Default: `{ cache: true }`

Note: the `fix` option is only supported from `1.3.4`

### shouldLint

- Type: `(path: string) => boolean`

- Default: `(path) => path.match(/\/src\/[^?]*\.(vue|svelte|m?[jt]sx?)$/)`

You can use `DEBUG=eslint node_modules/.bin/vite` to debug this option (available in `1.4.0`)

### formatter

- Type: `string | ((result: ESLint.LintResult) => void)`

- Default: Custom format with one line per warning/error.

If provided, the value is passed to `eslint.loadFormatter`. Use `stylish` to get a CRA like output. Async formatters are supported in `1.5.0`. Function support was added in `2.0.2`.