@rushstack/node-core-library - npm Package Compare versions

Comparing version 3.41.0 to 3.42.0

CHANGELOG.json

@@ -5,2 +5,14 @@ {
     {
+      "version": "3.42.0",
+      "tag": "@rushstack/node-core-library_v3.42.0",
+      "date": "Tue, 05 Oct 2021 15:08:38 GMT",
+      "comments": {
+        "minor": [
+          {
+            "comment": "Expose an ITerminal interface."
+          }
+        ]
+      }
+    },
+    {
       "version": "3.41.0",
@@ -7,0 +19,0 @@ "tag": "@rushstack/node-core-library_v3.41.0",

CHANGELOG.md

 # Change Log - @rushstack/node-core-library
 
-This log was last generated on Fri, 24 Sep 2021 00:09:29 GMT and should not be manually modified.
+This log was last generated on Tue, 05 Oct 2021 15:08:38 GMT and should not be manually modified.
 
+## 3.42.0
+Tue, 05 Oct 2021 15:08:38 GMT
+
+### Minor changes
+
+- Expose an ITerminal interface.
+
 ## 3.41.0
@@ -6,0 +13,0 @@ Fri, 24 Sep 2021 00:09:29 GMT

lib/index.d.ts

@@ -32,2 +32,3 @@ /**
 export { StringBuilder, IStringBuilder } from './StringBuilder';
+export { ITerminal } from './Terminal/ITerminal';
 export { Terminal } from './Terminal/Terminal';
@@ -34,0 +35,0 @@ export { Colors, IColorableSequence, ColorValue, TextAttribute } from './Terminal/Colors';

lib/Terminal/Terminal.d.ts

 import { ITerminalProvider } from './ITerminalProvider';
 import { IColorableSequence } from './Colors';
+import { ITerminal } from './ITerminal';
 /**
@@ -8,63 +9,51 @@ * This class facilitates writing to a console.
  */
-export declare class Terminal {
+export declare class Terminal implements ITerminal {
     private _providers;
     constructor(provider: ITerminalProvider);
     /**
-     * Subscribe a new terminal provider.
+     * {@inheritdoc ITerminal.registerProvider}
      */
     registerProvider(provider: ITerminalProvider): void;
     /**
-     * Unsubscribe a terminal provider. If the provider isn't subscribed, this function does nothing.
+     * {@inheritdoc ITerminal.unregisterProvider}
      */
     unregisterProvider(provider: ITerminalProvider): void;
     /**
-     * Write a generic message to the terminal
+     * {@inheritdoc ITerminal.write}
      */
     write(...messageParts: (string | IColorableSequence)[]): void;
     /**
-     * Write a generic message to the terminal, followed by a newline
+     * {@inheritdoc ITerminal.writeLine}
      */
     writeLine(...messageParts: (string | IColorableSequence)[]): void;
     /**
-     * Write a warning message to the console with yellow text.
-     *
-     * @remarks
-     * The yellow color takes precedence over any other foreground colors set.
+     * {@inheritdoc ITerminal.writeWarning}
      */
     writeWarning(...messageParts: (string | IColorableSequence)[]): void;
     /**
-     * Write a warning message to the console with yellow text, followed by a newline.
-     *
-     * @remarks
-     * The yellow color takes precedence over any other foreground colors set.
+     * {@inheritdoc ITerminal.writeWarningLine}
      */
     writeWarningLine(...messageParts: (string | IColorableSequence)[]): void;
     /**
-     * Write an error message to the console with red text.
-     *
-     * @remarks
-     * The red color takes precedence over any other foreground colors set.
+     * {@inheritdoc ITerminal.writeError}
      */
     writeError(...messageParts: (string | IColorableSequence)[]): void;
     /**
-     * Write an error message to the console with red text, followed by a newline.
-     *
-     * @remarks
-     * The red color takes precedence over any other foreground colors set.
+     * {@inheritdoc ITerminal.writeErrorLine}
      */
     writeErrorLine(...messageParts: (string | IColorableSequence)[]): void;
     /**
-     * Write a verbose-level message.
+     * {@inheritdoc ITerminal.writeVerbose}
      */
     writeVerbose(...messageParts: (string | IColorableSequence)[]): void;
     /**
-     * Write a verbose-level message followed by a newline.
+     * {@inheritdoc ITerminal.writeVerboseLine}
      */
     writeVerboseLine(...messageParts: (string | IColorableSequence)[]): void;
     /**
-     * Write a debug-level message.
+     * {@inheritdoc ITerminal.writeDebug}
      */
     writeDebug(...messageParts: (string | IColorableSequence)[]): void;
     /**
-     * Write a debug-level message followed by a newline.
+     * {@inheritdoc ITerminal.writeDebugLine}
      */
@@ -71,0 +60,0 @@ writeDebugLine(...messageParts: (string | IColorableSequence)[]): void;

lib/Terminal/Terminal.js

@@ -19,3 +19,3 @@ "use strict";
     /**
-     * Subscribe a new terminal provider.
+     * {@inheritdoc ITerminal.registerProvider}
      */
@@ -26,3 +26,3 @@ registerProvider(provider) {
     /**
-     * Unsubscribe a terminal provider. If the provider isn't subscribed, this function does nothing.
+     * {@inheritdoc ITerminal.unregisterProvider}
      */
@@ -35,3 +35,3 @@ unregisterProvider(provider) {
     /**
-     * Write a generic message to the terminal
+     * {@inheritdoc ITerminal.write}
      */
@@ -42,3 +42,3 @@ write(...messageParts) {
     /**
-     * Write a generic message to the terminal, followed by a newline
+     * {@inheritdoc ITerminal.writeLine}
      */
@@ -49,6 +49,3 @@ writeLine(...messageParts) {
     /**
-     * Write a warning message to the console with yellow text.
-     *
-     * @remarks
-     * The yellow color takes precedence over any other foreground colors set.
+     * {@inheritdoc ITerminal.writeWarning}
      */
@@ -59,6 +56,3 @@ writeWarning(...messageParts) {
     /**
-     * Write a warning message to the console with yellow text, followed by a newline.
-     *
-     * @remarks
-     * The yellow color takes precedence over any other foreground colors set.
+     * {@inheritdoc ITerminal.writeWarningLine}
      */
@@ -72,6 +66,3 @@ writeWarningLine(...messageParts) {
     /**
-     * Write an error message to the console with red text.
-     *
-     * @remarks
-     * The red color takes precedence over any other foreground colors set.
+     * {@inheritdoc ITerminal.writeError}
      */
@@ -82,6 +73,3 @@ writeError(...messageParts) {
     /**
-     * Write an error message to the console with red text, followed by a newline.
-     *
-     * @remarks
-     * The red color takes precedence over any other foreground colors set.
+     * {@inheritdoc ITerminal.writeErrorLine}
      */
@@ -95,3 +83,3 @@ writeErrorLine(...messageParts) {
     /**
-     * Write a verbose-level message.
+     * {@inheritdoc ITerminal.writeVerbose}
      */
@@ -102,3 +90,3 @@ writeVerbose(...messageParts) {
     /**
-     * Write a verbose-level message followed by a newline.
+     * {@inheritdoc ITerminal.writeVerboseLine}
      */
@@ -109,3 +97,3 @@ writeVerboseLine(...messageParts) {
     /**
-     * Write a debug-level message.
+     * {@inheritdoc ITerminal.writeDebug}
      */
@@ -116,3 +104,3 @@ writeDebug(...messageParts) {
     /**
-     * Write a debug-level message followed by a newline.
+     * {@inheritdoc ITerminal.writeDebugLine}
      */
@@ -119,0 +107,0 @@ writeDebugLine(...messageParts) {

package.json

 {
 	"name": "@rushstack/node-core-library",
-	"version": "3.41.0",
+	"version": "3.42.0",
 	"description": "Core libraries that every NodeJS toolchain project should use",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1005829

increased by0.73%

Number of package files

147

increased by2.8%

Lines of code

13997

increased by0.82%

No dependency changes