Add discoverable JSON Schema for config files (e.g. wp-cli.yml)

[montchr]

Feature Request

Is your feature request directly related to a specific, existing command?

No – this applies to configuration files for WP-CLI as described in https://make.wordpress.org/cli/handbook/references/config/

Is your feature request about a new command, or a more general idea?

Not really – it is rather common for JSON-compatible configuration files (e.g. JSON/YAML/TOML) to define and publish a discoverable JSON Schema declaration. Since wp-cli.yml already exists and has a clear definition, publishing structured metadata about its format has a clearly-defined scope with many existing examples to follow.

• Yes, I reviewed the contribution guidelines.

Describe your use case and the problem you are facing

As a developer creating a new or editing an existing YAML config file for WP-CLI, I would like to use my text editor's integrated support for autocompletion, inline documentation, and validation of my file so that I can remain within my editor without needing to mentally compute the supported configuration structure/keys/values as listed in Config – WP-CLI – WordPress.org.

Describe the solution you'd like

Generate a comprehensive JSON Schema for the WP-CLI configuration file specification. If it exists already (I haven't found it), it should be made more discoverable. I would like to see it included in the JSON Schema Store, which would automatically be ingested by VS Code et al.

Maybe-Relevant Examples

• GitHub Actions Workflow spec: https://json.schemastore.org/github-workflow.json – the most extensive example I have seen and used
• .eslintrc: https://json.schemastore.org/eslintrc.json
• https://json.schemastore.org/drupal-config.json
• https://json.schemastore.org/drush.site.yml.json
• https://raw.githubusercontent.com/composer/composer/main/res/composer-schema.json

Further References

• https://developer.wordpress.org/rest-api/extending-the-rest-api/schema/
• [JSON Schema Store](https://www.schemastore.org/json/)
• https://github.com/jsonsystems/public#cli – JSON Schema generator from an example JSON file (untested, but hey, it might help kick things off if it works well enough)
• https://www.jsonschema.net/ – Web-app version of the jsn CLI listed above (requires account?!)

[danielbachhuber]

Thanks for the suggestion, @montchr ! This seems like a sensible thing to do.

[montchr]

Awesome!

I don’t think I have the context to open a pull request for this but I would gladly test out an implementation. Let me know if I can be of any help.