Add automated validation for JSON schemas

[ajlende]

Description

Adds a GitHub action for validating JSON files with schemas that are modified in a PR.

Validating only the changed files allows for themes to be incrementally fixed without blocking other themes.

Expand to see the full list of existing errors.

[
  {
    file: './atlas/theme.json',
    schema: 'https://schemas.wp.org/wp/6.3/theme.json',
    error: [
      {
        instancePath: '/styles/blocks/core~1navigation/spacing/blockGap',
        schemaPath: '#/properties/spacing/properties/blockGap/oneOf/0/type',
        keyword: 'type',
        params: { type: 'string' },
        message: 'must be string'
      },
      {
        instancePath: '/styles/blocks/core~1navigation/spacing/blockGap',
        schemaPath: '#/definitions/refComplete/type',
        keyword: 'type',
        params: { type: 'object' },
        message: 'must be object'
      },
      {
        instancePath: '/styles/blocks/core~1navigation/spacing/blockGap',
        schemaPath: '#/properties/spacing/properties/blockGap/oneOf',
        keyword: 'oneOf',
        params: { passingSchemas: null },
        message: 'must match exactly one schema in oneOf'
      },
      {
        instancePath: '/styles/blocks/core~1navigation/spacing/blockGap',
        schemaPath: '#/properties/spacing/properties/blockGap/oneOf/0/type',
        keyword: 'type',
        params: { type: 'string' },
        message: 'must be string'
      },
      {
        instancePath: '/styles/blocks/core~1navigation/spacing/blockGap',
        schemaPath: '#/definitions/refComplete/type',
        keyword: 'type',
        params: { type: 'object' },
        message: 'must be object'
      },
      {
        instancePath: '/styles/blocks/core~1navigation/spacing/blockGap',
        schemaPath: '#/properties/spacing/properties/blockGap/oneOf',
        keyword: 'oneOf',
        params: { passingSchemas: null },
        message: 'must match exactly one schema in oneOf'
      }
    ]
  },
  {
    file: './blue-note/theme.json',
    schema: 'https://schemas.wp.org/wp/6.2/theme.json',
    error: [
      {
        instancePath: '/styles/elements',
        schemaPath: '#/additionalProperties',
        keyword: 'additionalProperties',
        params: { additionalProperty: 'textarea' },
        message: 'must NOT have additional properties'
      },
      {
        instancePath: '/styles/elements',
        schemaPath: '#/additionalProperties',
        keyword: 'additionalProperties',
        params: { additionalProperty: 'input' },
        message: 'must NOT have additional properties'
      }
    ]
  },
  {
    file: './stacks/theme.json',
    schema: 'https://schemas.wp.org/trunk/theme.json',
    error: [
      {
        instancePath: '/version',
        schemaPath: '#/properties/version/const',
        keyword: 'const',
        params: { allowedValue: 3 },
        message: 'must be equal to constant'
      },
      {
        instancePath: '/styles/elements/h1/typography/lineHeight',
        schemaPath: '#/properties/typography/properties/lineHeight/oneOf/0/type',
        keyword: 'type',
        params: { type: 'string' },
        message: 'must be string'
      },
      {
        instancePath: '/styles/elements/h1/typography/lineHeight',
        schemaPath: '#/definitions/refComplete/type',
        keyword: 'type',
        params: { type: 'object' },
        message: 'must be object'
      },
      {
        instancePath: '/styles/elements/h1/typography/lineHeight',
        schemaPath: '#/properties/typography/properties/lineHeight/oneOf',
        keyword: 'oneOf',
        params: { passingSchemas: null },
        message: 'must match exactly one schema in oneOf'
      },
      {
        instancePath: '/styles/elements/h2/typography/lineHeight',
        schemaPath: '#/properties/typography/properties/lineHeight/oneOf/0/type',
        keyword: 'type',
        params: { type: 'string' },
        message: 'must be string'
      },
      {
        instancePath: '/styles/elements/h2/typography/lineHeight',
        schemaPath: '#/definitions/refComplete/type',
        keyword: 'type',
        params: { type: 'object' },
        message: 'must be object'
      },
      {
        instancePath: '/styles/elements/h2/typography/lineHeight',
        schemaPath: '#/properties/typography/properties/lineHeight/oneOf',
        keyword: 'oneOf',
        params: { passingSchemas: null },
        message: 'must match exactly one schema in oneOf'
      }
    ]
  },
  {
    file: './tt1-blocks/theme.json',
    schema: undefined,
    error: [
      {
        instancePath: '',
        schemaPath: '#/required',
        keyword: 'required',
        params: { missingProperty: '$schema' },
        message: "must have required property '$schema'"
      }
    ]
  }
]

Screenshot

I made some test changes so you could see an example of failing changes in #231.

Testing

This can be tested locally with https://github.com/nektos/act.

act -s GITHUB_TOKEN="$(gh auth token)" pull_request -j validate-schema