Node's Perpetuum Mobile
Join us to discuss the challenges, solutions and best practices for in-house JavaScript code sharing. Tuesday, 12/17 at 10am PT/1pm ET.Sign up here »

eslint-config-xo-vue

3.1.0 • Public • Published

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

Install

npm i eslint-config-xo-vue

DownloadsWeekly Downloads

33

Version

3.1.0

License

MIT

Unpacked Size

26.9 kB

Total Files

5

Last publish

Collaborators

  • avatar