@blackbyte/sugar 1.0.0-beta.1

package/dist/node/fs/fileHashSync.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @name            fileHashSync
+ * @namespace       node.fs
+ * @type            Function
+ * @platform        node
+ * @status          stable
+ *
+ * This function allows you to get back an integrity hash for the passed file.
+ * This mean that if a file returns the same integrity hash twice, the folder or files in it
+ * has not been updated...
+ *
+ * @param           {String}                filePath              The folder path you want to get the hash back
+ * @param           {TFileHashSettings}      [settings={}]        Some settings to configure your hash generation process
+ * @return          {String}                                      The calculated folder hash
+ *
+ * @setting         {String}                    [algo='sha356']             The algorithm to use
+ * @setting         {BinaryToTextEncoding}      [digest='base64']           How to digest the hash
+ *
+ * @todo            tests
+ *
+ * @snippet         fileHashSync($1)
+ *
+ * @example         js
+ * import { fileHashSync } from '@blackbyte/sugar/fs';
+ * fileHashSync('my/cool/folder'); // => YZOrKDx9LCLd8X39PoFTflXGpRU=,
+ *
+ * @since           1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TFileHashSettings = {
+    algo: 'md5' | 'sha1' | 'sha256' | 'sha512';
+    encoding: 'hex' | 'base64' | 'buffer' | 'latin1';
+};
+export default function fileHashSync(filePath: string, settings?: Partial<TFileHashSettings>): string;

package/dist/node/fs/fileHashSync.js

@@ -0,0 +1,10 @@
+import { hashFileSync } from 'hasha';
+export default function fileHashSync(filePath, settings = {}) {
+    const finalSettings = Object.assign({ algo: 'sha256', encoding: 'base64' }, (settings !== null && settings !== void 0 ? settings : {}));
+    return hashFileSync(filePath, {
+        algorithm: finalSettings.algo,
+        // @ts-ignore
+        encoding: finalSettings.encoding,
+    });
+}
+//# sourceMappingURL=fileHashSync.js.map

package/dist/node/fs/fileHashSync.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileHashSync.js","sourceRoot":"","sources":["../../../src/node/fs/fileHashSync.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AAqCrC,MAAM,CAAC,OAAO,UAAU,YAAY,CAClC,QAAgB,EAChB,WAAuC,EAAE;IAEzC,MAAM,aAAa,mBACjB,IAAI,EAAE,QAAQ,EACd,QAAQ,EAAE,QAAQ,IACf,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;IAEF,OAAO,YAAY,CAAC,QAAQ,EAAE;QAC5B,SAAS,EAAE,aAAa,CAAC,IAAI;QAC7B,aAAa;QACb,QAAQ,EAAE,aAAa,CAAC,QAAQ;KACjC,CAAC,CAAC;AACL,CAAC"}

package/dist/node/fs/filename.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @name                 filename
+ * @namespace            node.fs
+ * @type                 Function
+ * @platform             node
+ * @status               stable
+ *
+ * Return the filename from the passed path with or without the extension
+ *
+ * @param           {String}              path                        The path to take the filename from
+ * @param           {Boolean}             [withExtension=true]        Tell if we want the filename with or without the extension
+ * @return          {String}                                          The requested filename
+ *
+ * @todo        tests
+ *
+ * @snippet         filename($1)
+ *
+ * @example       js
+ * import { filename } from '@blackbyte/sugar/fs';
+ * filename('hello/world.js'); // => world.js
+ *
+ * @since         1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function filename(path: string, withExtension?: boolean): string;

package/dist/node/fs/filename.js

