markdown_link_checker_sc/src/process_image_orphans.js

Markdown Link Checker

import { logToFile, logFunction } from "./helpers.js";
import fs from "fs";
import path from "path";
import { OrphanedImageError } from "./errors.js";

function isImage(file) {
  const imageExtensions = [".jpg", ".jpeg", ".png", ".svg", ".gif", ".webm"];
  const fileExtension = path.extname(file).toLowerCase();
  return imageExtensions.includes(fileExtension) ? true : false;
}

var otherFileTypes = []; // Just used for logging in function below.

// Gets all image files in a directory.
async function getAllImageFilesInDirectory(dir, options) {
  logFunction(options, `Function: getAllImageFilesInDirectory(${dir})`);

  let files;
  try {
    files = await fs.promises.readdir(dir, { withFileTypes: true });
  } catch {
    console.warn(`Warning: Image directory not found, skipping orphan check: ${dir}`);
    return [];
  }
  const images = [];
  for (let i = 0; i < files.length; i++) {
    const file = path.join(dir, files[i].name);
    if (files[i].isDirectory()) {
      const subImages = await getAllImageFilesInDirectory(file, options);
      images.push(...subImages);
    } else if (isImage(file)) {
      images.push(file);
    } else {
      const fileExtension = path.extname(file).toLowerCase();
      otherFileTypes.includes(fileExtension)
        ? null
        : otherFileTypes.push(path.extname(file).toLowerCase());
    }
  }
  //console.log(    `XXXX Other file types ${JSON.stringify(otherFileTypes, null, 2)}`  );
  return images;
}

// Checks if any images in the options.directory
async function checkImageOrphansGlobal(results, options, allImageFiles) {
  logFunction(options, `Function: checkImageOrphansGlobal()`);

  const errors = [];
  let allImagesFound = [];

  if (options.imagedir !== "") {
    const imagePath = path.resolve(
      options.docsroot,
      options.imagedir
    );

    allImagesFound = await getAllImageFilesInDirectory(imagePath, options);
  }

  allImageFiles.forEach((value) => {
    const imagePath = path.resolve(options.docsroot, value);
    //console.log('val: ' + value);
    allImagesFound.push(imagePath);
  });

  // Check all image files listed are in the array of local images we have (this is from the options.images directory)
  const allImagesLinked = [];
  results.forEach((page) => {
    page.relativeImageLinks.forEach((link) => {
      const fullImagePath = link.getAbsolutePath();
      allImagesLinked.push(fullImagePath);
    });
  });

  //console.log(`XXXXallImagesFound ${JSON.stringify(allImagesFound, null, 2)}`);
  //console.log( `XXXXallImagesLinked ${JSON.stringify(allImagesLinked, null, 2)}`  );

  // Add the image/assets directory to all the files found in the markdown directory.
  //

  allImagesFound.forEach((image) => {
    if (!allImagesLinked.includes(image)) {
      const error = new OrphanedImageError({ file: image, docsroot: options.docsroot });
      errors.push(error);
    }
  });
  //console.log(`XXXXOrphanedImageErrors ${JSON.stringify(errors, null, 2)}`);
  return errors;
}

/*
Add function to check if supplied images are linked or orphans - i.e. PR that adds an image that isn't used.
Might not be needed - ie the above should make a filtered image on page.
*/

export { checkImageOrphansGlobal };