manifest.js

"use strict";
var fs = require("fs");
var path = require("path");
var yaml = require("js-yaml");
const debug = require("debug");
var debugManifest = debug("manifest");
var debugDeprication = debug("manifest:deprecation");
var debugmanifestJson = debug("manifest:json");

exports.debbugOptions = {
  "manifest": "",
  "manifest:deprecation": "",
  "manifest:json": "",
};

const DEF_MANIFEST_NAME = "manifest";
const DEF_MANIFEST_EXTS = [".yml", ".yaml", ".json"];

/**
 * Creates a valid manifest JSON based on input (or no input)
 * DEBUG=index:manifest:json
 */
exports.getManifestObj = function (inputManifestFile, qaMode) {
  var fileType = path.extname(inputManifestFile).toLowerCase();
  if (!DEF_MANIFEST_EXTS.includes(fileType)) {
    console.log("Manifest extension must be: [" + DEF_MANIFEST_EXTS.join("|") + "]");
    return;
  }
  debugManifest("Found manifest to use: " + inputManifestFile);
  var fileContents = fs.readFileSync(inputManifestFile, "utf8");
  var jsonObj = "";
  try {
    //Attempt to read the YAML and output JSON
    var data = yaml.loadAll(fileContents, "json");
    var yamlContents = JSON.stringify(data[0], null, 2);
    jsonObj = JSON.parse(yamlContents);
  } catch {
    debugmanifestJson("Could not read YAML, attemping JSON");
    try {
      //Attempt to read JSON
      jsonObj = JSON.parse(fileContents);
    } catch (e) {
      console.log("Manifest file does not contain valid YAML or JSON content.");
      throw e;
    }
  }

  // If the manifest doesn"t have an output, generate the output name based on the manifest directory
  if (!jsonObj.output || !jsonObj.output.name) throw new Error("Manifest is missing output.name. Consider auto-creating an initial manifest");
  // jsonObj = fixDeprecatedEntry(jsonObj);
  if (jsonObj.output.name.split(".").pop() != "md") throw new Error("output.name needs to be a .md file but found: " + jsonObj.output.name);
  if (!jsonObj.input) throw new Error("Manifest is missing input. Consider auto-creating an initial manifest");

  jsonObj = fixDeprecatedEntry(jsonObj);

  if (qaMode) {
    if (!jsonObj.qa || !jsonObj.qa.exclude) {
      console.log("No exclude patterns given for QA. Using default `frontmatter` for exclusion.");
      jsonObj.qa = { "exclude": "frontmatter" };
    }
  }
  return jsonObj;
};

/**
 * Method to organize the manifest for merge and presentation to 
 * allow for non-destructive updates to mege-markdown.
 * Important if users are coming from earlier versions of merge-markdown
 */
function fixDeprecatedEntry(manifestFix) {
  var updatesNeeded = "";
  //Fix output to allow for keys under the output
  if (typeof manifestFix.output === "string") {
    var name = manifestFix.output;
    delete manifestFix.output;
    manifestFix.output = {};
    manifestFix.output.name = name;
    updatesNeeded += "   manifest.output >> manifest.output.name.\n";
  }

  //Move all outputOptions under the output
  if (Object.prototype.hasOwnProperty.call(manifestFix, "mergedTOC")) {
    manifestFix.output.doctoc = manifestFix.mergedTOC;
    delete manifestFix.mergedTOC;
    updatesNeeded += "   manifest.mergedTOC >> manifest.output.doctoc.\n";
  }
  if (Object.prototype.hasOwnProperty.call(manifestFix, "pandoc")) {
    manifestFix.output.pandoc = manifestFix.pandoc;
    delete manifestFix.pandoc;
    updatesNeeded += "   manifest.pandoc >> manifest.output.pandoc.\n";
  }
  if (Object.prototype.hasOwnProperty.call(manifestFix, "wkhtmltopdf")) {
    manifestFix.output.wkhtmltopdf = manifestFix.wkhtmltopdf;
    delete manifestFix.wkhtmltopdf;
    updatesNeeded += "   manifest.wkhtmltopdf >> manifest.output.wkhtmltopdf.\n";
  }

  //Update all TOC and mergedTOC keys to doctoc
  if (Object.prototype.hasOwnProperty.call(manifestFix.output, "TOC")) {
    manifestFix.output.doctoc = manifestFix.output.TOC;
    delete manifestFix.output.TOC;
    updatesNeeded += "   manifest.output.TOC >> manifest.output.doctoc.\n";
  }
  if (Object.prototype.hasOwnProperty.call(manifestFix.output, "mergedTOC")) {
    manifestFix.output.doctoc = manifestFix.output.mergedTOC;
    delete manifestFix.output.mergedTOC;
    updatesNeeded += "   manifest.output.mergedTOC >> manifest.output.doctoc.\n";
  }
  if (Object.prototype.hasOwnProperty.call(manifestFix, "TOC")) {
    manifestFix.doctoc = manifestFix.TOC;
    delete manifestFix.TOC;
    updatesNeeded += "   manifest.TOC >> manifest.doctoc.\n";
  }
  if (Object.prototype.hasOwnProperty.call(manifestFix, "input")) {
    var update = false;
    for (var i in manifestFix.input) {
      if (Object.prototype.hasOwnProperty.call(manifestFix.input[i], "TOC")) {
        manifestFix.input[i].doctoc = manifestFix.input[i].TOC;
        delete manifestFix.input[i].TOC;
        update = true;
      }
    }
    if (update) updatesNeeded += "   manifest.input[item].TOC >> manifest.input[item].doctoc.\n";
  }

  //Display to the user which keys should be updated in their manifest
  if (updatesNeeded) {
    console.log("[WARNING] Below entries are old. Consider updating your manifest:");
    console.log(updatesNeeded);
  }
  debugDeprication(JSON.stringify(manifestFix, null, 2));
  return manifestFix;
}

