Adding BEM naming convention to the stylelint rules #28954
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
|
Size Change: +23 kB (+2%) Total Size: 1.41 MB
ℹ️ View Unchanged
|
|
@gziolo the checks have failed since the rule is now applied in the linter. What should I do in this case, disable the rule and keep only the regex change, or change the CSS rules as well? 😅 |
ocean90
reviewed
Feb 11, 2021
packages/stylelint-config/index.js
Outdated
| @@ -98,7 +98,7 @@ module.exports = { | |||
| 'selector-attribute-operator-space-before': 'never', | |||
| 'selector-attribute-quotes': 'always', | |||
| 'selector-class-pattern': [ | |||
| '^([a-z][a-z0-9]*)(-[a-z0-9]+)*$', | |||
| '^([a-z][a-z0-9]*)(-[a-z0-9]+)*((__([a-z][a-z0-9]*)(-[a-z0-9]+)*)?(--([a-z][a-z0-9]*)(-[a-z0-9]+)*)?)$', | |||
There was a problem hiding this comment.
I suggest to also set the resolveNestedSelectors option and the message needs an update too. See this example for inspiration.
gziolo
added
[Package] stylelint config
|
Nice one, the number of violations reported is so long 😅
We definitely should ignore those violations for React Native files ( https://github.com/WordPress/gutenberg/blob/master/packages/stylelint-config/CHANGELOG.md |
@gziolo Gotcha. There's probably an option... I tried it on #28988. |
|
@gziolo Gotcha. There's probably an option... I tried it on #28988.
I commented on the PR and asked the mobile team to share their thoughts on the approach proposed. Great idea to automate it, it would be too much hassle otherwise 😄
It sounds promising. We should also disable this rule in https://github.com/WordPress/gutenberg/blob/master/packages/components/src/date-time/datepicker.scss since we forked https://github.com/airbnb/react-dates so those class names are completely different. With that, the number of violations should be way smaller. |
This was referenced Feb 15, 2021
7 tasks
* Scope selector-class-pattern stylelint rule to web stylesheets Native stylesheets currently do not adhere to the same BEM selector patterns as web stylesheets. This introduces a custom stylelint plugin to exclude native stylesheets from the selector-class-pattern rule. * Fixing unit tests to use correct base directory * Append native suffix to avoid web-specific lint rules All stylesheet files that do not have the native suffix are linted with web-specific selector rules. Adding the suffix disables those irrelevant rules for the native stylesheet. Co-authored-by: Rafael Galani <galani.rafael@gmail.com>
This was referenced Dec 22, 2021
|
Hi, @rafaelgalani The original issue came up during Weekly Editor Bug Scrub. I just wanted to check if you've time to continue working on this PR or how I can help to move this forward. Thanks |
|
It would be great to move forward with this PR, just saying 😄 |
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.
Description
Fixes #28616.
It's basically an increment to a
stylelintrule validation regex, extending it to also allow BEM naming convention (block__element--modifier).How has this been tested?
npx stylelint **/*.scssand making sure tests wouldn't break.Types of changes
Bugfix - I guess. Since the validation was disabled...
I'm not sure how to categorize it.
Checklist: