pwd-fs 3.2.0 → 3.2.2

package/{lib → dist}/src/powered-file-system.d.ts

@@ -76,14 +76,14 @@ export declare class PoweredFileSystem {
     }): Promise<void>;
     read(src: string, options: {
         sync: true;
-        encoding?: BufferEncoding;
+        encoding: null;
         flag?: Flag;
-    }): string;
+    }): Buffer;
     read(src: string, options: {
         sync: true;
-        encoding?: null;
+        encoding?: BufferEncoding;
         flag?: Flag;
-    }): Buffer;
+    }): string;
     read(src: string, options: {
         sync?: false;
         encoding: null;

package/{lib → dist}/src/powered-file-system.js

@@ -162,10 +162,13 @@ class PoweredFileSystem {
     read(src, { sync = false, encoding = 'utf8', flag = 'r' } = {}) {
         src = this.resolve(src);
         if (sync) {
-            return node_fs_1.default.readFileSync(src, {
+            const content = node_fs_1.default.readFileSync(src, {
                 encoding,
                 flag
             });
+            return encoding === null
+                ? Buffer.from(content)
+                : content;
         }
         return new Promise((resolve, reject) => {
             node_fs_1.default.readFile(src, {
@@ -202,9 +205,6 @@ class PoweredFileSystem {
             });
         });
     }
-    /**
-    * @deprecated The method should not be used
-    */
     append(src, data, { sync = false, encoding = 'utf8', umask = 0o000, flag = 'a' } = {}) {
         src = this.resolve(src);
         const mode = 0o666 - umask;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pwd-fs",
-  "version": "3.2.0",
+  "version": "3.2.2",
   "description": "Extend the file system the capabilities of declaring the present working directory and recursive execution",
   "keywords": [
     "umask",
@@ -29,11 +29,11 @@
   "engines": {
     "node": ">=13.2.0"
   },
-  "main": "./lib/src/index.js",
-  "types": "./lib/src/index.d.ts",
+  "main": "./dist/src/index.js",
+  "types": "./dist/src/index.d.ts",
   "scripts": {
     "build": "tsc",
-    "test": "mocha ./lib/test"
+    "test": "mocha ./dist/test"
   },
   "devDependencies": {
     "@types/chance": "^1.1.6",

package/src/powered-file-system.ts

@@ -92,13 +92,9 @@ export class PoweredFileSystem {
     });
   }
 
-  chmod(src: string, mode: number, options: {
-    sync: true
-  }): void;
+  chmod(src: string, mode: number, options: { sync: true }): void;
   
-  chmod(src: string, mode: number, options?: {
-    sync?: false
-  }): Promise<void>;
+  chmod(src: string, mode: number, options?: { sync?: false }): Promise<void>;
   
   chmod(src: string, mode: number, { sync = false }: { sync?: boolean } = {}) {
     src = this.resolve(src);
@@ -148,13 +144,9 @@ export class PoweredFileSystem {
     });
   }
 
-  symlink(src: string, use: string, options: {
-    sync: true
-  }): void;
+  symlink(src: string, use: string, options: { sync: true }): void;
 
-  symlink(src: string, use: string, options?: {
-    sync?: false
-  }): Promise<void>;
+  symlink(src: string, use: string, options?: { sync?: false }): Promise<void>;
 
   symlink(src: string, use: string, { sync = false }: { sync?: boolean } = {}) {
     src = this.resolve(src);
@@ -207,13 +199,9 @@ export class PoweredFileSystem {
     });
   }
 
-  rename(src: string, use: string, options: {
-    sync: true
-  }): void;
+  rename(src: string, use: string, options: { sync: true }): void;
 
-  rename(src: string, use: string, options?: {
-    sync?: false
-  }): Promise<void>;
+  rename(src: string, use: string, options?: { sync?: false }): Promise<void>;
 
   rename(src: string, use: string, { sync = false }: { sync?: boolean } = {}) {
     src = this.resolve(src);
@@ -234,13 +222,9 @@ export class PoweredFileSystem {
     });
   }
 
-  remove(src: string, options: {
-    sync: true
-  }): void;
+  remove(src: string, options: { sync: true }): void;
 
-  remove(src: string, options?: {
-    sync?: false
-  }): Promise<void>;
+  remove(src: string, options?: { sync?: false }): Promise<void>;
 
   remove(src: string, { sync = false }: { sync?: boolean } = {}) {
     src = this.resolve(src);
@@ -268,15 +252,15 @@ export class PoweredFileSystem {
 
   read(src: string, options: {
     sync: true,
-    encoding?: BufferEncoding,
+    encoding: null,
     flag?: Flag
-  }): string;
+  }): Buffer;
 
   read(src: string, options: {
     sync: true,
-    encoding?: null,
+    encoding?: BufferEncoding,
     flag?: Flag
-  }): Buffer;
+  }): string;
 
   read(src: string, options: {
     sync?: false,
@@ -298,10 +282,14 @@ export class PoweredFileSystem {
     src = this.resolve(src);
 
     if (sync) {
-      return fs.readFileSync(src, {
+      const content = fs.readFileSync(src, {
         encoding,
         flag
       });
+
+      return encoding === null
+        ? Buffer.from(content)
+        : content;
     }
 
     return new Promise((resolve, reject) => {
@@ -421,9 +409,6 @@ export class PoweredFileSystem {
     flag?: Flag
   }): Promise<void>;
 
-  /**
-  * @deprecated The method should not be used
-  */
   append(src: string, data: Buffer | string, { sync = false, encoding = 'utf8', umask = 0o000, flag = 'a' }: {
     sync?: boolean,
     encoding?: BufferEncoding | null,

package/test/read.spec.ts

@@ -70,12 +70,12 @@ describe('read(src [, options])', () => {
   
   
   it('[sync] Positive: Must read Buffer content of file when encoding is null', () => {
-    const buffer = pfs.read('./tmpdir/tings.txt', {
-      encoding: null,
-      sync: true
+    const buf = pfs.read('./tmpdir/tings.txt', {
+      sync: true,
+      encoding: null
     });
 
-    assert(buffer instanceof Buffer);
+    assert(buf instanceof Buffer);
   });
   
   

package/tsconfig.json

@@ -3,17 +3,12 @@
     "lib": [
 			"es2022"
 		],
-		"module": "CommonJS",
+		"module": "commonjs",
 		"target": "es2022",
 		"moduleResolution": "node",
     "resolveJsonModule": true,
     "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true,
-    "strict": true,
-    "useUnknownInCatchVariables": false,
     "declaration": true,
-    "noEmitOnError": true,
-    "noUnusedLocals": false,
-    "outDir": "lib"
+    "outDir": "./dist"
   }
 }

package/lib/test/__fmock.d.ts

@@ -1,5 +0,0 @@
-export interface Iframe {
-    [key: string]: any;
-}
-export declare function fmock(frame: Iframe): void;
-export declare function restore(tmpDir: string): void;

package/lib/test/__fmock.js

@@ -1,40 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.restore = exports.fmock = void 0;
-const node_fs_1 = __importDefault(require("node:fs"));
-const node_path_1 = __importDefault(require("node:path"));
-function fmock(frame) {
-    for (const src of Object.keys(frame)) {
-        const { dir } = node_path_1.default.parse(src);
-        const value = frame[src];
-        node_fs_1.default.mkdirSync(dir, { recursive: true });
-        if (value.type === 'directory') {
-            node_fs_1.default.mkdirSync(src);
-        }
-        if (value.type === 'file') {
-            node_fs_1.default.writeFileSync(src, value.data);
-        }
-        if (value.type === 'symlink') {
-            node_fs_1.default.symlinkSync(value.target, src);
-        }
-    }
-}
-exports.fmock = fmock;
-function restore(tmpDir) {
-    const removeRecursive = (src) => {
-        if (node_fs_1.default.existsSync(src)) {
-            node_fs_1.default.readdirSync(src).forEach((item) => {
-                const curl = `${src}/${item}`;
-                node_fs_1.default.lstatSync(curl).isDirectory()
-                    ? removeRecursive(curl)
-                    : node_fs_1.default.unlinkSync(curl);
-            });
-            node_fs_1.default.rmdirSync(src);
-        }
-    };
-    removeRecursive(tmpDir);
-}
-exports.restore = restore;

package/lib/test/append.spec.d.ts

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

package/lib/test/append.spec.js

@@ -1,58 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const node_assert_1 = __importDefault(require("node:assert"));
-const node_fs_1 = __importDefault(require("node:fs"));
-const chance_1 = __importDefault(require("chance"));
-const expect_1 = require("expect");
-const __fmock_1 = require("./__fmock");
-const src_1 = require("../src");
-describe('append(src, data [, options])', () => {
-    const chance = new chance_1.default();
-    beforeEach(() => {
-        (0, __fmock_1.fmock)({
-            './tmpdir/tings.txt': {
-                type: 'file',
-                data: 'hoodie'
-            }
-        });
-    });
-    afterEach(() => {
-        (0, __fmock_1.restore)('./tmpdir');
-    });
-    it('Positive: Must append content to file', async () => {
-        const payload = chance.paragraph();
-        await src_1.pfs.append('./tmpdir/tings.txt', payload);
-        const { size } = node_fs_1.default.statSync('./tmpdir/tings.txt');
-        (0, node_assert_1.default)(payload.length + 6 === size);
-    });
-    it(`Negative: Unexpected option 'flag' returns Error`, async () => {
-        const payload = chance.paragraph();
-        await (0, expect_1.expect)(async () => {
-            await src_1.pfs.append('./tmpdir/tings.txt', payload, {
-                flag: 'r'
-            });
-        })
-            .rejects
-            .toThrow();
-    });
-    it(`[sync] Positive: Must append content to file`, () => {
-        const payload = chance.paragraph();
-        src_1.pfs.append('./tmpdir/tings.txt', payload, {
-            sync: true
-        });
-        const { size } = node_fs_1.default.statSync('./tmpdir/tings.txt');
-        (0, node_assert_1.default)(payload.length + 6 === size);
-    });
-    it(`[sync] Negative: Unexpected option 'flag' returns Error`, () => {
-        const payload = chance.paragraph();
-        node_assert_1.default.throws(() => {
-            src_1.pfs.append('./tmpdir/tings.txt', payload, {
-                sync: true,
-                flag: 'r'
-            });
-        });
-    });
-});

package/lib/test/bitmask.spec.d.ts

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

package/lib/test/bitmask.spec.js

@@ -1,26 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const node_assert_1 = __importDefault(require("node:assert"));
-const src_1 = require("../src");
-describe('static bitmask(mode: number)', () => {
-    it('Positive: Calculate bitmask', () => {
-        (0, node_assert_1.default)((0, src_1.bitmask)(33024) === 0o400); // (r--------)
-        (0, node_assert_1.default)((0, src_1.bitmask)(33152) === 0o600); // (rw-------)
-        (0, node_assert_1.default)((0, src_1.bitmask)(33216) === 0o700); // (rwx------)
-        (0, node_assert_1.default)((0, src_1.bitmask)(32800) === 0o040); // (---r-----)
-        (0, node_assert_1.default)((0, src_1.bitmask)(32816) === 0o060); // (---rw----)
-        (0, node_assert_1.default)((0, src_1.bitmask)(32824) === 0o070); // (---rwx---)
-        (0, node_assert_1.default)((0, src_1.bitmask)(32772) === 0o004); // (------r--)
-        (0, node_assert_1.default)((0, src_1.bitmask)(32774) === 0o006); // (------rw-)
-        (0, node_assert_1.default)((0, src_1.bitmask)(32775) === 0o007); // (------rwx)
-    });
-    it(`Negative: Throw an exception if the argument is 'null' type`, () => {
-        node_assert_1.default.throws(() => {
-            // @ts-ignore
-            (0, src_1.bitmask)(null);
-        });
-    });
-});

package/lib/test/chmod.spec.d.ts

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

package/lib/test/chmod.spec.js

@@ -1,62 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const node_assert_1 = __importDefault(require("node:assert"));
-const node_fs_1 = __importDefault(require("node:fs"));
-const chance_1 = __importDefault(require("chance"));
-const expect_1 = require("expect");
-const __fmock_1 = require("./__fmock");
-const src_1 = require("../src");
-describe('chmod(src, mode [, options])', () => {
-    const chance = new chance_1.default();
-    beforeEach(() => {
-        (0, __fmock_1.fmock)({
-            './tmpdir/tings.txt': {
-                type: 'file',
-                data: chance.string()
-            }
-        });
-    });
-    afterEach(() => {
-        (0, __fmock_1.restore)('./tmpdir');
-    });
-    it('Positive: Changes directory and file permissions', async () => {
-        await src_1.pfs.chmod('./tmpdir', 0o744);
-        const { mode } = node_fs_1.default.lstatSync('./tmpdir/tings.txt');
-        const umask = (0, src_1.bitmask)(mode);
-        (0, node_assert_1.default)(umask === 0o744);
-    });
-    it('Negative: Throw if not exists resource', async () => {
-        await (0, expect_1.expect)(async () => {
-            await src_1.pfs.chmod('./non-existent-source', 0o744);
-        })
-            .rejects
-            .toThrow();
-    });
-    it(`[sync] Positive: Changes permissions of directory`, () => {
-        src_1.pfs.chmod('./tmpdir', 0o744, {
-            sync: true
-        });
-        const { mode } = node_fs_1.default.lstatSync('./tmpdir');
-        const umask = (0, src_1.bitmask)(mode);
-        (0, node_assert_1.default)(umask === 0o744);
-    });
-    it(`[sync] Positive: Changes file permissions`, () => {
-        src_1.pfs.chmod('./tmpdir', 0o744, {
-            sync: true
-        });
-        const { mode } = node_fs_1.default.lstatSync('./tmpdir/tings.txt');
-        const umask = (0, src_1.bitmask)(mode);
-        (0, node_assert_1.default)(umask === 0o744);
-    });
-    it('[sync] Negative: Throw if not exists resource', () => {
-        const guid = chance.guid();
-        node_assert_1.default.throws(() => {
-            src_1.pfs.chmod(`./${guid}`, 0o744, {
-                sync: true
-            });
-        });
-    });
-});

package/lib/test/chown.spec.d.ts

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

package/lib/test/chown.spec.js

@@ -1,74 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const node_assert_1 = __importDefault(require("node:assert"));
-const node_fs_1 = __importDefault(require("node:fs"));
-const chance_1 = __importDefault(require("chance"));
-const expect_1 = require("expect");
-const __fmock_1 = require("./__fmock");
-const src_1 = require("../src");
-describe('chown(src, [, options])', () => {
-    const chance = new chance_1.default();
-    beforeEach(() => {
-        (0, __fmock_1.fmock)({
-            './tmpdir/tings.txt': {
-                type: 'file',
-                data: chance.string()
-            },
-            './tmpdir/digest/': { type: 'directory' }
-        });
-    });
-    afterEach(() => {
-        (0, __fmock_1.restore)('./tmpdir');
-    });
-    it('Positive: Changes the permissions of a file', async () => {
-        const { uid, gid } = node_fs_1.default.statSync('./tmpdir/tings.txt');
-        await src_1.pfs.chown('./tmpdir/tings.txt', { uid, gid });
-        (0, node_assert_1.default)(uid && gid);
-    });
-    it('Positive: Changes the permissions of a directory', async () => {
-        const { uid, gid } = node_fs_1.default.statSync('./tmpdir/digest');
-        await src_1.pfs.chown('./tmpdir/digest', { uid, gid });
-        (0, node_assert_1.default)(uid && gid);
-    });
-    it('Negative: To a non-existent resource to return an Error', async () => {
-        const guid = chance.guid();
-        const { uid, gid } = node_fs_1.default.statSync('./tmpdir/tings.txt');
-        await (0, expect_1.expect)(async () => {
-            await src_1.pfs.chown(`./tmpdir/${guid}`, { uid, gid });
-        })
-            .rejects
-            .toThrow();
-    });
-    it('[sync] Positive: Changes the permissions of a file', () => {
-        const { uid, gid } = node_fs_1.default.statSync('./tmpdir/tings.txt');
-        src_1.pfs.chown('./tmpdir/tings.txt', {
-            sync: true,
-            uid,
-            gid
-        });
-        (0, node_assert_1.default)(uid && gid);
-    });
-    it('[sync] Positive: Changes the permissions of a directory', () => {
-        const { uid, gid } = node_fs_1.default.statSync('./tmpdir/digest');
-        src_1.pfs.chown('./tmpdir/digest', {
-            sync: true,
-            uid,
-            gid
-        });
-        (0, node_assert_1.default)(uid && gid);
-    });
-    it('[sync] Negative: To a non-existent resource to return an Error', () => {
-        const guid = chance.guid();
-        const { uid, gid } = node_fs_1.default.statSync('./tmpdir/tings.txt');
-        node_assert_1.default.throws(() => {
-            src_1.pfs.chown(`./tmpdir/${guid}`, {
-                sync: true,
-                uid,
-                gid
-            });
-        });
-    });
-});

package/lib/test/constructor.spec.d.ts

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

package/lib/test/constructor.spec.js

@@ -1,17 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const node_assert_1 = __importDefault(require("node:assert"));
-const src_1 = require("../src");
-describe('#constructor: new PoweredFileSystem(pwd?)', () => {
-    it('Positive: An empty path must match the context of the cwd', () => {
-        const { pwd } = new src_1.PoweredFileSystem();
-        (0, node_assert_1.default)(pwd === process.cwd());
-    });
-    it('Positive: Absolute path must match the context of the pwd', () => {
-        const { pwd } = new src_1.PoweredFileSystem(__dirname);
-        (0, node_assert_1.default)(pwd === __dirname);
-    });
-});

package/lib/test/copy.spec.d.ts

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

package/lib/test/copy.spec.js

@@ -1,80 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const node_assert_1 = __importDefault(require("node:assert"));
-const node_fs_1 = __importDefault(require("node:fs"));
-const chance_1 = __importDefault(require("chance"));
-const expect_1 = require("expect");
-const __fmock_1 = require("./__fmock");
-const src_1 = require("../src");
-describe('copy(src, dir [, options])', () => {
-    const chance = new chance_1.default();
-    beforeEach(() => {
-        (0, __fmock_1.fmock)({
-            './tmpdir/tings.txt': {
-                type: 'file',
-                data: chance.string()
-            },
-            './tmpdir/digest/': { type: 'directory' }
-        });
-    });
-    afterEach(() => {
-        (0, __fmock_1.restore)('./tmpdir');
-    });
-    it('Positive: Copying a item file', async () => {
-        await src_1.pfs.copy('./tmpdir/tings.txt', './tmpdir/digest');
-        const exist = node_fs_1.default.existsSync(`./tmpdir/digest/tings.txt`);
-        (0, node_assert_1.default)(exist);
-    });
-    it('Positive: Recursive copying a directory', async () => {
-        await src_1.pfs.copy('./src', './tmpdir');
-        const exist = node_fs_1.default.existsSync(`./tmpdir/src`);
-        (0, node_assert_1.default)(exist);
-    });
-    it('Negative: Throw if not exists resource', async () => {
-        const guid = chance.guid();
-        await (0, expect_1.expect)(async () => {
-            await src_1.pfs.copy(`./${guid}`, '.');
-        })
-            .rejects
-            .toThrow();
-    });
-    it('Negative: An attempt to copy to an existing resource should return an Error', async () => {
-        await (0, expect_1.expect)(async () => {
-            await src_1.pfs.copy('./tmpdir', '.');
-        })
-            .rejects
-            .toThrow();
-    });
-    it('[sync] Positive: Copying a file', () => {
-        src_1.pfs.copy('./tmpdir/tings.txt', './tmpdir/digest', {
-            sync: true
-        });
-        const exist = node_fs_1.default.existsSync(`./tmpdir/digest/tings.txt`);
-        (0, node_assert_1.default)(exist);
-    });
-    it('[sync] Positive: Recursive copying a directory', () => {
-        src_1.pfs.copy('./src', './tmpdir', {
-            sync: true
-        });
-        const exist = node_fs_1.default.existsSync(`./tmpdir/src`);
-        (0, node_assert_1.default)(exist);
-    });
-    it('[sync] Negative: Throw if not exists resource', () => {
-        const guid = chance.guid();
-        node_assert_1.default.throws(() => {
-            src_1.pfs.copy(`./${guid}`, '.', {
-                sync: true
-            });
-        });
-    });
-    it('[sync] Negative: An attempt to copy to an existing resource should return an Error', () => {
-        node_assert_1.default.throws(() => {
-            src_1.pfs.copy('./tmpdir', '.', {
-                sync: true
-            });
-        });
-    });
-});

package/lib/test/mkdir.spec.d.ts

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