Code Monkey home page Code Monkey logo

eslint-config-vue2-roboleary's Introduction

eslint-config-vue2-roboleary

My ESLint config for linting Vue 2 apps. You can use it along side Prettier without conflicts.

It includes the following:

Usage

  1. Install this package, ESLint (peer dependency) and Prettier (peer dependency) as devDependencies with the command npm i --save-dev eslint prettier eslint-config-vue2-roboleary.

  2. Create an eslint config file in the root of your project directory e.g. .eslintrc. Add the following:

    {
      "extends": ["eslint-config-vue2-roboleary"]
    }

    Alternatively, you can put a reference to the config in your package.json under the property eslintConfig.

  3. You can add scripts to your package.json to lint, fix, and format your code from the command-line.

    {
    	"scripts": {
    		"lint": "eslint .",
    		"lint:fix": "npm run lint -- --fix",
    		"format": "prettier src test --check",
    		"format:fix": "npm run prettier -- --write",
    	},
    }

Configuration in VS Code

If you want to use ES Lint and Prettier in VS Code, I recommend installing the extensions: ESLint, Prettier, and Format Code Action.

To format and lint code on save, you can update your user settings with the following:

{
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "eslint.probe": [
      "javascript",
      "javascriptreact",
      "vue"
  ],
  "editor.formatOnSave": false,
  "editor.codeActionsOnSave": [
    "source.formatDocument",
    "source.fixAll"
  ],
}

If you use the Vetur plugin, ensure that Vetur's template validation does not interfere with linting. The setting is "vetur.validation.template", it is set to false by default.

eslint-config-vue2-roboleary's People

Contributors

robole 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.