Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ChocPanda/eslint-config-xo-vue
ESLint shareable config for Vue to be used with eslint-config-xo https://github.com/xojs/xo
https://github.com/ChocPanda/eslint-config-xo-vue
eslint javascript liniting-rules linting node nodejs vue vuejs xo
Last synced: 3 months ago
JSON representation
ESLint shareable config for Vue to be used with eslint-config-xo https://github.com/xojs/xo
- Host: GitHub
- URL: https://github.com/ChocPanda/eslint-config-xo-vue
- Owner: ChocPanda
- License: mit
- Created: 2019-06-06T08:52:23.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-06T09:55:43.000Z (5 months ago)
- Last Synced: 2024-11-14T09:06:39.881Z (3 months ago)
- Topics: eslint, javascript, liniting-rules, linting, node, nodejs, vue, vuejs, xo
- Language: JavaScript
- Homepage:
- Size: 2.23 MB
- Stars: 35
- Watchers: 3
- Forks: 5
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-config-xo-vue
> ESLint [shareable config](http://eslint.org/docs/developer-guide/shareable-configs.html) for vue to be used with [eslint-config-xo](https://github.com/xojs/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](#Use-with-XO)
## Usage
Add some ESLint config to your package.json:
```json
{
"name": "my-awesome-project",
"eslintConfig": {
"extends": [
"xo",
"xo-vue"
]
}
}
```
Or to .eslintrc:
```json
{
"extends": [
"xo",
"xo-vue"
]
}
```
Use the `space` sub-config if you want 2 space indentation instead of tabs:
```json
{
"extends": [
"xo",
"xo-vue/space"
]
}
```
You can also mix it with a [XO](https://github.com/xojs/xo) sub-config:
```json
{
"extends": [
"xo/esnext",
"xo-vue"
]
}
```
### WARNING
When running eslint be sure to add the [--ext vue](https://eslint.org/docs/user-guide/configuring#specifying-file-extensions-to-lint) 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
```
```json
{
"name": "my-awesome-project",
"xo": {
"extends": "xo-vue",
"extensions": ["js", "vue"]
}
}
```
## Known Issues
Hoping you'll report any you find, checkout [github issues](https://github.com/ChocPanda/eslint-config-xo-vue/issues)
## Related
- [eslint-config-xo](https://github.com/xojs/eslint-config-xo) - ESLint shareable config for XO
- [XO](https://github.com/xojs/xo)
## Contributions
See our [contributing doc](./CONTRIBUTING.md), be sure to checkout the [code of conduct](./CONTRIBUTING.md#code-of-conduct)
### Conventional Commits
This project uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0-beta.3/#specification) to manage versions and releases of the library therefore when making a commit please use `yarn commit ` and this will guide you through writing a conventional commit message which can be understood work with the ci pipeline