mem-fs-editor 5.0.0 → 7.0.1

package/README.md

@@ -1,19 +1,17 @@
-mem-fs-editor [![Build Status](https://api.travis-ci.org/SBoudrias/mem-fs-editor.svg?branch=master)](https://travis-ci.org/SBoudrias/mem-fs-editor) [![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 [![Build Status](https://api.travis-ci.org/SBoudrias/mem-fs-editor.svg?branch=master)](https://travis-ci.org/SBoudrias/mem-fs-editor) [![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)
 
 File edition helpers working on top of [mem-fs](https://github.com/SBoudrias/mem-fs)
 
-Usage
--------------
+## Usage
 
 ```js
-var memFs = require('mem-fs');
-var editor = require('mem-fs-editor');
+var memFs = require("mem-fs");
+var editor = require("mem-fs-editor");
 
 var store = memFs.create();
 var fs = editor.create(store);
 
-fs.write('somefile.js', 'var a = 1;');
+fs.write("somefile.js", "var a = 1;");
 ```
 
 ### `#read(filepath, [options])`
@@ -61,7 +59,7 @@ Optionally take the same JSON formatting arguments than `#writeJSON()`.
 
 Delete a file or a directory.
 
-`filePath` can also be a `glob`. If `filePath` is glob, you can optionally pass in an `options.globOptions` object to change its pattern matching behavior. The full list of options are being described [here](https://github.com/isaacs/node-glob#options). The `sync` flag is forced to be `true` in `globOptions`.
+`filePath` can also be a `glob`. If `filePath` is glob, you can optionally pass in an `options.globOptions` object to change its pattern matching behavior. The full list of options are being described [here](https://github.com/mrmlnc/fast-glob#options-1). The `sync` flag is forced to be `true` in `globOptions`.
 
 ### `#copy(from, to, [options], context[, templateOptions ])`
 
@@ -69,7 +67,11 @@ Copy a file from the `from` path to the `to` path.
 
 Optionally, pass an `options.process` function (`process(contents)`) returning a string or a buffer who'll become the new file content. The process function will take a single contents argument who is the copied file contents as a `Buffer`.
 
-`from` can be a glob pattern that'll be match against the file system. If that's the case, then `to` must be an output directory. For a globified `from`, you can optionally pass in an `options.globOptions` object to change its pattern matching behavior. The full list of options are being described [here](https://github.com/isaacs/node-glob#options). The `nodir` flag is forced to be `true` in `globOptions` to ensure a vinyl object representing each matching directory is marked as `deleted` in the `mem-fs` store.
+`option.ignoreNoMatch` can be used to silence the error thrown if no files match the `from` pattern.
+
+`from` can be a glob pattern that'll be match against the file system. If that's the case, then `to` must be an output directory. For a globified `from`, you can optionally pass in an `options.globOptions` object to change its pattern matching behavior. The full list of options are being described [here](https://github.com/mrmlnc/fast-glob#options-1). The `nodir` flag is forced to be `true` in `globOptions` to ensure a vinyl object representing each matching directory is marked as `deleted` in the `mem-fs` store.
+
+Optionally, when `from` is a glob pattern, pass an `options.processDestinationPath` function (`processDestinationPath(destinationFile)`) returning a string who'll become the new file name.
 
 ### `#copyTpl(from, to, context[, templateOptions [, copyOptions]])`
 
@@ -85,7 +87,9 @@ Templates syntax looks like this:
 <%= value %>
 <%- include('partial.ejs', { name: 'Simon' }) %>
 ```
+
 Dir syntax looks like this:
+
 ```
 /some/path/dir<%= value %>/...
 ```

package/lib/actions/append.js

@@ -1,13 +1,13 @@
 'use strict';
 
-var extend = require('deep-extend');
 var EOL = require('os').EOL;
 
 module.exports = function (to, contents, options) {
-  options = extend({
+  options = {
     trimEnd: true,
-    separator: EOL
-  }, options || {});
+    separator: EOL,
+    ...options
+  };
 
   var currentContents = this.read(to);
   if (options.trimEnd) {

package/lib/actions/commit.js

@@ -11,6 +11,7 @@ function write(file) {
   if (!fs.existsSync(dir)) {
     mkdirp.sync(dir);
   }
+
   fs.writeFileSync(file.path, file.contents, {
     mode: file.stat ? file.stat.mode : null
   });

package/lib/actions/copy-tpl.js

@@ -1,21 +1,20 @@
 'use strict';
 
-var extend = require('deep-extend');
 var ejs = require('ejs');
-var isBinaryFile = require('isbinaryfile');
+var isBinaryFileSync = require('isbinaryfile').isBinaryFileSync;
 
 function render(contents, filename, context, tplSettings) {
   let result;
 
   const contentsBuffer = Buffer.from(contents, 'binary');
-  if (isBinaryFile.sync(contentsBuffer, contentsBuffer.length)) {
+  if (isBinaryFileSync(contentsBuffer, contentsBuffer.length)) {
     result = contentsBuffer;
   } else {
     result = ejs.render(
       contents.toString(),
       context,
       // Setting filename by default allow including partials.
-      extend({filename: filename}, tplSettings)
+      {filename: filename, ...tplSettings}
     );
   }
 
@@ -26,10 +25,17 @@ module.exports = function (from, to, context, tplSettings, options) {
   context = context || {};
   tplSettings = tplSettings || {};
 
-  this.copy(from, to, extend(options || {}, {
-    process: function (contents, filename) {
-      return render(contents, filename, context, tplSettings);
-    }
-  }),
-  context, tplSettings);
+  this.copy(
+    from,
+    to,
+    {
+      processDestinationPath: path => path.replace(/.ejs$/, ''),
+      ...options,
+      process: function (contents, filename) {
+        return render(contents, filename, context, tplSettings);
+      }
+    },
+    context,
+    tplSettings
+  );
 };

package/lib/actions/copy.js

@@ -5,7 +5,6 @@ var fs = require('fs');
 var path = require('path');
 var glob = require('glob');
 var globby = require('globby');
-var extend = require('deep-extend');
 var multimatch = require('multimatch');
 var ejs = require('ejs');
 var util = require('../util');
@@ -20,11 +19,12 @@ exports.copy = function (from, to, options, context, tplSettings) {
   options = options || {};
   var fromGlob = util.globify(from);
 
-  var globOptions = extend(options.globOptions || {}, {nodir: true});
+  var globOptions = {...options.globOptions, nodir: true};
   var diskFiles = globby.sync(fromGlob, globOptions);
   var storeFiles = [];
   this.store.each(file => {
-    if (multimatch([file.path], fromGlob).length !== 0) {
+    // The store may have a glob path and when we try to copy it will fail because not real file
+    if (!glob.hasMagic(file.path) && multimatch([file.path], fromGlob).length !== 0) {
       storeFiles.push(file.path);
     }
   });
@@ -37,15 +37,16 @@ exports.copy = function (from, to, options, context, tplSettings) {
       'When copying multiple files, provide a directory as destination'
     );
 
+    const processDestinationPath = options.processDestinationPath || (path => path);
     var root = util.getCommonPath(from);
     generateDestination = filepath => {
       var toFile = path.relative(root, filepath);
-      return path.join(to, toFile);
+      return processDestinationPath(path.join(to, toFile));
     };
   }
 
   // Sanity checks: Makes sure we copy at least one file.
-  assert(files.length > 0, 'Trying to copy from a source that does not exist: ' + from);
+  assert(options.ignoreNoMatch || files.length > 0, 'Trying to copy from a source that does not exist: ' + from);
 
   files.forEach(file => {
     this._copySingle(file, generateDestination(file), options, context, tplSettings);
@@ -63,6 +64,7 @@ exports._copySingle = function (from, to, options, context, tplSettings) {
   if (options.process) {
     contents = applyProcessingFunc(options.process, file.contents, file.path);
   }
+
   if (context) {
     to = ejs.render(to, context, tplSettings);
   }

package/lib/actions/delete.js

@@ -16,6 +16,7 @@ module.exports = function (paths, options) {
   if (!Array.isArray(paths)) {
     paths = [paths];
   }
+
   paths = paths.map(function (filePath) {
     return path.resolve(filePath);
   });

package/lib/util.js

@@ -36,6 +36,7 @@ exports.globify = function (filePath) {
   if (glob.hasMagic(filePath)) {
     return filePath;
   }
+
   if (!fs.existsSync(filePath)) {
     // The target of a pattern who's not a glob and doesn't match an existing
     // entity on the disk is ambiguous. As such, match both files and directories.
@@ -49,8 +50,10 @@ exports.globify = function (filePath) {
   if (fsStats.isFile()) {
     return filePath;
   }
+
   if (fsStats.isDirectory()) {
     return path.join(filePath, '**');
   }
+
   throw new Error('Only file path or directory path are supported.');
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mem-fs-editor",
-  "version": "5.0.0",
+  "version": "7.0.1",
   "description": "File edition helpers working on top of mem-fs",
   "scripts": {
     "pretest": "eslint .",
@@ -16,28 +16,31 @@
   "dependencies": {
     "commondir": "^1.0.1",
     "deep-extend": "^0.6.0",
-    "ejs": "^2.5.9",
-    "glob": "^7.0.3",
-    "globby": "^8.0.1",
-    "isbinaryfile": "^3.0.2",
-    "mkdirp": "^0.5.0",
-    "multimatch": "^2.0.0",
-    "rimraf": "^2.2.8",
-    "through2": "^2.0.0",
-    "vinyl": "^2.0.1"
+    "ejs": "^3.0.1",
+    "glob": "^7.1.4",
+    "globby": "^9.2.0",
+    "isbinaryfile": "^4.0.0",
+    "mkdirp": "^1.0.0",
+    "multimatch": "^4.0.0",
+    "rimraf": "^3.0.0",
+    "through2": "^3.0.1",
+    "vinyl": "^2.2.0"
   },
   "devDependencies": {
-    "coveralls": "^3.0.0",
+    "coveralls": "^3.0.3",
     "escape-regexp": "0.0.1",
-    "eslint": "^5.0.1",
-    "eslint-config-xo-space": "^0.19.0",
-    "jest": "^23.2.0",
+    "eslint": "^6.0.0",
+    "eslint-config-xo-space": "^0.21.0",
+    "jest": "^24.8.0",
     "mem-fs": "^1.0.0",
-    "sinon": "^6.0.1"
+    "sinon": "^8.0.0"
   },
   "jest": {
     "collectCoverage": true,
     "coverageDirectory": "coverage",
     "testEnvironment": "node"
+  },
+  "engines": {
+    "node": ">=10.0.0"
   }
 }