Merge pull request #3176 from iclanton/move-terminal

Move `Terminal` from node-core-library to the terminal package.
microsoft · Feb 17, 2024 · e91545e · e91545e
2 parents c3a9c7a + 3707ab0
commit e91545e
Show file tree

Hide file tree

Showing 239 changed files with 4,296 additions and 3,256 deletions.
diff --git a/apps/heft/package.json b/apps/heft/package.json
@@ -38,6 +38,7 @@
     "@rushstack/node-core-library": "workspace:*",
     "@rushstack/operation-graph": "workspace:*",
     "@rushstack/rig-package": "workspace:*",
+    "@rushstack/terminal": "workspace:*",
     "@rushstack/ts-command-line": "workspace:*",
     "@types/tapable": "1.0.6",
     "chokidar": "~3.4.0",

diff --git a/apps/heft/src/cli/HeftActionRunner.ts b/apps/heft/src/cli/HeftActionRunner.ts
@@ -5,14 +5,8 @@ import { performance } from 'perf_hooks';
 import { createInterface, type Interface as ReadlineInterface } from 'readline';
 import os from 'os';
 
-import {
-  AlreadyReportedError,
-  Colors,
-  ConsoleTerminalProvider,
-  InternalError,
-  type ITerminal,
-  type IPackageJson
-} from '@rushstack/node-core-library';
+import { AlreadyReportedError, InternalError, type IPackageJson } from '@rushstack/node-core-library';
+import { Colorize, ConsoleTerminalProvider, type ITerminal } from '@rushstack/terminal';
 import {
   type IOperationExecutionOptions,
   type IWatchLoopState,
@@ -93,7 +87,7 @@ export function ensureCliAbortSignal(terminal: ITerminal): AbortSignal {
         process.exit(1);
       } else {
         terminal.writeLine(
-          Colors.yellow(Colors.bold(`Canceling... Press Ctrl+C again to forcibly terminate.`))
+          Colorize.yellow(Colorize.bold(`Canceling... Press Ctrl+C again to forcibly terminate.`))
         );
       }
 
@@ -150,8 +144,8 @@ export async function runWithLoggingAsync(
     const durationSeconds: number = Math.round(duration) / 1000;
     const finishedLoggingLine: string = `-------------------- ${finishedLoggingWord} (${durationSeconds}s) --------------------`;
     terminal.writeLine(
-      Colors.bold(
-        (encounteredError ? Colors.red : encounteredWarnings ? Colors.yellow : Colors.green)(
+      Colorize.bold(
+        (encounteredError ? Colorize.red : encounteredWarnings ? Colorize.yellow : Colorize.green)(
           finishedLoggingLine
         )
       )
@@ -313,7 +307,7 @@ export class HeftActionRunner {
           await watchLoop.runIPCAsync();
         } else {
           await watchLoop.runUntilAbortedAsync(cliAbortSignal, () => {
-            terminal.writeLine(Colors.bold('Waiting for changes. Press CTRL + C to exit...'));
+            terminal.writeLine(Colorize.bold('Waiting for changes. Press CTRL + C to exit...'));
             terminal.writeLine('');
           });
         }
@@ -336,16 +330,16 @@ export class HeftActionRunner {
         // Write an empty line to the terminal for separation between iterations. We've already iterated
         // at this point, so log out that we're about to start a new run.
         terminal.writeLine('');
-        terminal.writeLine(Colors.bold('Starting incremental build...'));
+        terminal.writeLine(Colorize.bold('Starting incremental build...'));
       },
       executeAsync: (state: IWatchLoopState): Promise<OperationStatus> => {
         return this._executeOnceAsync(executionManager, state.abortSignal, state.requestRun);
       },
       onRequestRun: (requestor?: string) => {
-        terminal.writeLine(Colors.bold(`New run requested by ${requestor || 'unknown task'}`));
+        terminal.writeLine(Colorize.bold(`New run requested by ${requestor || 'unknown task'}`));
       },
       onAbort: () => {
-        terminal.writeLine(Colors.bold(`Cancelling incremental build...`));
+        terminal.writeLine(Colorize.bold(`Cancelling incremental build...`));
       }
     });
     return watchLoop;
@@ -392,7 +386,7 @@ export class HeftActionRunner {
             // Only write once, and write with yellow to make it stand out without writing a warning to stderr
             hasWarnedAboutSkippedPhases = true;
             this._terminal.writeLine(
-              Colors.bold(
+              Colorize.bold(
                 'The provided list of phases does not contain all phase dependencies. You may need to run the ' +
                   'excluded phases manually.'
               )

diff --git a/apps/heft/src/cli/HeftCommandLineParser.ts b/apps/heft/src/cli/HeftCommandLineParser.ts
@@ -7,13 +7,8 @@ import {
   type CommandLineFlagParameter,
   type CommandLineAction
 } from '@rushstack/ts-command-line';
-import {
-  Terminal,
-  InternalError,
-  ConsoleTerminalProvider,
-  AlreadyReportedError,
-  type ITerminal
-} from '@rushstack/node-core-library';
+import { InternalError, AlreadyReportedError } from '@rushstack/node-core-library';
+import { Terminal, ConsoleTerminalProvider, type ITerminal } from '@rushstack/terminal';
 
 import { MetricsCollector } from '../metrics/MetricsCollector';
 import { HeftConfiguration } from '../configuration/HeftConfiguration';

diff --git a/apps/heft/src/cli/actions/AliasAction.ts b/apps/heft/src/cli/actions/AliasAction.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
-import type { ITerminal } from '@rushstack/node-core-library';
+import type { ITerminal } from '@rushstack/terminal';
 import {
   AliasCommandLineAction,
   type IAliasCommandLineActionOptions,

diff --git a/apps/heft/src/cli/actions/CleanAction.ts b/apps/heft/src/cli/actions/CleanAction.ts
@@ -6,7 +6,7 @@ import {
   type CommandLineFlagParameter,
   type CommandLineStringListParameter
 } from '@rushstack/ts-command-line';
-import type { ITerminal } from '@rushstack/node-core-library';
+import type { ITerminal } from '@rushstack/terminal';
 import { OperationStatus } from '@rushstack/operation-graph';
 
 import type { IHeftAction, IHeftActionOptions } from './IHeftAction';

diff --git a/apps/heft/src/cli/actions/IHeftAction.ts b/apps/heft/src/cli/actions/IHeftAction.ts
@@ -2,7 +2,7 @@
 // See LICENSE in the project root for license information.
 
 import type { CommandLineAction } from '@rushstack/ts-command-line';
-import type { ITerminal } from '@rushstack/node-core-library';
+import type { ITerminal } from '@rushstack/terminal';
 
 import type { HeftConfiguration } from '../../configuration/HeftConfiguration';
 import type { MetricsCollector } from '../../metrics/MetricsCollector';

diff --git a/apps/heft/src/cli/actions/RunAction.ts b/apps/heft/src/cli/actions/RunAction.ts
@@ -6,7 +6,8 @@ import {
   type CommandLineParameterProvider,
   type CommandLineStringListParameter
 } from '@rushstack/ts-command-line';
-import { AlreadyReportedError, type ITerminal } from '@rushstack/node-core-library';
+import { AlreadyReportedError } from '@rushstack/node-core-library';
+import type { ITerminal } from '@rushstack/terminal';
 
 import { Selection } from '../../utilities/Selection';
 import { HeftActionRunner } from '../HeftActionRunner';

diff --git a/apps/heft/src/configuration/HeftConfiguration.ts b/apps/heft/src/configuration/HeftConfiguration.ts
@@ -2,14 +2,8 @@
 // See LICENSE in the project root for license information.
 
 import * as path from 'path';
-import {
-  Terminal,
-  type ITerminalProvider,
-  type IPackageJson,
-  PackageJsonLookup,
-  InternalError,
-  type ITerminal
-} from '@rushstack/node-core-library';
+import { type IPackageJson, PackageJsonLookup, InternalError } from '@rushstack/node-core-library';
+import { Terminal, type ITerminalProvider, type ITerminal } from '@rushstack/terminal';
 import { trueCasePathSync } from 'true-case-path';
 import { type IRigConfig, RigConfig } from '@rushstack/rig-package';
 

diff --git a/apps/heft/src/configuration/RigPackageResolver.ts b/apps/heft/src/configuration/RigPackageResolver.ts
@@ -5,10 +5,10 @@ import * as path from 'path';
 import {
   PackageJsonLookup,
   Import,
-  type ITerminal,
   type INodePackageJson,
   type IPackageJson
 } from '@rushstack/node-core-library';
+import type { ITerminal } from '@rushstack/terminal';
 import type { IRigConfig } from '@rushstack/rig-package';
 
 /**

diff --git a/apps/heft/src/pluginFramework/HeftPluginHost.ts b/apps/heft/src/pluginFramework/HeftPluginHost.ts
@@ -2,7 +2,8 @@
 // See LICENSE in the project root for license information.
 
 import { SyncHook } from 'tapable';
-import { InternalError, type ITerminal } from '@rushstack/node-core-library';
+import { InternalError,  } from '@rushstack/node-core-library';
+import type { ITerminal } from '@rushstack/terminal';
 
 import type { HeftPluginDefinitionBase } from '../configuration/HeftPluginDefinition';
 import type { IHeftPlugin } from './IHeftPlugin';

diff --git a/apps/heft/src/pluginFramework/logging/LoggingManager.ts b/apps/heft/src/pluginFramework/logging/LoggingManager.ts
@@ -5,10 +5,9 @@ import { ScopedLogger } from './ScopedLogger';
 import {
   FileError,
   type FileLocationStyle,
-  type ITerminalProvider,
   type IFileErrorFormattingOptions
 } from '@rushstack/node-core-library';
-
+import type { ITerminalProvider } from '@rushstack/terminal';
 export interface ILoggingManagerOptions {
   terminalProvider: ITerminalProvider;
 }

diff --git a/apps/heft/src/pluginFramework/logging/MockScopedLogger.ts b/apps/heft/src/pluginFramework/logging/MockScopedLogger.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
-import type { ITerminal } from '@rushstack/node-core-library';
+import type { ITerminal } from '@rushstack/terminal';
 
 import type { IScopedLogger } from './ScopedLogger';
 

diff --git a/apps/heft/src/pluginFramework/logging/ScopedLogger.ts b/apps/heft/src/pluginFramework/logging/ScopedLogger.ts
@@ -6,7 +6,7 @@ import {
   Terminal,
   type ITerminalProvider,
   type ITerminal
-} from '@rushstack/node-core-library';
+} from '@rushstack/terminal';
 
 import { LoggingManager } from './LoggingManager';
 

diff --git a/apps/heft/src/plugins/CopyFilesPlugin.ts b/apps/heft/src/plugins/CopyFilesPlugin.ts
@@ -3,7 +3,8 @@
 
 import type * as fs from 'fs';
 import * as path from 'path';
-import { AlreadyExistsBehavior, FileSystem, Async, type ITerminal } from '@rushstack/node-core-library';
+import { AlreadyExistsBehavior, FileSystem, Async } from '@rushstack/node-core-library';
+import type { ITerminal } from '@rushstack/terminal';
 
 import { Constants } from '../utilities/Constants';
 import {

diff --git a/apps/heft/src/plugins/DeleteFilesPlugin.ts b/apps/heft/src/plugins/DeleteFilesPlugin.ts
@@ -2,7 +2,8 @@
 // See LICENSE in the project root for license information.
 
 import type * as fs from 'fs';
-import { FileSystem, Async, type ITerminal } from '@rushstack/node-core-library';
+import { FileSystem, Async } from '@rushstack/node-core-library';
+import type { ITerminal } from '@rushstack/terminal';
 
 import { Constants } from '../utilities/Constants';
 import {

diff --git a/apps/heft/src/utilities/CoreConfigFiles.ts b/apps/heft/src/utilities/CoreConfigFiles.ts
@@ -8,7 +8,8 @@ import {
   PathResolutionMethod,
   type IJsonPathMetadataResolverOptions
 } from '@rushstack/heft-config-file';
-import { Import, PackageJsonLookup, type ITerminal, InternalError } from '@rushstack/node-core-library';
+import { Import, PackageJsonLookup, InternalError } from '@rushstack/node-core-library';
+import type { ITerminal } from '@rushstack/terminal';
 import type { IRigConfig } from '@rushstack/rig-package';
 
 import type { IDeleteOperation } from '../plugins/DeleteFilesPlugin';

diff --git a/apps/rush/package.json b/apps/rush/package.json
@@ -39,7 +39,8 @@
     "@microsoft/rush-lib": "workspace:*",
     "@rushstack/node-core-library": "workspace:*",
     "colors": "~1.2.1",
-    "semver": "~7.5.4"
+    "semver": "~7.5.4",
+    "@rushstack/terminal": "workspace:*"
   },
   "devDependencies": {
     "@rushstack/heft": "workspace:*",

diff --git a/apps/rush/src/start-dev-docs.ts b/apps/rush/src/start-dev-docs.ts
@@ -1,9 +1,9 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
-import { Colors, ConsoleTerminalProvider, Terminal } from '@rushstack/node-core-library';
+import { Colorize, ConsoleTerminalProvider, Terminal } from '@rushstack/terminal';
 
 const terminal: Terminal = new Terminal(new ConsoleTerminalProvider());
 
 terminal.writeLine('For instructions on debugging Rush, please see this documentation:');
-terminal.writeLine(Colors.bold('https://rushjs.io/pages/contributing/debugging/'));
+terminal.writeLine(Colorize.bold('https://rushjs.io/pages/contributing/debugging/'));
diff --git a/apps/rush/src/start.ts b/apps/rush/src/start.ts
@@ -22,12 +22,8 @@ import colors from 'colors/safe';
 import * as os from 'os';
 import * as semver from 'semver';
 
-import {
-  ConsoleTerminalProvider,
-  Text,
-  PackageJsonLookup,
-  type ITerminalProvider
-} from '@rushstack/node-core-library';
+import { Text, PackageJsonLookup } from '@rushstack/node-core-library';
+import { ConsoleTerminalProvider, type ITerminalProvider } from '@rushstack/terminal';
 import { EnvironmentVariableNames } from '@microsoft/rush-lib';
 import * as rushLib from '@microsoft/rush-lib';
 

diff --git a/build-tests/install-test-workspace/package.json b/build-tests/install-test-workspace/package.json
@@ -10,6 +10,7 @@
   "devDependencies": {
     "@microsoft/rush-lib": "workspace:*",
     "@rushstack/node-core-library": "workspace:*",
-    "@rushstack/rush-sdk": "workspace:*"
+    "@rushstack/rush-sdk": "workspace:*",
+    "@rushstack/terminal": "workspace:*"
   }
 }