Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including eslint-config-xo-vue with all npm packages installed. Try it out:

require("eslint/package.json"); // eslint is a peer dependency. require("eslint-config-xo/package.json"); // eslint-config-xo is a peer dependency. require("eslint-plugin-vue/package.json"); // eslint-plugin-vue is a peer dependency. var eslintConfigXoVue = require("eslint-config-xo-vue")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

eslint-config-xo-vue v3.1.0

Unofficial ESLint shareable config for Vue to be used with eslint-config-xo https://github.com/xojs/xo

eslint-config-xo-vue

npm

ESLint shareable config for vue to be used with eslint-config-xo

Install

To use with an eslint:

$ npm install --save-dev eslint-config-xo eslint-config-xo-vue eslint-plugin-vue
$ yarn add --dev eslint-config-xo eslint-config-xo-vue eslint-plugin-vue

I recommend using with xo

Usage

Add some ESLint config to your package.json:

{
    "name": "my-awesome-project",
    "eslintConfig": {
        "extends": [
            "xo",
            "xo-vue"
        ]
    }
}

Or to .eslintrc:

{
    "extends": [
        "xo",
        "xo-vue"
    ]
}

Use the space sub-config if you want 2 space indentation instead of tabs:

{
    "extends": [
        "xo",
        "xo-vue/space"
    ]
}

You can also mix it with a XO sub-config:

{
    "extends": [
        "xo/esnext",
        "xo-vue"
    ]
}

WARNING

When running eslint be sure to add the --ext vue command line param

Tip

Use with XO

$ npm install --save-dev xo eslint-config-xo-vue eslint-plugin-vue
$ yarn add --dev xo eslint-config-xo-vue eslint-plugin-vue
{
    "name": "my-awesome-project",
    "xo": {
        "extends": "xo-vue",
        "extensions": ["js", "vue"]
    }
}

Known Issues

Hoping you'll report any you find, checkout github issues

Related

Contributions

See our contributing doc, be sure to checkout the code of conduct

Conventional Commits

This project used conventianal commits to manage versions and releases of the library therefore when making a commit please use yarn commit <COMMIT_PARAMETERS> and this will guide you through writing a conventional commit message which can be understood work with the ci pipeline

Metadata

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free