eslint-config-xo-vue

eslint-config-xo-vue

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

• eslint-config-xo - ESLint shareable config for XO
• XO

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