compile-quarto-latexmk.ts

/*
* compile-quarto-latexmk.ts
*
* Copyright (C) 2020-2022 Posit Software, PBC
*
*/
import { Command } from "cliffy/command/mod.ts";
import { basename, join } from "../../../src/deno_ral/path.ts";
import { ensureDirSync } from "../../../src/deno_ral/fs.ts";
import { info } from "../../../src/deno_ral/log.ts";

import { Configuration, readConfiguration } from "../common/config.ts";
import { compile, install, updateDenoPath } from "../util/deno.ts";

export function compileQuartoLatexmkCommand() {
  return new Command()
    .name("compile-quarto-latexmk")
    .description("Builds binary for quarto-latexmk")
    .option(
      "-d, --development",
      "Install for local development",
    )
    .option(
      "-t, --target <target:string>",
      "The target architecture for the binary (e.g. x86_64-unknown-linux-gnu, x86_64-pc-windows-msvc, x86_64-apple-darwin, aarch64-apple-darwin)",
      {
        collect: true,
      },
    )
    .option(
      "-v, --version <version:string>",
      "The version number of the compiled executable",
    )
    .option(
      "-n, --name <name:string>",
      "The name of the compiled executable",
    )
    .option(
      "--description <description...:string>",
      "The description of the compiled executable",
    )
    // deno-lint-ignore no-explicit-any
    .action(async (args: Record<string, any>) => {
      const configuration = readConfiguration();
      info("Using configuration:");
      info(configuration);
      info("");

      if (args.development) {
        await installQuartoLatexmk(configuration);
      } else {
        const description = Array.isArray(args.description)
          ? args.description.join(" ")
          : args.description || "Quarto Latexmk Engine";

        const version = args.version || configuration.version;
        const name = args.name || "quarto-latexmk";
        const targets = (args.targets || [Deno.build.target]) as string[];

        await compileQuartoLatexmk(
          configuration,
          targets,
          version,
          name,
          description,
        );
      }
    });
}

// Using --allow-all as there is otherwise an issue in Deno 1.46.3 with --allow-read and --allow-write with network drives
// https://github.com/quarto-dev/quarto-cli/issues/11332
/* 
const kFlags = [
  "--allow-read",
  "--allow-write",
  "--allow-run",
  "--allow-env",
  "--allow-net",
];
*/
const kFlags = ["--allow-all"];

export async function installQuartoLatexmk(
  config: Configuration,
) {
  const installPath = await install(
    entryPointPath(config),
    ["-f", ...kFlags],
    config,
  );
  if (installPath) {
    updateDenoPath(installPath, config);
  }
}

export async function compileQuartoLatexmk(
  config: Configuration,
  targets: string[],
  version: string,
  name: string,
  description: string,
) {
  const workingTempDir = Deno.makeTempDirSync();
  try {
    // If target isn't specified, build for whatever the current architecture is
    targets = targets || [Deno.build.target];

    // temporarily update the constants to reflect the provided information
    const metadataPath = metadataFilePath(config);
    info("Using executable info:");
    info(`version: ${version}`);
    info(`name: ${name}`);
    info(`description: ${description}`);
    info("");

    // Backup a copy of the source
    Deno.copyFileSync(
      metadataPath,
      join(workingTempDir, basename(metadataPath)),
    );

    // Generate the proper constants and compile
    const verRegex = /^(export const kExeVersion = ").*(";)$/gm;
    const nameRegex = /^(export const kExeName = ").*(";)$/gm;
    const descRegex = /^(export const kExeDescription = ").*(";)$/gm;

    let contents = Deno.readTextFileSync(metadataPath);
    contents = contents.replace(verRegex, `$1${version}$2`);
    contents = contents.replace(nameRegex, `$1${name}$2`);
    contents = contents.replace(descRegex, `$1${description}$2`);

    Deno.writeTextFileSync(metadataPath, contents);

    for (const target of targets) {
      const outputName = name || "quarto-latexmk";
      info(`Compiling for ${target}:`);
      const outputDir = join(
        config.directoryInfo.bin,
        outputName,
        target,
      );
      ensureDirSync(outputDir);
      const output = join(outputDir, filename(outputName, target));

      await compile(
        entryPointPath(config),
        output,
        [...kFlags],
        config,
      );
      info(output + "\n");
    }

    // Restore the previously backed up file
    Deno.copyFileSync(
      join(workingTempDir, basename(metadataPath)),
      metadataPath,
    );
  } finally {
    Deno.removeSync(workingTempDir, { recursive: true });
  }
}

function filename(name: string, target: string) {
  if (target.match(/.*windows.*/)) {
    return `${name}.exe`;
  } else {
    return name;
  }
}

function metadataFilePath(config: Configuration) {
  return join(
    config.directoryInfo.src,
    "command",
    "render",
    "latexmk",
    "quarto-latexmk-metadata.ts",
  );
}

function entryPointPath(config: Configuration) {
  return join(
    config.directoryInfo.src,
    "command",
    "render",
    "latexmk",
    "quarto-latexmk.ts",
  );
}