@reliverse/relifso 1.2.10 → 1.3.1

package/README.md

@@ -51,7 +51,7 @@ bun dler relifso init ...
 
 ## Usage
 
-Check [./example/e-mod.ts](./example/e-mod.ts) for a full example. You can clone this repo and run via `bun dev`.
+Check [./e-relifso.ts](./e-relifso.ts) and [./e-pathkit.ts](./e-pathkit.ts) for a full examples. You can clone this repo and run via `bun dev`.
 
 Relifso works just like `fs-extra` — every method is promise-first, ergonomic, and future-ready.
 
@@ -276,10 +276,10 @@ All async methods return a `Promise` if no callback is passed.
 
 ## TODO
 
-- [x] Create usage example in [./example/e-mod.ts](./example/e-mod.ts)
-- [ ] Ensure [./example/e-mod.ts](./example/e-mod.ts) works 100% correctly
+- [x] Create usage example in [./e-relifso.ts](./e-relifso.ts) and [./e-pathkit.ts](./e-pathkit.ts)
+- [ ] Ensure [./e-relifso.ts](./e-relifso.ts) and [./e-pathkit.ts](./e-pathkit.ts) works 100% correctly
 - [ ] Consider using [@reliverse/repath](https://github.com/reliverse/repath) instead of just `node:path`.
-- [ ] Pass all `fs-extra` tests with Bun/Vitest (+ fix & improve them).
+- [ ] Pass all `fs-extra` tests with Bun (+ fix & improve them).
 - [ ] Convert all jsdoc comments to TypeScript types.
 - [ ] Fully improve all `fs-extra` codebase files.
 

package/bin/impl/utils/additional.d.ts

@@ -0,0 +1,15 @@
+import { exec } from "node:child_process";
+export declare const execAsync: typeof exec.__promisify__;
+export declare function setHiddenAttributeOnWindows(folderPath: string): Promise<void>;
+export declare function isHidden(filePath: string): Promise<boolean>;
+/**
+ * Checks if a directory is empty
+ * @param directory Path to the directory
+ * @returns Boolean indicating if the directory is empty
+ */
+export declare function isDirectoryEmpty(directory: string): Promise<boolean>;
+/**
+ * Removes the specified directory if it exists and then ensures it exists.
+ * @param dir - The directory to remove and ensure.
+ */
+export declare function rmEnsureDir(dir: string): Promise<void>;

package/bin/impl/utils/additional.js

@@ -0,0 +1,47 @@
+import { ensuredir } from "@reliverse/relifso";
+import { exec } from "node:child_process";
+import { readdir } from "node:fs/promises";
+import { promisify } from "node:util";
+import { pathExists } from "../node/path-exists.js";
+import { remove } from "../node/remove.js";
+export const execAsync = promisify(exec);
+export async function setHiddenAttributeOnWindows(folderPath) {
+  if (process.platform === "win32") {
+    try {
+      if (await pathExists(folderPath)) {
+        const isAlreadyHidden = await isHidden(folderPath);
+        if (!isAlreadyHidden) {
+          await execAsync(`attrib +h "${folderPath}"`);
+        }
+      }
+    } catch (error) {
+      console.warn("Failed to set hidden attribute:", String(error));
+    }
+  }
+}
+export async function isHidden(filePath) {
+  if (process.platform === "win32") {
+    const attributes = await execAsync(`attrib "${filePath}"`);
+    return attributes.stdout.includes("H");
+  }
+  return false;
+}
+export async function isDirectoryEmpty(directory) {
+  try {
+    const files = await readdir(directory);
+    return files.length === 0;
+  } catch (_error) {
+    return false;
+  }
+}
+export async function rmEnsureDir(dir) {
+  try {
+    if (await pathExists(dir)) {
+      await remove(dir);
+    }
+    await ensuredir(dir);
+  } catch (error) {
+    console.error(`Error while removing/ensuring directory ${dir}: ${error}`);
+    throw error;
+  }
+}

package/bin/mod.d.ts

@@ -2,20 +2,21 @@ import type { Stats } from "node:fs";
 import { renameSync as nodeRenameSync, unlinkSync as nodeUnlinkSync, accessSync, constants, readdirSync, statSync, copyFileSync, appendFileSync, chmodSync, chownSync, closeSync, createReadStream, createWriteStream, fchmodSync, fchownSync, fdatasyncSync, fstatSync, fsyncSync, ftruncateSync, futimesSync, lchmodSync, lchownSync, linkSync, lstatSync, lutimesSync, mkdtempSync, openSync, opendirSync, readSync, readlinkSync, realpathSync, rmSync, rmdirSync, statfsSync, symlinkSync, truncateSync, unwatchFile, utimesSync, watchFile, writeFileSync, writeSync, readvSync, writevSync } from "node:fs";
 import { readdir as nodeReaddirInternal, stat as nodeStatInternal, rename as nodeRename, unlink as nodeUnlink, access, appendFile, chmod, chown, copyFile, lchmod, lchown, link, lstat, lutimes, mkdtemp, open, opendir, readdir, readlink, realpath, rm, rmdir, stat, statfs, symlink, truncate, utimes, watch, writeFile } from "node:fs/promises";
 import { resolve } from "node:path";
-import type { DiveOptions } from "./impl/dive.js";
-import { copy, copySync } from "./impl/copy.js";
-import { createFile, createFileSync } from "./impl/create-file.js";
-import { diveSync } from "./impl/dive.js";
-import { emptyDir, emptyDirSync } from "./impl/empty-dir.js";
-import { mkdirs, mkdirsSync } from "./impl/mkdirs.js";
-import { move, moveSync } from "./impl/move.js";
-import { outputFile, outputFileSync } from "./impl/output-file.js";
-import { outputJson, outputJsonSync } from "./impl/output-json.js";
-import { pathExists, pathExistsSync } from "./impl/path-exists.js";
-import { readFile, readFileSync } from "./impl/read-file.js";
-import { readJson, readJsonSync } from "./impl/read-json.js";
-import { remove, removeSync } from "./impl/remove.js";
-import { writeJson, writeJsonSync } from "./impl/write-json.js";
+import type { DiveOptions } from "./impl/node/dive.js";
+import { copy, copySync } from "./impl/node/copy.js";
+import { createFile, createFileSync } from "./impl/node/create-file.js";
+import { diveSync } from "./impl/node/dive.js";
+import { emptyDir, emptyDirSync } from "./impl/node/empty-dir.js";
+import { mkdirs, mkdirsSync } from "./impl/node/mkdirs.js";
+import { move, moveSync } from "./impl/node/move.js";
+import { outputFile, outputFileSync } from "./impl/node/output-file.js";
+import { outputJson, outputJsonSync } from "./impl/node/output-json.js";
+import { pathExists, pathExistsSync } from "./impl/node/path-exists.js";
+import { readFile, readFileSync } from "./impl/node/read-file.js";
+import { readJson, readJsonSync } from "./impl/node/read-json.js";
+import { remove, removeSync } from "./impl/node/remove.js";
+import { writeJson, writeJsonSync } from "./impl/node/write-json.js";
+import { execAsync, setHiddenAttributeOnWindows, isHidden, isDirectoryEmpty, rmEnsureDir } from "./impl/utils/additional.js";
 /**
  * Recursively dives into a directory and yields files and directories.
  * @param directory - The directory to dive into.
@@ -71,13 +72,13 @@ declare function isDirectory(filePath: string): Promise<boolean>;
 declare function isDirectorySync(filePath: string): boolean;
 declare function isSymlink(filePath: string): Promise<boolean>;
 declare function isSymlinkSync(filePath: string): boolean;
-export type { CopyOptions } from "./impl/copy.js";
-export type { MoveOptions } from "./impl/move.js";
-export type { ReadFileOptions } from "./impl/read-file.js";
-export type { ReadJsonOptions } from "./impl/read-json.js";
-export type { JsonStringifyOptions } from "./impl/write-json.js";
-export type { WriteJsonOptions } from "./impl/write-json.js";
-export { accessSync, appendFileSync, chmodSync, chownSync, closeSync, copyFileSync, createReadStream, createWriteStream, fchmodSync, fchownSync, fdatasyncSync, fstatSync, fsyncSync, ftruncateSync, futimesSync, lchmodSync, lchownSync, linkSync, lstatSync, lutimesSync, mkdtempSync, openSync, opendirSync, readFileSync, readlinkSync, readSync, readdirSync, realpathSync, nodeRenameSync, rmSync, rmdirSync, statSync, statfsSync, symlinkSync, truncateSync, nodeUnlinkSync, unwatchFile, utimesSync, watchFile, writeFileSync, writeSync, readvSync, writevSync, readJsonSync, writeJsonSync, createFileSync, mkdirsSync, emptyDirSync, pathExistsSync, copySync, moveSync, removeSync, outputJsonSync, outputFileSync, diveSync, cpSync, ensureDirSync as ensuredirSync, ensureDirSync, ensureFileSync, existsSync, mkdirpSync, mkdirSync, ncpSync, outputJSONSync, readJSONSync, renameSync, rimrafSync, unlinkSync, writeJSONSync, isDirectorySync, isSymlinkSync, readLinesSync, readTextSync, readJson, writeJson, createFile, mkdirs, emptyDir, pathExists, copy, move, remove, outputJson, outputFile, access, appendFile, chmod, chown, copyFile, lchmod, lchown, link, lstat, lutimes, mkdtemp, open, opendir, readFile, readdir, readlink, realpath, nodeRename, rm, rmdir, stat, statfs, symlink, truncate, nodeUnlink, utimes, watch, writeFile, constants, cp, ensureDir as ensuredir, ensureDir, ensureFile, exists, mkdir, mkdirp, ncp, outputJSON, readJSON, rename, resolve, rimraf, unlink, writeJSON, isDirectory, isSymlink, readLines, readText, };
+export type { CopyOptions } from "./impl/node/copy.js";
+export type { MoveOptions } from "./impl/node/move.js";
+export type { ReadFileOptions } from "./impl/node/read-file.js";
+export type { ReadJsonOptions } from "./impl/node/read-json.js";
+export type { JsonStringifyOptions } from "./impl/node/write-json.js";
+export type { WriteJsonOptions } from "./impl/node/write-json.js";
+export { accessSync, appendFileSync, chmodSync, chownSync, closeSync, copyFileSync, createReadStream, createWriteStream, fchmodSync, fchownSync, fdatasyncSync, fstatSync, fsyncSync, ftruncateSync, futimesSync, lchmodSync, lchownSync, linkSync, lstatSync, lutimesSync, mkdtempSync, openSync, opendirSync, readFileSync, readlinkSync, readSync, readdirSync, realpathSync, nodeRenameSync, rmSync, rmdirSync, statSync, statfsSync, symlinkSync, truncateSync, nodeUnlinkSync, unwatchFile, utimesSync, watchFile, writeFileSync, writeSync, readvSync, writevSync, readJsonSync, writeJsonSync, createFileSync, mkdirsSync, emptyDirSync, pathExistsSync, copySync, moveSync, removeSync, outputJsonSync, outputFileSync, diveSync, cpSync, ensureDirSync as ensuredirSync, ensureDirSync, ensureFileSync, existsSync, mkdirpSync, mkdirSync, ncpSync, outputJSONSync, readJSONSync, renameSync, rimrafSync, unlinkSync, writeJSONSync, isDirectorySync, isSymlinkSync, readLinesSync, readTextSync, readJson, writeJson, createFile, mkdirs, emptyDir, pathExists, copy, move, remove, outputJson, outputFile, access, appendFile, chmod, chown, copyFile, lchmod, lchown, link, lstat, lutimes, mkdtemp, open, opendir, readFile, readdir, readlink, realpath, nodeRename, rm, rmdir, stat, statfs, symlink, truncate, nodeUnlink, utimes, watch, writeFile, constants, cp, ensureDir as ensuredir, ensureDir, ensureFile, exists, mkdir, mkdirp, ncp, outputJSON, readJSON, rename, resolve, rimraf, unlink, writeJSON, isDirectory, isSymlink, readLines, readText, execAsync, setHiddenAttributeOnWindows, isHidden, isDirectoryEmpty, rmEnsureDir, };
 declare const fs: {
     accessSync: typeof accessSync;
     appendFileSync: typeof appendFileSync;
@@ -211,5 +212,10 @@ declare const fs: {
     isSymlink: typeof isSymlink;
     readLines: typeof readLines;
     readText: typeof readText;
+    execAsync: typeof import("child_process").exec.__promisify__;
+    setHiddenAttributeOnWindows: typeof setHiddenAttributeOnWindows;
+    isHidden: typeof isHidden;
+    isDirectoryEmpty: typeof isDirectoryEmpty;
+    rmEnsureDir: typeof rmEnsureDir;
 };
 export default fs;

package/bin/mod.js

@@ -75,19 +75,26 @@ import {
   writeFile
 } from "node:fs/promises";
 import { join as pathJoin, resolve } from "node:path";
-import { copy, copySync } from "./impl/copy.js";
-import { createFile, createFileSync } from "./impl/create-file.js";
-import { diveSync } from "./impl/dive.js";
-import { emptyDir, emptyDirSync } from "./impl/empty-dir.js";
-import { mkdirs, mkdirsSync } from "./impl/mkdirs.js";
-import { move, moveSync } from "./impl/move.js";
-import { outputFile, outputFileSync } from "./impl/output-file.js";
-import { outputJson, outputJsonSync } from "./impl/output-json.js";
-import { pathExists, pathExistsSync } from "./impl/path-exists.js";
-import { readFile, readFileSync } from "./impl/read-file.js";
-import { readJson, readJsonSync } from "./impl/read-json.js";
-import { remove, removeSync } from "./impl/remove.js";
-import { writeJson, writeJsonSync } from "./impl/write-json.js";
+import { copy, copySync } from "./impl/node/copy.js";
+import { createFile, createFileSync } from "./impl/node/create-file.js";
+import { diveSync } from "./impl/node/dive.js";
+import { emptyDir, emptyDirSync } from "./impl/node/empty-dir.js";
+import { mkdirs, mkdirsSync } from "./impl/node/mkdirs.js";
+import { move, moveSync } from "./impl/node/move.js";
+import { outputFile, outputFileSync } from "./impl/node/output-file.js";
+import { outputJson, outputJsonSync } from "./impl/node/output-json.js";
+import { pathExists, pathExistsSync } from "./impl/node/path-exists.js";
+import { readFile, readFileSync } from "./impl/node/read-file.js";
+import { readJson, readJsonSync } from "./impl/node/read-json.js";
+import { remove, removeSync } from "./impl/node/remove.js";
+import { writeJson, writeJsonSync } from "./impl/node/write-json.js";
+import {
+  execAsync,
+  setHiddenAttributeOnWindows,
+  isHidden,
+  isDirectoryEmpty,
+  rmEnsureDir
+} from "./impl/utils/additional.js";
 async function* _diveWorker(currentPath, options, currentDepth) {
   const maxDepth = options.depth ?? Number.POSITIVE_INFINITY;
   if (currentDepth > maxDepth) {
@@ -384,7 +391,12 @@ export {
   isDirectory,
   isSymlink,
   readLines,
-  readText
+  readText,
+  execAsync,
+  setHiddenAttributeOnWindows,
+  isHidden,
+  isDirectoryEmpty,
+  rmEnsureDir
 };
 const fs = {
   // Sync direct exports (node:fs)
@@ -524,6 +536,12 @@ const fs = {
   isDirectory,
   isSymlink,
   readLines,
-  readText
+  readText,
+  // Additional utility functions
+  execAsync,
+  setHiddenAttributeOnWindows,
+  isHidden,
+  isDirectoryEmpty,
+  rmEnsureDir
 };
 export default fs;

package/package.json

@@ -5,7 +5,7 @@
   "license": "MIT",
   "name": "@reliverse/relifso",
   "type": "module",
-  "version": "1.2.10",
+  "version": "1.3.1",
   "keywords": [
     "fs",
     "file",
@@ -30,67 +30,7 @@
     "move",
     "promise"
   ],
-  "devDependencies": {
-    "@babel/plugin-transform-block-scoping": "^7.27.1",
-    "@biomejs/biome": "1.9.4",
-    "@cspotcode/source-map-support": "^0.8.1",
-    "@eslint/js": "^9.27.0",
-    "@reliverse/dler": "^1.3.6",
-    "@reliverse/pathkit": "^1.0.4",
-    "@reliverse/pathkit-plus": "^1.0.4",
-    "@rollup/plugin-alias": "^5.1.1",
-    "@rollup/plugin-babel": "^6.0.4",
-    "@rollup/plugin-commonjs": "^28.0.3",
-    "@rollup/plugin-node-resolve": "^16.0.1",
-    "@rollup/plugin-replace": "^6.0.2",
-    "@rollup/plugin-terser": "^0.4.4",
-    "@stylistic/eslint-plugin": "^4.2.0",
-    "@swc/core": "^1.11.24",
-    "@types/eslint": "^9.6.1",
-    "@types/fs-extra": "^11.0.4",
-    "@types/graceful-fs": "^4.1.9",
-    "@types/jsonfile": "^6.1.4",
-    "@types/klaw": "^3.0.6",
-    "@types/klaw-sync": "^6.0.5",
-    "@types/minimist": "^1.2.5",
-    "@types/mocha": "^10.0.10",
-    "@types/node": "^22.15.19",
-    "@types/proxyquire": "^1.3.31",
-    "@types/universalify": "^1.0.3",
-    "@types/verror": "^1.10.11",
-    "@typescript-eslint/eslint-plugin": "^8.32.1",
-    "@typescript-eslint/parser": "^8.32.1",
-    "@uwx/fsxt-rollup-plugin-dts": "^6.0.2",
-    "eslint": "^9.27.0",
-    "eslint-config-google": "^0.14.0",
-    "eslint-plugin-no-relative-import-paths": "^1.6.1",
-    "eslint-plugin-perfectionist": "^4.13.0",
-    "fs-extra": "^11.3.0",
-    "graceful-fs": "^4.2.11",
-    "jsonfile": "^6.1.0",
-    "klaw": "^4.1.0",
-    "klaw-sync": "^7.0.0",
-    "knip": "^5.56.0",
-    "minimist": "^1.2.8",
-    "mocha": "^11.4.0",
-    "nyc": "^17.1.0",
-    "proxyquire": "^2.1.3",
-    "read-dir-files": "^0.1.1",
-    "rimraf": "^6.0.1",
-    "rollup": "^4.41.0",
-    "rollup-plugin-bundle-size": "^1.0.3",
-    "rollup-plugin-typescript-paths": "^1.5.0",
-    "ts-node": "^10.9.2",
-    "tsconfig-paths": "^4.2.0",
-    "tslib": "2.8.1",
-    "typedoc": "^0.28.4",
-    "typedoc-plugin-missing-exports": "^4.0.0",
-    "typescript": "^5.8.3",
-    "typescript-eslint": "^8.32.1",
-    "universalify": "^2.0.1",
-    "unplugin-swc": "^1.5.3",
-    "verror": "^1.10.1"
-  },
+  "devDependencies": {},
   "exports": {
     ".": "./bin/mod.js"
   },
@@ -105,4 +45,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}