Merge pull request #2428 from quarto-dev/feature/tinytex-stbl

TinyTeX improvements

Author: dragonstyle

news/changelog-1.2.md

@@ -76,6 +76,14 @@
 - Support formats `bibtex`, `biblatex`, and `csljson`. When rendered to one of these formats any citations within the document will be rendered as the specified bibliography format.
 - Always add citeproc filter if `citeproc: true` is specified, even if there isn't a bibliography or references in the document (#2294)
 
+## TinyTex
+
+- `quarto install tool tinytex` will now install TinyTex even if a system installation of TeX is detected.
+- `quarto install tool tinytex` will no longer add TinyTex to the system path by default.
+- When rendering PDFs, Quarto will prefer an existing installation of TinyTex over a system Tex installation
+- To prevent Quarto from using an installation of TinyTex (if you'd prefer the system installation be used), set `latex-tinytex: false` in your project or document front matter.
+- To install TinyTex system wide, using the `--update-path` flag when installing (this will add TinyTex to the system path)
+
 ## Miscellaneous
 
 - Render: ability to compose `--to all` with other formats (e.g. `--to all,json`)

src/command/install/cmd.ts

@@ -28,6 +28,10 @@ export const installCommand = new Command()
     "--embed <extensionId>",
     "Embed this extension within another extension (used when authoring extensions).",
   )
+  .option(
+    "--update-path",
+    "Update system path when a tool is installed",
+  )
   .description(
     "Installs an extension or global dependency.",
   )
@@ -57,7 +61,7 @@ export const installCommand = new Command()
   )
   .action(
     async (
-      options: { prompt?: boolean; embed?: string },
+      options: { prompt?: boolean; embed?: string; updatePath?: boolean },
       type: string,
       target?: string,
     ) => {
@@ -80,7 +84,12 @@ export const installCommand = new Command()
           // Install a tool
           if (target) {
             // Use the tool name
-            await updateOrInstallTool(target, "install", options.prompt);
+            await updateOrInstallTool(
+              target,
+              "install",
+              options.prompt,
+              options.updatePath,
+            );
           } else {
             // Not provided, give the user a list to choose from
             const allTools = await loadTools();
@@ -91,7 +100,7 @@ export const installCommand = new Command()
               const toolTarget = await selectTool(allTools, "install");
               if (toolTarget) {
                 info("");
-                await installTool(toolTarget);
+                await installTool(toolTarget, options.updatePath);
               }
             }
           }

src/command/remove/cmd.ts

@@ -39,6 +39,10 @@ export const removeCommand = new Command()
     "--embed <extensionId>",
     "Remove this extension from within another extension (used when authoring extensions).",
   )
+  .option(
+    "--update-path",
+    "Update system path when a tool is installed",
+  )
   .description(
     "Removes an extension or global dependency.",
   )
