Recommend using shared configs #5598
Conversation
|
@ybiquitous Thanks for all the catches! I've committed them all. |
docs/user-guide/get-started.md
Outdated
| - parse CSS-like syntaxes like SCSS, Less and SugarSS | ||
| - extract styles from HTML, JavaScript and Markdown |
There was a problem hiding this comment.
I'm thinking if this messaging is making sense to the end user. It's a PostCSS syntax, which is parses something, or extract something. Our users don't use Stylelint to parse or extract, they use it for lint. Maybe we can reword selected lines to highlight that Stylelint could be used with different syntaxes, including files, where CSS is embed into different language?
P. S. It's weird to write Stylelint from capital letter after all these years of writing it with lower case :)
There was a problem hiding this comment.
I've added a commit (5384f54) to make it clear that it's the PostCSS syntaxes doing the parsing/extracting, and that a PostCSS syntax is needed if linting anything other than CSS.
P. S. It's weird to write Stylelint from capital letter after all these years of writing it with lower case :)
Ha, I know! I keep catching myself doing it.
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
jeddy3
force-pushed
the
config-migration
branch
from
1237467
to
6678fa9
Compare
docs/user-guide/get-started.md
Outdated
| @@ -2,9 +2,9 @@ | |||
|
|
|||
| Stylelint is designed for CSS. | |||
|
|
|||
| However, it can be extended to: | |||
| However, it can used with [PostCSS syntaxes](https://github.com/postcss/postcss#syntaxes) that: | |||
There was a problem hiding this comment.
Sorry, I don't know if it's a typo I spotted, or it's part of English I don't know :) Is “be” needed after “can”?
Follows on from: #5563
Ref: #5205
It's likely the SCSS configs and plugins will be ready for release, see:
This pull request updates the 14.0.0 migration guide and getting started page to recommend installing a shared config for your preferred language.
It's a dramatic shift from syntax inferral to explicit configuration, and we should emphasise shared configs as the best way to do that configuration. They are the easiest way for users to get up and running with comprehensive linting that doesn't leave gaps.
If you use Stylelint to lint SCSS, please have a look at the above pull request especially what rules the configs turn on.