wp-env: $schema property is not allowed

[sirreal]

#36276 added a JSON schema for wp-env, but if the $schema property appears in wp-env configuration, it throws an error:

Invalid /Users/jonsurrell/a8c/wordpress-develop/trunk/.wp-env.json: "$schema" is not a configuration option.

It should allow that property, or possibly even better use the schema to parse configuration.

Originally posted by @sirreal in #36276 (comment)

[t-hamano]

Perhaps we need to submit a PR to the Schema Store repository, as was done by theme.json and block.json?

For example, if I directly reference the schema in the Gutenberg repository, it works correctly.

However, if I use the same format as block.json or theme.json, it doesn't work.

Maybe @ajlende or @gziolo know something about this.

[sirreal]

Perhaps we need to submit a PR to the Schema Store repository, as was done by theme.json and block.json?

Yes, we should do that, but that's just for inclusion in that directory of schemas.

The issue here is that the tool itself rejects configuration values that it does not recognize:

gutenberg/packages/env/lib/config/parse-config.js

Lines 415 to 438 in 708ce27

	for ( const key in config ) {
	if ( DEFAULT_ENVIRONMENT_CONFIG[ key ] !== undefined ) {
	continue;
	}
	// We should also check root-only options for the root config
	// because these aren't part of the above defaults but are
	// configuration options that we will parse.
	switch ( key ) {
	case 'testsPort':
	case 'lifecycleScripts':
	case 'env': {
	if ( options.rootConfig ) {
	continue;
	}
	break;
	}
	}
	throw new ValidationError(
	`Invalid ${ configFile }: "${ environmentPrefix }${ key }" is not a configuration option.`
	);
	}

[ajlende]

However, if I use the same format as block.json or theme.json, it doesn't work.

There must be a whitelist for the wp.org redirects somewhere. We made a systems request for the initial JSON Schema. I don't seems to have access to make a systems request, so I'm asking around to get it fixed.

[ajlende]

I think I know what's going on. The redirects probably don't support dotfiles. I checked the schemastore website and they don't do dotfiles either. I think we should follow their lead and use wp-env.json for the filename instead.

EDIT: Opened #62634