pwd-fs 3.1.3 → 3.2.0

package/lib/test/read.spec.js

@@ -0,0 +1,73 @@
+"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 chance_1 = __importDefault(require("chance"));
+const expect_1 = require("expect");
+const __fmock_1 = require("./__fmock");
+const src_1 = require("../src");
+describe('read(src [, options])', () => {
+    const chance = new chance_1.default();
+    let sentences = 0;
+    beforeEach(() => {
+        const tingsContent = chance.paragraph();
+        sentences = tingsContent.length;
+        (0, __fmock_1.fmock)({
+            './tmpdir/tings.txt': {
+                type: 'file',
+                data: tingsContent
+            }
+        });
+    });
+    afterEach(() => {
+        (0, __fmock_1.restore)('./tmpdir');
+    });
+    it('Positive: Must read content of file; String type by default', async () => {
+        const { length } = await src_1.pfs.read('./tmpdir/tings.txt');
+        (0, node_assert_1.default)(length === sentences);
+    });
+    it('Positive: Must read Buffer content of file when encoding is null', async () => {
+        const buffer = await src_1.pfs.read('./tmpdir/tings.txt', {
+            encoding: null
+        });
+        (0, node_assert_1.default)(buffer instanceof Buffer);
+    });
+    it('Negative: Throw if resource is not file', async () => {
+        await (0, expect_1.expect)(async () => {
+            await src_1.pfs.read(`./tmpdir`);
+        })
+            .rejects
+            .toThrow();
+    });
+    it('Negative: Throw if not exists resource', async () => {
+        const guid = chance.guid();
+        await (0, expect_1.expect)(async () => {
+            await src_1.pfs.read(`./tmpdir/${guid}`);
+        })
+            .rejects
+            .toThrow();
+    });
+    it('[sync] Positive: Must read content of file; String type by default', () => {
+        const { length } = src_1.pfs.read('./tmpdir/tings.txt', {
+            sync: true
+        });
+        (0, node_assert_1.default)(length === sentences);
+    });
+    it('[sync] Positive: Must read Buffer content of file when encoding is null', () => {
+        const buffer = src_1.pfs.read('./tmpdir/tings.txt', {
+            encoding: null,
+            sync: true
+        });
+        (0, node_assert_1.default)(buffer instanceof Buffer);
+    });
+    it(`[sync] Negative: Throw if not exists resource`, () => {
+        const guid = chance.guid();
+        node_assert_1.default.throws(() => {
+            src_1.pfs.read(`./tmpdir/${guid}`, {
+                sync: true
+            });
+        });
+    });
+});

package/lib/test/readdir.spec.js

@@ -0,0 +1,70 @@
+"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 chance_1 = __importDefault(require("chance"));
+const expect_1 = require("expect");
+const __fmock_1 = require("./__fmock");
+const src_1 = require("../src");
+describe('readdir(src[, options])', () => {
+    const chance = new chance_1.default();
+    let counter = 0;
+    beforeEach(() => {
+        const frame = {
+            './tmpdir/tings.txt': {
+                type: 'file',
+                data: chance.string()
+            }
+        };
+        counter = chance.natural({ max: 7 });
+        for (let i = 0; i < counter; i++) {
+            frame[`./tmpdir/${i}`] = { type: 'directory' };
+        }
+        (0, __fmock_1.fmock)(frame);
+    });
+    afterEach(() => {
+        (0, __fmock_1.restore)('./tmpdir');
+    });
+    it('Positive: Must return a directory listing', async () => {
+        const { length } = await src_1.pfs.readdir('./tmpdir');
+        (0, node_assert_1.default)(counter + 1 === length);
+    });
+    it('Negative: Throw if resource is not directory', async () => {
+        await (0, expect_1.expect)(async () => {
+            await src_1.pfs.readdir(`./tmpdir/tings.txt`);
+        })
+            .rejects
+            .toThrow();
+    });
+    it('Negative: Throw if not exists resource', async () => {
+        const guid = chance.guid();
+        await (0, expect_1.expect)(async () => {
+            await src_1.pfs.readdir(`./tmpdir/${guid}`);
+        })
+            .rejects
+            .toThrow();
+    });
+    it('[sync] Positive: Must return a directory listing', () => {
+        const { length } = src_1.pfs.readdir('./tmpdir', {
+            sync: true
+        });
+        (0, node_assert_1.default)(counter + 1 === length);
+    });
+    it('Negative: Throw if resource is not directory', () => {
+        node_assert_1.default.throws(() => {
+            src_1.pfs.readdir(`./tmpdir/tings.txt`, {
+                sync: true
+            });
+        });
+    });
+    it(`Negative: Throw if not exists resource`, () => {
+        const guid = chance.guid();
+        node_assert_1.default.throws(() => {
+            src_1.pfs.readdir(`./tmpdir/${guid}`, {
+                sync: true
+            });
+        });
+    });
+});

