@visulima/fs - npm Package Compare versions

Comparing version 2.2.2 to 2.3.0

CHANGELOG.md

@@ -0,1 +1,7 @@
+## @visulima/fs [2.3.0](https://github.com/visulima/visulima/compare/@visulima/fs@2.2.2...@visulima/fs@2.3.0) (2024-10-25)
+
+### Features
+
+* **fs:** added moveFile, moveFileSync, renameFile, renameFileSync ([#477](https://github.com/visulima/visulima/issues/477)) ([1f2cd29](https://github.com/visulima/visulima/commit/1f2cd29e3c62a9cc661f6f97b1d1cbda8566ea9c))
+
 ## @visulima/fs [2.2.2](https://github.com/visulima/visulima/compare/@visulima/fs@2.2.1...@visulima/fs@2.2.2) (2024-10-05)
@@ -2,0 +8,0 @@

dist/index.d.ts

 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 { symlink } from 'node:fs';
+import { brotliDecompress, unzip, brotliDecompressSync, unzipSync } from 'node:zlib';
 import { CreateNodeOptions, DocumentOptions, ParseOptions, SchemaOptions, ToStringOptions } from 'yaml';
@@ -44,6 +45,28 @@
 
-declare const readFile: <O extends ReadFileOptions<"brotli" | "gzip" | "none"> | undefined = undefined>(path: URL | string, options?: O) => Promise<ContentType<O>>;
+type FilePermissions = number;
+type Options$2 = {
+    cwd?: URL | string;
+    readonly directoryMode?: FilePermissions;
+    readonly overwrite?: boolean;
+};
 
-declare const readFileSync: <O extends ReadFileOptions<"brotli" | "gzip" | "none"> | undefined = undefined>(path: URL | string, options?: O) => ContentType<O>;
+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 decompressionMethods$1: {
+    readonly brotli: typeof brotliDecompress;
+    readonly gzip: typeof unzip;
+    readonly none: (buffer: Buffer, callback: (error: Error | null, result: Buffer) => void) => void;
+};
+declare const readFile: <O extends ReadFileOptions<keyof typeof decompressionMethods$1> | undefined = undefined>(path: URL | string, options?: O) => Promise<ContentType<O>>;
+
+declare const decompressionMethods: {
+    readonly brotli: typeof brotliDecompressSync;
+    readonly gzip: typeof unzipSync;
+    readonly none: (buffer: Buffer) => Buffer;
+};
+declare const readFileSync: <O extends ReadFileOptions<keyof typeof decompressionMethods> | undefined = undefined>(path: URL | string, options?: O) => ContentType<O>;
+
 declare function readJson<T extends JsonValue>(path: URL | string, options?: ReadJsonOptions): Promise<T>;
@@ -91,2 +114,2 @@ declare function readJson<T extends JsonValue>(path: URL | string, reviver: JsonReviver, options?: ReadJsonOptions): Promise<T>;
 
-export { CRLF, EOL, EmptyDirOptions, FindUpName, FindUpNameSync, FindUpOptions, JsonReviver, LF, 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, readFile, readFileSync, readJson, readJsonSync, readYaml, readYamlSync, remove, removeSync, walk, walkSync, writeFile, writeFileSync, writeJson, writeJsonSync, writeYaml, writeYamlSync };
+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 };

package.json

 {
   "name": "@visulima/fs",
-  "version": "2.2.2",
+  "version": "2.3.0",
   "description": "Human friendly file system utilities for Node.js",
@@ -143,9 +143,10 @@ "keywords": [
     "@arethetypeswrong/cli": "^0.16.4",
-    "@babel/core": "^7.25.7",
+    "@babel/core": "^7.26.0",
+    "@ckeditor/typedoc-plugins": "43.0.0",
     "@rushstack/eslint-plugin-security": "^0.8.3",
     "@types/node": "18.19.15",
     "@visulima/error": "4.4.7",
-    "@visulima/packem": "1.0.7",
-    "@vitest/coverage-v8": "^2.1.2",
-    "@vitest/ui": "^2.1.2",
+    "@visulima/packem": "1.1.1",
+    "@vitest/coverage-v8": "^2.1.3",
+    "@vitest/ui": "^2.1.3",
     "conventional-changelog-conventionalcommits": "8.0.0",
@@ -164,11 +165,14 @@ "cross-env": "^7.0.3",
     "prettier": "^3.3.3",
-    "redos-detector": "^5.1.2",
-    "rimraf": "5.0.9",
+    "redos-detector": "^5.1.3",
+    "rimraf": "6.0.1",
     "safe-regex2": "^4.0.0",
-    "semantic-release": "24.0.0",
+    "semantic-release": "24.1.3",
     "tempy": "^3.1.0",
     "type-fest": "^4.26.1",
-    "typescript": "5.4.5",
-    "vitest": "^2.1.2",
-    "yaml": "^2.5.1"
+    "typedoc": "0.26.10",
+    "typedoc-plugin-markdown": "4.2.9",
+    "typedoc-plugin-rename-defaults": "0.7.1",
+    "typescript": "5.6.3",
+    "vitest": "^2.1.3",
+    "yaml": "^2.6.0"
   },
@@ -175,0 +179,0 @@ "peerDependencies": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 2 instances in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 2 instances in 1 package

Improved metrics

Total package byte prevSize

235895

increased by44.08%

Number of package files

129

increased by1.57%

Lines of code

665

increased by6.57%

Number of lines in readme file

4216

increased by795.12%

Worsened metrics

Dev dependency count

38

increased by11.76%

Number of low quality alerts

39

increased by5.41%

No dependency changes