pwd-fs 3.1.3 → 3.2.0

package/readme.md

@@ -19,7 +19,7 @@ To improve reliability and maintainability the code is migrated to [TypeScript](
 To use `Powered File System` in your project, run:
 
 ```bash
-npm i pwd-fs
+npm install pwd-fs
 ```
 
 #### Table of Contents
@@ -47,7 +47,7 @@ The scope `URI` of the class methods are divided into groups.
 | URI                         | Methods                                                          |
 |-----------------------------|------------------------------------------------------------------|
 | Common (file and directory) | `chmod` `chown` `copy` `remove` `rename` `symlink` `stat` `test` |
-| File only                   | `read` `write`                                          |
+| File only                   | `read` `write`                                                   |
 | Directory only              | `mkdir` `readdir`                                                |
 
 
@@ -63,19 +63,17 @@ This class implemented by following the [ECMAScript® 2018 Language Specificatio
 String form paths are interpreted as UTF-8 character sequences identifying the absolute or relative filename.
 
 ```ts
-import PoweredFileSystem from 'pwd-fs';
+import { pfs } from 'pwd-fs';
 
 /**
  * pfs.pwd === process.cwd()
  */
-
-const pfs = new PoweredFileSystem();
 ```
 
 Relative paths will be resolved relative to the current working directory as specified by `process.cwd()`:
 
 ```ts
-import PoweredFileSystem from 'pwd-fs';
+import { PoweredFileSystem } from 'pwd-fs';
 
 /**
  * pfs.pwd === `${process.cwd()}/foo/bar`
@@ -87,7 +85,7 @@ const pfs = new PoweredFileSystem('./foo/bar');
 Absolute paths:
 
 ```ts
-import PoweredFileSystem from 'pwd-fs';
+import { PoweredFileSystem } from 'pwd-fs';
 
 /**
  * pfs.pwd === __dirname
@@ -141,23 +139,25 @@ These functions return information about a resource in the file system.
 Asynchronously changes the permissions of a file.
 
 ```ts
+import { bitmask } from 'pwd-fs';
+
 await pfs.chmod('./path', 0o750);
 const { mode } = await pfs.stat('./path');
 
-console.log(PoweredFileSystem.bitmask(mode) === 0o750); // true
+console.log(bitmask(mode) === 0o750); // true
 ```
 
 > **Caveats:** on Windows only the write permission can be changed, and the distinction among the permissions of group, owner or others is not implemented.
 
 See manuals [chmod(2)](http://man7.org/linux/man-pages/man2/chmod.2.html)
 
-#### pfs.chown(src, uid, gid[, options])
+#### pfs.chown(src, [, options])
 
 - `src` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)> Absolute or relative path to the resource in the file system. Relative paths will be resolved relative to the present working directory as specified by `pfs.pwd`.
-- `uid` <[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>
-- `gid` <[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>
 - `options` <[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>
   - `sync` <[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)> Synchronous execution. **Default:** `false`.
+  - `uid` <[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)> The file's new owner's user id.
+  - `gid` <[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)> The file's new group's group id.
 - returns: <[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)> Following successful change, the `Promise` is resolved with an value with a `undefined`.
 
 Asynchronously changes owner and group of a file.
@@ -194,10 +194,12 @@ See manuals [symlink(2)](http://man7.org/linux/man-pages/man2/symlink.2.html).
 Asynchronously recursively copy a file or directory.
 
 ```ts
+import { bitmask } from 'pwd-fs';
+
 await pfs.copy('./path/file.txt', './dist');
 const { mode } = await pfs.stat('./dist/path/file.txt');
 
-console.log(PoweredFileSystem.bitmask(mode) === 0o666); // true
+console.log(bitmask(mode) === 0o666); // true
 ```
 
 #### pfs.rename(src, use[, options])

package/src/bitmask.ts

@@ -0,0 +1,20 @@
+export function bitmask(mode: number) {
+  const type = typeof mode;
+
+  if (type !== 'number') {
+    throw new Error(
+      `Argument of type '${type}' is not assignable to parameter of type 'number'.`
+    );
+  }
+
+  const permissions: number[] = [ 0o400, 0o200, 0o100, 0o040, 0o020, 0o010, 0o004, 0o002, 0o001 ];
+  let umask = 0o000;
+
+  for (const flag of permissions) {
+    if (mode & flag) {
+      umask += flag;
+    }
+  }
+
+  return umask;
+}

package/src/index.ts

@@ -1,29 +1,7 @@
-import {
-  type Mode as TMode,
-  type Flag as TFlag,
-  type Stats as TStats,
-  PoweredFileSystem
-} from './powered-file-system';
+import { PoweredFileSystem } from './powered-file-system';
 
-export type Mode = TMode;
-export type Flag = TFlag;
-export type Stats = TStats;
+export const pfs = new PoweredFileSystem();
 
-// const pfs = new PoweredFileSystem();
+export default PoweredFileSystem;
 
-// export const test = pfs.test;
-// export const stat = pfs.stat;
-// export const chmod = pfs.chmod;
-// export const chown = pfs.chown;
-// export const symlink = pfs.symlink;
-// export const copy = pfs.copy;
-// export const rename = pfs.rename;
-// export const remove = pfs.remove;
-// export const read = pfs.read;
-// export const write = pfs.write;
-// export const append = pfs.append;
-// export const readdir = pfs.readdir;
-// export const mkdir = pfs.mkdir;
-
-export const bitmask = PoweredFileSystem.bitmask;
-export default PoweredFileSystem;
+export * from './powered-file-system';

package/src/powered-file-system.ts

@@ -1,12 +1,15 @@
-import fs from 'node:fs';
+import fs, { NoParamCallback } from 'node:fs';
 import path from 'node:path';
-import recurse, { Files, NoParamCallback } from './recurse-io';
-import recurseSync from './recurse-io-sync';
+import { chmod, chown, copy, remove, mkdir } from './recurse-io';
+import { chmodSync, chownSync, copySync, removeSync, mkdirSync } from './recurse-io-sync';
+import { bitmask } from './bitmask';
 
 export type Mode = keyof IConstants;
 export type Flag = Mode | 'a';
 export type Stats = fs.Stats;
 
+export * from './bitmask';
+
 export interface IConstants {
   e: number,
   r: number,
@@ -14,18 +17,6 @@ export interface IConstants {
   x: number
 }
 
-const permissions: number[] = [
-  0o400, // OWNER_READ
-  0o200, // OWNER_WRITE
-  0o100, // OWNER_EXECUTE
-  0o040, // GROUP_READ
-  0o020, // GROUP_WRITE
-  0o010, // GROUP_EXECUTE
-  0o004, // OTHERS_READ
-  0o002, // OTHERS_WRITE
-  0o001  // OTHERS_EXECUTE
-];
-
 export class PoweredFileSystem {
   readonly pwd: string;
 
@@ -36,6 +27,8 @@ export class PoweredFileSystem {
     x: fs.constants.X_OK
   };
 
+  static bitmask = bitmask;
+
   constructor(pwd?: string) {
     this.pwd = pwd ? path.resolve(pwd) : process.cwd();
   }
@@ -43,26 +36,6 @@ export class PoweredFileSystem {
   private resolve(src: string) {
     return path.resolve(this.pwd, src);
   }
-  
-  static bitmask(mode: number) {
-    const type = typeof mode;
-
-    if (type !== 'number') {
-      throw new Error(
-        `Argument of type '${type}' is not assignable to parameter of type 'number'.`
-      );
-    }
-
-    let umask = 0o000;
-
-    for (const flag of permissions) {
-      if (mode & flag) {
-        umask += flag;
-      }
-    }
-
-    return umask;
-  }
 
   test(src: string, options: {
     sync: true,
@@ -131,11 +104,11 @@ export class PoweredFileSystem {
     src = this.resolve(src);
 
     if (sync) {
-      return recurseSync.chmod(src, mode);
+      return chmodSync(src, mode);
     }
 
     return new Promise<void>((resolve, reject) => {
-      recurse.chmod(src, mode, (err) => {
+      chmod(src, mode, (err) => {
         if (err) {
           return reject(err);
         }
@@ -145,23 +118,27 @@ export class PoweredFileSystem {
     });
   }
 
-  chown(src: string, uid: number, gid: number, options: {
-    sync: true
+  chown(src: string, options: {
+    sync: true,
+    uid?: number,
+    gid?: number
   }): void;
 
-  chown(src: string, uid: number, gid: number, options?: {
-    sync?: false
+  chown(src: string, options?: {
+    sync?: false,
+    uid?: number,
+    gid?: number
   }): Promise<void>;
 
-  chown(src: string, uid: number, gid: number, { sync = false }: { sync?: boolean } = {}) {
+  chown(src: string, { sync = false, uid = 0, gid = 0 }: { sync?: boolean, uid?: number, gid?: number } = {}) {
     src = this.resolve(src);
 
     if (sync) {
-      return recurseSync.chown(src, uid, gid);
+      return chownSync(src, uid, gid);
     }
 
     return new Promise<void>((resolve, reject) => {
-      recurse.chown(src, uid, gid, (err) => {
+      chown(src, uid, gid, (err) => {
         if (err) {
           return reject(err);
         }
@@ -216,11 +193,11 @@ export class PoweredFileSystem {
     dir = this.resolve(dir);
     
     if (sync) {
-      return recurseSync.copy(src, dir, umask);
+      return copySync(src, dir, umask);
     }
 
     return new Promise<void>((resolve, reject) => {
-      recurse.copy(src, dir, umask, (err) => {
+      copy(src, dir, umask, (err) => {
         if (err) {
           return reject(err);
         }
@@ -269,17 +246,23 @@ export class PoweredFileSystem {
     src = this.resolve(src);
 
     if (sync) {
-      return recurseSync.remove(src);
+      removeSync(src);
     }
 
     return new Promise<void>((resolve, reject) => {
-      recurse.remove(src, (err) => {
+      const callback: NoParamCallback = (err) => {
         if (err) {
           return reject(err);
         }
 
         resolve();
-      });
+      };
+
+      if ('rm' in fs) {
+        return fs.rm(src, { recursive: true }, callback);
+      }
+      
+      remove(src, callback);
     });
   }
 
@@ -398,6 +381,9 @@ export class PoweredFileSystem {
     });
   }
 
+  /**
+  * @deprecated The method should not be used
+  */
   append(src: string, data: Buffer, options: {
     sync: true,
     encoding: null,
@@ -405,6 +391,9 @@ export class PoweredFileSystem {
     flag?: Flag
   }): void;
 
+  /**
+  * @deprecated The method should not be used
+  */
   append(src: string, data: string, options: {
     sync: true,
     encoding?: BufferEncoding,
@@ -412,6 +401,9 @@ export class PoweredFileSystem {
     flag?: Flag
   }): void;
 
+  /**
+  * @deprecated The method should not be used
+  */
   append(src: string, data: Buffer, options: {
     sync?: false,
     encoding: null,
@@ -419,6 +411,9 @@ export class PoweredFileSystem {
     flag?: Flag
   }): Promise<void>;
 
+  /**
+  * @deprecated The method should not be used
+  */
   append(src: string, data: string, options?: {
     sync?: false,
     encoding?: BufferEncoding,
@@ -426,6 +421,9 @@ 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,
@@ -509,11 +507,11 @@ export class PoweredFileSystem {
     dir = this.resolve(dir);
 
     if (sync) {
-      return recurseSync.mkdir(dir, umask);
+      return mkdirSync(dir, umask);
     }
 
     return new Promise<void>((resolve, reject) => {
-      recurse.mkdir(dir, umask, (err) => {
+      mkdir(dir, umask, (err) => {
         if (err) {
           return reject(err);
         }
@@ -522,4 +520,4 @@ export class PoweredFileSystem {
       });
     });
   }
-}
+}

package/src/recurse-io-sync.ts

@@ -3,35 +3,43 @@ import path from 'node:path';
 
 const { sep } = path;
 
-function chmod(src: string, mode: number) {
-  const stat = fs.statSync(src);
+export function chmodSync(src: string, mode: number) {
+  const stats = fs.statSync(src);
 
-  if (stat.isDirectory()) {
+  if (stats.isDirectory()) {
     const list = fs.readdirSync(src);
 
     for (const loc of list) {
-      chmod(`${src}${sep}${loc}`, mode);
+      chmodSync(`${src}${sep}${loc}`, mode);
     }
   }
 
   fs.chmodSync(src, mode);
 }
 
-function chown(src: string, uid: number, gid: number) {
-  const stat = fs.statSync(src);
+export function chownSync(src: string, uid: number, gid: number) {
+  const stats = fs.statSync(src);
 
-  if (stat.isDirectory()) {
+  if (uid === 0) {
+    uid = stats.uid;
+  }
+
+  if (gid === 0) {
+    gid = stats.gid;
+  }
+
+  if (stats.isDirectory()) {
     const list = fs.readdirSync(src);
 
     for (const loc of list) {
-      chown(`${src}${sep}${loc}`, uid, gid);
+      chownSync(`${src}${sep}${loc}`, uid, gid);
     }
   }
 
   fs.chownSync(src, uid, gid);
 }
 
-function copy(src: string, dir: string, umask: number) {
+export function copySync(src: string, dir: string, umask: number) {
   const stat = fs.statSync(src);
 
   if (stat.isDirectory()) {
@@ -45,7 +53,7 @@ function copy(src: string, dir: string, umask: number) {
     fs.mkdirSync(dir, mode);
 
     for (const loc of list) {
-      copy(`${src}${sep}${loc}`, dir, umask);
+      copySync(`${src}${sep}${loc}`, dir, umask);
     }
   }
   else {
@@ -56,14 +64,14 @@ function copy(src: string, dir: string, umask: number) {
   }
 }
 
-function remove(src: string) {
-  const stat = fs.statSync(src);
+export function removeSync(src: string) {
+  const stats = fs.statSync(src);
 
-  if (stat.isDirectory()) {
+  if (stats.isDirectory()) {
     const list = fs.readdirSync(src);
 
     for (const loc of list) {
-      remove(`${src}${sep}${loc}`);
+      removeSync(`${src}${sep}${loc}`);
     }
 
     fs.rmdirSync(src);
@@ -73,14 +81,14 @@ function remove(src: string) {
   }
 }
 
-function mkdir(dir: string, umask: number) {
+export function mkdirSync(dir: string, umask: number) {
   const mode = 0o777 - umask;
   const cwd = process.cwd();
   let use = '';
 
   if (dir.indexOf(cwd) === 0) {
     use = cwd;
-    dir = dir.substr(cwd.length);
+    dir = dir.substring(cwd.length);
   }
 
   const ways = dir.split(sep).slice(1);
@@ -98,11 +106,3 @@ function mkdir(dir: string, umask: number) {
     }
   }
 }
-
-export default {
-  chmod,
-  chown,
-  copy,
-  remove,
-  mkdir
-}

package/src/recurse-io.ts

@@ -1,20 +1,19 @@
-import fs from 'node:fs';
+import fs, { NoParamCallback } from 'node:fs';
 import path from 'node:path';
 
-export type Files = Array<string>;
-export type NoParamCallback = fs.NoParamCallback;
+type Files = Array<string>;
 
 const { sep } = path;
 
-function chmod(src: string, mode: number, callback: NoParamCallback) {
+export function chmod(src: string, mode: number, callback: NoParamCallback) {
   let reduce = 0;
 
-  fs.stat(src, (err, stat) => {
+  fs.stat(src, (err, stats) => {
     if (err) {
       return callback(err);
     }
 
-    if (stat.isDirectory()) {
+    if (stats.isDirectory()) {
       fs.readdir(src, (err, list) => {
         if (err) {
           return callback(err);
@@ -45,7 +44,7 @@ function chmod(src: string, mode: number, callback: NoParamCallback) {
   });
 }
 
-function chown(src: string, uid: number, gid: number, callback: NoParamCallback) {
+export function chown(src: string, uid: number, gid: number, callback: NoParamCallback) {
   let reduce = 0;
 
   fs.stat(src, (err, stats) => {
@@ -53,6 +52,14 @@ function chown(src: string, uid: number, gid: number, callback: NoParamCallback)
       return callback(err);
     }
 
+    if (uid === 0) {
+      uid = stats.uid;
+    }
+
+    if (gid === 0) {
+      gid = stats.gid;
+    }
+
     if (stats.isDirectory()) {
       fs.readdir(src, (err, list) => {
         if (err) {
@@ -84,7 +91,7 @@ function chown(src: string, uid: number, gid: number, callback: NoParamCallback)
   });
 }
 
-function copy(src: string, dir: string, umask: number, callback: NoParamCallback) {
+export function copy(src: string, dir: string, umask: number, callback: NoParamCallback) {
   let reduce = 0;
 
   fs.stat(src, (err, stat) => {
@@ -150,7 +157,7 @@ function copy(src: string, dir: string, umask: number, callback: NoParamCallback
   });
 }
 
-function remove(src: string, callback: NoParamCallback) {
+export function remove(src: string, callback: NoParamCallback) {
   fs.stat(src, (err, stat) => {
     if (err) {
       return callback(err);
@@ -187,7 +194,7 @@ function remove(src: string, callback: NoParamCallback) {
   });
 }
 
-function mkdir(dir: string, umask: number, callback: NoParamCallback) {
+export function mkdir(dir: string, umask: number, callback: NoParamCallback) {
   const cwd = process.cwd();
 
   if (dir === cwd) {
@@ -218,7 +225,7 @@ function mkdir(dir: string, umask: number, callback: NoParamCallback) {
 
   if (dir.indexOf(cwd) === 0) {
     use = cwd;
-    dir = dir.substr(cwd.length);
+    dir = dir.substring(cwd.length);
   }
 
   const files = dir.split(sep);
@@ -229,11 +236,3 @@ function mkdir(dir: string, umask: number, callback: NoParamCallback) {
   iter.next();
   iter.next(iter);
 }
-
-export default {
-  chmod,
-  chown,
-  copy,
-  remove,
-  mkdir
-}

package/{__tests__ → test}/append.spec.ts

@@ -1,12 +1,11 @@
 import assert from 'node:assert';
-import { sep } from 'node:path';
 import fs from 'node:fs';
 import Chance  from 'chance';
+import { expect } from 'expect';
 import { fmock, restore } from './__fmock';
-import PoweredFileSystem from '../src';
+import { pfs } from '../src';
 
 describe('append(src, data [, options])', () => {
-  const pfs = new PoweredFileSystem();
   const chance = new Chance();
 
   beforeEach(() => {

package/{__tests__ → test}/chmod.spec.ts

@@ -1,12 +1,11 @@
 import assert from 'node:assert';
-import { sep } from 'node:path';
 import fs from 'node:fs';
 import Chance  from 'chance';
+import { expect } from 'expect';
 import { fmock, restore } from './__fmock';
-import PoweredFileSystem, { bitmask } from '../src';
+import { pfs, bitmask } from '../src';
 
 describe('chmod(src, mode [, options])', () => {
-  const pfs = new PoweredFileSystem();
   const chance = new Chance();
 
   beforeEach(() => {

package/{__tests__ → test}/chown.spec.ts

@@ -1,11 +1,11 @@
 import assert from 'node:assert';
 import fs from 'node:fs';
 import Chance  from 'chance';
+import { expect } from 'expect';
 import { fmock, restore } from './__fmock';
-import PoweredFileSystem from '../src';
+import { pfs } from '../src';
 
-describe('chown(src, uid, gid [, options])', () => {
-  const pfs = new PoweredFileSystem();
+describe('chown(src, [, options])', () => {
   const chance = new Chance();
 
   beforeEach(() => {
@@ -25,8 +25,7 @@ describe('chown(src, uid, gid [, options])', () => {
   
   it('Positive: Changes the permissions of a file', async () => {
     const { uid, gid } = fs.statSync('./tmpdir/tings.txt');
-    
-    await pfs.chown('./tmpdir/tings.txt', uid, gid);
+    await pfs.chown('./tmpdir/tings.txt', { uid, gid });
 
     assert(uid && gid);
   });
@@ -34,8 +33,7 @@ describe('chown(src, uid, gid [, options])', () => {
   
   it('Positive: Changes the permissions of a directory', async () => {
     const { uid, gid } = fs.statSync('./tmpdir/digest');
-
-    await pfs.chown('./tmpdir/digest', uid, gid);
+    await pfs.chown('./tmpdir/digest', { uid, gid });
 
     assert(uid && gid);
   });
@@ -46,7 +44,7 @@ describe('chown(src, uid, gid [, options])', () => {
     const { uid, gid } = fs.statSync('./tmpdir/tings.txt');
     
     await expect(async () => {
-      await pfs.chown(`./tmpdir/${guid}`, uid, gid);
+      await pfs.chown(`./tmpdir/${guid}`, { uid, gid });
     })
     .rejects
     .toThrow();
@@ -56,8 +54,10 @@ describe('chown(src, uid, gid [, options])', () => {
   it('[sync] Positive: Changes the permissions of a file', () => {
     const { uid, gid } = fs.statSync('./tmpdir/tings.txt');
 
-    pfs.chown('./tmpdir/tings.txt', uid, gid, {
-      sync: true
+    pfs.chown('./tmpdir/tings.txt', {
+      sync: true,
+      uid,
+      gid
     });
 
     assert(uid && gid);
@@ -67,8 +67,10 @@ describe('chown(src, uid, gid [, options])', () => {
   it('[sync] Positive: Changes the permissions of a directory', () => {
     const { uid, gid } = fs.statSync('./tmpdir/digest');
 
-    pfs.chown('./tmpdir/digest', uid, gid, {
-      sync: true
+    pfs.chown('./tmpdir/digest', {
+      sync: true,
+      uid,
+      gid
     });
 
     assert(uid && gid);
@@ -80,8 +82,10 @@ describe('chown(src, uid, gid [, options])', () => {
     const { uid, gid } = fs.statSync('./tmpdir/tings.txt');
     
     assert.throws(() => {
-      pfs.chown(`./tmpdir/${guid}`, uid, gid, {
-        sync: true
+      pfs.chown(`./tmpdir/${guid}`, {
+        sync: true,
+        uid,
+        gid
       });
     });
   });