@valtech-commerce/fs/src/async/lib/misc.js

graceful-fs / fs-extra wrapper with goodies

//--------------------------------------------------------
//-- Miscellaneous
//--------------------------------------------------------
'use strict';

const async           = require('async');
const { forEach }     = require('async-foreach');
const deleteEmpty     = require('delete-empty');
const fsExtra         = require('fs-extra');
const glob            = require('glob');
const gracefulFs      = require('graceful-fs');
const junk            = require('junk');
const klaw            = require('klaw');
const minimatch       = require('minimatch');
const { default: ow } = require('ow');
const path            = require('path');
const rimraf          = require('rimraf');
const zlib            = require('zlib');
const utils           = require('./helpers/utils');


class FspMisc {

	scandir(root, type, { recursive = false, fullPath = false, pattern = '**', keepJunk = false } = {}) {
		ow(root,      ow.string.nonEmpty);
		ow(type,      ow.string.nonEmpty.is(() => { return ['file', 'dir'].includes(type) || `Must be 'file' or 'dir'`; }));
		ow(recursive, ow.boolean);
		ow(fullPath,  ow.boolean);
		ow(pattern,   ow.string.nonEmpty);
		ow(keepJunk,  ow.boolean);

		return new Promise((resolve) => {

			// Remove trailing slash
			const rootPath = root.replace(/\/$/u, '');

			const list = [];

			klaw(rootPath, {
				nodir:      false,
				nofile:     type === 'dir',
				depthLimit: recursive ? -1 : 0
			})

				.on('readable', function() {
					let item;

					// eslint-disable-next-line no-cond-assign
					while (item = this.read()) {
						const { path: current, stats } = item;

						const file     = current.split(path.sep).pop();
						const relative = current.slice(rootPath.length + 1);

						if (
							(type === 'dir' || (type === 'file' && !stats.isDirectory())) &&
							(keepJunk || (!keepJunk && junk.not(file) && !['.gitkeep'].includes(file))) &&
							minimatch(relative, pattern, { dot: true, matchBase: true })
						) {

							list.push(fullPath ? item.path : item.path.slice(rootPath.length + 1));
						}
					}
				})

				.on('end', () => {
					resolve(list);
				})
			;
		});

	}


  // eslint-disable-next-line unicorn/prevent-abbreviations
	removeEmptyDir(root) {
		ow(root, ow.string.nonEmpty);

		return deleteEmpty(root);
	}


	removePattern(pattern) {
		ow(pattern, ow.string.nonEmpty);

		return new Promise((resolve, reject) => {
			rimraf(pattern, (error) => {
				if (!error) {
					resolve();
				} else {
					reject(error);
				}
			});
		});
	}


	mergeFiles(sources, destination) {
		ow(sources,     ow.array.nonEmpty);
		ow(destination, ow.string.nonEmpty);

		return new Promise((resolve) => {

			fsExtra.remove(destination).then(() => {

				forEach(sources, function(file) {
					const done = this.async();

					const readStream  = gracefulFs.createReadStream(file);
					const writeStream = gracefulFs.createWriteStream(destination, { flags: 'a' });

					if (destination.endsWith('.gz')) {
						readStream.pipe(zlib.createGzip({ level: utils.defaultCompressionLevel })).pipe(writeStream);
					} else {
						readStream.pipe(writeStream);
					}

					readStream.on('close', done);

				}, resolve);
			});
		});
	}


	chmodPattern(pattern, mode, options) {
		ow(pattern, ow.string.nonEmpty);
		ow(mode,    ow.number.integer.positive.finite);
		ow(options, ow.optional.object);

		return new Promise((resolve, reject) => {

			glob(pattern, options, (error, matches) => {
				if (!error) {
					async.every(matches, (match, callback) => {
						gracefulFs.chmod(match, mode, callback);
					}, () => {
						resolve();
					});
				} else {
					reject(error);
				}
			});
		});
	}

}


module.exports = new FspMisc();