Skip to content
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

docs: remove mention of "prettier/vue" #1449

Merged
merged 3 commits into from Mar 3, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 5 additions & 11 deletions docs/user-guide/README.md
Expand Up @@ -266,7 +266,7 @@ See also: "[How to use a custom parser?](#how-to-use-a-custom-parser)" section.

### Conflict with [Prettier]

If the [Prettier] conflicts with the shareable config provided by this plugin, use [eslint-config-prettier] to resolve it.
Use [eslint-config-prettier] for [Prettier] not to conflict with the shareable config provided by this plugin.

Example **.eslintrc.js**:

Expand All @@ -279,35 +279,29 @@ module.exports = {
// ...
'plugin:vue/vue3-recommended',
// ...
"prettier",
"prettier/vue",
// "prettier/@typescript-eslint", // required if you are using @typescript-eslint.
// Other settings may be required depending on the plugin you are using. See the eslint-config-prettier documentation for more details.
"prettier"
// Make sure "prettier" is the last element in this list.
],
// ...
}
```

If the [Prettier] conflicts with the rule you have set, turn off that rule.

Example **.eslintrc.js**:

When the `vue/html-indent` rule conflict with [Prettier].
If Prettier conflicts with a rule you have set, [turn off that rule][prettier-linters]. For example, if you have `vue/html-indent` configured as `error` in `rules`, but it conflicts with Prettier, remove that line:

```diff
module.exports = {
// ...
rules: {
// ...
- "vue/html-indent": "error",
+ "vue/html-indent": "off",
// ...
},
// ...
}
```

[prettier]: https://prettier.io/
[prettier-linters]: https://prettier.io/docs/en/integrating-with-linters.html
[eslint-config-prettier]: https://github.com/prettier/eslint-config-prettier

### Using JSX
Expand Down