@rushstack/terminal - npm Package Compare versions

Comparing version 0.12.3 to 0.13.0

dist/terminal.d.ts

@@ -984,3 +984,3 @@ /**
  */
-export declare const enum TerminalChunkKind {
+export declare enum TerminalChunkKind {
     /**
@@ -987,0 +987,0 @@ * Indicates a `ITerminalChunk` object representing `stdout` console output.

dist/tsdoc-metadata.json

@@ -8,5 +8,5 @@ // This file is read by tools that parse documentation comments conforming to the TSDoc standard.
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.43.7"
+      "packageVersion": "7.46.1"
     }
   ]
 }

lib/DiscardStdoutTransform.js

@@ -6,2 +6,3 @@ "use strict";
 exports.DiscardStdoutTransform = void 0;
+const ITerminalChunk_1 = require("./ITerminalChunk");
 const TerminalTransform_1 = require("./TerminalTransform");
@@ -63,3 +64,3 @@ var State;
         }
-        if (chunk.kind === "O" /* TerminalChunkKind.Stdout */) {
+        if (chunk.kind === ITerminalChunk_1.TerminalChunkKind.Stdout) {
             if (this._state === State.StderrFragment) {
@@ -71,3 +72,3 @@ if (chunk.text.indexOf('\n') >= 0) {
         }
-        else if (chunk.kind === "E" /* TerminalChunkKind.Stderr */) {
+        else if (chunk.kind === ITerminalChunk_1.TerminalChunkKind.Stderr) {
             let correctedText;
@@ -80,3 +81,3 @@ if (this._state === State.InsertLinefeed) {
             }
-            this.destination.writeChunk({ kind: "E" /* TerminalChunkKind.Stderr */, text: correctedText });
+            this.destination.writeChunk({ kind: ITerminalChunk_1.TerminalChunkKind.Stderr, text: correctedText });
             if (correctedText.length > 0) {
@@ -83,0 +84,0 @@ if (correctedText[correctedText.length - 1] === '\n') {

lib/index.d.ts

@@ -10,26 +10,26 @@ /**
  */
-export { ICallbackWritableOptions, CallbackWritable } from './CallbackWritable';
-export { IDiscardStdoutTransformOptions, DiscardStdoutTransform } from './DiscardStdoutTransform';
-export { TerminalChunkKind, ITerminalChunk } from './ITerminalChunk';
+export { type ICallbackWritableOptions, CallbackWritable } from './CallbackWritable';
+export { type IDiscardStdoutTransformOptions, DiscardStdoutTransform } from './DiscardStdoutTransform';
+export { TerminalChunkKind, type ITerminalChunk } from './ITerminalChunk';
 export { MockWritable } from './MockWritable';
-export { INormalizeNewlinesTextRewriterOptions, NormalizeNewlinesTextRewriter } from './NormalizeNewlinesTextRewriter';
+export { type INormalizeNewlinesTextRewriterOptions, NormalizeNewlinesTextRewriter } from './NormalizeNewlinesTextRewriter';
 export { DEFAULT_CONSOLE_WIDTH, PrintUtilities } from './PrintUtilities';
 export { RemoveColorsTextRewriter } from './RemoveColorsTextRewriter';
-export { ISplitterTransformOptions, SplitterTransform } from './SplitterTransform';
-export { IStdioLineTransformOptions, StderrLineTransform } from './StdioLineTransform';
-export { IStdioSummarizerOptions, StdioSummarizer } from './StdioSummarizer';
+export { type ISplitterTransformOptions, SplitterTransform } from './SplitterTransform';
+export { type IStdioLineTransformOptions, StderrLineTransform } from './StdioLineTransform';
+export { type IStdioSummarizerOptions, StdioSummarizer } from './StdioSummarizer';
 export { StdioWritable } from './StdioWritable';
-export { ITerminalTransformOptions, TerminalTransform } from './TerminalTransform';
-export { ITerminalWritableOptions, TerminalWritable } from './TerminalWritable';
-export { TextRewriterState, TextRewriter } from './TextRewriter';
-export { ITextRewriterTransformOptions, TextRewriterTransform } from './TextRewriterTransform';
-export { AnsiEscape, IAnsiEscapeConvertForTestsOptions } from './AnsiEscape';
-export { ITerminal, TerminalWriteParameters, ITerminalWriteOptions } from './ITerminal';
+export { type ITerminalTransformOptions, TerminalTransform } from './TerminalTransform';
+export { type ITerminalWritableOptions, TerminalWritable } from './TerminalWritable';
+export { type TextRewriterState, TextRewriter } from './TextRewriter';
+export { type ITextRewriterTransformOptions, TextRewriterTransform } from './TextRewriterTransform';
+export { AnsiEscape, type IAnsiEscapeConvertForTestsOptions } from './AnsiEscape';
+export type { ITerminal, TerminalWriteParameters, ITerminalWriteOptions } from './ITerminal';
 export { Terminal } from './Terminal';
 export { Colorize } from './Colorize';
-export { ITerminalProvider, TerminalProviderSeverity } from './ITerminalProvider';
-export { ConsoleTerminalProvider, IConsoleTerminalProviderOptions } from './ConsoleTerminalProvider';
-export { StringBufferTerminalProvider, IStringBufferOutputOptions } from './StringBufferTerminalProvider';
-export { PrefixProxyTerminalProvider, IPrefixProxyTerminalProviderOptions, IDynamicPrefixProxyTerminalProviderOptions, IPrefixProxyTerminalProviderOptionsBase, IStaticPrefixProxyTerminalProviderOptions } from './PrefixProxyTerminalProvider';
-export { TerminalStreamWritable, ITerminalStreamWritableOptions } from './TerminalStreamWritable';
+export { type ITerminalProvider, TerminalProviderSeverity } from './ITerminalProvider';
+export { ConsoleTerminalProvider, type IConsoleTerminalProviderOptions } from './ConsoleTerminalProvider';
+export { StringBufferTerminalProvider, type IStringBufferOutputOptions } from './StringBufferTerminalProvider';
+export { PrefixProxyTerminalProvider, type IPrefixProxyTerminalProviderOptions, type IDynamicPrefixProxyTerminalProviderOptions, type IPrefixProxyTerminalProviderOptionsBase, type IStaticPrefixProxyTerminalProviderOptions } from './PrefixProxyTerminalProvider';
+export { TerminalStreamWritable, type ITerminalStreamWritableOptions } from './TerminalStreamWritable';
 //# sourceMappingURL=index.d.ts.map

lib/index.js

@@ -5,3 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TerminalStreamWritable = exports.PrefixProxyTerminalProvider = exports.StringBufferTerminalProvider = exports.ConsoleTerminalProvider = exports.TerminalProviderSeverity = exports.Colorize = exports.Terminal = exports.AnsiEscape = exports.TextRewriterTransform = exports.TextRewriter = exports.TerminalWritable = exports.TerminalTransform = exports.StdioWritable = exports.StdioSummarizer = exports.StderrLineTransform = exports.SplitterTransform = exports.RemoveColorsTextRewriter = exports.PrintUtilities = exports.DEFAULT_CONSOLE_WIDTH = exports.NormalizeNewlinesTextRewriter = exports.MockWritable = exports.DiscardStdoutTransform = exports.CallbackWritable = void 0;
+exports.TerminalStreamWritable = exports.PrefixProxyTerminalProvider = exports.StringBufferTerminalProvider = exports.ConsoleTerminalProvider = exports.TerminalProviderSeverity = exports.Colorize = exports.Terminal = exports.AnsiEscape = exports.TextRewriterTransform = exports.TextRewriter = exports.TerminalWritable = exports.TerminalTransform = exports.StdioWritable = exports.StdioSummarizer = exports.StderrLineTransform = exports.SplitterTransform = exports.RemoveColorsTextRewriter = exports.PrintUtilities = exports.DEFAULT_CONSOLE_WIDTH = exports.NormalizeNewlinesTextRewriter = exports.MockWritable = exports.TerminalChunkKind = exports.DiscardStdoutTransform = exports.CallbackWritable = void 0;
 /**
@@ -20,2 +20,4 @@ * This library implements a system for processing human readable text that
 Object.defineProperty(exports, "DiscardStdoutTransform", { enumerable: true, get: function () { return DiscardStdoutTransform_1.DiscardStdoutTransform; } });
+var ITerminalChunk_1 = require("./ITerminalChunk");
+Object.defineProperty(exports, "TerminalChunkKind", { enumerable: true, get: function () { return ITerminalChunk_1.TerminalChunkKind; } });
 var MockWritable_1 = require("./MockWritable");
@@ -22,0 +24,0 @@ Object.defineProperty(exports, "MockWritable", { enumerable: true, get: function () { return MockWritable_1.MockWritable; } });

lib/ITerminalChunk.d.ts

@@ -5,3 +5,3 @@ /**
  */
-export declare const enum TerminalChunkKind {
+export declare enum TerminalChunkKind {
     /**
@@ -8,0 +8,0 @@ * Indicates a `ITerminalChunk` object representing `stdout` console output.

lib/ITerminalChunk.js

@@ -5,2 +5,18 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.TerminalChunkKind = void 0;
+/**
+ * Specifies the kind of data represented by a {@link ITerminalChunk} object.
+ * @public
+ */
+var TerminalChunkKind;
+(function (TerminalChunkKind) {
+    /**
+     * Indicates a `ITerminalChunk` object representing `stdout` console output.
+     */
+    TerminalChunkKind["Stdout"] = "O";
+    /**
+     * Indicates a `ITerminalChunk` object representing `stderr` console output.
+     */
+    TerminalChunkKind["Stderr"] = "E";
+})(TerminalChunkKind || (exports.TerminalChunkKind = TerminalChunkKind = {}));
 //# sourceMappingURL=ITerminalChunk.js.map

lib/StdioLineTransform.js

@@ -7,2 +7,3 @@ "use strict";
 const node_core_library_1 = require("@rushstack/node-core-library");
+const ITerminalChunk_1 = require("./ITerminalChunk");
 const TerminalTransform_1 = require("./TerminalTransform");
@@ -74,3 +75,3 @@ /**
         while (startIndex < text.length) {
-            if (chunk.kind === "E" /* TerminalChunkKind.Stderr */) {
+            if (chunk.kind === ITerminalChunk_1.TerminalChunkKind.Stderr) {
                 this._accumulatedStderr = true;
@@ -101,3 +102,3 @@ }
             this.destination.writeChunk({
-                kind: "E" /* TerminalChunkKind.Stderr */,
+                kind: ITerminalChunk_1.TerminalChunkKind.Stderr,
                 text: this._accumulatedLine
@@ -108,3 +109,3 @@ });
             this.destination.writeChunk({
-                kind: "O" /* TerminalChunkKind.Stdout */,
+                kind: ITerminalChunk_1.TerminalChunkKind.Stdout,
                 text: this._accumulatedLine
@@ -111,0 +112,0 @@ });

lib/StdioSummarizer.js

@@ -6,2 +6,3 @@ "use strict";
 exports.StdioSummarizer = void 0;
+const ITerminalChunk_1 = require("./ITerminalChunk");
 const TerminalWritable_1 = require("./TerminalWritable");
@@ -74,3 +75,3 @@ /**
         }
-        if (chunk.kind === "E" /* TerminalChunkKind.Stderr */ && !this._abridgedStderr) {
+        if (chunk.kind === ITerminalChunk_1.TerminalChunkKind.Stderr && !this._abridgedStderr) {
             // The first time we see stderr, switch to capturing stderr
@@ -82,3 +83,3 @@ this._abridgedStderr = true;
         }
-        else if (this._abridgedStderr && chunk.kind !== "E" /* TerminalChunkKind.Stderr */) {
+        else if (this._abridgedStderr && chunk.kind !== ITerminalChunk_1.TerminalChunkKind.Stderr) {
             // If we're capturing stderr, then ignore non-stderr input
@@ -85,0 +86,0 @@ return;

lib/StdioWritable.js

@@ -10,2 +10,3 @@ "use strict";
 const process_1 = __importDefault(require("process"));
+const ITerminalChunk_1 = require("./ITerminalChunk");
 const TerminalWritable_1 = require("./TerminalWritable");
@@ -24,6 +25,6 @@ /**
     onWriteChunk(chunk) {
-        if (chunk.kind === "O" /* TerminalChunkKind.Stdout */) {
+        if (chunk.kind === ITerminalChunk_1.TerminalChunkKind.Stdout) {
             process_1.default.stdout.write(chunk.text);
         }
-        else if (chunk.kind === "E" /* TerminalChunkKind.Stderr */) {
+        else if (chunk.kind === ITerminalChunk_1.TerminalChunkKind.Stderr) {
             process_1.default.stderr.write(chunk.text);
@@ -30,0 +31,0 @@ }

lib/TextRewriterTransform.js

@@ -6,2 +6,3 @@ "use strict";
 exports.TextRewriterTransform = void 0;
+const ITerminalChunk_1 = require("./ITerminalChunk");
 const TerminalTransform_1 = require("./TerminalTransform");
@@ -42,6 +43,6 @@ const RemoveColorsTextRewriter_1 = require("./RemoveColorsTextRewriter");
     onWriteChunk(chunk) {
-        if (chunk.kind === "E" /* TerminalChunkKind.Stderr */) {
+        if (chunk.kind === ITerminalChunk_1.TerminalChunkKind.Stderr) {
             this._processText(chunk, this._stderrStates);
         }
-        else if (chunk.kind === "O" /* TerminalChunkKind.Stdout */) {
+        else if (chunk.kind === ITerminalChunk_1.TerminalChunkKind.Stdout) {
             this._processText(chunk, this._stdoutStates);
@@ -89,4 +90,4 @@ }
     onClose() {
-        this._closeRewriters(this._stderrStates, "E" /* TerminalChunkKind.Stderr */);
-        this._closeRewriters(this._stdoutStates, "O" /* TerminalChunkKind.Stdout */);
+        this._closeRewriters(this._stderrStates, ITerminalChunk_1.TerminalChunkKind.Stderr);
+        this._closeRewriters(this._stdoutStates, ITerminalChunk_1.TerminalChunkKind.Stdout);
         this.autocloseDestination();
@@ -93,0 +94,0 @@ }

package.json

 {
   "name": "@rushstack/terminal",
-  "version": "0.12.3",
+  "version": "0.13.0",
   "description": "User interface primitives for console applications",
@@ -15,7 +15,7 @@ "main": "lib/index.js",
     "supports-color": "~8.1.1",
-    "@rushstack/node-core-library": "5.4.0"
+    "@rushstack/node-core-library": "5.4.1"
   },
   "devDependencies": {
-    "@rushstack/heft": "0.66.9",
-    "@rushstack/heft-node-rig": "2.6.7",
+    "@rushstack/heft": "0.66.16",
+    "@rushstack/heft-node-rig": "2.6.14",
     "@types/heft-jest": "1.0.1",
@@ -22,0 +22,0 @@ "@types/node": "18.17.15",

No alert changes

Improved metrics

Total package byte prevSize

362721

0.53%

Lines of code

4659

0.5%

Dependency changes

• + Added

  @rushstack/node-core-library@5.4.1
  (transitive)

• - Removed

  @rushstack/node-core-library@5.4.0
  (transitive)

• Updated

  @rushstack/node-core-library@5.4.1