typo3-json-schemas's Introduction

Validating site config of #TYPO3

This is a proof of concept validating the TYPO3 site configuration.

Setup

PhpStorm

Open PhpStorm and switch to File > Preferences > Languages & Frameworks > Schemas and DTDs > JSON Schema Mappings
Add a new entry with the following options
- Schema file or URL: https://raw.githubusercontent.com/georgringer/site-config-validation/master/siteconfig.json
- File path Pattern: **/sites/*/config.yaml
Provide path to the directory containg the yaml files.

IMPORTANT: Currently I have troubles with validation having the schema remotely. I propose to clone the repository and define the path to the siteconfig.json file!

Visual Studio Code

Install the plugin "redhat.vscode-yaml"
Open the settings and search for "yaml schemas" and open the settings.json.
Add the following config

"yaml.schemas": {
    "https://raw.githubusercontent.com/georgringer/site-config-validation/master/siteconfig.json" : ["**/sites/*/config.yaml"],
}

A basic configuration.json looks like this

{
    "explorer.confirmDelete": false,
    "window.zoomLevel": 1,
    "security.workspace.trust.untrustedFiles": "open",
    "yaml.schemas": {
        "https://raw.githubusercontent.com/georgringer/site-config-validation/master/siteconfig.json" : ["**/sites/*/config.yaml"],
    }
}

All other IDEs

TBD, I guess google should help

Say thanks

If you find validation useful, please support me:

Patreon: Support me on patreon.com and get access to additional extensions and snippets as reward.
PayPal: Support me by a donation on paypal.com. It is just one click away.
Amazon Wishlist: Satisfy a wish of my Amazon wishlist.

Next steps

Finish site config

Testing

cd tests
npm install
npm test

Thanks to https://github.com/buildkite/pipeline-schema/ for inspiration

typo3-json-schemas's People

Contributors

Stargazers

Watchers

typo3-json-schemas's Issues

Add some github tags to identify repo as TYPO3 related?

request for new schema store

see SchemaStore/schemastore#2524

Ordering of properties in auto-complete of a baseVariant wrong

The core writes a baseVariant were the base is first written and then the condition line.

When using the json-schema auto completion, the condition is suggested first, and then the base property.

[DOC][ENHANCEMENT] Use the schema also in vscode

To use the schema also in vscode, I would suggest to install the extension YAML by Redhat (redhat.vscode-yaml).
It comes already with a full bunch of schemas for YAML (e.g. Kubernetes).
Now you could add your own schemas.

Go to: File -> Preferences -> Settings
Search for "yaml: schemas"
select "Edit in settings.json"
Add this code:

  "yaml.schemas": {
        "https://raw.githubusercontent.com/georgringer/site-config-validation/master/siteconfig.json" : ["*/Configuration/Yaml/*.yaml"],
    },

(in fact, yaml.schemas is already written, you just have to add the second line for schema-file.)

Done.

Recommend Projects