mem-fs-editor 9.0.2 → 9.4.0

package/README.md

@@ -1,17 +1,21 @@
-# mem-fs-editor [![Node.js CI](https://github.com/SBoudrias/mem-fs-editor/workflows/Node.js%20CI/badge.svg)](https://github.com/SBoudrias/mem-fs-editor/actions?query=workflow%3A%22Node.js+CI%22) [![NPM version](https://badge.fury.io/js/mem-fs-editor.svg)](http://badge.fury.io/js/mem-fs-editor) [![Coverage Status](https://coveralls.io/repos/github/SBoudrias/mem-fs-editor/badge.svg)](https://coveralls.io/github/SBoudrias/mem-fs-editor)
+# mem-fs-editor
+
+[![Node.js CI](https://github.com/SBoudrias/mem-fs-editor/workflows/Node.js%20CI/badge.svg)](https://github.com/SBoudrias/mem-fs-editor/actions?query=workflow%3A%22Node.js+CI%22)
+[![NPM version](https://badge.fury.io/js/mem-fs-editor.svg)](http://badge.fury.io/js/mem-fs-editor)
+[![Coverage Status](https://codecov.io/gh/SBoudrias/mem-fs-editor/branch/master/graph/badge.svg)](https://codecov.io/gh/SBoudrias/mem-fs-editor)
 
 File edition helpers working on top of [mem-fs](https://github.com/SBoudrias/mem-fs)
 
 ## Usage
 
 ```js
-var memFs = require("mem-fs");
-var editor = require("mem-fs-editor");
+import memFs from 'mem-fs';
+import editor from 'mem-fs-editor';
 
-var store = memFs.create();
-var fs = editor.create(store);
+const store = memFs.create();
+const fs = editor.create(store);
 
-fs.write("somefile.js", "var a = 1;");
+fs.write('somefile.js', 'var a = 1;');
 ```
 
 ### `#read(filepath, [options])`
@@ -82,6 +86,8 @@ Optionally, pass an `options.process` function (`process(contents)`) returning a
 
 Optionally, when `from` is a glob pattern, pass an `options.processDestinationPath` function (`processDestinationPath(destinationFile)`) returning a string who'll become the new file name.
 
+`options.noGlob` can be used to by bypass glob matching entirely. In that case, `from` will directly match file paths against the file system.
+
 ### `#copyAsync(from, to, [options], context[, templateOptions ])`
 
 Async version of `copy`.
@@ -140,3 +146,9 @@ If provided, `filters` is an array of TransformStream to be applied on a stream
 If provided, `stream` is a stream of vinyl files.
 
 `callback` is called once the files are updated on disk.
+
+### `#dump([cwd,] [filter])`
+
+Dump files to compare expected result.
+Provide a `cwd` for relative path. Allows to omit temporary path.
+Provide a `filter` function or glob to focus on specific files.

package/lib/actions/commit-file-async.js

@@ -32,7 +32,11 @@ async function remove(file) {
 }
 
 module.exports = async function (file) {
-  this.store.add(file);
+  const existingFile = this.store.get(file.path);
+  if (!existingFile || existingFile !== file) {
+    this.store.add(file);
+  }
+
   if (isFileStateModified(file)) {
     setCommittedFile(file);
     await write(file);

package/lib/actions/copy.js

@@ -19,8 +19,15 @@ exports.copy = function (from, to, options, context, tplSettings) {
   options = options || {};
   const fromGlob = util.globify(from);
 
-  const globOptions = {...options.globOptions, nodir: true};
-  const diskFiles = globby.sync(fromGlob, globOptions).map(file => path.resolve(file));
+  let diskFiles = [];
+  if (options.noGlob) {
+    const fromFiles = Array.isArray(fromGlob) ? fromGlob : [fromGlob];
+    diskFiles = fromFiles.filter(filepath => fs.existsSync(filepath));
+  } else {
+    const globOptions = {...options.globOptions, nodir: true};
+    diskFiles = globby.sync(fromGlob, globOptions).map(file => path.resolve(file));
+  }
+
   const storeFiles = [];
   this.store.each(file => {
     // The store may have a glob path and when we try to copy it will fail because not real file
@@ -31,7 +38,7 @@ exports.copy = function (from, to, options, context, tplSettings) {
   const files = diskFiles.concat(storeFiles);
 
   let generateDestination = () => to;
-  if (Array.isArray(from) || !this.exists(from) || globby.hasMagic(normalize(from))) {
+  if (Array.isArray(from) || !this.exists(from) || (globby.hasMagic(normalize(from)) && !options.noGlob)) {
     assert(
       !this.exists(to) || fs.statSync(to).isDirectory(),
       'When copying multiple files, provide a directory as destination',

package/lib/actions/dump.js

@@ -2,12 +2,18 @@
 
 const path = require('path');
 const normalize = require('normalize-path');
+const minimatch = require('minimatch');
 
 const {hasClearedState, hasState, STATE, STATE_CLEARED} = require('../state');
 
 module.exports = function (cwd = process.cwd(), filter = file => hasClearedState(file) || hasState(file)) {
+  if (typeof filter === 'string') {
+    const pattern = filter;
+    filter = file => minimatch(file.path, pattern);
+  }
+
   return Object.fromEntries(
-    this.store.all().filter(file => filter(file)).map(file => {
+    this.store.all().filter(file => filter(file, cwd)).map(file => {
       const filePath = normalize(cwd ? path.relative(cwd, file.path) : file.path);
       const fileDump = {
         contents: file.contents ? file.contents.toString() : file.contents,

package/lib/actions/write.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const assert = require('assert');
-const {setModifiedFileState} = require('../state');
+const {isFileStateModified, setModifiedFileState} = require('../state');
 
 module.exports = function (filepath, contents, stat) {
   assert(
@@ -10,10 +10,18 @@ module.exports = function (filepath, contents, stat) {
   );
 
   const file = this.store.get(filepath);
-  setModifiedFileState(file);
-  file.contents = Buffer.isBuffer(contents) ? contents : Buffer.from(contents);
-  file.stat = stat;
-  this.store.add(file);
+  const newContents = Buffer.isBuffer(contents) ? contents : Buffer.from(contents);
+  if (
+    !isFileStateModified(file)
+    || !Buffer.isBuffer(file.contents)
+    || !newContents.equals(file.contents)
+    || (stat !== undefined && file.stat !== stat)
+  ) {
+    setModifiedFileState(file);
+    file.contents = newContents;
+    file.stat = stat;
+    this.store.add(file);
+  }
 
   return file.contents.toString();
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mem-fs-editor",
-  "version": "9.0.2",
+  "version": "9.4.0",
   "description": "File edition helpers working on top of mem-fs",
   "scripts": {
     "fix": "eslint . --fix",
@@ -15,15 +15,16 @@
     "lib"
   ],
   "dependencies": {
-    "binaryextensions": "^4.15.0",
+    "binaryextensions": "^4.16.0",
     "commondir": "^1.0.1",
     "deep-extend": "^0.6.0",
     "ejs": "^3.1.6",
     "globby": "^11.0.3",
     "isbinaryfile": "^4.0.8",
+    "minimatch": "^3.0.4",
     "multimatch": "^5.0.0",
     "normalize-path": "^3.0.0",
-    "textextensions": "^5.12.0"
+    "textextensions": "^5.13.0"
   },
   "peerDependencies": {
     "mem-fs": "^2.1.0"
@@ -36,11 +37,11 @@
   "devDependencies": {
     "coveralls": "^3.0.3",
     "escape-regexp": "0.0.1",
-    "eslint": "^7.26.0",
-    "eslint-config-xo-space": "^0.28.0",
+    "eslint": "^8.5.0",
+    "eslint-config-xo-space": "^0.30.0",
     "jest": "^27.0.6",
-    "mem-fs": "^2.1.0",
-    "sinon": "^11.1.2"
+    "mem-fs": "^2.2.1",
+    "sinon": "^12.0.1"
   },
   "jest": {
     "collectCoverage": true,