nuxt-modules / eslint

ESLint module for Nuxt.js
MIT License
159 stars 15 forks source link
eslint nuxt nuxt-module nuxtjs

@nuxtjs/eslint-module

npm version npm downloads Github Actions CI Codecov License

ESLint module for Nuxt

πŸ“– Release Notes


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

  1. 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
  1. 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 */
  }
})

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

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

include

Specify directories, files, or globs.

exclude

Specify the files and/or directories to exclude.

eslintPath

Path to eslint instance that will be used for linting.

formatter

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

Check all matching files on project startup, too slow, turn on discreetly.

emitWarning

The warnings found will be printed.

emitError

The errors found will be printed.

failOnWarning

Will cause the module build to fail if there are any warnings, based on emitWarning.

failOnError

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:

Edit @nuxtjs/robots

Or locally:

  1. Clone this repository
  2. Install dependencies using pnpm install
  3. Prepare development server using pnpm dev:prepare
  4. Build module using pnpm build
  5. Launch playground using pnpm dev

License

MIT License

Copyright (c) Nuxt Community