Git Product home page Git Product logo

eslint-plugin-nuxt's Introduction

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

Other Rules

Rule ID Description
nuxt/require-func-head Enforce head property in component to be a function.

eslint-plugin-nuxt's People

Contributors

atinux avatar clarkdo avatar gion avatar remino avatar renovate-bot avatar renovate[bot] avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.