@reliverse/relifso 1.4.2 → 1.4.4

package/README.md

@@ -17,13 +17,7 @@
 - 🎯 Supports all Node.js v16+ features — optimized for Node.js v22+
 - 🧪 Soon: Ready for upcoming Node.js v22+ experimental features
 - ✌️ Bun v1.2+ ready — ships with Bun-aware enhancements out of the box
-- 🐦‍🔥 Finally! Your `fs.*` usage is now can correctly read/write JSON/JSONC!  
-
-## Heads Up
-
-- **Most of the things** mentioned in this doc **aren't implemented yet** — they're part of the vision for ~`v1.5.0`.
-- Got thoughts? Ideas? Send your feedback in [Discord](https://discord.gg/Pb8uKbwpsJ) or use [GitHub Issues](https://github.com/reliverse/relifso/issues).
-- Your feedback means the world and helps shape where this project goes next. Thank you!
+- 🐦‍🔥 Finally! Your `fs.*` usage is now can correctly read/write JSON/JSONC!
 
 ## Install
 
@@ -39,10 +33,11 @@ bun rm fs-extra
 bun rm @types/fs-extra
 # soon:
 # bun add -D @reliverse/dler
-# bun dler relifso node-fs to relifso
-# bun dler relifso fs-extra to relifso
+# bun dler migrate fs-relifso
 ```
 
+**Pro Tip**: _Use Ctrl+Shift+H to replace `fs-extra` with `@reliverse/relifso` in your project._
+
 ### Core Features
 
 - **File Operations**
@@ -129,6 +124,71 @@ console.log(config); // { hello: 'world' }
 await remove(".reliverse");
 ```
 
+## Run Example
+
+Install this repository locally and run the example by using `bun dev`:
+
+```bash
+$ bun e-mod.ts
+✓   Running examples with Bun...
+Created directory ./tests-runtime
+[env] writeJson was successfully executed in Bun (for JSON)
+Wrote JSON tests-runtime\config.json
+[env] readJson was successfully executed in Bun
+Read JSON {"hello":"world","ts":"2025-06-02T19:01:53.291Z"}
+[env] copy was successfully executed in Bun
+Moved → Copied (with overwrite) tests-runtime\config.old.json → tests-runtime\config.copy.json
+[env] readFile was successfully executed in Bun
+Wrote & read text file Hello Relifso!
+[env] writeFile was successfully executed in Bun
+[env] writeFile was successfully executed in Bun
+Ensured nested & output files
+[env] writeJson was successfully executed in Bun (for JSON)
+[env] readJson was successfully executed in Bun
+writeJson / readJson round-trip {"foo":"bar"}
+[env] writeJson was successfully executed in Bun (for JSONC)
+Wrote JSONC tests-runtime\config.jsonc
+[env] readJson was successfully executed in Bun
+Read JSONC {
+  "name": "relifso",
+  "version": "1.0.0",
+  "features": [
+    "file operations",
+    "directory operations",
+    "JSONC support"
+  ],
+  "settings": {
+    "debug": true,
+    "verbose": false
+  }
+}
+Emptied directory tests-runtime\empty-me
+[env] writeFileSync was successfully executed in Bun
+[env] writeJsonSync was successfully executed in Bun (for JSON)
+Sync JSON round-trip {"sync":true}
+[env] copySync was successfully executed in Bun
+copySync → moveSync → removeSync chain complete
+Directory structure via dive
+ • tests-runtime\config-sync.json
+ • tests-runtime\config.copy.json
+ • tests-runtime\config.jsonc
+ • tests-runtime\config.old.json
+ • tests-runtime\config2.json
+ • tests-runtime\hello.txt
+ • tests-runtime\nested\deep\file.txt
+ • tests-runtime\output-file.txt
+Directory structure via diveSync
+ • tests-runtime\config-sync.json
+ • tests-runtime\config.copy.json
+ • tests-runtime\config.jsonc
+ • tests-runtime\config.old.json
+ • tests-runtime\config2.json
+ • tests-runtime\hello.txt
+ • tests-runtime\nested\deep\file.txt
+ • tests-runtime\output-file.txt
+Removed directory ./tests-runtime
+```
+
 ## Sync vs Async vs Legacy
 
 You choose your flavor:
@@ -361,12 +421,10 @@ const stats = await getStats("file.txt");
 
 ## TODO
 
-- [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
+- [x] Create usage example in [./example/e-relifso.ts](./e-relifso.ts) and [./example/e-pathkit.ts](./e-pathkit.ts)
+- [x] Ensure [./example/e-relifso.ts](./example/e-relifso.ts) and [./example/e-pathkit.ts](./example/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 (+ fix & improve them).
-- [ ] Convert all jsdoc comments to TypeScript types.
-- [ ] Fully improve all `fs-extra` codebase files.
 - [ ] In [docs.reliverse.org](https://docs.reliverse.org) implement feature and performance comparison table with `fs-extra`.
 
 ## Shoutouts

package/bin/impl/copy.d.ts

@@ -1,7 +1,7 @@
 export interface CopyOptions {
-    /** Whether to overwrite existing files. Default: true */
+    /** @deprecated Use `overwrite` instead. This option will be removed in a future. */
     force?: boolean;
-    /** Whether to overwrite existing files. Alias for force. Default: true */
+    /** Whether to overwrite existing files. Default: true */
     overwrite?: boolean;
     /** @deprecated Use `overwrite`. */
     clobber?: boolean;

package/bin/impl/copy.js

@@ -29,7 +29,7 @@ export function copySync(src, dest, options = {}) {
   const {
     overwrite = options.clobber ?? true,
     force = true,
-    recursive = false,
+    recursive = true,
     dereference = false,
     errorOnExist = false,
     ensureSource = true,
@@ -124,7 +124,7 @@ export async function copy(src, dest, options = {}) {
   const {
     overwrite = options.clobber ?? true,
     force = true,
-    recursive = false,
+    recursive = true,
     dereference = false,
     errorOnExist = false,
     ensureSource = true,

package/bin/impl/move.d.ts

@@ -1,4 +1,7 @@
 export interface MoveOptions {
+    /** @deprecated Use `overwrite` instead. This option will be removed in a future. */
+    force?: boolean;
+    /** Whether to overwrite existing files. Default: false */
     overwrite?: boolean;
     /** @deprecated Use `overwrite`. */
     clobber?: boolean;

package/package.json

@@ -5,7 +5,7 @@
   "license": "MIT",
   "name": "@reliverse/relifso",
   "type": "module",
-  "version": "1.4.2",
+  "version": "1.4.4",
   "keywords": [
     "fs",
     "file",