@hypernym/utils 1.0.0 → 1.1.0

package/dist/node.cjs

@@ -0,0 +1,65 @@
+'use strict';
+
+var promises = require('node:fs/promises');
+var node_path = require('node:path');
+var formatBytes = require('../mix/format-bytes');
+
+async function exists(path) {
+  return await promises.access(path, promises.constants.F_OK).then(() => true).catch(() => false);
+}
+
+async function getDirStats(dirPath, options) {
+  const dirFiles = await promises.readdir(dirPath);
+  const dirBase = node_path.basename(dirPath);
+  let dirStats = [];
+  const subdirList = [];
+  const fileList = [];
+  let dirSize = 0;
+  let dirIndex = 0;
+  let fileIndex = -1;
+  let subdirIndex = -1;
+  for (const file of dirFiles) {
+    const filePath = node_path.resolve(dirPath, file);
+    const fileStat = await promises.stat(filePath);
+    if (fileStat.isDirectory()) {
+      subdirIndex++;
+      subdirList.push({
+        index: subdirIndex,
+        path: filePath,
+        base: file
+      });
+      if (options?.recursive) {
+        dirBase === dirPath ? dirBase : node_path.basename(filePath);
+        const stats = await getDirStats(filePath);
+        const updateDirStats = { ...stats[0], ...{ index: dirIndex++ } };
+        dirStats = [...dirStats, updateDirStats];
+      }
+    } else {
+      const { base, name, ext } = node_path.parse(file);
+      const path = filePath;
+      const size = formatBytes.formatBytes(fileStat.size);
+      fileIndex++;
+      dirSize += fileStat.size;
+      fileList.push({
+        index: fileIndex,
+        path,
+        base,
+        name,
+        ext,
+        size
+      });
+    }
+  }
+  dirStats.push({
+    index: dirIndex,
+    path: dirPath,
+    base: dirBase,
+    size: formatBytes.formatBytes(dirSize),
+    subdirs: subdirList,
+    files: fileList
+  });
+  return dirStats;
+}
+
+exports.exists = exists;
+exports.getDirStats = getDirStats;

package/dist/node.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Checks if the file exists.
+ */
+declare function exists(path: string): Promise<boolean>;
+
+/**
+ * Scans the specified directory and gets details for each subdirectory and file.
+ *
+ * By default, recursive mode is disabled so only one level is scanned.
+ */
+declare function getDirStats(dirPath: string, options?: DirStatsOptions): Promise<DirStats[]>;
+
+interface SubdirDetails {
+    index: number;
+    path: string;
+    base: string;
+}
+interface FileDetails {
+    index: number;
+    path: string;
+    base: string;
+    name: string;
+    ext: string;
+    size: string;
+}
+interface DirStats {
+    index: number;
+    path: string;
+    base: string;
+    size: string;
+    subdirs: SubdirDetails[];
+    files: FileDetails[];
+}
+interface DirStatsOptions {
+    recursive?: boolean;
+}
+
+export { DirStats, DirStatsOptions, exists, getDirStats };

package/dist/node.mjs

