nuxt-community
@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 eslintOr, with yarn
yarn add -D eslintOr, with npm
npm install -D eslintSetup
- Add
@nuxtjs/eslint-moduledependency to your project
With pnpm
pnpm add -D @nuxtjs/eslint-moduleOr, with yarn
yarn add -D @nuxtjs/eslint-moduleOr, with npm
npm install -D @nuxtjs/eslint-module- Add
@nuxtjs/eslint-moduleto themodulessection ofnuxt.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 */
}
})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
- 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.
lintOnStart
- Type:
Boolean - Default:
true
Check all matching files on project startup, too slow, turn on discreetly.
emitWarning
- Type:
Boolean - Default:
true
The warnings found will be printed.
emitError
- Type:
Boolean - Default:
true
The errors found will be printed.
failOnWarning
- Type:
Boolean - Default:
false
Will cause the module build to fail if there are any warnings, based on emitWarning.
failOnError
- Type:
Boolean - Default:
false
Will cause the module build to fail if there are any errors, based on emitError.
Contributing
You can contribute to this module online with CodeSandBox:
Or locally:
- Clone this repository
- Install dependencies using
pnpm install - Prepare development server using
pnpm dev:prepare - Build module using
pnpm build - Launch playground using
pnpm dev
License
Copyright (c) Nuxt Community