Repository navigation
Improve design guide defaults and schema descriptions - #193
MaggieCabrera merged 7 commits into
Conversation
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. 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. Props Bot commandsYou can trigger Props Bot actions by commenting on this PR:
|
|
Thanks for this. The new defaults and descriptions read well. A few things to fix before merging:
|
A preset without a name, a template part with no area, or an empty block font map was failing output validation on the default call.
|
Thanks @MaggieCabrera - addressed in b6cf477 / 50a163d:
|
gziolo
left a comment
There was a problem hiding this comment.
Thanks for contributing! This is looking good overall and addresses the feedback, apart from the test coverage requested in the original issue. I left a few suggestions to simplify the schema helpers and remove the redundant cast.
| return $object_list( | ||
| $description, | ||
|
|
||
| $titled = static function ( $title, $description = '' ) use ( $string ) { |
There was a problem hiding this comment.
Could we use explicit schema arrays here? This helper also sets the type to string, which its name does not make clear. The translations work correctly.
| return $schema; | ||
| }; | ||
|
|
||
| $preset_list = static function ( $title, $description, $value_key, $value_schema, $extra_properties = array(), $require_name = true ) use ( $object_list, $titled ) { |
There was a problem hiding this comment.
Could we simplify the arguments? Calls ending in array(), false are hard to follow. Listing the required fields at the call site would make them clearer.
| // An empty array JSON-encodes as [], which fails the object schema. | ||
| 'blockFonts' => (object) $block_fonts, |
There was a problem hiding this comment.
This cast and comment are no longer needed in WordPress 7.2. Core already converts empty arrays to JSON objects based on the output schema.
An empty blockFonts is sent as [], but the schema says it's an object. Casting it to (object) fixes that.
|
Thanks for the review! Addressed all three points in 083e968 |
The `ipsum/get-design-guide` ability now returns only the basic design sections by default, and the larger lists, such as patterns and templates, are available through `fields`. Its schema gets clearer translated titles and descriptions, and marks the nested fields that are always there. The tests live in core, since Ipsum's repository has no PHPUnit setup. They cover the ability's registration and schema, the default and requested sections, invalid input, permissions, the REST endpoint, and how the guide follows the saved global styles and customized templates. Synced from WordPress/ipsum#193. See #66678. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This updates Ipsum from `bc2e5af700e28980f251d97f58cf80c72ee50a13` to `d26734ecc1ba178d9c120178ce9d2c48825fc108` on its `trunk` branch. A full list of changes included in this commit can be found on GitHub: WordPress/ipsum@bc2e5af...d26734e - Address the review notes from the 7.2 Beta 5 core commit (WordPress/ipsum#216) - Fix Pullquote custom line height not applying on the front end (WordPress/ipsum#203) - Fix horizontal scroll caused by long unbroken words in comments (WordPress/ipsum#200) - Improve design guide defaults and schema descriptions (WordPress/ipsum#193) - Make the short post date format translatable (WordPress/ipsum#224) - Fix Details block markers being announced by screen readers (WordPress/ipsum#230) - Remove the physical left alignment from the page patterns (WordPress/ipsum#226) - Indent the navigation submenus on the inline start (WordPress/ipsum#225) - Fix accessible names for overlay navigation (WordPress/ipsum#228) - Split AGENTS.md so it holds for any copy of the theme (WordPress/ipsum#214) - Use a logical margin for the comment form checkbox (WordPress/ipsum#231) - Keep keyboard focus visible and clear of the sticky header (WordPress/ipsum#145) - Fix accessible name of overlay search form (WordPress/ipsum#239) - Show a message when the blog and Archive Full have no posts (WordPress/ipsum#238) - Keep the post date on one line when categories wrap (WordPress/ipsum#205) - Remove repeated button styles from theme.json (WordPress/ipsum#235) - Remove unused values from theme.json (WordPress/ipsum#237) - Make the credit line URL translatable (WordPress/ipsum#240) - Use single border radius values in theme.json (WordPress/ipsum#236) - Escape the short post date format instead of ignoring PHPCS (WordPress/ipsum#245) - Use the Site Title in Footer Centered (WordPress/ipsum#244) - Keep AGENTS.md about the theme, not the GitHub repository (WordPress/ipsum#247) - Treat "Written by" as a label before the author name (WordPress/ipsum#246) - Use Quote blocks for statement patterns and remove text quote mark styles (WordPress/ipsum#232) This commit also includes changes that only exist in core: - Tests for the `ipsum/get-design-guide` ability are added in `tests/phpunit/tests/theme/ipsumGetDesignGuideAbility.php`, because Ipsum's repository has no PHPUnit setup. On multisite, the tests save global styles as a super admin, since only super admins can save unfiltered global styles. - `contributing.txt` says Ipsum is developed on GitHub until its 1.0 release, with contributions going through Trac after that. It also drops the note about `style.css` being used when it is newer than `style.min.css`. - A test message in `ipsumDesignGuide.php` says "do not match" instead of "to not match". Developed in: #15948 Follow-up to r65366. Props onemaggie, juanfra, shailu25, iamarinoh, 369work, gziolo, wildworks, suryakantupadhyay, khushalsains, ravipatel, meahadi. Fixes #66678. See #66352. git-svn-id: https://develop.svn.wordpress.org/trunk@65549 602fd350-edb4-49c9-b593-d223f7449a82
This updates Ipsum from `bc2e5af700e28980f251d97f58cf80c72ee50a13` to `d26734ecc1ba178d9c120178ce9d2c48825fc108` on its `trunk` branch. A full list of changes included in this commit can be found on GitHub: WordPress/ipsum@bc2e5af...d26734e - Address the review notes from the 7.2 Beta 5 core commit (WordPress/ipsum#216) - Fix Pullquote custom line height not applying on the front end (WordPress/ipsum#203) - Fix horizontal scroll caused by long unbroken words in comments (WordPress/ipsum#200) - Improve design guide defaults and schema descriptions (WordPress/ipsum#193) - Make the short post date format translatable (WordPress/ipsum#224) - Fix Details block markers being announced by screen readers (WordPress/ipsum#230) - Remove the physical left alignment from the page patterns (WordPress/ipsum#226) - Indent the navigation submenus on the inline start (WordPress/ipsum#225) - Fix accessible names for overlay navigation (WordPress/ipsum#228) - Split AGENTS.md so it holds for any copy of the theme (WordPress/ipsum#214) - Use a logical margin for the comment form checkbox (WordPress/ipsum#231) - Keep keyboard focus visible and clear of the sticky header (WordPress/ipsum#145) - Fix accessible name of overlay search form (WordPress/ipsum#239) - Show a message when the blog and Archive Full have no posts (WordPress/ipsum#238) - Keep the post date on one line when categories wrap (WordPress/ipsum#205) - Remove repeated button styles from theme.json (WordPress/ipsum#235) - Remove unused values from theme.json (WordPress/ipsum#237) - Make the credit line URL translatable (WordPress/ipsum#240) - Use single border radius values in theme.json (WordPress/ipsum#236) - Escape the short post date format instead of ignoring PHPCS (WordPress/ipsum#245) - Use the Site Title in Footer Centered (WordPress/ipsum#244) - Keep AGENTS.md about the theme, not the GitHub repository (WordPress/ipsum#247) - Treat "Written by" as a label before the author name (WordPress/ipsum#246) - Use Quote blocks for statement patterns and remove text quote mark styles (WordPress/ipsum#232) This commit also includes changes that only exist in core: - Tests for the `ipsum/get-design-guide` ability are added in `tests/phpunit/tests/theme/ipsumGetDesignGuideAbility.php`, because Ipsum's repository has no PHPUnit setup. On multisite, the tests save global styles as a super admin, since only super admins can save unfiltered global styles. - `contributing.txt` says Ipsum is developed on GitHub until its 1.0 release, with contributions going through Trac after that. It also drops the note about `style.css` being used when it is newer than `style.min.css`. - A test message in `ipsumDesignGuide.php` says "do not match" instead of "to not match". Developed in: WordPress/wordpress-develop#15948 Follow-up to r65366. Props onemaggie, juanfra, shailu25, iamarinoh, 369work, gziolo, wildworks, suryakantupadhyay, khushalsains, ravipatel, meahadi. Fixes #66678. See #66352. Built from https://develop.svn.wordpress.org/trunk@65549 git-svn-id: http://core.svn.wordpress.org/trunk@64622 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This updates Ipsum from `bc2e5af700e28980f251d97f58cf80c72ee50a13` to `d26734ecc1ba178d9c120178ce9d2c48825fc108` on its `trunk` branch. A full list of changes included in this commit can be found on GitHub: WordPress/ipsum@bc2e5af...d26734e - Address the review notes from the 7.2 Beta 5 core commit (WordPress/ipsum#216) - Fix Pullquote custom line height not applying on the front end (WordPress/ipsum#203) - Fix horizontal scroll caused by long unbroken words in comments (WordPress/ipsum#200) - Improve design guide defaults and schema descriptions (WordPress/ipsum#193) - Make the short post date format translatable (WordPress/ipsum#224) - Fix Details block markers being announced by screen readers (WordPress/ipsum#230) - Remove the physical left alignment from the page patterns (WordPress/ipsum#226) - Indent the navigation submenus on the inline start (WordPress/ipsum#225) - Fix accessible names for overlay navigation (WordPress/ipsum#228) - Split AGENTS.md so it holds for any copy of the theme (WordPress/ipsum#214) - Use a logical margin for the comment form checkbox (WordPress/ipsum#231) - Keep keyboard focus visible and clear of the sticky header (WordPress/ipsum#145) - Fix accessible name of overlay search form (WordPress/ipsum#239) - Show a message when the blog and Archive Full have no posts (WordPress/ipsum#238) - Keep the post date on one line when categories wrap (WordPress/ipsum#205) - Remove repeated button styles from theme.json (WordPress/ipsum#235) - Remove unused values from theme.json (WordPress/ipsum#237) - Make the credit line URL translatable (WordPress/ipsum#240) - Use single border radius values in theme.json (WordPress/ipsum#236) - Escape the short post date format instead of ignoring PHPCS (WordPress/ipsum#245) - Use the Site Title in Footer Centered (WordPress/ipsum#244) - Keep AGENTS.md about the theme, not the GitHub repository (WordPress/ipsum#247) - Treat "Written by" as a label before the author name (WordPress/ipsum#246) - Use Quote blocks for statement patterns and remove text quote mark styles (WordPress/ipsum#232) This commit also includes changes that only exist in core: - Tests for the `ipsum/get-design-guide` ability are added in `tests/phpunit/tests/theme/ipsumGetDesignGuideAbility.php`, because Ipsum's repository has no PHPUnit setup. On multisite, the tests save global styles as a super admin, since only super admins can save unfiltered global styles. - `contributing.txt` says Ipsum is developed on GitHub until its 1.0 release, with contributions going through Trac after that. It also drops the note about `style.css` being used when it is newer than `style.min.css`. - A test message in `ipsumDesignGuide.php` says "do not match" instead of "to not match". Developed in: WordPress#15948 Follow-up to r65366. Props onemaggie, juanfra, shailu25, iamarinoh, 369work, gziolo, wildworks, suryakantupadhyay, khushalsains, ravipatel, meahadi. Fixes #66678. See #66352. git-svn-id: https://develop.svn.wordpress.org/trunk@65549 602fd350-edb4-49c9-b593-d223f7449a82
Description
Fixes #191
Follow-up to the
ipsum/get-design-guideability after #182 and the review of wordpress-develop#15113.theme,colorScheme,colors,gradients,duotone,typography,spacing,layout,guidelines). Larger lists (patterns,templates,templateParts,templatePartAreas,blockStyles,styleVariations) are available throughfields.fieldsbehavior in the ability and input schema.hidden, patternblockTypes/postTypes, templatecustomized/pattern, font value shapes and heading fallback, and that font sizes and spacing are not sorted.requiredand useadditionalProperties: falseon fixed objects, while keeping top-level sections optional.nameon font family, font size, or spacing presets. A template partareamay be null, and an emptyblockFontsmap is an object.wordpress-develop PHPUnit coverage called out in the issue is left for a separate core PR.
Screenshots
N/A
Testing Instructions
edit_theme_options.await wp.apiFetch( { path: '/wp-abilities/v1/abilities/ipsum/get-design-guide/run' } ).patterns,templates,templateParts,templatePartAreas,blockStyles, andstyleVariations.await wp.apiFetch( { path: '/wp-abilities/v1/abilities/ipsum/get-design-guide/run?input=' + encodeURIComponent( JSON.stringify( { fields: [ 'patterns' ] } ) ) } ). Confirm only that section is returned.fields: [ 'colors', 'typography' ], and confirm the response is limited to those keys.fieldsdescription and property titles.Use of AI Tools