xprogress 0.19.0 → 0.19.2

package/README.md

@@ -79,6 +79,7 @@ const bar = new ProgressBar(100, [20, 44]);
 - <a id="globopts:template"></a> `template`: &lt;[string][]|[string][][]&gt; The template to use for the progressbar view. This is parsed by [stringd][]. with [`this.variables`](#globopts:variables) **Default**: `''`.
 - <a id="globopts:variables"></a> `variables`: &lt;[VariableOpts](#variableopts)&gt; Variables with which to parse [`this.template`](#globopts:template), extended with [`cStringd.raw`][cstringd:raw].
 - `forceFirst`: &lt;[boolean][]&gt; Whether or not to force a multi-bar progressbar to a single bar (useful either when terminal width is too small or when filled with excess addons). **Default**: `false`.
+- `writeStream`: &lt;[WriteStream][]&gt; The tty-ish writable stream we are writing to. **Default**: [stdout](https://nodejs.org/api/process.html#processstdout).
 
 The global options shared by both [ProgressBar](#progressbar) and [ProgressStream](#progressstream).
 
@@ -134,7 +135,7 @@ npm install
 
 ## License
 
-[Apache 2.0][license] © **Miraculous Owonubi** ([@miraclx][author-url]) &lt;omiraculous@gmail.com&gt;
+[Apache 2.0][license] © **Miraculous Owonubi** ([@miraclx][author-url]) &lt;<omiraculous@gmail.com>&gt;
 
 [BarOpts]: #globopts
 
@@ -144,7 +145,6 @@ npm install
 [stringd]:  https://github.com/miraclx/stringd "NodeJS String Variable Parser"
 [xbytes]:  https://github.com/miraclx/xbytes "NodeJS ByteParser"
 [prettyMs]:  https://github.com/sindresorhus/pretty-ms "Convert milliseconds to a human readable string: `1337000000` → `15d 11h 23m 20s`"
-[cstringd]:  https://github.com/miraclx/stringd-colors "ANSI colors for stringd formatting"
 [pad-ratio]:  https://github.com/miraclx/pad-ratio "Pad or trim an array to sum up to a maximum value"
 [hybridinput]:  https://github.com/miraclx/pad-ratio#hybridinput
 [ProgressStreamSlice]: https://github.com/freeall/progress-stream#progress
@@ -152,7 +152,6 @@ npm install
 [cstringd:raw]:  https://github.com/miraclx/stringd-colors#cstringdraw "Raw ANSI codes for stringd-colors"
 
 [author-url]: https://github.com/miraclx
-[ansi-styles]:  https://github.com/chalk/ansi-styles "ANSI escape codes for styling strings in the terminal"
 [xprogress-result]: screenshots/example.gif "StringD Colors Example"
 
 [npm-url]: https://npmjs.org/package/xprogress
@@ -162,8 +161,8 @@ npm install
 [downloads-image]: https://badgen.net/npm/dm/xprogress
 
 [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object
-[regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp
-[function]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function
 [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type
 [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type
 [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type
+
+[WriteStream]: https://nodejs.org/api/tty.html#class-ttywritestream

package/index.d.ts

@@ -425,6 +425,7 @@ namespace Core {
     template: string | string[];
     variables: ProgressBar.VariableOpts;
     forceFirst: boolean;
+    writeStream: WriteStream;
   }
   interface SpecOpts {
     blot: boolean;

package/index.js

@@ -87,16 +87,26 @@ const streamOpts = {
  * Get a persistent tty output stream
  * @returns {tty.WriteStream} The writable stream instance similar to `process.stdout`
  */
-function getPersistentStdout() {
+export function getPersistentStdout(device = getPersistentStdout.stdout) {
   const self = getPersistentStdout;
   self.stdout =
-    self.stdout && self.stdout.isTTY
+    device && device.isTTY
+      ? device
+      : self.stdout && self.stdout.isTTY
       ? self.stdout
       : process.stdout.isTTY
       ? process.stdout
       : process.stderr.isTTY
       ? process.stderr
-      : new tty.WriteStream(openSync('/dev/tty', 'w'));
+      : null;
+  if (!self.stdout) {
+    try {
+      const fd = openSync('/dev/tty', 'w');
+      self.stdout = new tty.WriteStream(fd);
+    } catch (e) {
+      if (e.code !== 'ENXIO') throw e;
+    }
+  }
   return self.stdout;
 }
 
@@ -179,7 +189,7 @@ export default class ProgressBar {
       label: this.opts.label,
       append: [],
       length: this.opts.length,
-      stdout: getPersistentStdout(),
+      stdout: getPersistentStdout(this.opts.writeStream),
       pulsateSlots: [
         [0, 0],
         [this.opts.bar.pulsateLength, 100],
@@ -218,7 +228,7 @@ export default class ProgressBar {
    * @param {number} [value] The value to set the progressBar length to
    */
   length(value) {
-    const len = getPersistentStdout().columns;
+    const len = this.cores.stdout.columns;
     const core = this.cores.length;
     if (value && ['function', 'number'].includes(typeof value)) {
       this.cores.length = value;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xprogress",
-  "version": "0.19.0",
+  "version": "0.19.2",
   "description": "Dynamic, Flexible, extensible progressive CLI bar for the terminal built with NodeJS",
   "exports": "./index.js",
   "type": "module",
@@ -41,7 +41,6 @@
   "devDependencies": {
     "eslint": "8.19.0",
     "eslint-plugin-prettier": "4.2.1",
-    "jest": "^28.1.2",
     "prettier": "2.7.1"
   },
   "dependencies": {
@@ -53,10 +52,5 @@
     "stringd": "^2.2.0",
     "stringd-colors": "^1.10.0",
     "xbytes": "^1.6.1"
-  },
-  "homepage": "https://github.com/miraclx/xprogress#readme",
-  "directories": {
-    "lib": "lib",
-    "test": "test"
   }
 }