-
Notifications
You must be signed in to change notification settings - Fork 63
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adds testid
guidelines to Styleguide
#2221
Conversation
|
4dca626
to
4638ff2
Compare
STYLEGUIDE.md
Outdated
3. Blocks are separated by dash `-` | ||
4. Name hierarchy should somewhat match the directory structure | ||
|
||
e.g. `data-testid="lg-date_picker-calendar_cell"` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be lg-date-picker_calendar-cell
? date-picker is the block
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, since "date_picker" is one concept
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Whats the diff between a block and a concept? I know that we are not fully following BEM but from docs it looks like it should be date-picker
because that's the block.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
BEM uses dashes to separate words within a block/element, and a double underscore to separate blocks/elements/modifiers.
This proposal is to use a single underscore to separate words, and a dash to separate concepts/elements/blocks
My main gripe with this syntax is that in most text editors a Double click or Option
+ArrowKey
presses treat underscores as one works and dashes as a separator. So If I want to replace the "calendar_cell"
part I can double click it and paste. Or if I want to skip from the end of that string to the previous element I can just press Option
+ ArrowLeft
. All this is backwards with standard BEM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add this bit to the styleguide? ...use a single underscore to separate words, and a dash to separate concepts/elements/blocks
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oh nvm its there!
Size Change: 0 B Total Size: 1.24 MB ℹ️ View Unchanged
|
✍️ Proposed changes
Adds
testid
guidelines to StyleguideDiscussed in code review here: https://docs.google.com/document/d/1Vxv2XvPXn5ozAtKSbRQcbC_HgKUBFcn0so6Sm1z28HA/edit#heading=h.lc5w3k6ydn8c