utils.js

// Copyright 2024 Joseph P Medley

'use strict';

// Make config module paths work in multiple contexts.
// Must be set before require() statement.
process.env["NODE_CONFIG_DIR"] = `${__dirname}/config`;
const config = require('config');

const { Confirm, Input } = require('enquirer');
const fs = require('fs');
const { homedir } = require('os');
const JSON5 = require('json5');
const path = require('path');

let OT_FALSENEGATIVES = config.get('Application.origintrial');
let EXCLUSIONS = config.get('Application.deprecated');
EXCLUSIONS.push(...config.get('Application.muted'));
EXCLUSIONS.push(...OT_FALSENEGATIVES);
const USE_EXCLUSIONS = config.get('Application.useExclusions');
const QUESTIONS_FILE = _getConfig('questionsFile');
const TEMPLATES = `${__dirname}/templates/`;
const APP_ROOT = path.resolve(__dirname);

const KEY_FILE_PATH = 'config/alternate-keys.json';

const BLANK_LINE_RE = /^\s*$(\r\n|\r|\n)/gm;
const COMMENT_MULTILINE_RE = /^\s*\/\*([\s\S](?!\*\/))*\s?\*\//gm;
const COMMENT_SINGLELINE_RE = /\/\/.*$(\r\n|\r|\n)/gm;
const URL_RE = /https:\/\/(.(?!\*))*/g;

let AlternateKeys;

function loadWireFrames() {
  const wireframePath = TEMPLATES + QUESTIONS_FILE;
  const wireframeBuffer = fs.readFileSync(wireframePath);
  const wireframes =  JSON.parse(wireframeBuffer.toString()).templates;
  return wireframes;
}

const WIREFRAMES = loadWireFrames();

async function _confirm(msg, initial = "true") {
  if (global.__commandName == 'BoilerplateBuilder') { return true; }
  const prompt = new Confirm({
    name: 'confirm',
    message: msg,
    initial: initial,
    format: (v) => {
      return v ? 'yes' : 'no';
    }
  });
  return await prompt.run();
}

function _confirmPath(fileName) {
  const last = fileName.lastIndexOf("/");
  const path = fileName.substring(0, last);
  return _makeFolder(path);
}

function _deleteFile(file) {
  if (fs.existsSync(file)) {
    fs.unlinkSync(file);
  }
}

function _deleteFolderContents(folder, exclusions) {
  if (fs.existsSync(folder)) {
    exclusions.push('.DS_Store');
    fs.readdirSync(folder).forEach(file => {
      if (!exclusions.includes(file)) {
        _deleteUnemptyFolder(file);
      }
    });
  }
}

function _deleteUnemptyFolder(folder) {
  if (fs.existsSync(folder)) {
    fs.readdirSync(folder).forEach(file => {
      let path = folder + '/' + file;
      if (fs.statSync(path).isDirectory()) {
        _deleteUnemptyFolder(path);
      } else {
        fs.unlinkSync(path);
      }
    });
    fs.rmdirSync(folder);
  }
}

function _displayConfig() {
  let app = config.Application;
  _sendUserOutput('Application configuration values');
  for (let a in app) {
    _sendUserOutput('\t' + a + '=' + app[a]);
  }
  let user = config.User;
  let out = '';
  for (let u in user) {
    out += ('\t' + u + '=' + user[u] + '\n');
  }
  if (out) {
    _sendUserOutput('User configuration values');
    _sendUserOutput(out);
  }
  _sendUserOutput('');
}

function _getAlternateKey(key) {
  if (!AlternateKeys) {
    AlternateKeys = _getJSON(KEY_FILE_PATH);
  }
  return AlternateKeys.alternateKeys[key];
}

function _getBCDPath() {
  let bcdPath = config.get('Application.bcdCommitDirectory');
  return _resolveHome(bcdPath);
}

function _getConfig(parameter) {
  if (config.has('User.' + parameter)) {
    return config.get('User.' + parameter);
  }
  return config.get('Application.' + parameter);
}
function _getConfigs(parameter) {
  let returns = {};
  if (config.has(`User.${parameter}`)) {
    returns.user = config.get(`User.${parameter}`);
    returns.user = _terminatePath(returns.user);
    returns.user = _resolveHome(returns.user);
  }
  if (config.has(`Application.${parameter}`)) {
    returns.app = config.get(`Application.${parameter}`);
    returns.app = _terminatePath(returns.app);
    returns.app = _resolveHome(returns.app);
  }
  return returns;
}

function _getOutputDirectory() {
  let dirName = "";
  switch (global.__commandName) {
    case 'BoilerplateBuilder':
      dirName = config.get('Application.boilerplatesDirectory');
      break;
    default:
      dirName = config.get('Application.outputDirectory');
      break;
  }
  return _resolveHome(dirName);
}

function _getOutputFile(filePath, reuse = false) {
  if (!reuse) {
    if (fs.existsSync(filePath)) {
      fs.unlinkSync(filePath);
    }
  }
  return fs.openSync(filePath, 'w');
}