package/lib/test/remove.spec.js

@@ -0,0 +1,63 @@
+"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('remove(src [, options])', () => {
+    const chance = new chance_1.default();
+    beforeEach(() => {
+        const cwd = process.cwd();
+        const frame = {
+            './tmpdir/tings.txt': {
+                type: 'file',
+                data: chance.string()
+            },
+            './tmpdir/flexapp': {
+                type: 'symlink',
+                target: `${cwd}/tmpdir/tings.txt`
+            }
+        };
+        const counter = chance.natural({ max: 7 });
+        for (let i = 0; i < counter; i++) {
+            frame[`./tmpdir/${i}`] = { type: 'directory' };
+        }
+        (0, __fmock_1.fmock)(frame);
+    });
+    afterEach(() => {
+        (0, __fmock_1.restore)('./tmpdir');
+    });
+    it('Positive: Removal a directory with a file', async () => {
+        await src_1.pfs.remove('./tmpdir');
+        const exist = node_fs_1.default.existsSync(`./tmpdir`);
+        (0, node_assert_1.default)(exist === false);
+    });
+    it('Negative: Throw if not exists resource', async () => {
+        const guid = chance.guid();
+        await (0, expect_1.expect)(async () => {
+            await src_1.pfs.remove(`./${guid}`);
+        })
+            .rejects
+            .toThrow();
+    });
+    it('[sync] Positive: Removal a directory with a file', () => {
+        src_1.pfs.remove('./tmpdir', {
+            sync: true
+        });
+        const exist = node_fs_1.default.existsSync(`./tmpdir`);
+        (0, node_assert_1.default)(exist === false);
+    });
+    it('[sync] Negative: Throw if not exists resource', () => {
+        const guid = chance.guid();
+        node_assert_1.default.throws(() => {
+            src_1.pfs.remove(`./tmpdir/${guid}`, {
+                sync: true
+            });
+        });
+    });
+});

package/lib/test/rename.spec.js

@@ -0,0 +1,66 @@
+"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('rename(src, use [, 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: Must be recursive rename file', async () => {
+        await src_1.pfs.rename('./tmpdir/tings.txt', './tmpdir/newapp.txt');
+        const exist = node_fs_1.default.existsSync(`./tmpdir/newapp.txt`);
+        (0, node_assert_1.default)(exist);
+    });
+    it('Positive: Must be recursive rename directory', async () => {
+        await src_1.pfs.rename('./tmpdir/digest', './tmpdir/newxbase');
+        const exist = node_fs_1.default.existsSync(`./tmpdir/newxbase`);
+        (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.rename(`./tmpdir/${guid}`, './tmpdir/newxbase');
+        })
+            .rejects
+            .toThrow();
+    });
+    it('[sync] Positive: Must be recursive rename file', () => {
+        src_1.pfs.rename('./tmpdir/tings.txt', './tmpdir/newapp.txt', {
+            sync: true
+        });
+        const exist = node_fs_1.default.existsSync(`./tmpdir/newapp.txt`);
+        (0, node_assert_1.default)(exist);
+    });
+    it('[sync] Positive: Must be recursive rename directory', () => {
+        src_1.pfs.rename('./tmpdir/digest', './tmpdir/newxbase', {
+            sync: true
+        });
+        const exist = node_fs_1.default.existsSync(`./tmpdir/newxbase`);
+        (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.rename(`./tmpdir/${guid}`, './tmpdir/newxbase', {
+                sync: true
+            });
+        });
+    });
+});

