memfs 3.1.3 → 3.2.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [3.2.0](https://github.com/streamich/memfs/compare/v3.1.3...v3.2.0) (2020-05-19)
+
+
+### Bug Fixes
+
+* 'fromJSON()' did not consider cwd when creating directories ([3d6ee3b](https://github.com/streamich/memfs/commit/3d6ee3b2c0eef0345ba2bd400e9836f2d685321f))
+
+
+### Features
+
+* support nested objects in 'fromJSON()' ([f8c329c](https://github.com/streamich/memfs/commit/f8c329c8e57c85cc4a394a74802af1f37dcedefd))
+
 ## [3.1.3](https://github.com/streamich/memfs/compare/v3.1.2...v3.1.3) (2020-05-14)
 
 

package/README.md

@@ -1,6 +1,6 @@
 # memfs
 
-[![][npm-badge]][npm-url] [![][travis-badge]][travis-url]
+[![][chat-badge]][chat] [![][npm-badge]][npm-url] [![][travis-badge]][travis-url]
 
 In-memory file-system with [Node's `fs` API](https://nodejs.org/api/fs.html).
 
@@ -107,6 +107,8 @@ require('/index'); // hi world
 - [`fs-monkey`][fs-monkey] - monkey-patches Node's `fs` module and `require` function
 - [`libfs`](https://github.com/streamich/full-js/blob/master/src/lib/fs.ts) - real filesystem (that executes UNIX system calls) implemented in JavaScript
 
+[chat]: https://onp4.com/@vadim/~memfs
+[chat-badge]: https://img.shields.io/badge/Chat-%F0%9F%92%AC-green?style=flat&logo=chat&link=https://onp4.com/@vadim/~memfs
 [npm-url]: https://www.npmjs.com/package/memfs
 [npm-badge]: https://img.shields.io/npm/v/memfs.svg
 [travis-url]: https://travis-ci.org/streamich/memfs

package/lib/volume.d.ts

@@ -101,12 +101,19 @@ export declare function dataToStr(data: TData, encoding?: string): string;
 export declare function dataToBuffer(data: TData, encoding?: string): Buffer;
 export declare function bufferToEncoding(buffer: Buffer, encoding?: TEncodingExtended): TDataOut;
 export declare function toUnixTimestamp(time: any): any;
-export declare type DirectoryJSON = Record<string, string | null>;
+declare type DirectoryContent = string | null;
+export interface DirectoryJSON {
+    [key: string]: DirectoryContent;
+}
+export interface NestedDirectoryJSON {
+    [key: string]: DirectoryContent | NestedDirectoryJSON;
+}
 /**
  * `Volume` represents a file system.
  */
 export declare class Volume {
     static fromJSON(json: DirectoryJSON, cwd?: string): Volume;
+    static fromNestedJSON(json: NestedDirectoryJSON, cwd?: string): Volume;
     /**
      * Global file descriptor counter. UNIX file descriptors start from 0 and go sequentially
      * up, so here, in order not to conflict with them, we choose some big number and descrease
@@ -163,6 +170,7 @@ export declare class Volume {
     private _toJSON;
     toJSON(paths?: PathLike | PathLike[], json?: {}, isRelative?: boolean): DirectoryJSON;
     fromJSON(json: DirectoryJSON, cwd?: string): void;
+    fromNestedJSON(json: NestedDirectoryJSON, cwd?: string): void;
     reset(): void;
     mountSync(mountpoint: string, json: DirectoryJSON): void;
     private openLink;
@@ -378,3 +386,4 @@ export declare class FSWatcher extends EventEmitter {
     start(path: PathLike, persistent?: boolean, recursive?: boolean, encoding?: BufferEncoding): void;
     close(): void;
 }
+export {};

package/lib/volume.js

@@ -38,17 +38,7 @@ var util = require("util");
 var promises_1 = require("./promises");
 var resolveCrossPlatform = pathModule.resolve;
 var O_RDONLY = constants_1.constants.O_RDONLY, O_WRONLY = constants_1.constants.O_WRONLY, O_RDWR = constants_1.constants.O_RDWR, O_CREAT = constants_1.constants.O_CREAT, O_EXCL = constants_1.constants.O_EXCL, O_TRUNC = constants_1.constants.O_TRUNC, O_APPEND = constants_1.constants.O_APPEND, O_SYNC = constants_1.constants.O_SYNC, O_DIRECTORY = constants_1.constants.O_DIRECTORY, F_OK = constants_1.constants.F_OK, COPYFILE_EXCL = constants_1.constants.COPYFILE_EXCL, COPYFILE_FICLONE_FORCE = constants_1.constants.COPYFILE_FICLONE_FORCE;
-var sep;
-var relative;
-if (pathModule.posix) {
-    var posix = pathModule.posix;
-    sep = posix.sep;
-    relative = posix.relative;
-}
-else {
-    sep = pathModule.sep;
-    relative = pathModule.relative;
-}
+var _a = pathModule.posix ? pathModule.posix : pathModule, sep = _a.sep, relative = _a.relative, join = _a.join, dirname = _a.dirname;
 var isWin = process_1.default.platform === 'win32';
 var kMinPoolSpace = 128;
 // const kMaxLength = require('buffer').kMaxLength;
@@ -410,6 +400,29 @@ function validateGid(gid) {
     if (typeof gid !== 'number')
         throw TypeError(ERRSTR.GID);
 }
+function flattenJSON(nestedJSON) {
+    var flatJSON = {};
+    function flatten(pathPrefix, node) {
+        for (var path in node) {
+            var contentOrNode = node[path];
+            var joinedPath = join(pathPrefix, path);
+            if (typeof contentOrNode === 'string') {
+                flatJSON[joinedPath] = contentOrNode;
+            }
+            else if (typeof contentOrNode === 'object' && contentOrNode !== null && Object.keys(contentOrNode).length > 0) {
+                // empty directories need an explicit entry and therefore get handled in `else`, non-empty ones are implicitly considered
+                flatten(joinedPath, contentOrNode);
+            }
+            else {
+                // without this branch null, empty-object or non-object entries would not be handled in the same way
+                // by both fromJSON() and fromNestedJSON()
+                flatJSON[joinedPath] = null;
+            }
+        }
+    }
+    flatten('', nestedJSON);
+    return flatJSON;
+}
 /**
  * `Volume` represents a file system.
  */
@@ -486,6 +499,11 @@ var Volume = /** @class */ (function () {
         vol.fromJSON(json, cwd);
         return vol;
     };
+    Volume.fromNestedJSON = function (json, cwd) {
+        var vol = new Volume();
+        vol.fromNestedJSON(json, cwd);
+        return vol;
+    };
     Object.defineProperty(Volume.prototype, "promises", {
         get: function () {
             if (this.promisesApi === null)
@@ -729,18 +747,14 @@ var Volume = /** @class */ (function () {
         }
         return json;
     };
-    // fromJSON(json: {[filename: string]: string}, cwd: string = '/') {
     Volume.prototype.fromJSON = function (json, cwd) {
         if (cwd === void 0) { cwd = process_1.default.cwd(); }
         for (var filename in json) {
             var data = json[filename];
+            filename = resolve(filename, cwd);
             if (typeof data === 'string') {
-                filename = resolve(filename, cwd);
-                var steps = filenameToSteps(filename);
-                if (steps.length > 1) {
-                    var dirname = sep + steps.slice(0, steps.length - 1).join(sep);
-                    this.mkdirpBase(dirname, 511 /* DIR */);
-                }
+                var dir = dirname(filename);
+                this.mkdirpBase(dir, 511 /* DIR */);
                 this.writeFileSync(filename, data);
             }
             else {
@@ -748,6 +762,9 @@ var Volume = /** @class */ (function () {
             }
         }
     };
+    Volume.prototype.fromNestedJSON = function (json, cwd) {
+        this.fromJSON(flattenJSON(json), cwd);
+    };
     Volume.prototype.reset = function () {
         this.ino = 0;
         this.inodes = {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "memfs",
-  "version": "3.1.3",
+  "version": "3.2.0",
   "description": "In-memory file-system with Node's fs API.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",