@@ -64,7 +68,7 @@ export const removeCommand = new Command()
   )
   .action(
     async (
-      options: { prompt?: boolean; embed?: string },
+      options: { prompt?: boolean; embed?: string; updatePath?: boolean },
       type: string,
       target?: string,
     ) => {
@@ -130,7 +134,7 @@ export const removeCommand = new Command()
           // Process tool
           if (target) {
             // Explicitly provided
-            await removeTool(target, options.prompt);
+            await removeTool(target, options.prompt, options.updatePath);
           } else {
             // Not provided, give the user a list to choose from
             const allTools = await loadTools();

src/command/render/latexmk/latex.ts

@@ -19,6 +19,7 @@ import {
   kLatexBodyMessageOptions,
   kLatexHeaderMessageOptions,
 } from "./types.ts";
+import { texLiveCmd, TexLiveContext } from "./texlive.ts";
 
 export interface LatexCommandReponse {
   log: string;
@@ -43,6 +44,7 @@ export async function hasLatexDistribution() {
 export async function runPdfEngine(
   input: string,
   engine: PdfEngine,
+  texLive: TexLiveContext,
   outputDir?: string,
   texInputDirs?: string[],
   pkgMgr?: PackageManager,
@@ -85,6 +87,7 @@ export async function runPdfEngine(
       pkgMgr,
       cwd,
       texInputDirs,
+      texLive,
     },
     quiet,
   );
@@ -100,6 +103,7 @@ export async function runPdfEngine(
 // Run the index generation engine (currently hard coded to makeindex)
 export async function runIndexEngine(
   input: string,
+  texLive: TexLiveContext,
   engine?: string,
   args?: string[],
   pkgMgr?: PackageManager,
@@ -119,6 +123,7 @@ export async function runIndexEngine(
     {
       cwd,
       pkgMgr,
+      texLive,
     },
     quiet,
   );
@@ -134,6 +139,7 @@ export async function runBibEngine(
   engine: string,
   input: string,
   cwd: string,
+  texLive: TexLiveContext,
   pkgMgr?: PackageManager,
   texInputDirs?: string[],
   quiet?: boolean,
@@ -153,6 +159,7 @@ export async function runBibEngine(
       pkgMgr,
       cwd,
       texInputDirs,
+      texLive,
     },
     quiet,
   );
@@ -166,6 +173,7 @@ export interface LatexCommandContext {
   pkgMgr?: PackageManager;
   cwd?: string;
   texInputDirs?: string[];
+  texLive: TexLiveContext;
 }
 
 async function runLatexCommand(
@@ -174,8 +182,10 @@ async function runLatexCommand(
   context: LatexCommandContext,
   quiet?: boolean,
 ): Promise<ProcessResult> {
+  const fullLatexCmd = texLiveCmd(latexCmd, context.texLive);
+
   const runOptions: Deno.RunOptions = {
-    cmd: [latexCmd, ...args],
+    cmd: [fullLatexCmd.fullPath, ...args],
     stdout: "piped",
     stderr: "piped",
   };

src/command/render/latexmk/latexmk.ts

@@ -13,6 +13,7 @@ import {
   kLatexMaxRuns,
   kLatexMinRuns,
   kLatexOutputDir,
+  kLatexTinyTex,
   kOutputExt,
 } from "../../../config/constants.ts";
 import { Format } from "../../../config/types.ts";
@@ -75,6 +76,7 @@ export function quartoLatexmkOutputRecipe(
       autoMk: format.render[kLatexAutoMk],
       minRuns: format.render[kLatexMinRuns],
       maxRuns: format.render[kLatexMaxRuns],
+      tinyTex: format.render[kLatexTinyTex],
       texInputDirs,
       outputDir: outputDir === null ? undefined : outputDir,
       clean: !options.flags?.debug && format.render[kLatexClean] !== false,

src/command/render/latexmk/pdf.ts

@@ -14,7 +14,7 @@ import { kLatexHeaderMessageOptions, LatexmkOptions } from "./types.ts";
 import { dirAndStem } from "../../../core/path.ts";
 import { ProcessResult } from "../../../core/process.ts";
 
-import { hasTexLive } from "./texlive.ts";
+import { hasTexLive, TexLiveContext, texLiveContext } from "./texlive.ts";
 import { runBibEngine, runIndexEngine, runPdfEngine } from "./latex.ts";
 import { PackageManager, packageManager } from "./pkgmgr.ts";
 import {
@@ -51,14 +51,18 @@ export async function generatePdf(mkOptions: LatexmkOptions): Promise<string> {
   const allowUpdate = await hasTexLive();
   mkOptions.autoInstall = mkOptions.autoInstall && allowUpdate;
 
+  // Create the TexLive context for this compilation
+  const texLive = await texLiveContext(mkOptions.tinyTex !== false);
+
   // The package manager used to find and install packages
-  const pkgMgr = packageManager(mkOptions);
+  const pkgMgr = packageManager(mkOptions, texLive);
 
   // Render the PDF, detecting whether any packages need to be installed
   const response = await initialCompileLatex(
     mkOptions.input,
     mkOptions.engine,
     pkgMgr,
+    texLive,
     mkOptions.outputDir,
     mkOptions.texInputDirs,
     mkOptions.quiet,
@@ -70,6 +74,7 @@ export async function generatePdf(mkOptions: LatexmkOptions): Promise<string> {
     workingDir,
     stem,
     pkgMgr,
+    texLive,
     mkOptions.engine.indexEngine,
     mkOptions.engine.indexEngineOpts,
     mkOptions.quiet,
@@ -80,6 +85,7 @@ export async function generatePdf(mkOptions: LatexmkOptions): Promise<string> {
     mkOptions.input,
     mkOptions.engine.bibEngine || "citeproc",
     pkgMgr,
+    texLive,
     mkOptions.outputDir,
     mkOptions.texInputDirs,
     mkOptions.quiet,
@@ -99,6 +105,7 @@ export async function generatePdf(mkOptions: LatexmkOptions): Promise<string> {
       pkgMgr,
       mkOptions.minRuns || 1,
       maxRuns,
+      texLive,
       mkOptions.outputDir,
       mkOptions.texInputDirs,
       mkOptions.quiet,
@@ -125,6 +132,7 @@ async function initialCompileLatex(
   input: string,
   engine: PdfEngine,
   pkgMgr: PackageManager,
+  texLive: TexLiveContext,
   outputDir?: string,
   texInputDirs?: string[],
   quiet?: boolean,
@@ -135,6 +143,7 @@ async function initialCompileLatex(
     const response = await runPdfEngine(
       input,
       engine,
+      texLive,
       outputDir,
       texInputDirs,
       pkgMgr,
@@ -232,6 +241,7 @@ async function makeIndexIntermediates(
   dir: string,
   stem: string,
   pkgMgr: PackageManager,
+  texLive: TexLiveContext,
   engine?: string,
   args?: string[],
   quiet?: boolean,
@@ -247,6 +257,7 @@ async function makeIndexIntermediates(
     try {
       const response = await runIndexEngine(
         indexFile,
+        texLive,
         engine,
         args,
         pkgMgr,
@@ -291,6 +302,7 @@ async function makeBibliographyIntermediates(
   input: string,
   engine: string,
   pkgMgr: PackageManager,
+  texLive: TexLiveContext,
   outputDir?: string,
   texInputDirs?: string[],
   quiet?: boolean,
@@ -350,6 +362,7 @@ async function makeBibliographyIntermediates(
           bibCommand,
           auxBibPath,
           cwd,
+          texLive,
           pkgMgr,
           texInputDirs,
           quiet,
@@ -457,6 +470,7 @@ async function recompileLatexUntilComplete(
   pkgMgr: PackageManager,
   minRuns: number,
   maxRuns: number,
+  texLive: TexLiveContext,
   outputDir?: string,
   texInputDirs?: string[],
   quiet?: boolean,
@@ -488,6 +502,7 @@ async function recompileLatexUntilComplete(
     const result = await runPdfEngine(
       input,
       engine,
+      texLive,
       outputDir,
       texInputDirs,
       pkgMgr,

src/command/render/latexmk/pkgmgr.ts

@@ -9,7 +9,12 @@ import * as ld from "../../../core/lodash.ts";
 
 import { ProcessResult } from "../../../core/process.ts";
 
-import { findPackages, installPackages, updatePackages } from "./texlive.ts";
+import {
+  findPackages,
+  installPackages,
+  TexLiveContext,
+  updatePackages,
+} from "./texlive.ts";
 import { LatexmkOptions } from "./types.ts";
 
 export interface PackageManager {
@@ -19,7 +24,10 @@ export interface PackageManager {
   updatePackages(all: boolean, self: boolean): Promise<ProcessResult>;
 }
 
-export function packageManager(mkOptions: LatexmkOptions): PackageManager {
+export function packageManager(
+  mkOptions: LatexmkOptions,
+  texLive: TexLiveContext,
+): PackageManager {
   let lastPkgs: string[] = [];
   return {
     autoInstall: mkOptions.autoInstall === undefined
@@ -34,6 +42,7 @@ export function packageManager(mkOptions: LatexmkOptions): PackageManager {
         // Attempt to install the packages
         await installPackages(
           pkgs,
+          texLive,
           mkOptions.engine.tlmgrOpts,
           mkOptions.quiet,
         );
@@ -52,13 +61,15 @@ export function packageManager(mkOptions: LatexmkOptions): PackageManager {
       return updatePackages(
         all,
         self,
+        texLive,
         mkOptions.engine.tlmgrOpts,
         mkOptions.quiet,
       );
     },
     searchPackages: (searchTerms: string[]) => {
       return findPackages(
         searchTerms,
+        texLive,
         mkOptions.engine.tlmgrOpts,
         mkOptions.quiet,
       );