@visulima/fs - npm Package Compare versions

Comparing version 2.3.8 to 3.0.0

CHANGELOG.md

@@ -0,1 +1,16 @@
+## @visulima/fs [3.0.0](https://github.com/visulima/visulima/compare/@visulima/fs@2.3.8...@visulima/fs@3.0.0) (2025-01-25)
+
+### ⚠ BREAKING CHANGES
+
+* **fs:** The yaml dep is not more include out of the box, you need to install it your self, all yaml function can now be found on @visulima/fs/yaml
+Signed-off-by: prisis <[e-mail]>
+
+### Features
+
+* **fs:** moved all yaml functions out of the main exports into `/yaml`, to reduce the bundle size ([b3766a0](https://github.com/visulima/visulima/commit/b3766a002bd53ce6ec8ef63e7da22c5e4d03becc))
+
+### Miscellaneous Chores
+
+* updated all dev dependencies ([37fb298](https://github.com/visulima/visulima/commit/37fb298b2af7c63be64252024e54bb3af6ddabec))
+
 ## @visulima/fs [2.3.8](https://github.com/visulima/visulima/compare/@visulima/fs@2.3.7...@visulima/fs@2.3.8) (2025-01-22)
@@ -2,0 +17,0 @@

dist/index.d.ts

@@ -1,6 +0,7 @@
-import { W as WalkOptions, F as FindUpName, a as FindUpOptions, b as FindUpNameSync, c as WalkEntry, R as ReadFileOptions, C as ContentType, J as JsonValue, d as ReadJsonOptions, e as JsonReviver, f as ReadYamlOptions, Y as YamlReviver, E as EmptyDirOptions, g as WriteFileOptions, h as WriteJsonOptions, i as YamlReplacer } from './packem_shared/observable-like.d-CJo2GVD9.d.mjs';
-export { n as CodeFrameLocation, k as FIND_UP_STOP, j as F_OK, o as FindUpNameFnResult, p as FindUpNameSyncFnResult, q as JsonReplacer, l as R_OK, r as ReadFileEncoding, m as W_OK, X as X_OK } from './packem_shared/observable-like.d-CJo2GVD9.d.mjs';
+import { W as WalkOptions, F as FindUpName, a as FindUpOptions, b as FindUpNameSync, c as WalkEntry, R as ReadFileOptions, C as ContentType, d as ReadJsonOptions, J as JsonReviver, E as EmptyDirOptions, e as WriteFileOptions, f as WriteJsonOptions } from './packem_shared/types-CiwAWOQj.d.mjs';
+export { k as CodeFrameLocation, h as FIND_UP_STOP, g as F_OK, l as FindUpNameFnResult, m as FindUpNameSyncFnResult, n as JsonReplacer, i as R_OK, o as ReadFileEncoding, j as W_OK, X as X_OK } from './packem_shared/types-CiwAWOQj.d.mjs';
 import { symlink } from 'node:fs';
 import { brotliDecompress, unzip, brotliDecompressSync, unzipSync } from 'node:zlib';
-import { CreateNodeOptions, DocumentOptions, ParseOptions, SchemaOptions, ToStringOptions } from 'yaml';
+import { J as JsonValue } from './packem_shared/observable-like.d-BlD8q22s.d.mjs';
+import 'yaml';
 
@@ -46,3 +47,3 @@ declare const ensureDir: (directory: URL | string) => Promise<void>;
 type FilePermissions = number;
-type Options$2 = {
+type Options = {
     cwd?: URL | string;
@@ -53,6 +54,6 @@ readonly directoryMode?: FilePermissions;
 
-declare const move: (sourcePath: string, destinationPath: string, options?: Options$2) => Promise<void>;
-declare const moveSync: (sourcePath: string, destinationPath: string, options?: Options$2) => void;
-declare const rename: (source: string, destination: string, options?: Options$2) => Promise<void>;
-declare const renameSync: (source: string, destination: string, options?: Options$2) => void;
+declare const move: (sourcePath: string, destinationPath: string, options?: Options) => Promise<void>;
+declare const moveSync: (sourcePath: string, destinationPath: string, options?: Options) => void;
+declare const rename: (source: string, destination: string, options?: Options) => Promise<void>;
+declare const renameSync: (source: string, destination: string, options?: Options) => void;
 
@@ -79,8 +80,2 @@ declare const decompressionMethods$1: {
 
-declare function readYaml<R = Record<string, unknown>>(path: URL | string, options?: ReadYamlOptions<"brotli" | "gzip" | "none">): Promise<R>;
-declare function readYaml<R = Record<string, unknown>>(path: URL | string, reviver?: YamlReviver, options?: ReadYamlOptions<"brotli" | "gzip" | "none">): Promise<R>;
-
-declare function readYamlSync<R = Record<string, unknown>>(path: URL | string, options?: ReadYamlOptions<"brotli" | "gzip" | "none">): R;
-declare function readYamlSync<R = Record<string, unknown>>(path: URL | string, reviver?: YamlReviver, options?: ReadYamlOptions<"brotli" | "gzip" | "none">): R;
-
 declare const emptyDir$1: (dir: URL | string, options?: EmptyDirOptions) => Promise<void>;
@@ -108,10 +103,2 @@
 
-type Options$1 = CreateNodeOptions & DocumentOptions & ParseOptions & SchemaOptions & ToStringOptions;
-declare function writeYaml(path: URL | string, data: any, options?: Options$1): Promise<void>;
-declare function writeYaml(path: URL | string, data: any, replacer?: YamlReplacer, options?: Options$1 | number | string): Promise<void>;
-
-type Options = CreateNodeOptions & DocumentOptions & ParseOptions & SchemaOptions & ToStringOptions;
-declare function writeYamlSync(path: URL | string, data: any, options?: Options): void;
-declare function writeYamlSync(path: URL | string, data: any, replacer?: YamlReplacer, options?: Options | number | string): void;
-
-export { CRLF, EOL, EmptyDirOptions, FindUpName, FindUpNameSync, FindUpOptions, JsonReviver, LF, type Options$2 as MoveOptions, ReadFileOptions, ReadJsonOptions, WalkEntry, WalkOptions, WriteFileOptions, WriteJsonOptions, YamlReplacer, collect, collectSync, detect, emptyDir$1 as emptyDir, emptyDir as emptyDirSync, ensureDir, ensureDirSync, ensureFile, ensureFileSync, ensureLink, ensureLinkSync, ensureSymlink, ensureSymlinkSync, findUp, findUpSync, format, isAccessible, isAccessibleSync, move, moveSync, readFile, readFileSync, readJson, readJsonSync, readYaml, readYamlSync, remove, removeSync, rename, renameSync, walk, walkSync, writeFile, writeFileSync, writeJson, writeJsonSync, writeYaml, writeYamlSync };
+export { CRLF, EOL, EmptyDirOptions, FindUpName, FindUpNameSync, FindUpOptions, JsonReviver, LF, type Options as MoveOptions, ReadFileOptions, ReadJsonOptions, WalkEntry, WalkOptions, WriteFileOptions, WriteJsonOptions, collect, collectSync, detect, emptyDir$1 as emptyDir, emptyDir as emptyDirSync, ensureDir, ensureDirSync, ensureFile, ensureFileSync, ensureLink, ensureLinkSync, ensureSymlink, ensureSymlinkSync, findUp, findUpSync, format, isAccessible, isAccessibleSync, move, moveSync, readFile, readFileSync, readJson, readJsonSync, remove, removeSync, rename, renameSync, walk, walkSync, writeFile, writeFileSync, writeJson, writeJsonSync };

dist/utils.d.ts

 export { J as JSONError } from './packem_shared/json-error-ZPgZIXcg.d.mjs';
-import { J as JsonValue, s as CodeFrameOptions, e as JsonReviver } from './packem_shared/observable-like.d-CJo2GVD9.d.mjs';
+import { J as JsonValue } from './packem_shared/observable-like.d-BlD8q22s.d.mjs';
+import { p as CodeFrameOptions, J as JsonReviver } from './packem_shared/types-CiwAWOQj.d.mjs';
 export { toPath } from '@visulima/path/utils';
@@ -4,0 +5,0 @@ import 'node:fs';

package.json

 {
   "name": "@visulima/fs",
-  "version": "2.3.8",
+  "version": "3.0.0",
   "description": "Human friendly file system utilities for Node.js",
@@ -110,2 +110,12 @@ "keywords": [
     },
+    "./yaml": {
+      "require": {
+        "types": "./dist/yaml.d.cts",
+        "default": "./dist/yaml.cjs"
+      },
+      "import": {
+        "types": "./dist/yaml.d.mts",
+        "default": "./dist/yaml.mjs"
+      }
+    },
     "./package.json": "./package.json"
@@ -126,2 +136,5 @@ },
         "./dist/error.d.ts"
+      ],
+      "yaml": [
+        "./dist/yaml.d.ts"
       ]
@@ -137,5 +150,12 @@ }
   "dependencies": {
-    "@visulima/path": "1.3.3",
+    "@visulima/path": "1.3.3"
+  },
+  "peerDependencies": {
     "yaml": "^2.7.0"
   },
+  "peerDependenciesMeta": {
+    "yaml": {
+      "optional": true
+    }
+  },
   "engines": {
@@ -142,0 +162,0 @@ "node": ">=18.* <=23.*"

No alert changes

Improved metrics

Total package byte prevSize

319119

increased by0.67%

Number of package files

137

increased by6.2%

Lines of code

4228

increased by0.19%

Number of lines in readme file

4537

increased by0.38%

Dependency changes

• - Removedyaml@^2.7.0