smart-fs

smart-fs

Abstraction Layer for File Management.

Drop in replacement for fs.

Getting Started

$ npm install --save smart-fs

Functions

guessFile(filepath, { exclude = [] })

Extends and returns filepath with the file extension as appropriate. Returns null if no good match was found.

A few notes:

• Only extends extensions, not partial file names
• Will prefer to match the exact file
• Will return null when multiple possible extensions are found

To exclude certain extensions from being matched provide them in the exclude option.

walkDir(dirpath)

Iteratively walk dirpath and return relative paths of all files contained.

Will only return entries where fs.lstatSync(...).isFile() evaluates to true (this excludes symlinks).

cleaningDelete(filepath)

Delete file and all empty parent directories.

smartRead(filepath, options = { treatAs = null, resolve = true })

Read and parse file based on file extension.

The following extensions are handled in order:

• .json: Loads file using JSON.parse.
• .xml: Loads file using xml-js.
• .yml and .yaml: Loads file using yaml-boost.
• .js: Loads file using require.
• .*: Treats file as text file and loads as array of lines.

Note that the required cache is not automatically invalidated when loading cached .js files.

To ignore file extension and force treat the file as a certain type, you can pass the option treatAs as e.g. json.

To simply load yml files without resolving them pass resolve as false

smartWrite(filepath. content, options = { treatAs = null, mergeStrategy = (existing, changeset) => changeset, create = true, pretty = false, keepOrder = true, resolve = false })

Serialize and write content to file based on file extension.

The file and all necessary folders are created if not present.

The file is only actually written if the content has changed. Returns true if the file was written, false otherwise.

The following extension are handled in order:

• .json: Serialize uses JSON.stringify.
• .xml: Serialize using xml-js.
• .yml and .yaml: Serialize uses yaml-boost.
• .*: Expects content as array and serializes by joining array using new line character.

To ignore file extension and force treat the file as a certain type, you can pass the option treatAs as e.g. json.

The mergeStrategy option can be used to customize how the new content is merged if the target file already exists. By default the file is simply overwritten.

When create is set to false no action is taken if the file does not already exist.

When pretty is set to true, the output is formatted more compact.

When keepOrder is set to true and a file is overwritten, the new content is ordered according to the existing content (e.g. for json and yml)

To resolve the original file before overwrite merging pass the option as true.

Important

Do not use this library for loading if you don't trust the source of the files you are loading!