wrapper to path module, to simple require, get and others. 

wrapper to path module, to simple require, get and others

bmunoz89

jfierro

wrapper-path

  "description": "wrapper to path module, to simple require, get and others",

    "test-spec": "mocha --reporter spec test/index.js",

    "benchmark": "node --max_old_space_size=4096"

  "author": "Jonathan Fierro Sandoval <jofierro@live.com>",

    "url": "https://github.com/jofierro/wrapper-path"

    "url": "https://github.com/jofierro/wrapper-path/issues"

        resolve: require('path').resolve,

        readdirSync: require('fs').readdirSync,

        rmdirSync: require('fs').rmdirSync,

        statSync: require('fs').statSync,

        unlinkSync: require('fs').unlinkSync,

        if (!pathRoot || typeof pathRoot !== 'string') throw new Error('Param must be "string"');

        this.pathRoot = path.resolve(pathRoot);

        if (!dir || typeof dir !== 'string') throw new Error('Param must be "string"');

        if (dir.charAt(0) !== '/') throw new Error('Invalid path');

        if (dir.charAt(0) !== '/') throw new Error(`Invalid path "${dir}"`);

        if (!dir.startsWith(this.pathRoot)) return `${this.pathRoot}${dir}`;

            return fs.statSync(dir).isDirectory();

            throw new Error('No such file or directory');

            throw new Error(`No such file or directory "${dir}"`);

            throw new Error('Not a directory');

            throw new Error(`Not a directory "${dir}"`);

        if (this._isDirectory(dir) && dir.charAt(dir.length - 1) !== '/')

            files: function recursiveFiles(dir, opts, filelist, currentDepth = 0) {

                const {match, exclude, maxDepth = -1} = opts || {};

                if (maxDepth !== -1 && currentDepth === maxDepth)

                filelist = filelist || [];

                const files = self._getFiles(dir);

                for (let i = files.length - 1; i >= 0; i--) {

                    if (self._isDirectory(`${dir}${file}`))

                        recursiveFiles(`${dir}${file}`, opts, filelist, currentDepth + 1);

                        flag &= (match) ? match.test(`${dir}${file}`) : flag;

                        flag &= (exclude) ? !exclude.test(`${dir}${file}`) : flag;

                            filelist.push(`${dir}${file}`);

            folders: function recursiveFolders(dir, opts, folderlist, currentDepth = 0) {

                const {match, exclude, maxDepth = 0} = opts || {};

                if (maxDepth > 0 && currentDepth === maxDepth)

                folderlist = folderlist || [];

                    const file = files[i];

                    if (self._isDirectory(`${dir}${file}`)) {

                            folderlist.push(`${dir}${file}`);

                        return recursiveFolders(`${dir}${file}`, opts, folderlist, currentDepth + 1);

            file = (dir) => fs.unlinkSync(self.get(dir)),

            files = (dir, opts) => self.recursive.files(dir, opts).forEach(file),

                    fs.rmdirSync(self.get(dir));

                    if (/ENOTEMPTY/g.test(e)) {

                        const files = self.recursive.files(dir);

                        for (let i = files.length - 1; i >= 0; i--) {

                            const file = files[i];

                            fs.unlinkSync(self.get(file));

                        const folders = self.recursive.folders(dir);

                        for (let i = folders.length - 1; i >= 0; i--) {

                            const folder = folders[i];

                            fs.rmdirSync(self.get(folder));

                        fs.rmdirSync(self.get(dir));

            folders = (dir, opts) => self.recursive.folders(dir, opts).forEach(folder);

        return {file, files, folder, folders};

> Este proyecto nace de la necesidad de poder hacer un "require" con una "ruta" mas comprensible.

Es un paquete, para poder realizar **require** de manera más práctica, sin tener que agregar **.** o **../** a las rutas de los módulos o paquetes que se desean incluir y que pueda hacer desde cualquier lugar del proyecto de la misma manera.

Tomando una ruta base '/' como se hace en los sistemas operativos. Esta puede ser la ruta al directorio del proyecto o a cualquier otro punto dentro del sistema desde donde se desee.

Pensemos en la siguiente estructura de archivos:

Este método es el que se llama cuando se realiza el siguiente código:

- param $*String*$ **required**: ruta que queremos tener como base de nuestro proyecto

$*Path*$: Retorna la instancia de la clase **Path**

Este método permite obtener la ruta completa a el archivo o directorio que solicitemos por parámetro.

let path = new Path('/home/personal/proyecto');

path.get('/app.js'); // /home/personal/proyecto/app.js

- param $*String*$ **required**: ruta que queremos obtener.

Este método permite hacer el **require** como si fuera nativo pero tomando la ruta base con la cual se instancia nuestro objeto path.

let carpeta1 = path.require('/carpeta1');

- param $*String*$ **required**: ruta que queremos cargar.

$*File/Folder*$: retorna la carga del archivo o carpeta.

Esta funcionalidad **recursive**, es para obtener un listado recursivamente de todos los archivos o carpetas de un directorio en especifico.

- Se modifica mensaje de error cuando no se encuentra el archivo/carpeta, con el objetivo de tener conocimiento de a que esta intentando acceder

- Corrección de documentación de **remove** y detalles ortográficos

- Función **recursive** tiene como opción la profundidad máxima (maxDepth) con la que se desea obtener el listado de archivos/carpetas

- Función **recursive** tiene como opción de profundidad máxima (maxDepth) con la que se desea obtener el listado de archivos/carpetas

- CHANGELOG.md se elimina el archivo y se incluye al final de README.md

- Resultados de la funcionalidad **recursive.files**

- Se mejora el rendimiento de las funcionalidades, utilizando **for** en vez de **forEach**

- Se crea una clase en vez de funcionalidades separadas

- Obtener listado de archivos o carpetas de un directorio o poder filtrar las rutas por expresiones regulares

- Poder eliminar los archivos de una carpeta o la carpeta o poder filtrar que eliminar por expresiones regulares

- Se elimina la funcionalidad para agregar a **global** de node, ya que esto está fuera del objetivo principal del modulo que es simplificar el uso del require del path y tener algunas funciones extras que son comunes en el uso de archivos y carpetas

- Se elimina el uso de lodash, para mejorar el rendimiento del modulo

- Obtener ruta completa en segun la base que instancia el wrapper

- Utilizar **require** del wrapper como el require nativo de node

- Permite agregar al objeto **global** de node según un prefijo

		{
		"name": "wrapper-path",
		"version": "2.1.1",
		"version": "2.1.2",
		"description": "wrapper to path module, to simple require, get and others",
		@@ -5,0 +5,0 @@ "main": "Path.js",

		@@ -183,2 +183,6 @@ # wrapper-path
		### Changed
		- Se modifica mensaje de error cuando no se encuentra el archivo/carpeta, con el objetivo de tener conocimiento de a que esta intentando acceder

		## [2.1.1] - 2018-01-03
		### Changed
		- Corrección de documentación de remove y detalles ortográficos
		@@ -188,3 +192,3 @@
		### Added
		- Función recursive tiene como opción la profundidad máxima (maxDepth) con la que se desea obtener el listado de archivos/carpetas
		- Función recursive tiene como opción de profundidad máxima (maxDepth) con la que se desea obtener el listado de archivos/carpetas

		@@ -191,0 +195,0 @@ ## [2.0.2] - 2017-11-20

		@@ -22,3 +22,3 @@ 'use strict';
		if (!dir \|\| typeof dir !== 'string') throw new Error('Param must be "string"');
		if (dir.charAt(0) !== '/') throw new Error('Invalid path');
		if (dir.charAt(0) !== '/') throw new Error(`Invalid path "${dir}"`);
		if (!dir.startsWith(this.pathRoot)) return `${this.pathRoot}${dir}`;
		@@ -32,3 +32,3 @@ return dir;
		} catch (e) {
		throw new Error('No such file or directory');
		throw new Error(`No such file or directory "${dir}"`);
		}
		@@ -41,3 +41,3 @@ }
		} catch (e) {
		throw new Error('Not a directory');
		throw new Error(`Not a directory "${dir}"`);
		}
		@@ -44,0 +44,0 @@ }

Improved metrics