SBoudrias/mem-fs-editor


File edition helpers working on top of mem-fs (https://github.com/SBoudrias/mem-fs)

License: MIT

Language: JavaScript


mem-fs-editor Build Status NPM version Coverage Status

File edition helpers working on top of mem-fs

Usage

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;");

#read(filepath, [options])

Read a file and return its contents as a string.

You can alternatively get the raw contents buffer if you pass options.raw = true.

By default, calling read() on a file path that does not exist throws error. You can, however, pass options.defaults = 'your default content' to get a default content you pass in, if you prefer to not deal with try/catch.

#readJSON(filepath, [defaults])

Read a file and parse its contents as JSON.

readJSON() internally calls read() but will not throw an error if the file path you pass in does not exist. If you pass in an optional defaults, the defaults content will be returned in case of the target file is missing, instead of undefined. (Error would still be thrown if JSON.parse failed to parse your target file.)

#write(filepath, contents)

Replace the content of a file (existing or new) with a string or a buffer.

#writeJSON(filepath, contents[, replacer [, space]])

Replace the content of a file (existing or new) with an object that is to be converted by calling JSON.stringify().

contents should usually be a JSON object, but it can technically be anything that is acceptable by JSON.stringify.

Optionally pass replacer and space as the last two arguments, as defined by JSON.stringify. spacer is used to format the output string (prettify).

Default value for space is 2, when not specified.

#append(filepath, contents, [options])

Append the new contents to the current file contents.

  • options.trimEnd (default true). Trim trailing whitespace of the current file contents.
  • options.separator (default os.EOL). Separator to insert between current and new contents.

#extendJSON(filepath, contents[, replacer [, space]])

Extend the content of an existing JSON file with the partial objects provided as argument.

Optionally take the same JSON formatting arguments than #writeJSON().

#delete(filepath, [options])

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. The sync flag is forced to be true in globOptions.

#copy(from, to, [options], context[, templateOptions ])

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.

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. 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.

#copyTpl(from, to, context[, templateOptions [, copyOptions]])

Copy the from file and, if it is not a binary file, parse its content as an ejs template where context is the template context (the variable names available inside the template).

You can optionally pass a templateOptions object. mem-fs-editor automatically setup the filename option so you can easily use partials.

You can also optionally pass a copyOptions object (see copy() documentation for more details).

Templates syntax looks like this:

<%= value %>
<%- include('partial.ejs', { name: 'Simon' }) %>

Dir syntax looks like this:

/some/path/dir<%= value %>/...

Refer to the ejs documentation for more details.

#move(from, to, [options])

Move/rename a file from the from path to the to path.

#move internally uses #copy and #delete, so from can be a glob pattern, and you can provide options.globOptions with it.

#exists(filepath)

Returns true if a file exists. Returns false if the file is not found or deleted.

#commit([filters,] callback)

Persist every changes made to files in the mem-fs store to disk.

If provided, filters is an array of TransformStream to be applied on a stream of vinyl files (like gulp plugins).

callback is called once the files are updated on disk.

Project Statistics

Sourcerank 14
Repository Size 447 KB
Stars 277
Forks 33
Watchers 9
Open issues 12
Dependencies 531
Contributors 22
Tags 27
Created
Last updated
Last pushed

Top Contributors See all

Simon Boudrias greenkeeper[bot] Brian Lai Manuel Thalmann Steve Mao Sindre Sorhus Ian Paterson c.tarol c.tarol Jan Pilzer Rodrigo Moreno Nathan Jakub Bogucki alqh Kevin Schaul Michael Kühnel Jason Bellamy Shannon Moeller Stephan Schneider Johan Sjöblom

Packages Referencing this Repo

mem-fs-editor
File edition helpers working on top of mem-fs
Latest release 6.0.0 - Updated - 277 stars

Recent Tags See all

v6.0.0 May 28, 2019
v5.1.0 July 03, 2018
v5.0.0 June 30, 2018
v5.0.0 June 30, 2018
v4.0.3 June 30, 2018
v4.0.2 May 06, 2018
v4.0.1 April 30, 2018
v4.0.0 January 15, 2018
v3.0.2 January 31, 2017
v3.0.1 January 29, 2017
v3.0.0 January 27, 2017
v2.3.0 July 12, 2016
v2.2.1 May 27, 2016
v2.2.0 March 01, 2016
v2.1.0 November 24, 2015

Something wrong with this page? Make a suggestion

Last synced: 2019-05-28 09:48:52 UTC

Login to resync this repository