blockly/tests/migration/validate-renamings.js

#!/usr/bin/env node
/**
 * @license
 * Copyright 2022 Google LLC
 * SPDX-License-Identifier: Apache-2.0
 */

/**
 * @fileoverview A script to validate the renamings file
 * (scripts/migration/renamings.json5) agaist the schema
 * (renamings-schema.json).
 */

/* global require __dirname process */

const JsonSchema = require('@hyperjump/json-schema');
const JSON5 = require('json5');
const fs = require('fs');
const path = require('path');
const {posixPath} = require('../../scripts/helpers');


/**
 * Renaming schema filename.
 * @type {string}
 */
const SCHEMA_FILENAME = path.join(__dirname, 'renamings.schema.json');

/**
 * Renamings filename.
 * @type {string}
 */
const RENAMINGS_FILENAME =
    path.resolve(__dirname, '../../scripts/migration/renamings.json5');

// Can't use top-level await outside a module, and can't use require
// in a module, so use an IIAFE.
(async function() {
  const schemaUrl = 'file://' + posixPath(path.resolve(SCHEMA_FILENAME));
  const schema = await JsonSchema.get(schemaUrl);

  const renamingsJson5 = fs.readFileSync(RENAMINGS_FILENAME);
  const renamings = JSON5.parse(renamingsJson5);

  const output =
      await JsonSchema.validate(schema, renamings, JsonSchema.DETAILED);

  if (!output.valid) {
    console.log('Renamings file is invalid.');
    console.log('Maybe this validator output will help you find the problem:');
    console.log(JSON5.stringify(output, undefined, '  '));
    process.exit(1);
  }

  // File passed schema validation.  Do some additional checks.
  let ok = true;
  Object.entries(renamings).forEach(([version, modules]) => {
    // Scan through modules and check for duplicates.
    const seen = new Set();
    for (const {oldName} of modules) {
      if (seen.has(oldName)) {
        console.log(`Duplicate entry for module ${oldName} ` +
            `in version ${version}.`);
        ok = false;
      }
      seen.add(oldName);
    }
  });
  if (!ok) {
    console.log('Renamings file is invalid.');
    process.exit(1);
  }
  // Default is a successful exit 0.
})();