linkcheck-bin/lib/utils.js

An npm-installable wrapper for @filiph's linkcheck, a reasonably fast link checker.

import { execFileSync } from "child_process";
import { readPackageUpSync } from "read-package-up";

// This package's version number (should) always match the linkcheck release we want.
// We check for a `linkcheckVersion` field in package.json just in case it doesn't
// match in the future (from pushing an emergency package update, etc.).
export function getPkgVersion() {
  const { packageJson } = readPackageUpSync();
  return packageJson.linkcheckVersion || packageJson.version;
}

// Generate the full GitHub URL to a given release file.
export function getReleaseUrl(version, filename) {
  return `https://github.com/filiph/linkcheck/releases/download/${version}/${filename}`;
}

// Binary needs a file extension on windows
export function getBinFilename() {
  return process.platform === "win32" ? "linkcheck/linkcheck.bat" : "linkcheck/linkcheck";
}

// Returns the output of the `linkcheck --version` command, i.e.:
//   "linkcheck version 2.0.20"
export function getBinVersion(bin) {
	const stdout = execFileSync(bin, ["--version"], {
		// The shell: true option is required on Windows because the Windows wrapper is a batch file.
		// See https://github.com/nodejs/node/issues/52681#issuecomment-2076426887
		shell: process.platform === "win32",
	});
	return stdout.toString().trim();
}

export function getReleaseFilename(version) {
  const { platform, arch } = process;

  const filename =
    // macOS
    platform === "darwin" && ["x64", "arm64"].includes(arch) ?
      `linkcheck-${version}-macos-${arch}.tar.gz` :

    // Windows
    platform === "win32" && arch === "x64" ?
      `linkcheck-${version}-windows-${arch}.zip` :

    // Linux
    platform === "linux" && ["x64", "arm64"].includes(arch) ?
      `linkcheck-${version}-linux-${arch}.tar.gz` :

    // no binary for this platform
    undefined;

  if(filename === undefined) {
    console.warn(`Unsupported platform: ${platform} ${arch}`);
  }
  return filename;
}

/**
 * Returns a URL to a checksums file for the provided version.
 */
export function getChecksum(version) {
  return `https://raw.githubusercontent.com/tylerbutler/linkcheck-bin/main/data/${version}-checksums.txt`;
}