ESLint module for Nuxt
Note: This branch is for Nuxt 3 or Nuxt Bridge compatible module.
Checkout the nuxt2
branch for Nuxt 2 support.
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
@nuxtjs/eslint-module
dependency to your projectWith 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
@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 */ }]
]
})
export default defineNuxtConfig({
modules: [
'@nuxtjs/eslint-module'
],
eslint: {
/* module options */
}
})
You can pass eslint 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
Boolean
true
Note: The cache is enabled by default to decrease execution time.
include
String|Array[String]
[nuxt.options.srcDir.'/**/*.{js,jsx,ts,tsx,vue}']
Specify directories, files, or globs.
exclude
Array[String]
['**/node_modules/**', nuxt.options.buildDir]
Specify the files and/or directories to exclude.
eslintPath
String
eslint
Path to eslint
instance that will be used for linting.
formatter
String|Function
'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.
lintOnStart
Boolean
true
Check all matching files on project startup, too slow, turn on discreetly.
emitWarning
Boolean
true
The warnings found will be printed.
emitError
Boolean
true
The errors found will be printed.
failOnWarning
Boolean
false
Will cause the module build to fail if there are any warnings, based on emitWarning
.
failOnError
Boolean
false
Will cause the module build to fail if there are any errors, based on emitError
.
You can contribute to this module online with CodeSandBox:
Or locally:
pnpm install
pnpm dev:prepare
pnpm build
pnpm dev
Copyright (c) Nuxt Community