add terminal link as cli module so we can more easily patch it

Author: nicktrn

packages/cli-v3/package.json

@@ -91,6 +91,7 @@
     "@opentelemetry/semantic-conventions": "1.25.1",
     "@trigger.dev/build": "workspace:4.0.0-v4-beta.11",
     "@trigger.dev/core": "workspace:4.0.0-v4-beta.11",
+    "ansi-escapes": "^7.0.0",
     "c12": "^1.11.1",
     "chalk": "^5.2.0",
     "chokidar": "^3.6.0",
@@ -103,6 +104,7 @@
     "evt": "^2.4.13",
     "fast-npm-meta": "^0.2.2",
     "gradient-string": "^2.0.2",
+    "has-flag": "^5.0.1",
     "import-in-the-middle": "1.11.0",
     "import-meta-resolve": "^4.1.0",
     "jsonc-parser": "3.2.1",
@@ -123,6 +125,7 @@
     "socket.io-client": "4.7.5",
     "source-map-support": "0.5.21",
     "std-env": "^3.7.0",
+    "supports-color": "^10.0.0",
     "terminal-link": "^3.0.0",
     "tiny-invariant": "^1.2.0",
     "tinyexec": "^0.3.1",

packages/cli-v3/src/utilities/cliOutput.ts

@@ -1,6 +1,6 @@
 import { log } from "@clack/prompts";
 import chalk from "chalk";
-import terminalLink, { Options as TerminalLinkOptions } from "terminal-link";
+import { terminalLink, TerminalLinkOptions } from "./terminalLink.js";
 import { hasTTY } from "std-env";
 
 export const isInteractive = hasTTY;

packages/cli-v3/src/utilities/supportsHyperlinks.ts

@@ -0,0 +1,146 @@
+import { createSupportsColor } from "supports-color";
+import hasFlag from "has-flag";
+
+function parseVersion(versionString = ""): { major: number; minor: number; patch: number } {
+  if (/^\d{3,4}$/.test(versionString)) {
+    // Env var doesn't always use dots. example: 4601 => 46.1.0
+    const match = /(\d{1,2})(\d{2})/.exec(versionString) ?? [];
+    return {
+      major: 0,
+      minor: Number.parseInt(match[1] ?? "0", 10),
+      patch: Number.parseInt(match[2] ?? "0", 10),
+    };
+  }
+
+  const versions = (versionString ?? "").split(".").map((n) => Number.parseInt(n, 10));
+  return {
+    major: versions[0] ?? 0,
+    minor: versions[1] ?? 0,
+    patch: versions[2] ?? 0,
+  };
+}
+
+/**
+    Creates a supports hyperlinks check for a given stream.
+
+    @param stream - Optional stream to check for hyperlink support.
+    @returns boolean indicating whether hyperlinks are supported.
+*/
+export function createSupportsHyperlinks(stream: NodeJS.WriteStream): boolean {
+  const {
+    CI,
+    FORCE_HYPERLINK,
+    NETLIFY,
+    TEAMCITY_VERSION,
+    TERM_PROGRAM,
+    TERM_PROGRAM_VERSION,
+    VTE_VERSION,
+    TERM,
+  } = process.env;
+
+  if (FORCE_HYPERLINK) {
+    return !(FORCE_HYPERLINK.length > 0 && Number.parseInt(FORCE_HYPERLINK, 10) === 0);
+  }
+
+  if (
+    hasFlag("no-hyperlink") ||
+    hasFlag("no-hyperlinks") ||
+    hasFlag("hyperlink=false") ||
+    hasFlag("hyperlink=never")
+  ) {
+    return false;
+  }
+
+  if (hasFlag("hyperlink=true") || hasFlag("hyperlink=always")) {
+    return true;
+  }
+
+  // Netlify does not run a TTY, it does not need `supportsColor` check
+  if (NETLIFY) {
+    return true;
+  }
+
+  // If they specify no colors, they probably don't want hyperlinks.
+  if (!createSupportsColor(stream)) {
+    return false;
+  }
+
+  if (stream && !stream.isTTY) {
+    return false;
+  }
+
+  // Windows Terminal
+  if ("WT_SESSION" in process.env) {
+    return true;
+  }
+
+  if (process.platform === "win32") {
+    return false;
+  }
+
+  if (CI) {
+    return false;
+  }
+
+  if (TEAMCITY_VERSION) {
+    return false;
+  }
+
+  if (TERM_PROGRAM) {
+    const version = parseVersion(TERM_PROGRAM_VERSION);
+
+    switch (TERM_PROGRAM) {
+      case "iTerm.app": {
+        if (version.major === 3) {
+          return version.minor >= 1;
+        }
+
+        return version.major > 3;
+      }
+
+      case "WezTerm": {
+        return version.major >= 20_200_620;
+      }
+
+      case "vscode": {
+        // eslint-disable-next-line no-mixed-operators
+        return version.major > 1 || (version.major === 1 && version.minor >= 72);
+      }
+
+      case "ghostty": {
+        return true;
+      }
+      // No default
+    }
+  }
+
+  if (VTE_VERSION) {
+    // 0.50.0 was supposed to support hyperlinks, but throws a segfault
+    if (VTE_VERSION === "0.50.0") {
+      return false;
+    }
+
+    const version = parseVersion(VTE_VERSION);
+    return version.major > 0 || version.minor >= 50;
+  }
+
+  switch (TERM) {
+    case "alacritty": {
+      // Support added in v0.11 (2022-10-13)
+      return true;
+    }
+    // No default
+  }
+
+  return false;
+}
+
+/** Object containing hyperlink support status for stdout and stderr. */
+const supportsHyperlinks = {
+  /** Whether stdout supports hyperlinks. */
+  stdout: createSupportsHyperlinks(process.stdout),
+  /** Whether stderr supports hyperlinks. */
+  stderr: createSupportsHyperlinks(process.stderr),
+};
+
+export default supportsHyperlinks;

