The compare-gh-webhook-to-schema-function from g-rath

Use personal access token for update workflow so that checks trigger

Currently checks don't trigger as we're using GITHUB_TOKEN, which isn't allowed to trigger workflows to protect against inf. loops.

Schemas are duplicated in the generated types

Whenever a schema has

"type": [
    "object",
    "null"
  ],

it duplicates the schema, by using the intersection type and wrapping it in parenthesis and appending | null, insteaf of just appending | null

Example: (common/installation)

{
  "$schema": "http://json-schema.org/draft-07/schema",
  "$id": "common/installation.schema.json",
  "type": [
    "object",
    "null"
  ],
  "required": [
    "id",
    "node_id"
  ],
  "properties": {
    "id": {
      "type": "integer"
    },
    "node_id": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "title": "Installation"
}

Will turn into

export type Installation = {
  id: number;
  node_id: string;
} & ({
  id: number;
  node_id: string;
} | null);

Don't push the same error, for the same property multiple times

{
  "summary": "oh dear, there were errors :/",
  "errors": [
    {
      "keyword": "enum",
      "dataPath": "/action",
      "schemaPath": "#/properties/action/enum",
      "params": {
        "allowedValues": [
          "assigned"
        ]
      },
      "message": "should be equal to one of the allowed values"
    },
    {
      "keyword": "enum",
      "dataPath": "/action",
      "schemaPath": "#/properties/action/enum",
      "params": {
        "allowedValues": [
          "closed"
        ]
      },
      "message": "should be equal to one of the allowed values"
    },
    {
      "keyword": "enum",
      "dataPath": "/action",
      "schemaPath": "#/properties/action/enum",
      "params": {
        "allowedValues": [
          "edited"
        ]
      },
      "message": "should be equal to one of the allowed values"
    },
    {
      "keyword": "enum",
      "dataPath": "/action",
      "schemaPath": "#/properties/action/enum",
      "params": {
        "allowedValues": [
          "labeled"
        ]
      },
      "message": "should be equal to one of the allowed values"
    },
    {
      "keyword": "enum",
      "dataPath": "/action",
      "schemaPath": "#/properties/action/enum",
      "params": {
        "allowedValues": [
          "locked"
        ]
      },
      "message": "should be equal to one of the allowed values"
    },
    {
      "keyword": "enum",
      "dataPath": "/action",
      "schemaPath": "#/properties/action/enum",
      "params": {
        "allowedValues": [
          "opened"
        ]
      },
      "message": "should be equal to one of the allowed values"
    },
    {
      "keyword": "enum",
      "dataPath": "/action",
      "schemaPath": "#/properties/action/enum",
      "params": {
        "allowedValues": [
          "ready_for_review"
        ]
      },
      "message": "should be equal to one of the allowed values"
    },
    {
      "keyword": "additionalProperties",
      "dataPath": "/pull_request",
      "schemaPath": "#/properties/pull_request/additionalProperties",
      "params": {
        "additionalProperty": "active_lock_reason"
      },
      "message": "should NOT have additional properties"
    },
    {
      "keyword": "enum",
      "dataPath": "/action",
      "schemaPath": "#/properties/action/enum",
      "params": {
        "allowedValues": [
          "review_request_removed"
        ]
      },
      "message": "should be equal to one of the allowed values"
    },
    {
      "keyword": "enum",
      "dataPath": "/action",
      "schemaPath": "#/properties/action/enum",
      "params": {
        "allowedValues": [
          "review_requested"
        ]
      },
      "message": "should be equal to one of the allowed values"
    },
    {
      "keyword": "enum",
      "dataPath": "/action",
      "schemaPath": "#/properties/action/enum",
      "params": {
        "allowedValues": [
          "synchronize"
        ]
      },
      "message": "should be equal to one of the allowed values"
    },
    {
      "keyword": "enum",
      "dataPath": "/action",
      "schemaPath": "#/properties/action/enum",
      "params": {
        "allowedValues": [
          "unassigned"
        ]
      },
      "message": "should be equal to one of the allowed values"
    },
    {
      "keyword": "enum",
      "dataPath": "/action",
      "schemaPath": "#/properties/action/enum",
      "params": {
        "allowedValues": [
          "unlabeled"
        ]
      },
      "message": "should be equal to one of the allowed values"
    },
    {
      "keyword": "enum",
      "dataPath": "/action",
      "schemaPath": "#/properties/action/enum",
      "params": {
        "allowedValues": [
          "unlocked"
        ]
      },
      "message": "should be equal to one of the allowed values"
    },
    {
      "keyword": "oneOf",
      "dataPath": "",
      "schemaPath": "#/oneOf",
      "params": {
        "passingSchemas": null
      },
      "message": "should match exactly one schema in oneOf"
    }
  ]
}

Instead of listing all possibilities in multiple errors for the action property, list them all in one, since allowedValues is an array

New dev dependency: ajv-formats

I introduced a dev dependency on ajv-formats in octokit/webhooks#317

g-rath / compare-gh-webhook-to-schema-function Goto Github PK

compare-gh-webhook-to-schema-function's People

Contributors

Stargazers

Watchers

Forkers

compare-gh-webhook-to-schema-function's Issues

Use personal access token for update workflow so that checks trigger

Schemas are duplicated in the generated types

Don't push the same error, for the same property multiple times

New dev dependency: ajv-formats

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent