Style engine: pre-core migration documentation and house keeping #43840
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
ramonjd
added
[Package] Style Engine
|
Size Change: -1.89 kB (0%) Total Size: 1.25 MB
ℹ️ View Unchanged
|
ramonjd
requested review from
gziolo,
youknowriad,
andrewserong and
aristath
ramonjd
commented
Sep 5, 2022
aristath
reviewed
Sep 5, 2022
packages/style-engine/docs/using-the-style-engine-with-block-supports.md
Outdated
Show resolved
Hide resolved
ramonjd
force-pushed
the
update/style-engine-package-release
branch
from
b07ae52 to
07c978a
Compare
andrewserong
reviewed
Sep 6, 2022
packages/style-engine/docs/using-the-style-engine-with-block-supports.md
Show resolved
Hide resolved
andrewserong
reviewed
Sep 6, 2022
|
This is looking good to me @ramonjd, thanks for all the house keeping here! Just left a couple of comments about how we can expose the added document. The only issue I ran into is that I couldn't access the |
I'm not sure either 🤔 I tried a bunch of stuff, and compared the package with other packages but can't see anything that stands out. I must be missing something. Maybe @gziolo has a few tips for us 😄 |
gziolo
reviewed
Sep 6, 2022
ramonjd
force-pushed
the
update/style-engine-package-release
branch
from
12a9618 to
960e024
Compare
ramonjd
commented
Sep 6, 2022
| @@ -39,7 +39,6 @@ public function test_enqueue_stored_styles() { | |||
| $core_styles_to_enqueue, | |||
| array( | |||
| 'context' => 'block-supports', | |||
| 'enqueue' => true, | |||
There was a problem hiding this comment.
The enqueue option doesn't do anything and is deprecated.
gziolo
reviewed
Sep 6, 2022
ramonjd
force-pushed
the
update/style-engine-package-release
branch
6 times, most recently
from
894ffe6 to
2b8cf11
Compare
|
Looks like this is pretty much ready. Would someone mind rebasing and giving their final approval so we can get land this for WP 6.1? cc/ @andrewserong @aristath 😊 |
…eady to populate with real changes :P
ramonjd
force-pushed
the
update/style-engine-package-release
branch
from
ff7db37 to
19b6885
Compare
Rebased 🍺 |
andrewserong
approved these changes
Sep 13, 2022
There was a problem hiding this comment.
Thanks so much for rebasing @ramonjd, I was just about to do that! 😄
This is looking good to me, just smoke tested that it's still all working correctly in the post and site editors, and in server rendering block supports on the site front end 👍
The style engine is also available on the global wp object, too:
LGTM! 🎉
ockham
added
the
Backport to Gutenberg Minor Release
|
@c4rl0sbr4v0 Let's include this on in GB 14.1 stable 🙂 |
cbravobernal
pushed a commit
that referenced
this pull request
Sep 14, 2022
) * Initial commit. Adding further documentation, cleaning up changelog ready to populate with real changes :P * Typos, formatting * Typos, formatting * Sorting out change log and formatting * Remove enqueue option. It does nothing. * Update packages/style-engine/docs/using-the-style-engine-with-block-supports.md No empty lines! :D Co-authored-by: Ari Stathopoulos <aristath@gmail.com> * Update README.md typo * Updating manifest.json to include new style engine docs Splitting the global functions out of the class files Checking for the directory when loading rather than each individual file * Adding type annotation * Updating CHANGELOG.md * Updated version to prerelease Reverted JS comments for TS types and rebuilt docs Removed style engine from bundle exception array * Rebase after #43886 * Updating change logs and emphasizing that new global JS methods are available since 6.1 * Checking for functions and classes in tests so that Gutenberg tests don't fail during the backport to Core. This is valid for 6.1. After that, developing the packages might require another solution, such as testing against `gutenberg_` prefixed functions. * Formatting PHP doc comments and params that describe associative arrays Updating test function names and annotations. * Formatting * Combining tests for get_declarations_string Updating php doc params * Adding message parameter to assertions where more than one assertion is used in a test method. * Updating PHP docs Testing for WP_Style_Engine_CSS_Rules_Store in WP_Style_Engine_Processor->add_store * Text domain added to __() * Refactoring sanitization tests for CSS declarations Counting calls to mock filters executed in safecss_filter_attr() (kses.php) * Formatting styleEngine tests Removing duplicated test (we were already testing context below) * My blod is typo * Active voice rather than imperative * Remove Gutenberg suffix * Adding message to script loader block support enqueuing expectations * Grammar, formatting, removing class_exists checks * Ignore unused variable. This is a common test pattern in Core. * Remove unusued var in tests Co-authored-by: Ari Stathopoulos <aristath@gmail.com>
bph
added
Needs Dev Note
|
ockham
added
the
Backport to WP 6.7 Beta/RC
ockham
pushed a commit
that referenced
this pull request
Sep 19, 2022
) * Initial commit. Adding further documentation, cleaning up changelog ready to populate with real changes :P * Typos, formatting * Typos, formatting * Sorting out change log and formatting * Remove enqueue option. It does nothing. * Update packages/style-engine/docs/using-the-style-engine-with-block-supports.md No empty lines! :D Co-authored-by: Ari Stathopoulos <aristath@gmail.com> * Update README.md typo * Updating manifest.json to include new style engine docs Splitting the global functions out of the class files Checking for the directory when loading rather than each individual file * Adding type annotation * Updating CHANGELOG.md * Updated version to prerelease Reverted JS comments for TS types and rebuilt docs Removed style engine from bundle exception array * Rebase after #43886 * Updating change logs and emphasizing that new global JS methods are available since 6.1 * Checking for functions and classes in tests so that Gutenberg tests don't fail during the backport to Core. This is valid for 6.1. After that, developing the packages might require another solution, such as testing against `gutenberg_` prefixed functions. * Formatting PHP doc comments and params that describe associative arrays Updating test function names and annotations. * Formatting * Combining tests for get_declarations_string Updating php doc params * Adding message parameter to assertions where more than one assertion is used in a test method. * Updating PHP docs Testing for WP_Style_Engine_CSS_Rules_Store in WP_Style_Engine_Processor->add_store * Text domain added to __() * Refactoring sanitization tests for CSS declarations Counting calls to mock filters executed in safecss_filter_attr() (kses.php) * Formatting styleEngine tests Removing duplicated test (we were already testing context below) * My blod is typo * Active voice rather than imperative * Remove Gutenberg suffix * Adding message to script loader block support enqueuing expectations * Grammar, formatting, removing class_exists checks * Ignore unused variable. This is a common test pattern in Core. * Remove unusued var in tests Co-authored-by: Ari Stathopoulos <aristath@gmail.com>
|
I just cherry-picked this PR to the wp/6.1 branch to get it included in the next release: 0fc7a57 |
ockham
removed
the
Backport to WP 6.7 Beta/RC
michalczaplinski
removed
the
Backport to Gutenberg Minor Release
ramonjd
removed
the
Needs Dev Note
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?
Adding further documentation, cleaning up change log ready to populate with real changes (TODO) :P
Removing trailing references to
'enqueue' => true,Updating PHP unit tests to conform with WordPress PHP test standards: https://make.wordpress.org/core/handbook/testing/automated-testing/writing-phpunit-tests/
Why?
Getting the style engine package into a reasonable state to migrate to core for 6.1.
See backport PR: WordPress/wordpress-develop#3199
TODO
Testing Instructions
wp.styleEngine.compileCSSandwp.styleEngine.getCSSRulesare available in the global window scope in the editor.