Additional CSS: Add code comments contextualising tranformStyles for clarity #60267
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
andrewserong
added
[Type] Code Quality
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Size Change: +4 B (0%) Total Size: 1.72 MB
ℹ️ View Unchanged
|
| @@ -28,6 +28,10 @@ export default function AdvancedPanel( { | |||
| css: newValue, | |||
| } ); | |||
| if ( cssError ) { | |||
| // Pass a wrapping selector to transformStyles to ensure that the CSS | |||
| // tested resembles actual CSS rules. This is necessary because the additional CSS | |||
| // field supports CSS rules that are not wrapped in a selector. | |||
There was a problem hiding this comment.
To be precise, we need to pass a wrapper selector because otherwise the transformStyle function will return before it does the error checking. I don't think it really matters whether the actual CSS is a whole rule or just a property or two. Afaict inputting a single property will output the same (unwrapped) property, whether we pass a wrapper or not.
It would probably be better to have a dedicated error checking function instead of using this one 🤔 That might be a good improvement to add to the list for additional CSS!
There was a problem hiding this comment.
Thanks for following up on this @andrewserong 👍
As these comments note, the selector is only for validation purposes. I think we could make this obvious by replacing .editor-styles-wrapper here with something like .for-validation-only.
What do you think?
… classname will not be used in output
andrewserong
force-pushed
the
update/advanced-custom-css-to-clarify-transform-styles
branch
from
c376976
to
a2a6465
Compare
|
Thanks for the feedback and good ideas, folks! I've updated the classname strings to |
aaronrobertshaw
approved these changes
Apr 2, 2024
andrewserong
deleted the
update/advanced-custom-css-to-clarify-transform-styles
branch
cbravobernal
pushed a commit
to garridinsi/gutenberg
that referenced
this pull request
Apr 9, 2024
…clarity (WordPress#60267) * Additional CSS: Add code comments contextualising tranformStyles for clarity * Simplify comments, use a classname that more obviously flags that the classname will not be used in output Co-authored-by: andrewserong <andrewserong@git.wordpress.org> Co-authored-by: tellthemachines <isabel_brison@git.wordpress.org> Co-authored-by: aaronrobertshaw <aaronrobertshaw@git.wordpress.org>
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.
What?
In the AdvancedPanel for Additional CSS, add a couple of code comments clarifying that what looks like the styles being transform is actually just a transformation being used for validation only, it does not transform any of the styling rules that will be output.
Why?
While reviewing #56649, a few of us were tripped up by these lines. As described in this comment (#56649 (comment)) the reviewers got to the bottom of it, but I believe it'd help to add some code comments here for clarity, and to hopefully avoid confusion further down the track.
How?
Testing Instructions
asdf, example legal CSS:border: 1px solid;Testing Instructions for Keyboard
Screenshots or screencast