build: enforce that we use comments that won't show up in the generated output #22309
Conversation
This file contains hidden or 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
…ed output Adds a custom stylelint rule that will prevent multi-line comments (`/* */`) from being used in .scss files. The problem with such comments are preserved by Sass and will show up in the user's output, whereas single-line comments (`//`) will not. **Note:** while Stylelint has a `comment-pattern` rule already, we can't use it because the rule works on the comment text which doesn't include the syntax.
crisbeto
added
P3
crisbeto
requested review from
andrewseguin,
devversion,
jelbourn,
mmalerba and
a team
as code owners
google-cla
bot
added
the
cla: yes
There was a problem hiding this comment.
For comments that are meant akin to JsDocs - should we switch to using the /// standard?
https://sass-lang.com/documentation/syntax/comments (see bottom)
|
I think so, but we aren't generating any docs from these comments right now so it doesn't really matter. |
jelbourn
approved these changes
Mar 22, 2021
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Adds a custom stylelint rule that will prevent multi-line comments (
/* */) from being used in .scss files. The problem with such comments is that they are preserved by Sass and will show up in the user's output, whereas single-line comments (//) will not.Note: while Stylelint has a
comment-patternrule already, we can't use it because the rule works on the comment text which doesn't include the syntax.