generate-specs.js

const yaml = require("js-yaml");
const fs = require("fs");
const path = require("path");
const uniqWith = require("lodash/uniqWith");
const isEqual = require("lodash/isEqual");
const sortBy = require("lodash/sortBy");
const merge = require("lodash/merge");
const specDir = "./analyzer-specs";

const slugList = [];
function validateSlug(slug) {
  // Validate slug is unique
  if (slugList.includes(slug)) {
    throw new Error(`The slug ${slug} already exists, slugs must be unique`);
  }
  slugList.push(slug);

  // Validate slug does not have underscores or spaces
  if (!slug.match("^[A-Za-z0-9-]*$")) {
    throw new Error(`The slug ${slug} can only contain letters, numbers and dashes`);
  }
}

function validateCategory(category, file) {
  // Validate category does not have dashes or spaces
  if (!category.match("^[A-Za-z_]*$")) {
    throw new Error(`The category ${category} in ${file} can only contain letters and underscores`);
  }
}

function validateTag(tag, file) {
  // Validate tag does not have underscores or spaces
  if (!tag.match("^[A-Za-z0-9-]*$")) {
    throw new Error(`The tag ${tag} in ${file} can only contain letters, numbers and dashes`);
  }
}

const tags = [];
const categories = [];
const specs = [];

fs.readdir(specDir, (err, files) => {
  if (err) throw err;
  files.forEach((file) => {
    
    if (!fs.statSync(specDir + "/" + file).isDirectory()) {
      throw new Error(`files must live in a subdirectory with a unique name.`);
    }

    // Directory names have to be unique but this will validate directory naming conventions
    validateSlug(file);
    
    // This assumes everything in the top level director is a subdirectory
    const subDirPath = specDir + "/" + file;
    
    // Read the subdirectory files one at a time
    const subFile = fs.readdirSync(subDirPath);
    let subdirSpecs = [];
    subFile.forEach(f => {
      // Load YAML file contents
      const doc = yaml.safeLoad(fs.readFileSync(path.resolve(subDirPath + "/" + f)));
      
      // Add all tags from spec to the tags array (will be filtered later)
      let newTags = JSON.parse(doc.metadata.annotations.tags)
      newTags.map(tag =>  {
        validateTag(tag, f);
        tags.push(tag)
      });

      // Build and add a category object to the categories array (will be filtered later)
      validateCategory(doc.metadata.annotations.category, f);
      let categoryObj = new Object();
      categoryObj.name = doc.metadata.annotations.category;
      const displayName = doc.metadata.annotations.category.charAt(0).toUpperCase() + doc.metadata.annotations.category.slice(1);
      categoryObj.display = displayName.replace(/_/gi, " ");
      categories.push(categoryObj);
      
      // Build and add a contributor object to the spec.contributors array
      const contributorsArr = []
      const contributors = JSON.parse(doc.metadata.annotations.contributors);
      if (contributors.length > 0) {
       contributors.map(c => {
          contributorsArr.push({
            name: c.name,
            avatarUri: c.avatarUri || "/default-contributor@2x.jpg"
          })
        })
      } else {
        contributorsArr.push({
          name: "",
          avatarUri: "/default-contributor@2x.jpg"
        })
      }

      // Build the spec object
      let specObj = new Object();
      specObj.slug = file;
      specObj.category = doc.metadata.annotations.category;
      specObj.title = doc.metadata.annotations.title;
      specObj.description = doc.metadata.annotations.description;
      specObj.iconUri = doc.metadata.annotations.iconUri || "/category-icons/default-category.svg";
      specObj.contributors = contributorsArr;
      specObj.tags = JSON.parse(doc.metadata.annotations.tags);

      // Remove annotations before setting the yaml spec
      delete doc["metadata"]["annotations"];
      if (doc.kind === "Preflight") {
        specObj.preflightSpecYaml = yaml.safeDump(doc);
      }
      if (doc.kind === "SupportBundle") {
        specObj.supportSpecYaml = yaml.safeDump(doc);
      }

      // Add spec to specs array
      subdirSpecs.push(specObj);
    });

    // If there is a preflight and support pair, merge the specs to a single object
    if (subdirSpecs.length > 1) {
      merge(subdirSpecs[0], subdirSpecs[1]);
    }

    // Push the spec into the specs array
    specs.push(subdirSpecs[0]);

  });

  // Build JSON file with filtered tags and categories
  const jsonFile = {
    _comment: `This file is generated, do not change! Last generated on ${new Date()}. To regenerate run 'make generate-specs'`,
    tags: [...new Set(tags)].sort(),
    categories: uniqWith(sortBy(categories, c => c.name), isEqual),
    specs
  };

  // Write finalized JSON file to static directory
  fs.writeFile("./gatsby-theme-marketing/static/specs-gen.json", JSON.stringify(jsonFile), (err) => {
    if (err) throw err;
    console.log("\x1b[34m%s\x1b[0m", "Tags generated:", jsonFile.tags.length);
    console.log("\x1b[34m%s\x1b[0m", "Categories generated:", jsonFile.categories.length);
    console.log("\x1b[34m%s\x1b[0m", "Specs generated:", jsonFile.specs.length);
    console.log("\x1b[32m%s\x1b[0m", "Successfully generated specs-gen.json to the ./gatsby-theme-marketing/static directory");
  });

});