function _getIDLFile(filePath, options = { "clean": false }) {

  if (!filePath.endsWith(".idl")) { filePath += ".idl"; }
  const buffer = fs.readFileSync(filePath);
  let fileContents = buffer.toString();
  if (options.clean) {
    // Remove if no regressions appear because of its absence.
    // fileContents = fileContents.replace(COMMENT_START_RE, "");
    // URLs can cause false positives when removing comments
    fileContents = fileContents.replace(URL_RE, "");
    fileContents = fileContents.replace(COMMENT_MULTILINE_RE, "");
    fileContents = fileContents.replace(COMMENT_SINGLELINE_RE, "");
    fileContents = fileContents.replace(BLANK_LINE_RE, "");
    fileContents = fileContents.replaceAll("[EnforceRange]", "");
    fileContents = fileContents.replaceAll("[TreatNullAs=EmptyString] ", "");
  }
  return fileContents;
}

function _getFile(fileName) {
  fileName = path.join(__dirname, fileName);
  const buffer = fs.readFileSync(fileName);
  return buffer.toString();
}

function _getJSON(path) {
  let fileContents = _getFile(path);
  let parser;
  if (path.endsWith(".json")) {
    parser = JSON;
  } else if (path.endsWith(".json5")) {
    parser = JSON5;
  } else {
    const msg = `The requested file does not have a 'json' or 'json5' extension: ${path}.`;
    throw new TypeError(msg);
  }
  return parser.parse(fileContents);
}

function _getTemplate(name) {
  if (!name.endsWith(".md")) { name += ".md"; }
  let templatePath = TEMPLATES + name;
  let buffer = fs.readFileSync(templatePath);
  return buffer.toString();
}

function _haveTemplate(name) {
  if (!name.endsWith(".md")) { name += ".md"; }
  let templatePath = TEMPLATES + name;
  return fs.existsSync(templatePath);
}

function _isExcluded(apiName) {
  if (USE_EXCLUSIONS) {
    return EXCLUSIONS.includes(apiName);
  }
  return false;
}

function _isOTFalseNegative(apiName){
  if (OT_FALSENEGATIVES) {
    return OT_FALSENEGATIVES.includes(apiName)
  }
  return null;
}

function _getWireframes() {
  const json = this._getJSON(TEMPLATES + QUESTIONS_FILE);
  return json.templates;
}

function _makeOutputFolder(dirName) {
  _makeFolder(_getOutputDirectory());
  const folderToMake = _resolveHome(`${_getOutputDirectory()}${dirName}/`);
  return _makeFolder(folderToMake);
}

function _makeFolder(dirName) {
  dirName = _resolveHome(dirName);
  if (fs.existsSync(dirName)) { return dirName; }
  fs.mkdirSync(dirName, { recursive: true });
  return dirName;
}

async function _pause() {
  if (global.__commandName == "BoilerplateBuilder") { return; }
  const prompt = new Input({
    message: 'Press Enter to continue.'
  });
  let ans = await prompt.run();
}

function _printHelp() {
  let intro = 'Basic usage:\n' +
            '\tnpm run <command> [<arguments>] -- [<flags>]\n\n' +
            'Commands:';
  _sendUserOutput(intro);
  let help = fs.readFileSync(global.__basedir + '/help/HELP.txt');
  help = help.toString();
  _sendUserOutput(help);
}

function _printWelcome() {
  console.clear();
  console.log("=".repeat(80));
  console.log(" ".repeat(30) + "Welcome to MDNBanter" + " ".repeat(29));
  console.log("=".repeat(80));
}

function _resolveHome(path) {
  return path.replace('$HOME',homedir());
}

function _sendUserOutput(msg = ''){
  switch (global.__commandName) {
    case 'BoilerplateBuilder':
    case 'test':
      // Do nothing.
      break;
    default:
      console.log(msg);
      break;
  }
}

function _terminatePath(path) {
  if (path.endsWith('/')) { return path; }
  return `${path}/`;
}

function _today() {
  let today = new Date();
  let dd = today.getDate();
  let mm = today.getMonth()+1; //January is 0!
  let yyyy = today.getFullYear();

  if(dd<10) {
      dd = '0'+dd
  }

  if(mm<10) {
      mm = '0'+mm
  }

  today = `${yyyy}-${mm}-${dd}`;
  return today;
}

module.exports.APP_ROOT = APP_ROOT;
module.exports.WIREFRAMES = WIREFRAMES;
module.exports.confirm = _confirm;
module.exports.confirmPath = _confirmPath;
module.exports.deleteFile = _deleteFile
module.exports.deleteFolderContents = _deleteFolderContents;
module.exports.deleteUnemptyFolder = _deleteUnemptyFolder;
module.exports.displayConfig = _displayConfig;
module.exports.getAlternateKey = _getAlternateKey;
module.exports.getBCDPath = _getBCDPath
module.exports.getConfig = _getConfig;
module.exports.getConfigs = _getConfigs;
module.exports.getFile = _getFile;
module.exports.getIDLFile = _getIDLFile;
module.exports.getJSON = _getJSON;
module.exports.getOutputDirectory = _getOutputDirectory;
module.exports.getOutputFile = _getOutputFile;
module.exports.getTemplate = _getTemplate;
module.exports.getWireframes = _getWireframes;
module.exports.haveTemplate = _haveTemplate;
module.exports.isExcluded = _isExcluded;
module.exports.isOTFalseNegative = _isOTFalseNegative;
module.exports.makeFolder = _makeFolder;
module.exports.makeOutputFolder = _makeOutputFolder;
module.exports.pause = _pause;
module.exports.printHelp = _printHelp;
module.exports.printWelcome = _printWelcome;
module.exports.resolveHome = _resolveHome;
module.exports.sendUserOutput = _sendUserOutput;
module.exports.terminatePath = _terminatePath;
module.exports.today = _today;