Add support for —update-path flag

-> used when installing or removing a tool
-> will notify the tool of the request to update paths
-> only tinytex respects this

Author: dragonstyle

news/changelog-1.2.md

@@ -82,6 +82,7 @@
 - `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
 

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/tools/impl/tinytex.ts

@@ -22,6 +22,7 @@ import { execProcess } from "../../core/process.ts";
 import {
   InstallableTool,
   InstallContext,
+  kUpdatePath,
   PackageInfo,
   RemotePackageInfo,
   ToolConfigurationState,
@@ -292,7 +293,7 @@ async function afterInstall(context: InstallContext) {
 
     // If the environment has requested, add this tex installation to
     // the system path
-    if (addTexLiveToPath()) {
+    if (context.flags[kUpdatePath]) {
       const message =
         `Unable to determine a path to use when installing TeX Live. 
 To complete the installation, please run the following:
@@ -380,7 +381,7 @@ async function uninstall(context: InstallContext) {
     return Promise.reject();
   }
 
-  if (addTexLiveToPath()) {
+  if (context.flags[kUpdatePath]) {
     // remove symlinks
     if (await texLiveInPath()) {
       await context.withSpinner(

src/tools/tools-console.ts

@@ -146,11 +146,15 @@ export async function afterConfirm(
   }
 }
 
-export const removeTool = (toolname: string, prompt?: boolean) => {
+export const removeTool = (
+  toolname: string,
+  prompt?: boolean,
+  updatePath?: boolean,
+) => {
   return afterConfirm(
     `Are you sure you'd like to remove ${toolname}?`,
     () => {
-      return uninstallTool(toolname);
+      return uninstallTool(toolname, updatePath);
     },
     prompt,
   );
@@ -160,6 +164,7 @@ export async function updateOrInstallTool(
   tool: string,
   action: "update" | "install",
   prompt?: boolean,
+  updatePath?: boolean,
 ) {
   const summary = await toolSummary(tool);
 
@@ -168,7 +173,7 @@ export async function updateOrInstallTool(
       return afterConfirm(
         `${tool} is not installed. Do you want to install it now?`,
         () => {
-          return installTool(tool);
+          return installTool(tool, updatePath);
         },
         prompt,
       );
@@ -203,7 +208,7 @@ export async function updateOrInstallTool(
         );
       }
     } else {
-      return installTool(tool);
+      return installTool(tool, updatePath);
     }
   }
 }

src/tools/tools.ts

@@ -12,6 +12,7 @@ import { logError } from "../core/log.ts";
 import {
   InstallableTool,
   InstallContext,
+  kUpdatePath,
   ToolConfigurationState,
   ToolSummaryData,
 } from "./types.ts";
@@ -81,7 +82,7 @@ export async function printToolInfo(name: string) {
   }
 }
 
-export async function installTool(name: string) {
+export async function installTool(name: string, updatePath?: boolean) {
   name = name || "";
   // Run the install
   const installableTool = kInstallableTools[name.toLowerCase()];
@@ -90,7 +91,8 @@ export async function installTool(name: string) {
     const workingDir = Deno.makeTempDirSync();
     try {
       // The context for the installers
-      const context = installContext(workingDir);
+      const context = installContext(workingDir, updatePath);
+
       context.info(`Installing ${name}`);
 
       // See if it is already installed
@@ -145,13 +147,13 @@ export async function installTool(name: string) {
   }
 }
 
-export async function uninstallTool(name: string) {
+export async function uninstallTool(name: string, updatePath?: boolean) {
   const installableTool = kInstallableTools[name.toLowerCase()];
   if (installableTool) {
     const installed = await installableTool.installed();
     if (installed) {
       const workingDir = Deno.makeTempDirSync();
-      const context = installContext(workingDir);
+      const context = installContext(workingDir, updatePath);
 
       // Emit initial message
       context.info(`Uninstalling ${name}`);
@@ -244,7 +246,10 @@ export function installableTool(name: string) {
   return kInstallableTools[name.toLowerCase()];
 }
 
-const installContext = (workingDir: string): InstallContext => {
+const installContext = (
+  workingDir: string,
+  updatePath?: boolean,
+): InstallContext => {
   const installMessaging = {
     info: (msg: string) => {
       info(msg);
@@ -280,5 +285,8 @@ const installContext = (workingDir: string): InstallContext => {
     workingDir,
     ...installMessaging,
     props: {},
+    flags: {
+      [kUpdatePath]: updatePath,
+    },
   };
 };

src/tools/types.ts

@@ -7,6 +7,8 @@
 
 import { SpinnerOptions } from "../core/console.ts";
 
+export const kUpdatePath = "update-path";
+
 // Installable Tool interface
 export interface InstallableTool {
   name: string;
@@ -69,6 +71,9 @@ export interface InstallContext {
   confirm: (msg: string, def?: boolean) => Promise<boolean>;
   download: (name: string, url: string, target: string) => Promise<void>;
   props: { [key: string]: unknown };
+  flags: {
+    [kUpdatePath]?: boolean;
+  };
 }
 
 export interface ToolSummaryData {