package/lib/test/stat.spec.js

@@ -0,0 +1,76 @@
+"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 chance_1 = __importDefault(require("chance"));
+const expect_1 = require("expect");
+const __fmock_1 = require("./__fmock");
+const src_1 = require("../src");
+describe('stat(src [, options])', () => {
+    const chance = new chance_1.default();
+    beforeEach(() => {
+        const cwd = process.cwd();
+        (0, __fmock_1.fmock)({
+            './tmpdir/tings.txt': {
+                type: 'file',
+                data: chance.string()
+            },
+            './tmpdir/digest/': { type: 'directory' },
+            './tmpdir/flexapp': {
+                type: 'symlink',
+                target: `${cwd}/tmpdir/tings.txt`
+            }
+        });
+    });
+    afterEach(() => {
+        (0, __fmock_1.restore)('./tmpdir');
+    });
+    it('Positive: Must return information a file', async () => {
+        const stats = await src_1.pfs.stat('./tmpdir/tings.txt');
+        (0, node_assert_1.default)(stats.isFile());
+    });
+    it('Positive: Must return information a directory', async () => {
+        const stats = await src_1.pfs.stat('./tmpdir/digest');
+        (0, node_assert_1.default)(stats.isDirectory());
+    });
+    it('Positive: Must return information a symlink', async () => {
+        const stats = await src_1.pfs.stat('./tmpdir/flexapp');
+        (0, node_assert_1.default)(stats.isSymbolicLink());
+    });
+    it('Negative: Throw if not exists resource', async () => {
+        const guid = chance.guid();
+        await (0, expect_1.expect)(async () => {
+            await src_1.pfs.stat(`./tmpdir/${guid}`);
+        })
+            .rejects
+            .toThrow();
+    });
+    it('[sync] Positive: Must return information a file', () => {
+        const stats = src_1.pfs.stat('./tmpdir/tings.txt', {
+            sync: true
+        });
+        (0, node_assert_1.default)(stats.isFile());
+    });
+    it('[sync] Positive: Must return information a directory in ', () => {
+        const stats = src_1.pfs.stat('./tmpdir/digest', {
+            sync: true
+        });
+        (0, node_assert_1.default)(stats.isDirectory());
+    });
+    it('[sync] Positive: Must return information a symlink', () => {
+        const stats = src_1.pfs.stat('./tmpdir/flexapp', {
+            sync: true
+        });
+        (0, node_assert_1.default)(stats.isSymbolicLink());
+    });
+    it('[sync] Negative: Throw if not exists resource', () => {
+        const guid = chance.guid();
+        node_assert_1.default.throws(() => {
+            src_1.pfs.stat(`./tmpdir/${guid}`, {
+                sync: true
+            });
+        });
+    });
+});

package/lib/test/symlink.spec.js

