invalid-macros.js

/*
 *  Title: Test for the usage of invalid macros.
 *
 *  Example 1: The usage of <p>{{SomeMacro}}</p> should rather be removed, replaced by a valid
 *  macro or by static text and {{SomeMacro}} should be deleted.
 *
 *  Implementation notes: This test uses an (incomprehensive) whitelist of allowed macros and a
 *  list of obsolete macros. Obsolete macros are marked as errors, all others, which are not
 *  whitelisted are marked as warnings.
 */

const ERROR = require('./doctests.js').ERROR;
const WARNING = require('./doctests.js').WARNING;

const obsoleteMacros = [
  "languages"
];

exports.invalidMacros = {
  name: "invalid_macros",
  desc: "invalid_macros_desc",
  check: function checkInvalidMacros(rootElement) {
    const allowedMacros = [
      "addonsidebar",
      "apiref",
      "anch",
      "availableinworkers",
      "bug",
      "canvassidebar",
      "chromebug",
      "communitybox",
      "compat",
      "cssdata",
      "cssinfo",
      "cssref",
      "csssyntax",
      "cssxref",
      "defaultapisidebar",
      "deprecated_header",
      "deprecated_inline",
      "discussionlist",
      "docstatus",
      "domxref",
      "draft",
      "edgebug",
      "embedghlivesample",
      "embedlivesample",
      "embedyoutube",
      "event",
      "experimental_inline",
      "firefox_for_developers",
      "fx_minversion_inline",
      "fxos_maxversion_inline",
      "fxos_minversion_inline",
      "gecko",
      "gecko_minversion_inline",
      "geckorelease",
      "glossary",
      "groupdata",
      "htmlattrdef",
      "htmlattrxref",
      "htmlelement",
      "htmlref",
      "httpheader",
      "httpmethod",
      "httpsidebar",
      "httpstatus",
      "includesubnav",
      "inheritancediagram",
      "interface",
      "interfacedata",
      "jsfiddlelink",
      "jsref",
      "jssidebar",
      "jsxref",
      "js_property_attributes",
      "l10n:common",
      "l10n:compattable",
      "l10n:css",
      "l10n:javascript",
      "l10n:svg",
      "localizationstatusinsection",
      "mathmlelement",
      "mathmlref",
      "next",
      "non-standard_header",
      "non-standard_inline",
      "noscript_inline",
      "obsolete_header",
      "obsolete_inline",
      "optional_inline",
      "page",
      "previous",
      "previousmenunext",
      "previousnext",
      "promote-mdn",
      "property_prefix",
      "readonlyinline",
      "releasegecko",
      "rfc",
      "seecompattable",
      "sidebarutilities",
      "sm_minversion_inline",
      "spec2",
      "specname",
      "svgattr",
      "svgdata",
      "svgelement",
      "svginfo",
      "svgref",
      "tb_minversion_inline",
      "webextapiembedtype",
      "webextapiref",
      "webextapisidebar",
      "webextchromecompat",
      "webextexamplesdata",
      "webextexamples",
      "webglsidebar",
      "webkitbug",
      "webrtcsidebar",
      "xref",
      "xulattr",
      "xulelem"
    ];

    let treeWalker = document.createTreeWalker(
        rootElement,
        NodeFilter.SHOW_TEXT,
        // eslint-disable-next-line
      {acceptNode: node => node.textContent.match(/\{\{.*?\}\}/) ? NodeFilter.FILTER_ACCEPT : NodeFilter.FILTER_REJECT}
    );
    let matches = [];

    while (treeWalker.nextNode()) {
      let reMacroName = /\{\{\s*([^(}\s]+).*?\}\}/g;
      let macroNameMatch = reMacroName.exec(treeWalker.currentNode.textContent);
      while (macroNameMatch) {
        if (obsoleteMacros.includes(macroNameMatch[1].toLowerCase())) {
          matches.push({
            node: treeWalker.currentNode,
            msg: "obsolete_macro",
            msgParams: [macroNameMatch[0]],
            type: ERROR
          });
        } else if (!allowedMacros.includes(macroNameMatch[1].toLowerCase())) {
          matches.push({
            msg: macroNameMatch[0],
            type: WARNING
          });
        }
        macroNameMatch = reMacroName.exec(treeWalker.currentNode.textContent);
      }
    }

    return matches;
  },

  fix: function fixInvalidMacros(matches) {
    let reObsoleteMacros =
        new RegExp(`\\{\\{\\s*(?:${obsoleteMacros.join("|")}).*?\\}\\}`, "gi");

    matches.forEach(match => {
      if (!match.node) {
        return;
      }

      match.node.textContent = match.node.textContent.replace(reObsoleteMacros, "");
      if (match.node.parentNode.textContent.match(/^(\s|&nbsp;)*$/)) {
        match.node.parentNode.remove();
      }
    });
  }
};