konafets/statamic-blueprint-validation

Providing autocompletion and validation for Statamic Blueprints.

A JSON Schema for Statamic Blueprint YAML files

Introduction

The schema supports all fieldtypes, their options and the validation rules.

Setup

PhpStorm | IntelliJ

1. Open PhpStorm and switch to File > Preferences > Languages & Frameworks > Schemas and DTDs > JSON Schema Mappings
2. Add a new entry with the following options
   • Schema file or URL: https://raw.githubusercontent.com/Konafets/statamic-blueprint-validation/main/statamic.blueprint.schema.json
   • Directory: resources/blueprints

Sublime

TODO

Visual Studio Code

TODO

Credits

• Thanks Jonas for providing a test blueprint

statamic-blueprint-validation's Issues

Support for tabs

In Statamic 4, blueprints were updated a little. PHPStorm users (and probably other editors using this schema) are now seeing validation errors.

Blueprints can have a top level tabs key. The tabs are keyed by handle.

Each tab has multiple sections, which do not have named keys.

title: My Blueprint
tabs:
  tab_one:
    display: Tab One
    sections:
      -
        display: My Section # optional
        instructions: Some instructions #optional
        fields: [] # Same as existing fields.
      -
        fields: []

The top level sections as used on Statamic 3.x is still valid.

If I can help, let me know. But I'm sure you can update this more easily than me.