Add local version of wp-env schema to .wp-env.json by t-hamano · Pull Request #63253 · WordPress/gutenberg

t-hamano · 2024-07-08T14:55:39Z

Similar to #61312

What?

This PR adds a reference to the local schema in the wp-env config file used by the Gutenberg project.

Why?

This will prevent incorrect fields from being defined in future updates to .wp-env.json.
As mentioned in this comment, there are some fields missing in the current schema. When fixing these, it will be easier to test using the .wp-env.json in the Gutenberg project.

Testing Instructions

Check out this PR.
Open the .wp-env.json file in a code editor.
The code editor should help you auto-complete fields and warn you about invalid fields and values.

github-actions · 2024-07-08T14:57:03Z

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 props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: t-hamano <wildworks@git.wordpress.org>
Co-authored-by: fabiankaegy <fabiankaegy@git.wordpress.org>
Co-authored-by: ajlende <ajlende@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

fabiankaegy

Thanks for adding this 👍

ajlende

Looks good!

For our blocks and themes, we test the files with Ajv as part of the automated testing.

gutenberg/test/integration/blocks-schema.test.js

Lines 33 to 42 in ed018ef

    
           test.each( jsonFiles )( 'validates schema for `%s`', ( filepath ) => { 
        
           	// We want to validate the block.json file using the local schema. 
        
           	const { $schema, ...blockMetadata } = require( filepath ); 
        
           	expect( $schema ).toBe( 'https://schemas.wp.org/trunk/block.json' ); 
        
           	const result = ajv.validate( blockSchema, blockMetadata ) || ajv.errors; 
        
           	expect( result ).toBe( true ); 
        
           } );

gutenberg/test/integration/theme-schema.test.js

Lines 37 to 47 in ed018ef

    
           test.each( jsonFiles )( 'validates schema for `%s`', ( filepath ) => { 
        
           	// We want to validate the theme.json file using the local schema. 
        
           	const { $schema, ...metadata } = require( filepath ); 
        
           	// we expect the $schema property to be present in the theme.json file 
        
           	expect( $schema ).toBeTruthy(); 
        
           	const result = ajv.validate( themeSchema, metadata ) || ajv.errors; 
        
           	expect( result ).toBe( true ); 
        
           } );

Adding tests for our .wp-env.json would be a good next step.

Co-authored-by: t-hamano <wildworks@git.wordpress.org> Co-authored-by: fabiankaegy <fabiankaegy@git.wordpress.org> Co-authored-by: ajlende <ajlende@git.wordpress.org>

Add local version of wp-env schema to .wp-env.json

3f9986a

t-hamano added Gutenberg Plugin Issues or PRs related to Gutenberg Plugin management related efforts [Type] Project Management Meta-issues related to project management of Gutenberg labels Jul 8, 2024

t-hamano self-assigned this Jul 8, 2024

t-hamano requested review from Mamaduka, ajlende, fabiankaegy and gziolo July 8, 2024 14:56

t-hamano marked this pull request as ready for review July 8, 2024 14:56

fabiankaegy approved these changes Jul 8, 2024

View reviewed changes

ajlende approved these changes Jul 8, 2024

View reviewed changes

ajlende enabled auto-merge (squash) July 8, 2024 15:24

ajlende merged commit 99352db into trunk Jul 8, 2024

ajlende deleted the env/add-schema branch July 8, 2024 15:31

github-actions bot added this to the Gutenberg 18.8 milestone Jul 8, 2024

t-hamano mentioned this pull request Jul 9, 2024

.wp-env.json schema: Fix schema and add unit tests #63281

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add local version of wp-env schema to .wp-env.json#63253

Add local version of wp-env schema to .wp-env.json#63253
ajlende merged 1 commit intotrunkfrom
env/add-schema

t-hamano commented Jul 8, 2024

Uh oh!

github-actions bot commented Jul 8, 2024 •

edited

Loading

Uh oh!

fabiankaegy left a comment

Uh oh!

ajlende left a comment •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	test.each( jsonFiles )( 'validates schema for `%s`', ( filepath ) => {
	// We want to validate the block.json file using the local schema.
	const { $schema, ...blockMetadata } = require( filepath );

	expect( $schema ).toBe( 'https://schemas.wp.org/trunk/block.json' );

	const result = ajv.validate( blockSchema, blockMetadata ) \|\| ajv.errors;

	expect( result ).toBe( true );
	} );

	test.each( jsonFiles )( 'validates schema for `%s`', ( filepath ) => {
	// We want to validate the theme.json file using the local schema.
	const { $schema, ...metadata } = require( filepath );

	// we expect the $schema property to be present in the theme.json file
	expect( $schema ).toBeTruthy();

	const result = ajv.validate( themeSchema, metadata ) \|\| ajv.errors;

	expect( result ).toBe( true );
	} );

Conversation

t-hamano commented Jul 8, 2024

What?

Why?

Testing Instructions

Uh oh!

github-actions bot commented Jul 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fabiankaegy left a comment

Choose a reason for hiding this comment

Uh oh!

ajlende left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions bot commented Jul 8, 2024 •

edited

Loading

ajlende left a comment •

edited

Loading