Docs: add FAQ about vue-eslint-parser #82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merged

michalsnik merged 1 commit into master from docs-for-vue-eslint-parser

Jul 16, 2017

Merged

Docs: add FAQ about vue-eslint-parser #82

michalsnik merged 1 commit into master from docs-for-vue-eslint-parser

Jul 16, 2017

Conversation

mysticatea

Copy link

Member

@mysticatea mysticatea commented Jul 16, 2017

This PR adds FAQ about "Use the latest vue-eslint-parser" errors.
Also, the error message points that.

Please check this description is enough or not.

@mysticatea mysticatea added Ready for review semver-patch labels

Jul 16, 2017

@mysticatea mysticatea requested a review from michalsnik

July 16, 2017 08:59

michalsnik

michalsnik reviewed

Jul 16, 2017

View reviewed changes

README.md Outdated

@@ -113,6 +113,30 @@ The `--fix` option on the command line automatically fixes problems reported by

## :couple: FAQ

### What is "Use the latest vue-eslint-parser" errors?

Copy link

Member

@michalsnik michalsnik Jul 16, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it should be:

What is the `Use the latest vue-eslint-parser` error?

README.md Outdated

The most rules of `eslint-plugin-vue` requires `vue-eslint-parser` to check `<template>` ASTs.

Please add one of the following settings into your configuration:

Copy link

Member

@michalsnik michalsnik Jul 16, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about: Make sure you have one of the following settings in your **.eslintrc.js**: ?

README.md Outdated

- `"extends": ["plugin:vue/recommended"]`

- `"extends": ["plugin:vue/base"]`

- `"parser": "vue-eslint-parser"` (and do `npm install -D vue-eslint-parser`)

Copy link

Member

@michalsnik michalsnik Jul 16, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can remove the third option and force using base or recommended configuration. The less options the better, people will not get confused :)

README.md Outdated

- `"extends": ["plugin:vue/base"]`

- `"parser": "vue-eslint-parser"` (and do `npm install -D vue-eslint-parser`)

If you have `"parser": "babel-eslint"` setting or something like in your configuration, please move it into `parserOptions`.

Copy link

Member

@michalsnik michalsnik Jul 16, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you already use other parser (e.g. "parser": "babel-eslint"), please move it into parserOptions, so it doesn't collide with the vue-eslint-parser used by this plugin's configuration: