@rushstack/terminal 0.19.5 → 0.22.0

package/package.json

@@ -1,9 +1,30 @@
 {
   "name": "@rushstack/terminal",
-  "version": "0.19.5",
+  "version": "0.22.0",
   "description": "User interface primitives for console applications",
-  "main": "lib/index.js",
-  "typings": "dist/terminal.d.ts",
+  "main": "./lib-commonjs/index.js",
+  "module": "./lib-esm/index.js",
+  "types": "./dist/terminal.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/terminal.d.ts",
+      "import": "./lib-esm/index.js",
+      "require": "./lib-commonjs/index.js"
+    },
+    "./lib/*": {
+      "types": "./lib-dts/*.d.ts",
+      "import": "./lib-esm/*.js",
+      "require": "./lib-commonjs/*.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      "lib/*": [
+        "lib-dts/*"
+      ]
+    }
+  },
   "license": "MIT",
   "repository": {
     "url": "https://github.com/microsoft/rushstack.git",
@@ -12,11 +33,11 @@
   },
   "dependencies": {
     "supports-color": "~8.1.1",
-    "@rushstack/node-core-library": "5.19.1",
-    "@rushstack/problem-matcher": "0.1.1"
+    "@rushstack/node-core-library": "5.20.0",
+    "@rushstack/problem-matcher": "0.2.0"
   },
   "devDependencies": {
-    "@rushstack/heft": "1.1.4",
+    "@rushstack/heft": "1.1.7",
     "@types/supports-color": "8.1.3",
     "eslint": "~9.37.0",
     "decoupled-local-node-rig": "1.0.0"
@@ -29,6 +50,7 @@
       "optional": true
     }
   },
+  "sideEffects": false,
   "scripts": {
     "build": "heft build --clean",
     "_phase:build": "heft run --only build -- --clean",

package/lib/StringBufferTerminalProvider.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"StringBufferTerminalProvider.d.ts","sourceRoot":"","sources":["../src/StringBufferTerminalProvider.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,KAAK,iBAAiB,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAGvF;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;;OAKG;IACH,0BAA0B,EAAE,OAAO,CAAC;CACrC;AAED;;;;;;GAMG;AACH,qBAAa,4BAA6B,YAAW,iBAAiB;IACpE,OAAO,CAAC,eAAe,CAAsC;IAC7D,OAAO,CAAC,cAAc,CAAsC;IAC5D,OAAO,CAAC,YAAY,CAAsC;IAC1D,OAAO,CAAC,cAAc,CAAsC;IAC5D,OAAO,CAAC,YAAY,CAAsC;IAE1D,OAAO,CAAC,cAAc,CAAU;gBAEb,aAAa,GAAE,OAAe;IAIjD;;OAEG;IACI,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,wBAAwB,GAAG,IAAI;IA8BpE;;OAEG;IACH,IAAW,YAAY,IAAI,MAAM,CAEhC;IAED;;OAEG;IACH,IAAW,aAAa,IAAI,OAAO,CAElC;IAED;;OAEG;IACI,SAAS,CAAC,OAAO,CAAC,EAAE,0BAA0B,GAAG,MAAM;IAI9D;;OAEG;IACI,UAAU,CAAC,OAAO,CAAC,EAAE,0BAA0B,GAAG,MAAM;IAI/D;;OAEG;IACI,gBAAgB,CAAC,OAAO,CAAC,EAAE,0BAA0B,GAAG,MAAM;IAIrE;;OAEG;IACI,cAAc,CAAC,OAAO,CAAC,EAAE,0BAA0B,GAAG,MAAM;IAInE;;OAEG;IACI,cAAc,CAAC,OAAO,CAAC,EAAE,0BAA0B,GAAG,MAAM;IAInE;;OAEG;IACI,gBAAgB,CAAC,OAAO,CAAC,EAAE,0BAA0B,GAAG,MAAM;IAIrE,OAAO,CAAC,gBAAgB;CAezB"}

package/lib/StringBufferTerminalProvider.js

@@ -1,116 +0,0 @@
-"use strict";
-// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
-// See LICENSE in the project root for license information.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StringBufferTerminalProvider = void 0;
-const node_core_library_1 = require("@rushstack/node-core-library");
-const ITerminalProvider_1 = require("./ITerminalProvider");
-const AnsiEscape_1 = require("./AnsiEscape");
-/**
- * Terminal provider that stores written data in buffers separated by severity.
- * This terminal provider is designed to be used when code that prints to a terminal
- * is being unit tested.
- *
- * @beta
- */
-class StringBufferTerminalProvider {
-    constructor(supportsColor = false) {
-        this._standardBuffer = new node_core_library_1.StringBuilder();
-        this._verboseBuffer = new node_core_library_1.StringBuilder();
-        this._debugBuffer = new node_core_library_1.StringBuilder();
-        this._warningBuffer = new node_core_library_1.StringBuilder();
-        this._errorBuffer = new node_core_library_1.StringBuilder();
-        this._supportsColor = supportsColor;
-    }
-    /**
-     * {@inheritDoc ITerminalProvider.write}
-     */
-    write(data, severity) {
-        switch (severity) {
-            case ITerminalProvider_1.TerminalProviderSeverity.warning: {
-                this._warningBuffer.append(data);
-                break;
-            }
-            case ITerminalProvider_1.TerminalProviderSeverity.error: {
-                this._errorBuffer.append(data);
-                break;
-            }
-            case ITerminalProvider_1.TerminalProviderSeverity.verbose: {
-                this._verboseBuffer.append(data);
-                break;
-            }
-            case ITerminalProvider_1.TerminalProviderSeverity.debug: {
-                this._debugBuffer.append(data);
-                break;
-            }
-            case ITerminalProvider_1.TerminalProviderSeverity.log:
-            default: {
-                this._standardBuffer.append(data);
-                break;
-            }
-        }
-    }
-    /**
-     * {@inheritDoc ITerminalProvider.eolCharacter}
-     */
-    get eolCharacter() {
-        return '\n';
-    }
-    /**
-     * {@inheritDoc ITerminalProvider.supportsColor}
-     */
-    get supportsColor() {
-        return this._supportsColor;
-    }
-    /**
-     * Get everything that has been written at log-level severity.
-     */
-    getOutput(options) {
-        return this._normalizeOutput(this._standardBuffer.toString(), options);
-    }
-    /**
-     * @deprecated - use {@link StringBufferTerminalProvider.getVerboseOutput}
-     */
-    getVerbose(options) {
-        return this.getVerboseOutput(options);
-    }
-    /**
-     * Get everything that has been written at verbose-level severity.
-     */
-    getVerboseOutput(options) {
-        return this._normalizeOutput(this._verboseBuffer.toString(), options);
-    }
-    /**
-     * Get everything that has been written at debug-level severity.
-     */
-    getDebugOutput(options) {
-        return this._normalizeOutput(this._debugBuffer.toString(), options);
-    }
-    /**
-     * Get everything that has been written at error-level severity.
-     */
-    getErrorOutput(options) {
-        return this._normalizeOutput(this._errorBuffer.toString(), options);
-    }
-    /**
-     * Get everything that has been written at warning-level severity.
-     */
-    getWarningOutput(options) {
-        return this._normalizeOutput(this._warningBuffer.toString(), options);
-    }
-    _normalizeOutput(s, options) {
-        options = {
-            normalizeSpecialCharacters: true,
-            ...(options || {})
-        };
-        s = node_core_library_1.Text.convertToLf(s);
-        if (options.normalizeSpecialCharacters) {
-            return AnsiEscape_1.AnsiEscape.formatForTests(s, { encodeNewlines: true });
-        }
-        else {
-            return s;
-        }
-    }
-}
-exports.StringBufferTerminalProvider = StringBufferTerminalProvider;
-//# sourceMappingURL=StringBufferTerminalProvider.js.map

package/lib/StringBufferTerminalProvider.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"StringBufferTerminalProvider.js","sourceRoot":"","sources":["../src/StringBufferTerminalProvider.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,oEAAmE;AAEnE,2DAAuF;AACvF,6CAA0C;AAe1C;;;;;;GAMG;AACH,MAAa,4BAA4B;IASvC,YAAmB,gBAAyB,KAAK;QARzC,oBAAe,GAAkB,IAAI,iCAAa,EAAE,CAAC;QACrD,mBAAc,GAAkB,IAAI,iCAAa,EAAE,CAAC;QACpD,iBAAY,GAAkB,IAAI,iCAAa,EAAE,CAAC;QAClD,mBAAc,GAAkB,IAAI,iCAAa,EAAE,CAAC;QACpD,iBAAY,GAAkB,IAAI,iCAAa,EAAE,CAAC;QAKxD,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;IACtC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAY,EAAE,QAAkC;QAC3D,QAAQ,QAAQ,EAAE,CAAC;YACjB,KAAK,4CAAwB,CAAC,OAAO,CAAC,CAAC,CAAC;gBACtC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBACjC,MAAM;YACR,CAAC;YAED,KAAK,4CAAwB,CAAC,KAAK,CAAC,CAAC,CAAC;gBACpC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC/B,MAAM;YACR,CAAC;YAED,KAAK,4CAAwB,CAAC,OAAO,CAAC,CAAC,CAAC;gBACtC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBACjC,MAAM;YACR,CAAC;YAED,KAAK,4CAAwB,CAAC,KAAK,CAAC,CAAC,CAAC;gBACpC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC/B,MAAM;YACR,CAAC;YAED,KAAK,4CAAwB,CAAC,GAAG,CAAC;YAClC,OAAO,CAAC,CAAC,CAAC;gBACR,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAClC,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,OAAoC;QACnD,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;OAEG;IACI,UAAU,CAAC,OAAoC;QACpD,OAAO,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;OAEG;IACI,gBAAgB,CAAC,OAAoC;QAC1D,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,OAAoC;QACxD,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,OAAoC;QACxD,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACI,gBAAgB,CAAC,OAAoC;QAC1D,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAEO,gBAAgB,CAAC,CAAS,EAAE,OAA+C;QACjF,OAAO,GAAG;YACR,0BAA0B,EAAE,IAAI;YAEhC,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC;SACnB,CAAC;QAEF,CAAC,GAAG,wBAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;QAExB,IAAI,OAAO,CAAC,0BAA0B,EAAE,CAAC;YACvC,OAAO,uBAAU,CAAC,cAAc,CAAC,CAAC,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC;QAChE,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,CAAC;QACX,CAAC;IACH,CAAC;CACF;AArHD,oEAqHC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { StringBuilder, Text } from '@rushstack/node-core-library';\n\nimport { type ITerminalProvider, TerminalProviderSeverity } from './ITerminalProvider';\nimport { AnsiEscape } from './AnsiEscape';\n\n/**\n * @beta\n */\nexport interface IStringBufferOutputOptions {\n  /**\n   * If set to true, special characters like \\\\n, \\\\r, and the \\\\u001b character\n   * in color control tokens will get normalized to [-n-], [-r-], and [-x-] respectively\n   *\n   * This option defaults to `true`\n   */\n  normalizeSpecialCharacters: boolean;\n}\n\n/**\n * Terminal provider that stores written data in buffers separated by severity.\n * This terminal provider is designed to be used when code that prints to a terminal\n * is being unit tested.\n *\n * @beta\n */\nexport class StringBufferTerminalProvider implements ITerminalProvider {\n  private _standardBuffer: StringBuilder = new StringBuilder();\n  private _verboseBuffer: StringBuilder = new StringBuilder();\n  private _debugBuffer: StringBuilder = new StringBuilder();\n  private _warningBuffer: StringBuilder = new StringBuilder();\n  private _errorBuffer: StringBuilder = new StringBuilder();\n\n  private _supportsColor: boolean;\n\n  public constructor(supportsColor: boolean = false) {\n    this._supportsColor = supportsColor;\n  }\n\n  /**\n   * {@inheritDoc ITerminalProvider.write}\n   */\n  public write(data: string, severity: TerminalProviderSeverity): void {\n    switch (severity) {\n      case TerminalProviderSeverity.warning: {\n        this._warningBuffer.append(data);\n        break;\n      }\n\n      case TerminalProviderSeverity.error: {\n        this._errorBuffer.append(data);\n        break;\n      }\n\n      case TerminalProviderSeverity.verbose: {\n        this._verboseBuffer.append(data);\n        break;\n      }\n\n      case TerminalProviderSeverity.debug: {\n        this._debugBuffer.append(data);\n        break;\n      }\n\n      case TerminalProviderSeverity.log:\n      default: {\n        this._standardBuffer.append(data);\n        break;\n      }\n    }\n  }\n\n  /**\n   * {@inheritDoc ITerminalProvider.eolCharacter}\n   */\n  public get eolCharacter(): string {\n    return '\\n';\n  }\n\n  /**\n   * {@inheritDoc ITerminalProvider.supportsColor}\n   */\n  public get supportsColor(): boolean {\n    return this._supportsColor;\n  }\n\n  /**\n   * Get everything that has been written at log-level severity.\n   */\n  public getOutput(options?: IStringBufferOutputOptions): string {\n    return this._normalizeOutput(this._standardBuffer.toString(), options);\n  }\n\n  /**\n   * @deprecated - use {@link StringBufferTerminalProvider.getVerboseOutput}\n   */\n  public getVerbose(options?: IStringBufferOutputOptions): string {\n    return this.getVerboseOutput(options);\n  }\n\n  /**\n   * Get everything that has been written at verbose-level severity.\n   */\n  public getVerboseOutput(options?: IStringBufferOutputOptions): string {\n    return this._normalizeOutput(this._verboseBuffer.toString(), options);\n  }\n\n  /**\n   * Get everything that has been written at debug-level severity.\n   */\n  public getDebugOutput(options?: IStringBufferOutputOptions): string {\n    return this._normalizeOutput(this._debugBuffer.toString(), options);\n  }\n\n  /**\n   * Get everything that has been written at error-level severity.\n   */\n  public getErrorOutput(options?: IStringBufferOutputOptions): string {\n    return this._normalizeOutput(this._errorBuffer.toString(), options);\n  }\n\n  /**\n   * Get everything that has been written at warning-level severity.\n   */\n  public getWarningOutput(options?: IStringBufferOutputOptions): string {\n    return this._normalizeOutput(this._warningBuffer.toString(), options);\n  }\n\n  private _normalizeOutput(s: string, options: IStringBufferOutputOptions | undefined): string {\n    options = {\n      normalizeSpecialCharacters: true,\n\n      ...(options || {})\n    };\n\n    s = Text.convertToLf(s);\n\n    if (options.normalizeSpecialCharacters) {\n      return AnsiEscape.formatForTests(s, { encodeNewlines: true });\n    } else {\n      return s;\n    }\n  }\n}\n"]}