/**
 * Gets a valid file of manifest.[yaml|yml|json]
 * @param {} inputArg file/directory given in -m param
 * @returns file
 */
exports.getFile = function (inputArg) {
  var fsStat = fs.lstatSync(inputArg);
  if (fsStat.isFile()) { //Set if file is given
    const e = path.extname(inputArg).toLowerCase();
    debugManifest(e);
    if (DEF_MANIFEST_EXTS.includes(e)) {
      debugManifest("Using given manifest: " + inputArg);
      return inputArg;
    } else {
      console.log("Manifest file can only be yml|yaml|json");
      return;
    }
  } else if (fsStat.isDirectory()) { //Search for default manifest if directory
    debugManifest("Searching for manifest.yaml|yml|json in " + inputArg);
    const directory = inputArg;
    const possibleFileNames = DEF_MANIFEST_EXTS.map(ext => `manifest${ext}`);
    //Look for a manifest file in the given directory
    for (const fileName of possibleFileNames) {
      const filePath = path.join(directory, fileName);
      try {
        var fileStat = fs.lstatSync(filePath);
        if (fileStat.isFile()) {
          debugManifest(`Using default manifest[${DEF_MANIFEST_EXTS.join("|")}]: ${filePath}`);
          return filePath;
        }
      } catch (err) {
        debugManifest(filePath + " DNE.");
      }
    }
    console.log(`No default manifest[${DEF_MANIFEST_EXTS.join("|")}] file found in ${directory}`);
  }
};

/**
* Autocreates a starter manifest file 
* @param {*} dir location of input files
*/
exports.createManifestFile = function (dir) {
  const jsonObject = {
    input: {},
    output: {
      "name": path.join(dir, "target/mergedFile.md"),
      "doctoc": true,
      "pandoc": {
        "css": "-c path/to/theme.css",
        "latexTemplate": "--template path/to/latex/template.html"
      },
      "wkhtmltopdf": {
        "marginBottom": ".7in",
        "marginTop": "1in",
        "marginLeft": ".7in",
        "marginRight": ".7in",
        "pageSize": "Letter",
        "headerFontSize": 8,
        "headerSpacing": 5,
        "headerRight": "[section]",
        "footerLine": true,
        "footerFontSize": 8,
        "footerLeft": "[doctitle]",
        "footerCenter": "",
        "footerRight": "[page]",
      }
    },
    qa: { exclude: "(frontmatter|preamble)" },
    replace: {
      "<!--{timestamp}-->": "01/01/2024",
      "<!--{title}-->": "My Title",
      "<!--{author}-->": "Chuck Grant",
      "### My h3 title": "#### My h4 title",
      "({#(.*?)})": ""
    }
  };
  var inputArr = findMarkdownFiles(dir);
  var counter = 0;
  inputArr.forEach(file => {
    var inputOptions = {
      noYAML: true,
      doctoc: true,
      replace: {
        "\\[#\\]": counter
      }
    };
    jsonObject.input[file] = JSON.stringify(inputOptions);
    counter++;
  });

  //Write YAML File
  const yamlString = yaml.dump(jsonObject);
  const manifestPath = path.join(process.cwd(), "manifest.yml");
  try {
    fs.writeFileSync(manifestPath, yamlString);
    console.log("YAML file successfully created: " + manifestPath);
  } catch (error) {
    console.error("Error writing: " + manifestPath, error);
  }
};

/**
* Finds all markdown (.md) files within a directory
* @param {*} directoryPath path to search
* @returns array of .md paths
*/
function findMarkdownFiles(directoryPath) {
  let markdownFiles = [];
  // Synchronously read the contents of the directory
  const files = fs.readdirSync(directoryPath);
  // Iterate through each file in the directory
  for (const file of files) {
    const filePath = path.join(directoryPath, file);
    const stats = fs.statSync(filePath);
    // Check if the file is a directory
    if (stats.isDirectory()) {
      // Recursively search for .md files in the subdirectory
      markdownFiles = markdownFiles.concat(findMarkdownFiles(filePath));
    } else {
      if (path.extname(file).toLowerCase() === ".md") {
        markdownFiles.push(filePath);
      }
    }
  }
  return markdownFiles;
}

exports.DEF_MANIFEST_NAME = DEF_MANIFEST_NAME;
exports.DEF_MANIFEST_EXTS = DEF_MANIFEST_EXTS;