marko/src/compiler/index.js

UI Components + streaming, async, high performance, HTML templating for Node.js and the browser.

"use strict";

var ok = require("assert").ok;
var fs = require("fs");

// eslint-disable-next-line no-constant-binary-expression
var complain = "MARKO_DEBUG" && require("complain");
var compiler = require("@marko/compiler");
var extend = require("raptor-util/extend");
var taglib = require("../taglib");
var globalConfig = require("./config");
var defaults = extend({}, globalConfig);

// eslint-disable-next-line no-constant-condition
if ("MARKO_DEBUG") {
  if (
    require.main &&
    require.main.filename !== require.resolve("../../bin/markoc")
  ) {
    complain(
      "Using `marko/compiler` has been deprecated, please upgrade to the `@marko/compiler` module.",
    );
  }
}

var defaultOptionsExportDefinition = {
  get: function () {
    return globalConfig;
  },
  enumerable: true,
  configurable: false,
};

Object.defineProperties(exports, {
  defaultOptions: defaultOptionsExportDefinition,
  config: defaultOptionsExportDefinition,
});

function configure(newConfig) {
  if (!newConfig) {
    newConfig = {};
  }

  globalConfig = extend({}, defaults);
  extend(globalConfig, newConfig);

  compiler.configure(newConfig);
}

function resultCompat({ code, meta, map }, options = {}) {
  if (options.sourceOnly !== false) {
    return code;
  } else {
    return { code, meta, map };
  }
}

function _compile(src, filename, userConfig, callback) {
  ok(filename, '"filename" argument is required');
  ok(typeof filename === "string", '"filename" argument should be a string');
  var options = {};

  extend(options, globalConfig);

  if (userConfig) {
    extend(options, userConfig);
  }

  if (callback) {
    compiler.compile(src, filename, options).then(
      (result) => callback(null, resultCompat(result, options)),
      (error) => callback(error),
    );
  } else {
    return resultCompat(compiler.compileSync(src, filename, options), options);
  }
}

function compile(src, filename, options, callback) {
  if (typeof options === "function") {
    callback = options;
    options = null;
  }

  options = options || {};
  options.sourceOnly = options.sourceOnly !== false;

  return _compile(src, filename, options, callback);
}

function compileForBrowser(src, filename, options, callback) {
  if (typeof options === "function") {
    callback = options;
    options = null;
  }

  options = extend(
    {
      output: "dom",
      meta: false,
      sourceOnly: false,
    },
    options,
  );

  return compile(src, filename, options, callback);
}

function compileFile(filename, options, callback) {
  if (typeof options === "function") {
    callback = options;
    options = null;
  }

  options = options || {};
  options.sourceOnly = options.sourceOnly !== false;

  if (callback) {
    fs.readFile(filename, { encoding: "utf8" }, function (err, templateSrc) {
      if (err) {
        return callback(err);
      }

      _compile(templateSrc, filename, options, callback);
    });
  } else {
    let templateSrc = fs.readFileSync(filename, { encoding: "utf8" });
    return _compile(templateSrc, filename, options, callback);
  }
}

function compileFileForBrowser(filename, options, callback) {
  if (typeof options === "function") {
    callback = options;
    options = null;
  }

  options = extend({ output: "dom", meta: false, sourceOnly: false }, options);
  return compileFile(filename, options, callback);
}

exports.compileFile = compileFile;
exports.compile = compile;
exports.compileForBrowser = compileForBrowser;
exports.compileFileForBrowser = compileFileForBrowser;

exports.configure = configure;

exports.taglibLookup = taglib.lookup;
exports.taglibLoader = taglib.loader;
exports.taglibFinder = taglib.finder;
exports.buildTaglibLookup = taglib.lookup.buildLookup;
exports.clearCaches = function clearCaches() {
  compiler._clearDefaults();
  taglib.clearCache();
};

exports.registerTaglib = function (filePath) {
  ok(typeof filePath === "string", '"filePath" should be a string');
  taglib.registerFromFile(filePath);
  exports.clearCaches();
};

exports.isVDOMSupported = true;