@@ -0,0 +1,62 @@
+import { access, constants, readdir, stat } from 'node:fs/promises';
+import { basename, resolve, parse } from 'node:path';
+import { formatBytes } from '../mix/format-bytes';
+
+async function exists(path) {
+  return await access(path, constants.F_OK).then(() => true).catch(() => false);
+}
+
+async function getDirStats(dirPath, options) {
+  const dirFiles = await readdir(dirPath);
+  const dirBase = basename(dirPath);
+  let dirStats = [];
+  const subdirList = [];
+  const fileList = [];
+  let dirSize = 0;
+  let dirIndex = 0;
+  let fileIndex = -1;
+  let subdirIndex = -1;
+  for (const file of dirFiles) {
+    const filePath = resolve(dirPath, file);
+    const fileStat = await stat(filePath);
+    if (fileStat.isDirectory()) {
+      subdirIndex++;
+      subdirList.push({
+        index: subdirIndex,
+        path: filePath,
+        base: file
+      });
+      if (options?.recursive) {
+        dirBase === dirPath ? dirBase : basename(filePath);
+        const stats = await getDirStats(filePath);
+        const updateDirStats = { ...stats[0], ...{ index: dirIndex++ } };
+        dirStats = [...dirStats, updateDirStats];
+      }
+    } else {
+      const { base, name, ext } = parse(file);
+      const path = filePath;
+      const size = formatBytes(fileStat.size);
+      fileIndex++;
+      dirSize += fileStat.size;
+      fileList.push({
+        index: fileIndex,
+        path,
+        base,
+        name,
+        ext,
+        size
+      });
+    }
+  }
+  dirStats.push({
+    index: dirIndex,
+    path: dirPath,
+    base: dirBase,
+    size: formatBytes(dirSize),
+    subdirs: subdirList,
+    files: fileList
+  });
+  return dirStats;
+}
+
+export { exists, getDirStats };

package/dist/utils.cjs

@@ -33,6 +33,18 @@ const isNodeListEmpty = (v) => isNodeList(v) && v.length === 0;
 const isHtmlCollection = (v) => v instanceof HTMLCollection;
 const isHtmlCollectionEmpty = (v) => isHtmlCollection(v) && v.length === 0;
 
+function formatBytes(bytes, options) {
+  const decimals = options?.decimals || 2;
+  const units = ["B", "KB", "MB", "GB", "TB"];
+  if (bytes === 0)
+    return `0 B`;
+  const k = 1024;
+  const dm = decimals < 0 ? 0 : decimals;
+  const i = Math.floor(Math.log(bytes) / Math.log(k));
+  return `${parseFloat((bytes / Math.pow(k, i)).toFixed(dm))} ${units[i]}`;
+}
+
+exports.formatBytes = formatBytes;
 exports.isArray = isArray;
 exports.isArrayEmpty = isArrayEmpty;
 exports.isBigint = isBigint;

package/dist/utils.d.ts

@@ -1,8 +1,16 @@
+/**
+ * An empty arrow function that performs no operation.
+ */
+declare const noop: () => void;
+/**
+ * Returns a string representing the object.
+ */
+declare const toString: (v: any) => string;
+
 /**
  * Matches any primitive value.
  */
 type Primitive = null | undefined | string | number | boolean | symbol | bigint;
-
 /**
  * Matches any `Primitive`, `Date` or `RegExp` value.
  */
@@ -134,6 +142,15 @@ type IsAny<T> = 0 extends 1 & T ? true : false;
  */
 type IsNever<T> = [T] extends [never] ? true : false;
 
