Add autofixing caveats explanation #2667
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Users can use this trick for npm scripts to run stylelint twice :) {
"name": "project",
"scripts": {
"lintcss": "npm run postlintcss",
"postlintcss": "stylelint . --fix"
}
} |
jeddy3
requested changes
Jun 22, 2017
docs/user-guide/cli.md
Outdated
| @@ -80,6 +80,10 @@ Linting all `.css` files in the `foo` directory. And fixing source files if viol | |||
| stylelint "foo/*.css" --fix | |||
| ``` | |||
|
|
|||
| **Note:** It's an _experimental_ feature. It ignores special comments for disabling stylelint within style sheet (e. g. `/* stylelint-disable /*`). It means autofixing will apply regardless of these comments. | |||
|
|
|||
| If you're using both these special comments and autofixing, please run stylelint twice. On the first run, some violations could be missed, or some violations might be reported incorrectly. It's a temporary solution until stylelint learn to respect these comments. | |||
There was a problem hiding this comment.
"It's an experimental feature. It currently does not respect special comments for disabling stylelint within sources (e. g. /* stylelint-disable /*). Autofixing will be applied regardless of these comments."
"If you're using both these special comments and autofixing, please run stylelint twice as a temporary solution. On the first run, some violations could be missed, or some violations might be reported incorrectly."
jeddy3
approved these changes
Jun 26, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#2643 (comment)
Maybe we should even tweet about this, because it's pretty serious caveat.