Description
Add a $schema property to prismic.config.json so editors like VS Code can provide autocomplete and validation.
Approach
- Generate a JSON Schema from the Zod
ConfigSchema (see the docs) and ship it in the published package.
- Accept
$schema as an optional passthrough in the Zod schema so it doesn't fail validation.
- Write
$schema into the config during createConfig(), pointing to the schema file in node_modules (e.g., ./node_modules/@prismicio/cli/prismic.config.schema.json).
Description
Add a
$schemaproperty toprismic.config.jsonso editors like VS Code can provide autocomplete and validation.Approach
ConfigSchema(see the docs) and ship it in the published package.$schemaas an optional passthrough in the Zod schema so it doesn't fail validation.$schemainto the config duringcreateConfig(), pointing to the schema file innode_modules(e.g.,./node_modules/@prismicio/cli/prismic.config.schema.json).