@11ty/eleventy-img/src/build-logger.js

Low level utility to perform build-time image transformations.

const path = require("node:path");
const { TemplatePath } = require("@11ty/eleventy-utils");

const Util = require("./util.js");

class BuildLogger {
  #eleventyConfig;

  constructor() {
    this.hasAssigned = false;
  }

  setupOnce(eleventyConfig, beforeCallback, afterCallback) {
    if(this.hasAssigned) {
      return;
    }

    this.hasAssigned = true;
    this.#eleventyConfig = eleventyConfig;

    eleventyConfig.on("eleventy.before", beforeCallback);
    eleventyConfig.on("eleventy.after", afterCallback);

    eleventyConfig.on("eleventy.reset", () => {
      this.hasAssigned = false;
      beforeCallback(); // we run this on reset because the before callback will have disappeared (as the config reset)
    });
  }

  getFriendlyImageSource(imageSource) {
    if(Buffer.isBuffer(imageSource)) {
      return `<Buffer>`;
    }

    if(Util.isRemoteUrl(imageSource)) {
      return imageSource;
    }
    if(path.isAbsolute(imageSource)) {
      // convert back to relative url
      return TemplatePath.addLeadingDotSlash(path.relative(path.resolve("."), imageSource));
    }

    return TemplatePath.addLeadingDotSlash(imageSource);
  }

  log(message, options = {}, logOptions = {}) {
    if(typeof this.#eleventyConfig?.logger?.logWithOptions !== "function" || options.transformOnRequest) {
      return;
    }

    this.#eleventyConfig.logger.logWithOptions(Object.assign({
      message: `${message}${options.generatedVia ? ` (${options.generatedVia})` : ""}`,
      type: "log",
      prefix: "[11ty/eleventy-img]"
    }, logOptions));
  }

  error(message, options = {}, logOptions = {}) {
    logOptions.type = "error";
    logOptions.force = true;

    this.log(message, options, logOptions);
  }
}

module.exports = BuildLogger;