+/**
+ * Converts bytes to a _human-readable_ size and appends a units suffix.
+ */
+declare function formatBytes(bytes: number, options?: FormatBytesOptions): string;
+
+interface FormatBytesOptions {
+    decimals?: number;
+}
+
 type OptionsDeep = {
     /**
      * Enables recursive mode for arrays and tuples.
@@ -171,13 +188,4 @@ type RequiredObjectDeep<T extends object, Options extends OptionsDeep = {
     [K in keyof T]-?: RequiredDeep<T[K], Options>;
 };
 
-/**
- * An empty arrow function that performs no operation.
- */
-declare const noop: () => void;
-/**
- * Returns a string representing the object.
- */
-declare const toString: (v: any) => string;
-
-export { BuiltIn, IsAny, IsNever, IsNull, PartialDeep, Primitive, RequiredDeep, isArray, isArrayEmpty, isBigint, isBoolean, isBrowser, isDate, isElement, isError, isFunction, isHtmlCollection, isHtmlCollectionEmpty, isInfinity, isMap, isNaNValue, isNodeList, isNodeListEmpty, isNull, isNumber, isObject, isObjectEmpty, isPrimitive, isRegExp, isSet, isString, isStringEmpty, isSymbol, isURL, isUndefined, noop, toString };
+export { BuiltIn, FormatBytesOptions, IsAny, IsNever, IsNull, OptionsDeep, PartialDeep, Primitive, RequiredDeep, formatBytes, isArray, isArrayEmpty, isBigint, isBoolean, isBrowser, isDate, isElement, isError, isFunction, isHtmlCollection, isHtmlCollectionEmpty, isInfinity, isMap, isNaNValue, isNodeList, isNodeListEmpty, isNull, isNumber, isObject, isObjectEmpty, isPrimitive, isRegExp, isSet, isString, isStringEmpty, isSymbol, isURL, isUndefined, noop, toString };

package/dist/utils.mjs

@@ -31,4 +31,15 @@ const isNodeListEmpty = (v) => isNodeList(v) && v.length === 0;
 const isHtmlCollection = (v) => v instanceof HTMLCollection;
 const isHtmlCollectionEmpty = (v) => isHtmlCollection(v) && v.length === 0;
 
-export { isArray, isArrayEmpty, isBigint, isBoolean, isBrowser, isDate, isElement, isError, isFunction, isHtmlCollection, isHtmlCollectionEmpty, isInfinity, isMap, isNaNValue, isNodeList, isNodeListEmpty, isNull, isNumber, isObject, isObjectEmpty, isPrimitive, isRegExp, isSet, isString, isStringEmpty, isSymbol, isURL, isUndefined, noop, toString };
+function formatBytes(bytes, options) {
+  const decimals = options?.decimals || 2;
+  const units = ["B", "KB", "MB", "GB", "TB"];
+  if (bytes === 0)
+    return `0 B`;
+  const k = 1024;
+  const dm = decimals < 0 ? 0 : decimals;
+  const i = Math.floor(Math.log(bytes) / Math.log(k));
+  return `${parseFloat((bytes / Math.pow(k, i)).toFixed(dm))} ${units[i]}`;
+}
+
+export { formatBytes, isArray, isArrayEmpty, isBigint, isBoolean, isBrowser, isDate, isElement, isError, isFunction, isHtmlCollection, isHtmlCollectionEmpty, isInfinity, isMap, isNaNValue, isNodeList, isNodeListEmpty, isNull, isNumber, isObject, isObjectEmpty, isPrimitive, isRegExp, isSet, isString, isStringEmpty, isSymbol, isURL, isUndefined, noop, toString };

package/node.d.ts

@@ -0,0 +1 @@
+export * from './dist/node'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hypernym/utils",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "author": "Hypernym Studio",
   "maintainers": [
     "Ivo Dolenc (https://github.com/ivodolenc)"
@@ -19,10 +19,16 @@
       "types": "./dist/utils.d.ts",
       "import": "./dist/utils.mjs",
       "require": "./dist/utils.cjs"
+    },
+    "./node": {
+      "types": "./dist/node.d.ts",
+      "import": "./dist/node.mjs",
+      "require": "./dist/node.cjs"
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "*.d.ts"
   ],
   "keywords": [
     "typescript",
@@ -46,16 +52,16 @@
   "devDependencies": {
     "@hypernym/eslint-config": "^1.0.1",
     "@hypernym/prettier-config": "^1.0.1",
-    "@types/node": "^20.3.3",
+    "@types/node": "^20.4.1",
     "eslint": "^8.44.0",
     "prettier": "^2.8.8",
-    "rollup": "^3.26.0",
+    "rollup": "^3.26.2",
     "rollup-plugin-dts": "^5.3.0",
     "rollup-plugin-esbuild": "^5.0.0",
     "typescript": "^5.0.4",
-    "vite": "^4.3.9",
-    "vite-node": "^0.32.2",
-    "vitest": "^0.32.2"
+    "vite": "^4.4.2",
+    "vite-node": "^0.33.0",
+    "vitest": "^0.33.0"
   },
   "publishConfig": {
     "access": "public"