@nuxtjs/eslint-module

ESLint module for Nuxt

Note: This branch is for Nuxt 3 or Nuxt Bridge compatible module. Checkout the nuxt2 branch for Nuxt 2 support.

Requirements

You need to ensure that you have eslint >= 7 installed:

With pnpm

pnpm add -D eslint

Or, with yarn

yarn add -D eslint

Or, with npm

npm install -D eslint

Setup

Add @nuxtjs/eslint-module dependency to your project

With pnpm

pnpm add -D @nuxtjs/eslint-module

Or, with yarn

yarn add -D @nuxtjs/eslint-module

Or, with npm

npm install -D @nuxtjs/eslint-module

Add @nuxtjs/eslint-module to the modules section of nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    // Simple usage
    '@nuxtjs/eslint-module',

    // With options
    ['@nuxtjs/eslint-module', { /* module options */ }]
  ]
})

Using top level options

export default defineNuxtConfig({
  modules: [
    '@nuxtjs/eslint-module'
  ],
  eslint: {
    /* module options */
  }
})

Note that the config option you provide will be passed to the ESLint class. This is a different set of options than what you'd specify in package.json or .eslintrc. See the eslint docs for more details.

`cache`

Type: Boolean
Default: true

Note: The cache is enabled by default to decrease execution time.

`include`

Type: String|Array[String]
Default: [nuxt.options.srcDir.'/**/*.{js,jsx,ts,tsx,vue}']

Specify directories, files, or globs.

`exclude`

Type: Array[String]
Default: ['**/node_modules/**', nuxt.options.buildDir]

Specify the files and/or directories to exclude.

`eslintPath`

Type: String
Default: eslint

Path to eslint instance that will be used for linting.

`formatter`

Type: String|Function
Default: 'stylish'

Accepts a function that will have one argument: an array of eslint messages (object). The function must return the output as a string. You can use official eslint formatters.