schemaValidator.ts

import "source-map-support/register";

import axios from "axios";
import { green, yellow, red, blue } from "chalk";
import * as fs from "fs";
import { validate } from "jsonschema";

const latestMetadataSchema = "https://schemas.premid.app/metadata/1.1",
  stats = {
    validated: 0,
    validatedWithWarnings: 0,
    failedToValidate: 0
  },
  validated = (service: string): void => {
    console.log(green(`✔ ${service}`));
    stats.validated++;
  },
  validatedWithWarnings = (service: string, warning: string): void => {
    console.log(yellow(`✔ ${service} (${warning})`));
    stats.validatedWithWarnings++;
  },
  failedToValidate = (service: string, errors: string[]): void => {
    console.log(
      red(`✘ ${service}\n${errors.map((e) => `  -> ${e}`).join("\n")}`)
    );
    stats.failedToValidate++;
  },
  loadMetadata = (path: string): Metadata =>
    JSON.parse(fs.readFileSync(path, "utf-8")),
  changedFiles = fs
    .readFileSync("./file_changes.txt", "utf-8")
    .trim()
    .split("\n"),
  metaFiles = changedFiles.filter((f: string) => f.endsWith("metadata.json"));

(async (): Promise<void> => {
  console.log(blue("Getting latest schema..."));

  const schema = (await axios.get(latestMetadataSchema)).data;

  console.log(
    blue("Beginning validation of " + metaFiles.length + " presences...")
  );

  for (const metaFile of metaFiles) {
    const meta = loadMetadata(metaFile),
      service = meta.service,
      result = validate(meta, schema);

    if (result.valid) {
      if (meta.schema && meta.schema !== latestMetadataSchema) {
        validatedWithWarnings(service, "Using out of date schema");
      } else {
        validated(service);
      }
    } else {
      const errors: string[] = [];
      for (const error of result.errors)
        errors.push(`${error.message} @ ${error.property}`);

      failedToValidate(service, errors);
    }
  }

  console.log();
  console.log(blue("Statistics:"));
  console.log(
    green(`${stats.validated} fully validated\n`) +
      yellow(`${stats.validatedWithWarnings} validated, but with warnings\n`) +
      red(`${stats.failedToValidate} failed to validate`)
  );
  console.log();

  if (stats.failedToValidate > 0) {
    console.log(red("One or more services failed to validate."));
    process.exit(-1);
  }

  if (stats.validatedWithWarnings > 0) {
    console.log(yellow("One or more services validated, but with warnings."));
  }
})();

interface Metadata {
  schema: string;
  author: { name: string; id: string };
  contributors?: Array<{ name: string; id: string }>;
  service: string;
  description: Record<string, string>;
  url: string;
  version: string;
  logo: string;
  thumbnail: string;
  color: string;
  tags: string | Array<string>;
  category: string;
  iframe?: boolean;
  regExp?: RegExp;
  iframeRegExp?: RegExp;
  button?: boolean;
  warning?: boolean;
  settings?: Array<{
    id: string;
    title: string;
    icon: string;
    if?: Record<string, string>;
    placeholder?: string;
    value?: string | number | boolean;
    values?: Array<string | number | boolean>;
  }>;
}