Add clarification notes about EditorConfig #13828
Conversation
|
Can anyone please review it? |
|
|
||
| However, the API _doesn't_ respect `.editorconfig` by default, in order to avoid potential editor integration issues. To opt in, add `editorconfig: true` to the [`prettier.resolveConfig`](https://prettier.io/docs/en/api.html#prettierresolveconfigfilepath--options) options. | ||
|
|
||
| > Note: Rules that are set in `.editorconfig` can be overridden by their corresponding rules from `.prettierrc.js`, therefore rules from `.editorconfig` can be used as a fallback for files that Prettier doesn't support. See the languages list supported by Prettier [here](https://prettier.io/docs/en/index.html) |
There was a problem hiding this comment.
I don't understand this part: "rules from .editorconfig can be used as a fallback for files that Prettier doesn't support". What does this mean?
There was a problem hiding this comment.
Let's say there is a set of rules in .prettier.js and an environment that doesn't support prettier (the not widely used programming language that is not in the Prettier support list for instance).
However, we still have .editorconfig, which has better support for most IDEs.
For example, if, for the reasons above, the printWidth Prettier rule cannot be used, we still have its EditorConfig's alternative max_line_length that will be used as a fallback value.
Does it answer your question, @thorn0?
There was a problem hiding this comment.
I see what you mean now, but this isn't clear from the proposed paragraph. A better wording is needed.
Description
Although I'm not a Prettier expert, IMHO the section about the EditorConfig integration is not super clear, to be honest. So I'd add some more words about the relationships between Prettier and EditorConfig.
Please correct me, if I'm missing something.
Checklist
docs/directory).changelog_unreleased/*/XXXX.mdfile followingchangelog_unreleased/TEMPLATE.md.✨Try the playground for this PR✨