@vbarbarosh/node-helpers 3.63.2 → 3.65.0

package/package.json

@@ -2,7 +2,7 @@
     "author": "Vladimir Barbarosh <vladimir.barbarosh@gmail.com>",
     "license": "MIT",
     "name": "@vbarbarosh/node-helpers",
-    "version": "3.63.2",
+    "version": "3.65.0",
     "description": "A set of helpers for JavaScript/Node.js",
     "unpkg": "dist/browser.js",
     "jsdelivr": "dist/browser.js",
@@ -28,6 +28,7 @@
         "url": "https://github.com/vbarbarosh/node-helpers/issues"
     },
     "peerDependencies": {
+        "@vbarbarosh/type-helpers": "^0.1.0",
         "axios": "^1.7.9",
         "bluebird": "^3.7.2",
         "csv-parse": "^5.6.0",

package/src/format_progress_bytes.js

@@ -1,7 +1,7 @@
 const format_bytes = require('./format_bytes');
 const format_percents = require('./format_percents');
 const format_seconds = require('./format_seconds');
-const is_number_gt = require('./is_number_gt');
+const is_number_gt = require('@vbarbarosh/type-helpers/src/is_number_gt');
 
 function format_progress_bytes({percents, total, done, rate, eta, duration})
 {

package/src/format_progress_kilo.js

@@ -1,7 +1,7 @@
 const format_kilo = require('./format_kilo');
 const format_percents = require('./format_percents');
 const format_seconds = require('./format_seconds');
-const is_number_gt = require('./is_number_gt');
+const is_number_gt = require('@vbarbarosh/type-helpers/src/is_number_gt');
 
 function format_progress_kilo({percents, total, done, rate, eta, duration})
 {

package/src/fs_copy_excl.js

@@ -0,0 +1,8 @@
+const fs = require('fs');
+
+function fs_copy_excl(src, dest)
+{
+    return fs.promises.copyFile(src, dest, fs.constants.COPYFILE_EXCL);
+}
+
+module.exports = fs_copy_excl;

package/src/fs_path_relative.js

@@ -0,0 +1,8 @@
+const path = require('path');
+
+function fs_path_relative(from, to)
+{
+    return path.relative(from, to);
+}
+
+module.exports = fs_path_relative;

package/src/fs_rmrf.js

@@ -1,14 +1,15 @@
 const Promise = require('bluebird');
 const fs_lstat = require('./fs_lstat');
-const fs_path_resolve = require('./fs_path_resolve');
+const fs_path_join = require('./fs_path_join');
 const fs_readdir = require('./fs_readdir');
 const fs_rm = require('./fs_rm');
 const fs_rmdir = require('./fs_rmdir');
+const ignore = require('./ignore');
 
 /**
  * Remove a file or directory, along with all nested files and directories, recursively.
  */
-async function fs_rmrf(path)
+async function fs_rmrf(path, progress = ignore)
 {
     const lstat = await fs_lstat(path).catch(() => null);
     if (lstat === null) {
@@ -17,10 +18,12 @@ async function fs_rmrf(path)
 
     if (lstat.isDirectory()) {
         const names = await fs_readdir(path);
-        await Promise.all(names.map(v => fs_rmrf(fs_path_resolve(path, v))));
+        await Promise.all(names.map(v => fs_rmrf(fs_path_join(path, v), progress)));
+        progress('rmdir', path);
         await fs_rmdir(path);
     }
     else {
+        progress('rm', path);
         await fs_rm(path);
     }
 }

package/src/http_get_stream.js

@@ -1,5 +1,5 @@
 const axios = require('axios');
-const make_int = require('./make_int');
+const make_int = require('@vbarbarosh/type-helpers/src/make_int');
 
 async function http_get_stream(url, options)
 {

package/src/parallel.js

@@ -1,11 +1,20 @@
 const NotImplemented = require('./errors/NotImplemented');
+const Promise = require('bluebird');
+const is_async_function = require('@vbarbarosh/type-helpers/src/is_async_function');
+const is_async_generator = require('@vbarbarosh/type-helpers/src/is_async_generator');
 
 /**
  * - Run until `spawn` return `null`.
  * - Keep no more than `concurrency` number of workers at a time.
+ *
+ * ⚠️ Warning: `spawn` should not be async function (async functions are always return `promise`).
+ *    Instead, it should be a simple function returning either `null` or a `promise`.
  */
 async function parallel({concurrency, spawn, progress})
 {
+    if (is_async_function(spawn) || is_async_generator(spawn)) {
+        throw new Error('[spawn] should not be async function. Instead, it should be a simple function returning either [null] or a [promise].');
+    }
     const running = [];
     return new Promise(function (resolve, reject) {
         let failed = false;

package/src/parallel.test.js

@@ -0,0 +1,11 @@
+const assert = require('assert');
+const parallel = require('./parallel');
+
+describe('parallel', function () {
+    it('should reject when [spawn] is async function', function () {
+        assert.rejects(parallel({spawn: async function () {}}));
+    })
+    it('should reject when [spawn] is async generator', function () {
+        assert.rejects(parallel({spawn: async function* () {}}));
+    })
+});

package/src/shell_curl_progress.js

@@ -4,6 +4,7 @@ const stream = require('stream');
 const stream_curl_progress = require('./stream_curl_progress');
 const stream_each = require('./stream_each');
 
+// 🦋 TODO ...options
 async function shell_curl_progress(args, {options, user_friendly_status})
 {
     // $ man curl

package/src/is_number.js

@@ -1,6 +0,0 @@
-function is_number(value)
-{
-    return (typeof value === 'number') && isFinite(value);
-}
-
-module.exports = is_number;

package/src/is_number.test.js

@@ -1,20 +0,0 @@
-const assert = require('assert');
-const is_number = require('./is_number');
-
-const items = [
-    ['-inf → false', -Infinity, false],
-    ['+inf → false', +Infinity, false],
-    ['null → false', null, false],
-    ['{} → false', {}, false],
-    ['Symbol() → false', Symbol(), false],
-    ['Function → false', () => 1, false],
-    ['BigInt(1) → false', 1n, false],
-];
-
-describe('is_number', function () {
-    items.forEach(function ([title, input, expected]) {
-        it(title, function () {
-            assert.deepStrictEqual(is_number(input), expected);
-        });
-    });
-});

package/src/is_number_gt.js

@@ -1,8 +0,0 @@
-const is_number = require('./is_number');
-
-function is_number_gt(value, min)
-{
-    return is_number(value) && value > min;
-}
-
-module.exports = is_number_gt;

package/src/make_int.js

@@ -1,15 +0,0 @@
-function make_int(value, default_value = 0, min = Number.MIN_SAFE_INTEGER, max = Number.MAX_SAFE_INTEGER)
-{
-    switch (typeof value) {
-    case 'bigint':
-        return Math.max(min, Math.min(max, Number(value)));
-    case 'symbol':
-        return default_value;
-    }
-    if (value === null || value === undefined || !isFinite(value)) {
-        return default_value;
-    }
-    return Math.max(min, Math.min(max, Math.round(value === 0 ? value : (+value||default_value))));
-}
-
-module.exports = make_int;

package/src/make_number.js

@@ -1,15 +0,0 @@
-function make_number(value, default_value = 0, min = Number.MIN_SAFE_INTEGER, max = Number.MAX_SAFE_INTEGER)
-{
-    switch (typeof value) {
-    case 'bigint':
-        return Number(value);
-    case 'symbol':
-        return default_value;
-    }
-    if (value === null || value === undefined || !isFinite(value)) {
-        return default_value;
-    }
-    return Math.max(min, Math.min(max, Math.round(value === 0 ? value : (+value||default_value))));
-}
-
-module.exports = make_number;

package/src/make_number.test.js

@@ -1,25 +0,0 @@
-const assert = require('assert');
-const make_number = require('./make_number');
-
-const items = [
-    ['null → 0', null, 0],
-    ['undefined → 0', undefined, 0],
-    ['{} → 0', {}, 0],
-    ['nan → 0', NaN, 0],
-    ['-inf → 0', -Infinity, 0],
-    ['+inf → 0', +Infinity, 0],
-    ['false → 0', false, 0],
-    ['true → 1', true, 1],
-    ['Symbol() → 0', Symbol(), 0],
-    ['Function → 0', () => 1, 0],
-    ['BigInt(1) → 1', 1n, 1],
-    ['"123" → 123', '123', 123],
-];
-
-describe('make_number', function () {
-    items.forEach(function ([title, input, expected]) {
-        it(title, function () {
-            assert.deepStrictEqual(make_number(input), expected);
-        });
-    });
-});