@@ -0,0 +1,74 @@
+"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('symlink(src, use [, options])', () => {
+    const chance = new chance_1.default();
+    beforeEach(() => {
+        const cwd = process.cwd();
+        const frame = {
+            './tmpdir/tings.txt': {
+                type: 'file',
+                data: chance.string()
+            },
+            './tmpdir/digest/': { type: 'directory' },
+            './tmpdir/flexapp': {
+                type: 'symlink',
+                target: `${cwd}/tmpdir/tings.txt`
+            }
+        };
+        const counter = chance.natural({ max: 7 });
+        for (let i = 0; i < counter; i++) {
+            frame[`./tmpdir/${i}`] = { type: 'directory' };
+        }
+        (0, __fmock_1.fmock)(frame);
+    });
+    afterEach(() => {
+        (0, __fmock_1.restore)('./tmpdir');
+    });
+    it('Positive: Must be created a symbolic link', async () => {
+        await src_1.pfs.symlink('./tmpdir/tings.txt', './tmpdir/linkapp');
+        const stat = node_fs_1.default.lstatSync('./tmpdir/linkapp');
+        (0, node_assert_1.default)(stat.isSymbolicLink());
+    });
+    it('Positive: Must be created a symbolic link for directory', async () => {
+        await src_1.pfs.symlink('./tmpdir/digest', './tmpdir/linkapp');
+        const stat = node_fs_1.default.lstatSync('./tmpdir/linkapp');
+        (0, node_assert_1.default)(stat.isSymbolicLink());
+    });
+    it('Negative: Throw if destination already exists', async () => {
+        await (0, expect_1.expect)(async () => {
+            await src_1.pfs.symlink('./tmpdir/tings.txt', './tmpdir/flexapp');
+        })
+            .rejects
+            .toThrow();
+    });
+    it('[sync] Positive: Must be created a symbolic link', () => {
+        src_1.pfs.symlink('./tmpdir/tings.txt', './tmpdir/linkapp', {
+            sync: true
+        });
+        const stat = node_fs_1.default.lstatSync('./tmpdir/linkapp');
+        (0, node_assert_1.default)(stat.isSymbolicLink());
+    });
+    it('[sync] Positive: Must be created a symbolic link for directory', () => {
+        src_1.pfs.symlink('./tmpdir/digest', './tmpdir/linkapp', {
+            sync: true
+        });
+        const stat = node_fs_1.default.lstatSync('./tmpdir/linkapp');
+        (0, node_assert_1.default)(stat.isSymbolicLink());
+    });
+    it('[sync] Negative: Throw if destination already exists', () => {
+        node_assert_1.default.throws(() => {
+            src_1.pfs.symlink('./tmpdir/tings.txt', './tmpdir/flexapp', {
+                sync: true
+            });
+        });
+    });
+});

package/lib/test/test.spec.js

@@ -0,0 +1,60 @@
+"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 chance_1 = __importDefault(require("chance"));
+const __fmock_1 = require("./__fmock");
+const src_1 = require("../src");
+describe('test(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: Should return 'true' for current working directory`, async () => {
+        const exist = await src_1.pfs.test('.');
+        (0, node_assert_1.default)(exist);
+    });
+    it(`Positive: For existing file should return 'true'`, async () => {
+        const exist = await src_1.pfs.test('./tmpdir/tings.txt');
+        (0, node_assert_1.default)(exist);
+    });
+    it(`Positive: For existing directory should return 'true'`, async () => {
+        const exist = await src_1.pfs.test('./tmpdir/digest');
+        (0, node_assert_1.default)(exist);
+    });
+    it(`Positive: A non-existent file must return 'false'`, async () => {
+        const guid = chance.guid();
+        const exist = await src_1.pfs.test(`./tmpdir/${guid}`);
+        (0, node_assert_1.default)(exist === false);
+    });
+    it(`Positive: For existing file should return 'true'`, () => {
+        const exist = src_1.pfs.test('./tmpdir/tings.txt', {
+            sync: true
+        });
+        (0, node_assert_1.default)(exist);
+    });
+    it(`[sync] Positive: For existing directory should return 'true'`, () => {
+        const exist = src_1.pfs.test('./tmpdir/digest', {
+            sync: true
+        });
+        (0, node_assert_1.default)(exist);
+    });
+    it(`[sync] Positive: A non-existent file must return 'false'`, () => {
+        const guid = chance.guid();
+        const exist = src_1.pfs.test(`./tmpdir/${guid}`, {
+            sync: true
+        });
+        (0, node_assert_1.default)(exist === false);
+    });
+});