@@ -0,0 +1,34 @@
+import extension from '../fs/extension.js';
+/**
+ * @name                 filename
+ * @namespace            node.fs
+ * @type                 Function
+ * @platform             node
+ * @status               stable
+ *
+ * Return the filename from the passed path with or without the extension
+ *
+ * @param           {String}              path                        The path to take the filename from
+ * @param           {Boolean}             [withExtension=true]        Tell if we want the filename with or without the extension
+ * @return          {String}                                          The requested filename
+ *
+ * @todo        tests
+ *
+ * @snippet         filename($1)
+ *
+ * @example       js
+ * import { filename } from '@blackbyte/sugar/fs';
+ * filename('hello/world.js'); // => world.js
+ *
+ * @since         1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function filename(path, withExtension = true) {
+    var _a;
+    let filename = (_a = path.split('/').pop()) !== null && _a !== void 0 ? _a : '';
+    if (!withExtension) {
+        filename = filename.replace(`.${extension(filename)}`, '');
+    }
+    return filename;
+}
+//# sourceMappingURL=filename.js.map

package/dist/node/fs/filename.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filename.js","sourceRoot":"","sources":["../../../src/node/fs/filename.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,oBAAoB,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,OAAO,UAAU,QAAQ,CAC9B,IAAY,EACZ,gBAAyB,IAAI;;IAE7B,IAAI,QAAQ,GAAG,MAAA,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,mCAAI,EAAE,CAAC;IAC3C,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAC7D,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/dist/node/fs/findUp.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @name            findUp
+ * @namespace       node.fs
+ * @type            Function
+ * @platform        node
+ * @status          beta
+ * @async
+ *
+ * This function simply walk across upper folders to search for a file
+ * and returns you the first finded
+ *
+ * @param       {IFindUpSearch}         search              The name of the file you search
+ * @param       {TFindUpSettings}       [settings={}]       An object of settings to configure your research
+ * @return      {SFile|null}                                An SFile instance or null if nothings founded
+ *
+ * @todo            tests
+ *
+ * @snippet         findUp($1)
+ * await findUp($1)
+ *
+ * @example         js
+ * import { findUp } from '@blackbyte/sugar/fs';
+ * const file = await findUp('myCoolFile.json', {});
+ * console.log(file.path);
+ *
+ * @since       1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TFindUpSettings = {
+    symlinks?: boolean;
+    cwd?: string;
+    stopWhenFound?: boolean;
+};
+export default function findUp(search: string, settings: TFindUpSettings): Promise<string[]>;

package/dist/node/fs/findUp.js

@@ -0,0 +1,48 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as __fs from 'fs';
+import { globSync as __globSync } from 'glob';
+import isGlob from '../../shared/is/isGlob.js';
+export default function findUp(search, settings) {
+    settings = Object.assign({ symlinks: true, cwd: process.cwd(), stopWhenFound: true }, settings);
+    return new Promise((resolve) => __awaiter(this, void 0, void 0, function* () {
+        const cwd = settings.cwd;
+        // @ts-ignore
+        let currentPath = cwd.split('/').filter((p) => p.trim() !== '');
+        let foundedFiles = [];
+        while (currentPath.length > 0) {
+            const path = `/${currentPath.join('/')}`;
+            if (isGlob(search)) {
+                let files = __globSync(search, {
+                    cwd: path,
+                    follow: settings.symlinks,
+                });
+                if (files && files.length) {
+                    files = files.map((f) => {
+                        return `${path}/${f}`;
+                    });
+                    foundedFiles = [...foundedFiles, ...files];
+                }
+            }
+            else if (__fs.existsSync(`${path}/${search}`)) {
+                foundedFiles.push(`${path}/${search}`);
+            }
+            // check if we need to stop when found
+            if (settings.stopWhenFound && foundedFiles.length) {
+                break;
+            }
+            // update the currentPath
+            currentPath = currentPath.slice(0, -1);
+        }
+        // athe end
+        return resolve(foundedFiles);
+    }));
+}
+//# sourceMappingURL=findUp.js.map

package/dist/node/fs/findUp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"findUp.js","sourceRoot":"","sources":["../../../src/node/fs/findUp.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,KAAK,IAAI,MAAM,IAAI,CAAC;AAC3B,OAAO,EAAE,QAAQ,IAAI,UAAU,EAAE,MAAM,MAAM,CAAC;AAC9C,OAAO,MAAM,MAAM,2BAA2B,CAAC;AAqC/C,MAAM,CAAC,OAAO,UAAU,MAAM,CAC5B,MAAc,EACd,QAAyB;IAEzB,QAAQ,mBACN,QAAQ,EAAE,IAAI,EACd,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,EAClB,aAAa,EAAE,IAAI,IAChB,QAAQ,CACZ,CAAC;IAEF,OAAO,IAAI,OAAO,CAAC,CAAO,OAAO,EAAE,EAAE;QACnC,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;QACzB,aAAa;QACb,IAAI,WAAW,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QAChE,IAAI,YAAY,GAAa,EAAE,CAAC;QAEhC,OAAO,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YAEzC,IAAI,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;gBACnB,IAAI,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE;oBAC7B,GAAG,EAAE,IAAI;oBACT,MAAM,EAAE,QAAQ,CAAC,QAAQ;iBAC1B,CAAC,CAAC;gBACH,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;oBAC1B,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;wBACtB,OAAO,GAAG,IAAI,IAAI,CAAC,EAAE,CAAC;oBACxB,CAAC,CAAC,CAAC;oBACH,YAAY,GAAG,CAAC,GAAG,YAAY,EAAE,GAAG,KAAK,CAAC,CAAC;gBAC7C,CAAC;YACH,CAAC;iBAAM,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,IAAI,MAAM,EAAE,CAAC,EAAE,CAAC;gBAChD,YAAY,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,MAAM,EAAE,CAAC,CAAC;YACzC,CAAC;YACD,sCAAsC;YACtC,IAAI,QAAQ,CAAC,aAAa,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;gBAClD,MAAM;YACR,CAAC;YACD,yBAAyB;YACzB,WAAW,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACzC,CAAC;QAED,WAAW;QACX,OAAO,OAAO,CAAC,YAAY,CAAC,CAAC;IAC/B,CAAC,CAAA,CAAC,CAAC;AACL,CAAC"}

package/dist/node/fs/folderHashSync.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @name            folderHashSync
+ * @namespace       node.fs
+ * @type            Function
+ * @platform        node
+ * @status          stable
+ *
+ * This function allows you to get back an integrity hash for the passed folder.
+ * This mean that if a folder returns the same integrity hash twice, the folder or files in it
+ * has not been updated...
+ *
+ * @param           {String}                    folderPath          The folder path you want to get the hash back
+ * @param           {TFolderHashSettings}       [settings={}]       Some settings to configure your hash generation process
+ * @return          {String}                                        The calculated folder hash
+ *
+ * @setting         {Boolean}           [recursive=true]            Specify if you want to generate a hash using also the children or not
+ * @setting         {String}            [algo='sha356']             The algorithm to use
+ * @setting         {BinaryToTextEncoding}      [digest='base64']   How to digest the hash
+ *
+ * @snippet         folderHashSync($1)
+ *
+ * @example         js
+ * import { folderHashSync } from '@blackbyte/sugar/fs';
+ * folderHashSync('my/cool/folder'); // => YZOrKDx9LCLd8X39PoFTflXGpRU=,
+ *
+ * @since           1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TFolderHashSettings = {
+    recursive: boolean;
+    algo: 'md5' | 'sha1' | 'sha256' | 'sha512';
+    encoding: 'hex' | 'base64' | 'buffer' | 'latin1';
+};
+export default function folderHashSync(folderPath: string, settings?: Partial<TFolderHashSettings>): string;

package/dist/node/fs/folderHashSync.js

@@ -0,0 +1,29 @@
+import __isDirectory from '../is/isDirectory.js';
+import __fileHashSync from './fileHashSync.js';
+import * as fs from 'fs';
+import sha256 from '../../shared/crypto/sha256.js';
+export default function folderHashSync(folderPath, settings = {}) {
+    const finalSettings = Object.assign({ recursive: true, algo: 'sha256', encoding: 'base64' }, (settings !== null && settings !== void 0 ? settings : {}));
+    const paths = [];
+    function readDir(dir) {
+        const files = fs.readdirSync(dir);
+        files.forEach((filePath) => {
+            if (finalSettings.recursive && __isDirectory(`${dir}/${filePath}`)) {
+                return readDir(`${dir}/${filePath}`);
+            }
+            paths.push(`${dir}/${filePath}`);
+        });
+    }
+    readDir(folderPath);
+    const filesHashes = [];
+    paths.forEach((path) => {
+        if (__isDirectory(path))
+            return;
+        filesHashes.push(__fileHashSync(path, {
+            algo: finalSettings.algo,
+            encoding: finalSettings.encoding,
+        }));
+    });
+    return sha256.encrypt(filesHashes.join('-'));
+}
+//# sourceMappingURL=folderHashSync.js.map

package/dist/node/fs/folderHashSync.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"folderHashSync.js","sourceRoot":"","sources":["../../../src/node/fs/folderHashSync.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,sBAAsB,CAAC;AACjD,OAAO,cAAc,MAAM,mBAAmB,CAAC;AAE/C,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,MAAM,MAAM,+BAA+B,CAAC;AAqCnD,MAAM,CAAC,OAAO,UAAU,cAAc,CACpC,UAAkB,EAClB,WAAyC,EAAE;IAE3C,MAAM,aAAa,mBACjB,SAAS,EAAE,IAAI,EACf,IAAI,EAAE,QAAQ,EACd,QAAQ,EAAE,QAAQ,IACf,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;IACF,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,SAAS,OAAO,CAAC,GAAG;QAClB,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAClC,KAAK,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YACzB,IAAI,aAAa,CAAC,SAAS,IAAI,aAAa,CAAC,GAAG,GAAG,IAAI,QAAQ,EAAE,CAAC,EAAE,CAAC;gBACnE,OAAO,OAAO,CAAC,GAAG,GAAG,IAAI,QAAQ,EAAE,CAAC,CAAC;YACvC,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,QAAQ,EAAE,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,CAAC,UAAU,CAAC,CAAC;IAEpB,MAAM,WAAW,GAAa,EAAE,CAAC;IAEjC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACrB,IAAI,aAAa,CAAC,IAAI,CAAC;YAAE,OAAO;QAChC,WAAW,CAAC,IAAI,CACd,cAAc,CAAC,IAAI,EAAE;YACnB,IAAI,EAAE,aAAa,CAAC,IAAI;YACxB,QAAQ,EAAE,aAAa,CAAC,QAAQ;SACjC,CAAC,CACH,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAC/C,CAAC"}

package/dist/node/fs/folderPath.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @name                folderPath
+ * @namespace           node.fs
+ * @type                Function
+ * @platform            node
+ * @status              stable
+ *
+ * This function returns you the folder path of the file path passed.
+ * You can tell the function to check for file existence before getting
+ * the folder path with the second parameter.
+ *
+ * @param           {String}            path                          The file path to get folder path from
+ * @param           {Boolean}           [checkExistence=false]        Specify if you want to check the file existence before
+ * @return          {String}                                          The folder path or '' if not exists
+ *
+ * @todo            tests
+ *
+ * @snippet         folderPath($1)
+ *
+ * @example         js
+ * import { folderPath } from '@blackbyte/sugar/fs';
+ * folderPath('my/cool/path.js'); // => true
+ *
+ * @since           1.0.0
+ * @author 	        Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TFolderPathSettings = {
+    checkExistence: boolean;
+};
+export default function folderPath(path: string, settings?: Partial<TFolderPathSettings>): string;

package/dist/node/fs/folderPath.js

@@ -0,0 +1,14 @@
+import isPath from '../../shared/is/isPath.js';
+export default function folderPath(path, settings) {
+    const finalSettings = Object.assign({ checkExistence: false }, (settings !== null && settings !== void 0 ? settings : {}));
+    if (finalSettings.checkExistence) {
+        if (!isPath(path))
+            return '';
+    }
+    const parts = path.split('/');
+    if (parts.length <= 1) {
+        return '';
+    }
+    return parts.slice(0, -1).join('/');
+}
+//# sourceMappingURL=folderPath.js.map

package/dist/node/fs/folderPath.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"folderPath.js","sourceRoot":"","sources":["../../../src/node/fs/folderPath.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,2BAA2B,CAAC;AAiC/C,MAAM,CAAC,OAAO,UAAU,UAAU,CAChC,IAAY,EACZ,QAAuC;IAEvC,MAAM,aAAa,mBACjB,cAAc,EAAE,KAAK,IAClB,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;IAEF,IAAI,aAAa,CAAC,cAAc,EAAE,CAAC;QACjC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YAAE,OAAO,EAAE,CAAC;IAC/B,CAAC;IACD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;QACtB,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACtC,CAAC"}

package/dist/node/fs/folderSize.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @name                folderSize
+ * @namespace           node.fs
+ * @type                Function
+ * @platform            node
+ * @status              stable
+ * @async
+ *
+ * Calculate the size of the passed folder and return it through a promise in bytes format
+ *
+ * @param             {String}                folderPath                  The folder path to calculate the size
+ * @return            {Promise}                                           A promise that will be resolved once the folder size has been calculated
+ *
+ * @todo            tests
+ *
+ * @snippet         folderSize($1)
+ * await folderSize($1)
+ *
+ * @example           js
+ * import { folderSize } from '@blackbyte/sugar/fs';
+ * await folderSize('my/cool/folder');
+ *
+ *
+ * @see             https://www.npmjs.com/package/get-folder-size
+ * @since           1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function folderSize(folderPath: string): Promise<number>;

package/dist/node/fs/folderSize.js

@@ -0,0 +1,47 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+// @ts-ignore
+import fastFolderSize from 'fast-folder-size';
+/**
+ * @name                folderSize
+ * @namespace           node.fs
+ * @type                Function
+ * @platform            node
+ * @status              stable
+ * @async
+ *
+ * Calculate the size of the passed folder and return it through a promise in bytes format
+ *
+ * @param             {String}                folderPath                  The folder path to calculate the size
+ * @return            {Promise}                                           A promise that will be resolved once the folder size has been calculated
+ *
+ * @todo            tests
+ *
+ * @snippet         folderSize($1)
+ * await folderSize($1)
+ *
+ * @example           js
+ * import { folderSize } from '@blackbyte/sugar/fs';
+ * await folderSize('my/cool/folder');
+ *
+ *
+ * @see             https://www.npmjs.com/package/get-folder-size
+ * @since           1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function folderSize(folderPath) {
+    return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
+        // @ts-ignore
+        fastFolderSize(folderPath, (err, bytes) => {
+            resolve(bytes !== null && bytes !== void 0 ? bytes : 0);
+        });
+    }));
+}
+//# sourceMappingURL=folderSize.js.map

package/dist/node/fs/folderSize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"folderSize.js","sourceRoot":"","sources":["../../../src/node/fs/folderSize.ts"],"names":[],"mappings":";;;;;;;;;AAAA,aAAa;AACb,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,OAAO,UAAU,UAAU,CAAC,UAAkB;IACnD,OAAO,IAAI,OAAO,CAAC,CAAO,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3C,aAAa;QACb,cAAc,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YACxC,OAAO,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,CAAC,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;IACL,CAAC,CAAA,CAAC,CAAC;AACL,CAAC"}

package/dist/node/fs/grabFirstExistingSync.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @name                grabFirstExistingSync
+ * @namespace           node.fs
+ * @type                Function
+ * @platform            node
+ * @status              stable
+ *
+ * Check every passed paths and return the first existing one.
+ *
+ * @param         {String[]}            paths             The paths to check
+ * @return        {String}                                The first existing path
+ *
+ * @todo            tests
+ *
+ * @snippet         grabFirstExistingSync($1)
+ *
+ * @example       js
+ * import { grabFirstExistingSync } from '@blackbyte/sugar/fs';
+ * grabFirstExistingSync([
+ *  'file/1.txt',
+ *  'file/2.txt
+ * ]); // => 'file/2.txt'
+' *
+ * @since         1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function grabFirstExistingSync(paths: string[]): string;

package/dist/node/fs/grabFirstExistingSync.js

@@ -0,0 +1,38 @@
+import * as fs from 'fs';
+/**
+ * @name                grabFirstExistingSync
+ * @namespace           node.fs
+ * @type                Function
+ * @platform            node
+ * @status              stable
+ *
+ * Check every passed paths and return the first existing one.
+ *
+ * @param         {String[]}            paths             The paths to check
+ * @return        {String}                                The first existing path
+ *
+ * @todo            tests
+ *
+ * @snippet         grabFirstExistingSync($1)
+ *
+ * @example       js
+ * import { grabFirstExistingSync } from '@blackbyte/sugar/fs';
+ * grabFirstExistingSync([
+ *  'file/1.txt',
+ *  'file/2.txt
+ * ]); // => 'file/2.txt'
+' *
+ * @since         1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function grabFirstExistingSync(paths) {
+    let result = '';
+    for (let [idx, path] of Object.entries(paths)) {
+        if (fs.existsSync(path)) {
+            result = path;
+            break;
+        }
+    }
+    return result;
+}
+//# sourceMappingURL=grabFirstExistingSync.js.map

package/dist/node/fs/grabFirstExistingSync.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"grabFirstExistingSync.js","sourceRoot":"","sources":["../../../src/node/fs/grabFirstExistingSync.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AAEzB;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,OAAO,UAAU,qBAAqB,CAAC,KAAe;IAC3D,IAAI,MAAM,GAAW,EAAE,CAAC;IACxB,KAAK,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9C,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,MAAM,GAAG,IAAI,CAAC;YACd,MAAM;QACR,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/node/fs/isPath.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @name                isPath
+ * @namespace           node.fs
+ * @type                Function
+ * @platform            node
+ * @status              stable
+ *
+ * Check if the passed string is a valid path or not
+ *
+ * @param         {String}            path                        The path to check
+ * @param         {Boolean}           [checkExistence=false]      Specify if you want to check that the passed path actually exist
+ * @return        {Boolean}                                       true if the path is valide, false if not
+ *
+ * @todo        tests
+ *
+ * @snippet         isPath($1)
+ *
+ * @example       js
+ * import { isPath } from '@blackbyte/sugar/fs';
+ * isPath('hello/world'); // => true
+ *
+ * @see         https://www.npmjs.com/package/is-valid-path
+ * @since         1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function isPath(path: string, checkExistence?: boolean): boolean;

package/dist/node/fs/isPath.js

@@ -0,0 +1,54 @@
+import * as fs from 'fs';
+// @ts-ignore
+import isValidPath from 'is-valid-path';
+/**
+ * @name                isPath
+ * @namespace           node.fs
+ * @type                Function
+ * @platform            node
+ * @status              stable
+ *
+ * Check if the passed string is a valid path or not
+ *
+ * @param         {String}            path                        The path to check
+ * @param         {Boolean}           [checkExistence=false]      Specify if you want to check that the passed path actually exist
+ * @return        {Boolean}                                       true if the path is valide, false if not
+ *
+ * @todo        tests
+ *
+ * @snippet         isPath($1)
+ *
+ * @example       js
+ * import { isPath } from '@blackbyte/sugar/fs';
+ * isPath('hello/world'); // => true
+ *
+ * @see         https://www.npmjs.com/package/is-valid-path
+ * @since         1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function isPath(path, checkExistence = false) {
+    if (typeof path !== 'string')
+        return false;
+    // empty string
+    if (path.trim() === '')
+        return false;
+    // multiple lines content
+    if (path.split('\n').length > 1)
+        return false;
+    // check if we have some /
+    if (!path.includes('/')) {
+        if (!path.includes('.'))
+            return false;
+    }
+    // check if the path is valid or not
+    if (!isValidPath(path))
+        return false;
+    // if we have to check the path existence
+    if (checkExistence) {
+        if (!fs.existsSync(path))
+            return false;
+    }
+    // otherwise, all is ok
+    return true;
+}
+//# sourceMappingURL=isPath.js.map

package/dist/node/fs/isPath.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isPath.js","sourceRoot":"","sources":["../../../src/node/fs/isPath.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,aAAa;AACb,OAAO,WAAW,MAAM,eAAe,CAAC;AAExC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,UAAU,MAAM,CAC5B,IAAY,EACZ,iBAA0B,KAAK;IAE/B,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAE3C,eAAe;IACf,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE;QAAE,OAAO,KAAK,CAAC;IAErC,yBAAyB;IACzB,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IAE9C,0BAA0B;IAC1B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACxB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;IACxC,CAAC;IAED,oCAAoC;IACpC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IAErC,yCAAyC;IACzC,IAAI,cAAc,EAAE,CAAC;QACnB,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC;YAAE,OAAO,KAAK,CAAC;IACzC,CAAC;IAED,uBAAuB;IACvB,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/node/fs/move.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @name                move
+ * @namespace           node.fs
+ * @type                Function
+ * @platform            node
+ * @status              stable
+ *
+ * Moves a file or directory, even across devices (async)
+ *
+ * @param       {String}              src           The source path to move
+ * @param       {String}              dest          The destination path
+ * @return      {Promise}                           A promise that will be resolved once the file/directory has been moved...
+ *
+ * @todo        tests
+ *
+ * @snippet         move($1, $2)
+ * await move($1, $2)
+ *
+ * @example       js
+ * import { move } from '@blackbyte/sugar/fs';
+ * await move('my/cool/dir', 'another/place/for/directory').then(() => {
+ *    // do something...
+ * });
+ *
+ * @see             https://github.com/jprichardson/node-fs-extra
+ * @since           1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function move(src: string, dest: string): Promise<void>;

package/dist/node/fs/move.js

@@ -0,0 +1,36 @@
+import fs from 'fs-extra';
+/**
+ * @name                move
+ * @namespace           node.fs
+ * @type                Function
+ * @platform            node
+ * @status              stable
+ *
+ * Moves a file or directory, even across devices (async)
+ *
+ * @param       {String}              src           The source path to move
+ * @param       {String}              dest          The destination path
+ * @return      {Promise}                           A promise that will be resolved once the file/directory has been moved...
+ *
+ * @todo        tests
+ *
+ * @snippet         move($1, $2)
+ * await move($1, $2)
+ *
+ * @example       js
+ * import { move } from '@blackbyte/sugar/fs';
+ * await move('my/cool/dir', 'another/place/for/directory').then(() => {
+ *    // do something...
+ * });
+ *
+ * @see             https://github.com/jprichardson/node-fs-extra
+ * @since           1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function move(src, dest) {
+    if (src === dest) {
+        return Promise.resolve();
+    }
+    return fs.move(src, dest);
+}
+//# sourceMappingURL=move.js.map

package/dist/node/fs/move.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"move.js","sourceRoot":"","sources":["../../../src/node/fs/move.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,UAAU,CAAC;AAE1B;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,OAAO,UAAU,IAAI,CAAC,GAAW,EAAE,IAAY;IACpD,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QACjB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IACD,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;AAC5B,CAAC"}