packages/cli-v3/src/utilities/terminalLink.ts

@@ -0,0 +1,84 @@
+import ansiEscapes from "ansi-escapes";
+import supportsHyperlinks from "./supportsHyperlinks.js";
+
+export type TerminalLinkOptions = {
+  /**
+    Override the default fallback. If false, the fallback will be disabled.
+    @default `${text} (${url})`
+  */
+  readonly fallback?: ((text: string, url: string) => string) | boolean;
+};
+
+/**
+    Create a clickable link in the terminal's stdout.
+
+    [Supported terminals.](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda)
+    For unsupported terminals, the link will be printed in parens after the text: `My website (https://sindresorhus.com)`,
+    unless the fallback is disabled by setting the `fallback` option to `false`.
+
+    @param text - Text to linkify.
+    @param url - URL to link to.
+
+    @example
+    ```
+    import terminalLink from 'terminal-link';
+
+    const link = terminalLink('My Website', 'https://sindresorhus.com');
+    console.log(link);
+    ```
+*/
+function terminalLink(
+  text: string,
+  url: string,
+  { target = "stdout", ...options }: { target?: "stdout" | "stderr" } & TerminalLinkOptions = {}
+) {
+  if (!supportsHyperlinks[target]) {
+    // If the fallback has been explicitly disabled, don't modify the text itself.
+    if (options.fallback === false) {
+      return text;
+    }
+
+    return typeof options.fallback === "function"
+      ? options.fallback(text, url)
+      : `${text} (\u200B${url}\u200B)`;
+  }
+
+  return ansiEscapes.link(text, url);
+}
+/**
+    Check whether the terminal supports links.
+
+    Prefer just using the default fallback or the `fallback` option whenever possible.
+*/
+terminalLink.isSupported = supportsHyperlinks.stdout;
+terminalLink.stderr = terminalLinkStderr;
+
+/**
+    Create a clickable link in the terminal's stderr.
+
+    [Supported terminals.](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda)
+    For unsupported terminals, the link will be printed in parens after the text: `My website (https://sindresorhus.com)`.
+
+    @param text - Text to linkify.
+    @param url - URL to link to.
+
+    @example
+    ```
+    import terminalLink from 'terminal-link';
+
+    const link = terminalLink.stderr('My Website', 'https://sindresorhus.com');
+    console.error(link);
+    ```
+*/
+function terminalLinkStderr(text: string, url: string, options: TerminalLinkOptions = {}) {
+  return terminalLink(text, url, { target: "stderr", ...options });
+}
+
+/**
+    Check whether the terminal's stderr supports links.
+
+    Prefer just using the default fallback or the `fallback` option whenever possible.
+*/
+terminalLinkStderr.isSupported = supportsHyperlinks.stderr;
+
+export { terminalLink };