package/lib/test/write.spec.js

@@ -0,0 +1,82 @@
+"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('write(src, data[, 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: Must write content to file', async () => {
+        const payload = chance.paragraph();
+        const guid = chance.guid();
+        await src_1.pfs.write(`./tmpdir/${guid}.txt`, payload);
+        const { size } = node_fs_1.default.lstatSync(`./tmpdir/${guid}.txt`);
+        (0, node_assert_1.default)(payload.length === size);
+    });
+    it('Positive: Must rewrite content if file already exists', async () => {
+        const payload = chance.paragraph();
+        await src_1.pfs.write('./tmpdir/tings.txt', payload);
+        const { size } = node_fs_1.default.lstatSync('./tmpdir/tings.txt');
+        (0, node_assert_1.default)(payload.length === size);
+    });
+    it('Negative: Throw if resource is directory', async () => {
+        const payload = chance.paragraph();
+        await (0, expect_1.expect)(async () => {
+            await src_1.pfs.write('./tmpdir', payload);
+        })
+            .rejects
+            .toThrow();
+    });
+    it(`Negative: Unexpected option 'flag' returns Error`, async () => {
+        const payload = chance.paragraph();
+        await (0, expect_1.expect)(async () => {
+            await src_1.pfs.write('./tmpdir/tings.txt', payload, {
+                flag: 'r'
+            });
+        })
+            .rejects
+            .toThrow();
+    });
+    it('[sync] Positive: Write contents even to a non-existent file', () => {
+        const payload = chance.paragraph();
+        const guid = chance.guid();
+        src_1.pfs.write(`./tmpdir/${guid}.txt`, payload, {
+            sync: true
+        });
+        const content = node_fs_1.default.readFileSync(`./tmpdir/${guid}.txt`, 'utf8');
+        (0, node_assert_1.default)(payload === content);
+    });
+    it('[sync] Negative: Throw if resource is directory', () => {
+        const payload = chance.paragraph();
+        node_assert_1.default.throws(() => {
+            src_1.pfs.write('./tmpdir', payload, {
+                sync: true
+            });
+        });
+    });
+    it(`[sync] Negative: Unexpected option 'flag' returns Error`, () => {
+        const payload = chance.paragraph();
+        node_assert_1.default.throws(() => {
+            src_1.pfs.write('./tmpdir/tings.txt', payload, {
+                sync: true,
+                flag: 'r'
+            });
+        });
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pwd-fs",
-  "version": "3.1.3",
+  "version": "3.2.0",
   "description": "Extend the file system the capabilities of declaring the present working directory and recursive execution",
   "keywords": [
     "umask",
@@ -24,30 +24,23 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/woodger/pwd-fs.git"
+    "url": "git@github.com:woodger/pwd-fs.git"
   },
   "engines": {
     "node": ">=13.2.0"
   },
-  "type": "module",
-  "main": "./lib/index.js",
+  "main": "./lib/src/index.js",
   "types": "./lib/src/index.d.ts",
   "scripts": {
-    "build": "rollup -c",
-    "test": "jest"
+    "build": "tsc",
+    "test": "mocha ./lib/test"
   },
   "devDependencies": {
-    "@rollup/plugin-node-resolve": "^15.2.3",
-    "@rollup/plugin-typescript": "^11.1.6",
     "@types/chance": "^1.1.6",
-    "@types/jest": "^29.5.12",
-    "@types/node": "^20.12.7",
+    "@types/mocha": "^10.0.6",
     "chance": "^1.1.11",
-    "jest": "^29.7.0",
-    "rollup": "^4.14.3",
-    "ts-jest": "^29.1.2",
-    "ts-node": "^10.9.2",
-    "tslib": "^2.6.2",
+    "expect": "^29.7.0",
+    "mocha": "^10.4.0",
     "typescript": "^5.4.5"
   }
 }