Skip to content
ESLint plugin for Nuxt.js [WIP]
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci ci: changew workflow name Dec 5, 2018
.github ci: rename workflow Dec 20, 2018
docs/rules chore: move test to __tests__ Apr 24, 2019
lib chore: move test to __tests__ Apr 24, 2019
.editorconfig chore: init repo Dec 4, 2018
.eslintrc.js chore: add eslint Dec 5, 2018
.gitignore Initial commit Dec 4, 2018
CHANGELOG.md chore: correct changelog Mar 12, 2019
LICENSE license: correct name Dec 5, 2018
README.md doc: improve usage Feb 21, 2019
package.json chore(deps): update all non-major dependencies May 21, 2019
renovate.json chore: enable lockFile maintenance Apr 24, 2019
yarn.lock

README.md

eslint-plugin-nuxt

Standard JS Circle CI npm version npm downloads

ESLint plugin for Nuxt.js

💿 Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev
success Saved 1 new dependencies

Next, install eslint-plugin-nuxt:

$ npm install eslint-plugin-nuxt --save-dev
success Saved 1 new dependencies

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-nuxt globally.

🚀 Usage

Add nuxt to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

  1. Use our preset to extend recommended defaults:
{
  "extends": [
    "plugin:nuxt/recommended"
  ]
}
  1. Or specify individual rules manually:
{
    "plugins": [
        "nuxt"
    ],
    "rules": {
        "nuxt/rule-name": 2
    }
}

⚙️ Configs

This plugin provides four predefined configs:

  • plugin:nuxt/base - Settings and rules to enable correct ESLint parsing
  • plugin:nuxt/recommended - Above, plus rules to enforce subjective community defaults to ensure consistency

💡 Rules

Base Rules

{
  "extends": "plugin:nuxt/base"
}
Rule ID Description
nuxt/no-env-in-context Disallow context.isServer/context.isClient in asyncData/fetch/nuxtServerInit
nuxt/no-env-in-hooks Disallow process.server/process.client in client only Vue lifecycle hooks like: mounted, beforeMount, updated...
nuxt/no-globals-in-created Disallow window/document in created/beforeCreate
nuxt/no-this-in-fetch-data Disallow this in asyncData/fetch
nuxt/no-cjs-in-config Disallow require/modules.exports/exports in nuxt.config.js

Recommended Rules

Include all the below rules, as well as all priority rules in above categories, with:

{
  "extends": "plugin:nuxt/recommended"
}
Rule ID Description
🔧 nuxt/no-timing-in-fetch-data Disallow setTimeout/setInterval in asyncData/fetch
You can’t perform that action at this time.