@blackbyte/sugar 1.0.0-beta.1

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

@@ -0,0 +1,23 @@
+/**
+ * @name            moveSync
+ * @namespace       node.fs
+ * @type            Function
+ * @platform        node
+ * @status          stable
+ *
+ * Moves a file or directory, even across devices (sync)
+ *
+ * @param       {String}              src           The source path to moveSync
+ * @param       {String}              dest          The destination path
+ *
+ * @snippet         moveSync($1, $2)
+ *
+ * @example       js
+ * import { moveSync } from '@blackbyte/sugar/fs';
+ * moveSync('my/cool/dir', 'another/place/for/directory');
+ *
+ * @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 moveSync(src: string, dest: string): void;

package/dist/node/fs/moveSync.js

@@ -0,0 +1,30 @@
+import fs from 'fs-extra';
+/**
+ * @name            moveSync
+ * @namespace       node.fs
+ * @type            Function
+ * @platform        node
+ * @status          stable
+ *
+ * Moves a file or directory, even across devices (sync)
+ *
+ * @param       {String}              src           The source path to moveSync
+ * @param       {String}              dest          The destination path
+ *
+ * @snippet         moveSync($1, $2)
+ *
+ * @example       js
+ * import { moveSync } from '@blackbyte/sugar/fs';
+ * moveSync('my/cool/dir', 'another/place/for/directory');
+ *
+ * @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 moveSync(src, dest) {
+    if (src === dest) {
+        return;
+    }
+    fs.moveSync(src, dest);
+}
+//# sourceMappingURL=moveSync.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"moveSync.js","sourceRoot":"","sources":["../../../src/node/fs/moveSync.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,UAAU,CAAC;AAE1B;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,OAAO,UAAU,QAAQ,CAAC,GAAW,EAAE,IAAY;IACxD,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QACjB,OAAO;IACT,CAAC;IACD,EAAE,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;AACzB,CAAC"}

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

@@ -0,0 +1,30 @@
+/**
+ * @name            pickOneSync
+ * @namespace       node.fs
+ * @type            Function
+ * @platform        node
+ * @status          stable
+ *
+ * This function allows you to specify multiple files to check and pick one of them
+ *
+ * @param       {String[]}                   filesNames           The names of the files you want to check
+ * @param       {TPickOneSyncSettings}       [settings={}]        An object of settings to configure your research
+ * @return      {String}                                          The path of the file found
+ *
+ * @todo        tests
+ *
+ * @setting         {String}        [cwd=process.cwd()]       The current working directory to search in
+ *
+ * @snippet         pickOneSync([$1])
+ *
+ * @example         js
+ * import { pickOneSync } from '@blackbyte/sugar/fs';
+ * pickOneSync(['myCoolFile.json', 'myCoolFile2.json'], {});
+ *
+ * @since       1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TPickOneSyncSettings = {
+    cwd: string;
+};
+export default function pickOneSync(filesNames: string[], settings?: Partial<TPickOneSyncSettings>): string;

package/dist/node/fs/pickOneSync.js

@@ -0,0 +1,16 @@
+import * as fs from 'fs';
+import micromatch from 'micromatch';
+export default function pickOneSync(filesNames, settings) {
+    const finalSettings = Object.assign({ cwd: process.cwd() }, (settings !== null && settings !== void 0 ? settings : {}));
+    let result = '';
+    // check if we have a file
+    const files = fs.readdirSync(finalSettings.cwd);
+    for (const fileName of files) {
+        if (micromatch.isMatch(fileName, filesNames)) {
+            result = `${finalSettings.cwd}/${fileName}`;
+            break;
+        }
+    }
+    return result;
+}
+//# sourceMappingURL=pickOneSync.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pickOneSync.js","sourceRoot":"","sources":["../../../src/node/fs/pickOneSync.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,UAAU,MAAM,YAAY,CAAC;AAiCpC,MAAM,CAAC,OAAO,UAAU,WAAW,CACjC,UAAoB,EACpB,QAAwC;IAExC,MAAM,aAAa,mBACjB,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,IACf,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;IACF,IAAI,MAAM,GAAW,EAAE,CAAC;IACxB,0BAA0B;IAC1B,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAChD,KAAK,MAAM,QAAQ,IAAI,KAAK,EAAE,CAAC;QAC7B,IAAI,UAAU,CAAC,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,CAAC;YAC7C,MAAM,GAAG,GAAG,aAAa,CAAC,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC5C,MAAM;QACR,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

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

@@ -0,0 +1,24 @@
+/**
+ * @name            prependToFileSync
+ * @namespace       node.fs
+ * @type            Function
+ * @platform        node
+ * @status          stable
+ *
+ * This function allows you to simply append a string to a file.
+ *
+ * @todo        tests
+ *
+ * @param       {String}            path                The file path you want to check. With or without an extension
+ * @param       {String}            content             The content to add to the file
+ *
+ * @snippet         prependToFileSync($1, $2)
+ *
+ * @example         js
+ * import { prependToFileSync } from '@blackbyte/sugar/fs';
+ * prependToFileSync('/my/cool/file.txt', 'Hello world');
+ *
+ * @since       1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function prependToFileSync(path: string, content: string): void;

package/dist/node/fs/prependToFileSync.js

@@ -0,0 +1,35 @@
+import * as fs from 'fs';
+import writeFileSync from '../fs/writeFileSync.js';
+/**
+ * @name            prependToFileSync
+ * @namespace       node.fs
+ * @type            Function
+ * @platform        node
+ * @status          stable
+ *
+ * This function allows you to simply append a string to a file.
+ *
+ * @todo        tests
+ *
+ * @param       {String}            path                The file path you want to check. With or without an extension
+ * @param       {String}            content             The content to add to the file
+ *
+ * @snippet         prependToFileSync($1, $2)
+ *
+ * @example         js
+ * import { prependToFileSync } from '@blackbyte/sugar/fs';
+ * prependToFileSync('/my/cool/file.txt', 'Hello world');
+ *
+ * @since       1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function prependToFileSync(path, content) {
+    if (!fs.existsSync(path)) {
+        writeFileSync(path, content);
+        return;
+    }
+    const currentContent = fs.readFileSync(path).toString();
+    const newContent = `${content}\n${currentContent}`;
+    fs.writeFileSync(path, newContent);
+}
+//# sourceMappingURL=prependToFileSync.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"prependToFileSync.js","sourceRoot":"","sources":["../../../src/node/fs/prependToFileSync.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,aAAa,MAAM,wBAAwB,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,OAAO,UAAU,iBAAiB,CAAC,IAAY,EAAE,OAAe;IACrE,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC7B,OAAO;IACT,CAAC;IACD,MAAM,cAAc,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;IACxD,MAAM,UAAU,GAAG,GAAG,OAAO,KAAK,cAAc,EAAE,CAAC;IACnD,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;AACrC,CAAC"}

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

@@ -0,0 +1,24 @@
+/**
+ * @name            readJson
+ * @namespace       node.fs
+ * @type            Function
+ * @platform        node
+ * @status          stable
+ * @async
+ *
+ * This function allows you to read a json file
+ *
+ * @param       {String}           path             The json file path to read
+ * @return      {Object}                            The readed json
+ *
+ * @snippet         readJson($1)
+ * await readJson($1)
+ *
+ * @example         js
+ * import { readJson } from '@blackbyte/sugar/fs';
+ * await readJson('my-cool-json/file.json');
+ *
+ * @since       1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function readJson(path: string): Promise<any>;

package/dist/node/fs/readJson.js

@@ -0,0 +1,44 @@
+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 readJsonSync from './readJsonSync.js';
+/**
+ * @name            readJson
+ * @namespace       node.fs
+ * @type            Function
+ * @platform        node
+ * @status          stable
+ * @async
+ *
+ * This function allows you to read a json file
+ *
+ * @param       {String}           path             The json file path to read
+ * @return      {Object}                            The readed json
+ *
+ * @snippet         readJson($1)
+ * await readJson($1)
+ *
+ * @example         js
+ * import { readJson } from '@blackbyte/sugar/fs';
+ * await readJson('my-cool-json/file.json');
+ *
+ * @since       1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function readJson(path) {
+    if (!fs.existsSync(path)) {
+        throw new Error(`<red>[readJson]</red> Sorry but the passed file path "<cyan>${path}</cyan>" does not exists...`);
+    }
+    return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
+        const json = readJsonSync(path);
+        resolve(json);
+    }));
+}
+//# sourceMappingURL=readJson.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"readJson.js","sourceRoot":"","sources":["../../../src/node/fs/readJson.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAE7C;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,OAAO,UAAU,QAAQ,CAAC,IAAY;IAC3C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CACb,+DAA+D,IAAI,6BAA6B,CACjG,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,OAAO,CAAC,CAAO,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3C,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;QAChC,OAAO,CAAC,IAAI,CAAC,CAAC;IAChB,CAAC,CAAA,CAAC,CAAC;AACL,CAAC"}

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

@@ -0,0 +1,24 @@
+/**
+ * @name            readJsonSync
+ * @namespace       node.fs
+ * @type            Function
+ * @platform        node
+ * @status          stable
+ *
+ * This function allows you to read a json file
+ *
+ * @param       {String}           path             The json file path to read
+ * @return      {Object}                            The readed json
+ *
+ * @todo            tests
+ *
+ * @snippet         readJsonSync($1)
+ *
+ * @example         js
+ * import { readJsonSync } from '@blackbyte/sugar/fs';
+ * readJsonSync('my-cool-json/file.json');
+ *
+ * @since       1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function readJsonSync(path: string): any;

package/dist/node/fs/readJsonSync.js

@@ -0,0 +1,33 @@
+import * as fs from 'fs';
+/**
+ * @name            readJsonSync
+ * @namespace       node.fs
+ * @type            Function
+ * @platform        node
+ * @status          stable
+ *
+ * This function allows you to read a json file
+ *
+ * @param       {String}           path             The json file path to read
+ * @return      {Object}                            The readed json
+ *
+ * @todo            tests
+ *
+ * @snippet         readJsonSync($1)
+ *
+ * @example         js
+ * import { readJsonSync } from '@blackbyte/sugar/fs';
+ * readJsonSync('my-cool-json/file.json');
+ *
+ * @since       1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function readJsonSync(path) {
+    if (!fs.existsSync(path)) {
+        throw new Error(`<red>[readJsonSync]</red> Sorry but the passed file path "<cyan>${path}</cyan>" does not exists...`);
+    }
+    const jsonStr = fs.readFileSync(path, 'utf8').toString();
+    const json = JSON.parse(jsonStr);
+    return json;
+}
+//# sourceMappingURL=readJsonSync.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"readJsonSync.js","sourceRoot":"","sources":["../../../src/node/fs/readJsonSync.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AAEzB;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,IAAY;IAC/C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CACb,mEAAmE,IAAI,6BAA6B,CACrG,CAAC;IACJ,CAAC;IAED,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;IACzD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACjC,OAAO,IAAI,CAAC;AACd,CAAC"}

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

@@ -0,0 +1,24 @@
+/**
+ * @name            readXmlSync
+ * @namespace       node.fs
+ * @type            Function
+ * @platform        node
+ * @status          stable
+ *
+ * This function allows you to read an xml file and get his content back as JSON
+ *
+ * @param       {String}           path             The xml file path to read
+ * @return      {Object}                            The readed json
+ *
+ * @todo            tests
+ *
+ * @snippet         readXmlSync($1)
+ *
+ * @example         js
+ * import { readXmlSync } from '@blackbyte/sugar/fs';
+ * readXmlSync('my-cool-xml/file.xml');
+ *
+ * @since       1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function readXmlSync(path: string): any;

package/dist/node/fs/readXmlSync.js

@@ -0,0 +1,34 @@
+import * as fs from 'fs';
+import xmlToJson from '../../shared/convert/xmlTojson.js';
+/**
+ * @name            readXmlSync
+ * @namespace       node.fs
+ * @type            Function
+ * @platform        node
+ * @status          stable
+ *
+ * This function allows you to read an xml file and get his content back as JSON
+ *
+ * @param       {String}           path             The xml file path to read
+ * @return      {Object}                            The readed json
+ *
+ * @todo            tests
+ *
+ * @snippet         readXmlSync($1)
+ *
+ * @example         js
+ * import { readXmlSync } from '@blackbyte/sugar/fs';
+ * readXmlSync('my-cool-xml/file.xml');
+ *
+ * @since       1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function readXmlSync(path) {
+    if (!fs.existsSync(path)) {
+        throw new Error(`<red>[readXmlSync]</red> Sorry but the passed file path "<cyan>${path}</cyan>" does not exists...`);
+    }
+    const xmlStr = fs.readFileSync(path, 'utf8').toString();
+    const json = xmlToJson(xmlStr);
+    return json;
+}
+//# sourceMappingURL=readXmlSync.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"readXmlSync.js","sourceRoot":"","sources":["../../../src/node/fs/readXmlSync.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,SAAS,MAAM,mCAAmC,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,OAAO,UAAU,WAAW,CAAC,IAAY;IAC9C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CACb,kEAAkE,IAAI,6BAA6B,CACpG,CAAC;IACJ,CAAC;IACD,MAAM,MAAM,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;IACxD,MAAM,IAAI,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;IAC/B,OAAO,IAAI,CAAC;AACd,CAAC"}

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

@@ -0,0 +1,28 @@
+/**
+ * @name            remove
+ * @namespace       node.fs
+ * @type            Function
+ * @platform        node
+ * @status          stable
+ *
+ * Removes a file or directory. The directory can have contents. If the path does not exist, silently does nothing. Like rm -rf (async)
+ *
+ * @param       {String}              path            The file/directory path to delete
+ * @return      {Promise}                             A promise that will be resolved when the remove is completed
+ *
+ * @todo        tests
+ *
+ * @snippet         remove($1)
+ * await remove($1)
+ *
+ * @example       js
+ * import { remove } from '@blackbyte/sugar/fs';
+ * await remove('my/cool/file.json').then(() => {
+ *    // do something on complete...
+ * });
+ *
+ * @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 remove(path: string): Promise<void>;

package/dist/node/fs/remove.js

@@ -0,0 +1,32 @@
+import fs from 'fs-extra';
+/**
+ * @name            remove
+ * @namespace       node.fs
+ * @type            Function
+ * @platform        node
+ * @status          stable
+ *
+ * Removes a file or directory. The directory can have contents. If the path does not exist, silently does nothing. Like rm -rf (async)
+ *
+ * @param       {String}              path            The file/directory path to delete
+ * @return      {Promise}                             A promise that will be resolved when the remove is completed
+ *
+ * @todo        tests
+ *
+ * @snippet         remove($1)
+ * await remove($1)
+ *
+ * @example       js
+ * import { remove } from '@blackbyte/sugar/fs';
+ * await remove('my/cool/file.json').then(() => {
+ *    // do something on complete...
+ * });
+ *
+ * @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 remove(path) {
+    return fs.remove(path);
+}
+//# sourceMappingURL=remove.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"remove.js","sourceRoot":"","sources":["../../../src/node/fs/remove.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,UAAU,CAAC;AAE1B;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,OAAO,UAAU,MAAM,CAAC,IAAY;IACzC,OAAO,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AACzB,CAAC"}

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

@@ -0,0 +1,24 @@
+/**
+ * @name            removeSync
+ * @namespace       node.fs
+ * @type            Function
+ * @platform        node
+ * @status          stable
+ *
+ * Removes a file or directory. The directory can have contents. If the path does not exist, silently does nothing. Like rm -rf (sync)
+ *
+ * @param       {String}              path           The file/directory path to delete
+ *
+ * @todo      tests
+ *
+ * @snippet         removeSync($1)
+ *
+ * @example       js
+ * import { removeSync } from '@blackbyte/sugar/fs';
+ *  removeSync('my/cool/file.json');
+ *
+ * @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 removeSync(path: string): void;

package/dist/node/fs/removeSync.js

@@ -0,0 +1,28 @@
+import fs from 'fs-extra';
+/**
+ * @name            removeSync
+ * @namespace       node.fs
+ * @type            Function
+ * @platform        node
+ * @status          stable
+ *
+ * Removes a file or directory. The directory can have contents. If the path does not exist, silently does nothing. Like rm -rf (sync)
+ *
+ * @param       {String}              path           The file/directory path to delete
+ *
+ * @todo      tests
+ *
+ * @snippet         removeSync($1)
+ *
+ * @example       js
+ * import { removeSync } from '@blackbyte/sugar/fs';
+ *  removeSync('my/cool/file.json');
+ *
+ * @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 removeSync(path) {
+    fs.removeSync(path);
+}
+//# sourceMappingURL=removeSync.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"removeSync.js","sourceRoot":"","sources":["../../../src/node/fs/removeSync.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,UAAU,CAAC;AAE1B;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,OAAO,UAAU,UAAU,CAAC,IAAY;IAC7C,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;AACtB,CAAC"}

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

@@ -0,0 +1,27 @@
+/**
+ * @name            rename
+ * @namespace       node.fs
+ * @type            Function
+ * @platform        node
+ * @status          stable
+ * @async
+ *
+ * Moves a file or directory, even across devices (sync)
+ *
+ * @param       {String}              src           The source path to moveSync
+ * @param       {String}              dest          The destination path
+ *
+ * @snippet         rename($1, $2)
+ *
+ * @example       js
+ * import { rename } from '@blackbyte/sugar/fs';
+ * await rename('my/cool/dir', 'another/place/for/directory');
+ *
+ * @see           https://github.com/jprichardson/node-fs-extra
+ * @since         1.0.0
+ * @author        Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TRenameSettings = {
+    override: boolean;
+};
+export default function rename(src: string, newName: string, settings?: Partial<TRenameSettings>): Promise<void>;

package/dist/node/fs/rename.js

@@ -0,0 +1,16 @@
+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 renameSync from './renameSync.js';
+export default function rename(src, newName, settings) {
+    return __awaiter(this, void 0, void 0, function* () {
+        renameSync(src, newName, settings);
+    });
+}
+//# sourceMappingURL=rename.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"rename.js","sourceRoot":"","sources":["../../../src/node/fs/rename.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,UAAU,MAAM,iBAAiB,CAAC;AA8BzC,MAAM,CAAC,OAAO,UAAgB,MAAM,CAClC,GAAW,EACX,OAAe,EACf,QAAmC;;QAEnC,UAAU,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IACrC,CAAC;CAAA"}

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

@@ -0,0 +1,29 @@
+/**
+ * @name            renameSync
+ * @namespace       node.fs
+ * @type            Function
+ * @platform        node
+ * @status          stable
+ *
+ * This method allows you to rename a file or directory synchronously.
+ *
+ * @param       {String}              src               The source path to moveSync
+ * @param       {String}              dest              The destination path
+ * @param       {TRenameSyncSettings} [settings={}]     The settings for the operation
+ * @return      {String}                                The new path
+ *
+ * @snippet         renameSync($1, $2)
+ *
+ * @example       js
+ * import { renameSync } from '@blackbyte/sugar/fs';
+ * renameSync('my/cool/dir', 'another/place/for/directory');
+ *
+ * @see           https://github.com/jprichardson/node-fs-extra
+ * @since         1.0.0
+ * @author        Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TRenameSyncSettings = {
+    override: boolean;
+    dry: boolean;
+};
+export default function renameSync(src: string, newName: string, settings?: Partial<TRenameSyncSettings>): string;

package/dist/node/fs/renameSync.js

@@ -0,0 +1,42 @@
+import fs from 'fs';
+import ensureDirSync from './ensureDirSync.js';
+import moveSync from './moveSync.js';
+import unlinkSync from './unlinkSync.js';
+export default function renameSync(src, newName, settings) {
+    const finalSettings = Object.assign({ override: true, dry: false }, (settings !== null && settings !== void 0 ? settings : {}));
+    const parts = src.split('/');
+    let ext = '';
+    // remove the file name
+    const currentName = parts.pop();
+    const currentNameParts = currentName.split('.');
+    currentNameParts.shift();
+    const currentExt = currentNameParts.join('.');
+    let newPath = src;
+    // handle the case where the new name has an extension
+    if (newName.includes('.')) {
+        ext = src.split('.').pop();
+        newPath = parts.join('/') + '/' + newName;
+    }
+    else {
+        ext = currentExt;
+        newPath = parts.join('/') + '/' + newName + (ext ? '.' + ext : '');
+    }
+    // if already the same name
+    if (src === newPath) {
+        return newPath;
+    }
+    // only execute if not dry
+    if (!finalSettings.dry) {
+        // if want to override and file exists,
+        // remove it
+        if (finalSettings.override && fs.existsSync(newPath)) {
+            unlinkSync(newPath);
+        }
+        // make sure we have the folder to write in
+        ensureDirSync(newPath);
+        // move the file to his new destination
+        moveSync(src, newPath);
+    }
+    return newPath;
+}
+//# sourceMappingURL=renameSync.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"renameSync.js","sourceRoot":"","sources":["../../../src/node/fs/renameSync.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,QAAQ,MAAM,eAAe,CAAC;AACrC,OAAO,UAAU,MAAM,iBAAiB,CAAC;AAgCzC,MAAM,CAAC,OAAO,UAAU,UAAU,CAChC,GAAW,EACX,OAAe,EACf,QAAuC;IAEvC,MAAM,aAAa,mBACjB,QAAQ,EAAE,IAAI,EACd,GAAG,EAAE,KAAK,IACP,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;IAEF,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC7B,IAAI,GAAG,GAAG,EAAE,CAAC;IAEb,uBAAuB;IACvB,MAAM,WAAW,GAAG,KAAK,CAAC,GAAG,EAAY,CAAC;IAC1C,MAAM,gBAAgB,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAChD,gBAAgB,CAAC,KAAK,EAAE,CAAC;IACzB,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAE9C,IAAI,OAAO,GAAG,GAAG,CAAC;IAElB,sDAAsD;IACtD,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC1B,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAY,CAAC;QACrC,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,OAAO,CAAC;IAC5C,CAAC;SAAM,CAAC;QACN,GAAG,GAAG,UAAU,CAAC;QACjB,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,2BAA2B;IAC3B,IAAI,GAAG,KAAK,OAAO,EAAE,CAAC;QACpB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,0BAA0B;IAC1B,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC;QACvB,uCAAuC;QACvC,YAAY;QACZ,IAAI,aAAa,CAAC,QAAQ,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACrD,UAAU,CAAC,OAAO,CAAC,CAAC;QACtB,CAAC;QAED,2CAA2C;QAC3C,aAAa,CAAC,OAAO,CAAC,CAAC;QAEvB,uCAAuC;QACvC,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACzB,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/node/fs/tests/data/checkPathWithMultipleExtensions/test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/node/fs/tests/data/checkPathWithMultipleExtensions/test.js

@@ -0,0 +1,3 @@
+console.log('hello world');
+export {};
+//# sourceMappingURL=test.js.map

package/dist/node/fs/tests/data/checkPathWithMultipleExtensions/test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test.js","sourceRoot":"","sources":["../../../../../../src/node/fs/tests/data/checkPathWithMultipleExtensions/test.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC"}