pwd-fs 2.4.1 → 3.1.3

package/src/powered-file-system.ts

@@ -0,0 +1,525 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import recurse, { Files, NoParamCallback } from './recurse-io';
+import recurseSync from './recurse-io-sync';
+
+export type Mode = keyof IConstants;
+export type Flag = Mode | 'a';
+export type Stats = fs.Stats;
+
+export interface IConstants {
+  e: number,
+  r: number,
+  w: number,
+  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;
+
+  readonly constants: IConstants = {
+    e: fs.constants.F_OK,
+    r: fs.constants.R_OK,
+    w: fs.constants.W_OK,
+    x: fs.constants.X_OK
+  };
+
+  constructor(pwd?: string) {
+    this.pwd = pwd ? path.resolve(pwd) : process.cwd();
+  }
+  
+  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,
+    flag?: Mode
+  }): boolean;
+  
+  test(src: string, options?: {
+    sync?: false,
+    flag?: Mode
+  }): Promise<boolean>;
+  
+  test(src: string, { sync = false, flag = 'e' }: {
+    sync?: boolean,
+    flag?: Mode
+  } = {}) {
+    const mode = this.constants[flag];
+
+    src = path.resolve(this.pwd, src);
+
+    if (sync) {
+      return fs.existsSync(src);
+    }
+
+    return new Promise((resolve) => {
+      fs.access(src, mode, (err) => {
+        if (err) {
+          return resolve(false);
+        }
+
+        resolve(true);
+      });
+    });
+  }
+
+  stat(src: string, options: { sync: true }): Stats;
+  
+  stat(src: string, options?: { sync?: false }): Promise<Stats>;
+  
+  stat(src: string, { sync = false }: { sync?: boolean } = {}) {
+    src = this.resolve(src);
+
+    if (sync) {
+      return fs.lstatSync(src);
+    }
+
+    return new Promise((resolve, reject) => {
+      fs.lstat(src, (err, stats) => {
+        if (err) {
+          return reject(err);
+        }
+
+        resolve(stats);
+      });
+    });
+  }
+
+  chmod(src: string, mode: number, options: {
+    sync: true
+  }): void;
+  
+  chmod(src: string, mode: number, options?: {
+    sync?: false
+  }): Promise<void>;
+  
+  chmod(src: string, mode: number, { sync = false }: { sync?: boolean } = {}) {
+    src = this.resolve(src);
+
+    if (sync) {
+      return recurseSync.chmod(src, mode);
+    }
+
+    return new Promise<void>((resolve, reject) => {
+      recurse.chmod(src, mode, (err) => {
+        if (err) {
+          return reject(err);
+        }
+
+        resolve();
+      });
+    });
+  }
+
+  chown(src: string, uid: number, gid: number, options: {
+    sync: true
+  }): void;
+
+  chown(src: string, uid: number, gid: number, options?: {
+    sync?: false
+  }): Promise<void>;
+
+  chown(src: string, uid: number, gid: number, { sync = false }: { sync?: boolean } = {}) {
+    src = this.resolve(src);
+
+    if (sync) {
+      return recurseSync.chown(src, uid, gid);
+    }
+
+    return new Promise<void>((resolve, reject) => {
+      recurse.chown(src, uid, gid, (err) => {
+        if (err) {
+          return reject(err);
+        }
+
+        resolve();
+      });
+    });
+  }
+
+  symlink(src: string, use: string, options: {
+    sync: true
+  }): void;
+
+  symlink(src: string, use: string, options?: {
+    sync?: false
+  }): Promise<void>;
+
+  symlink(src: string, use: string, { sync = false }: { sync?: boolean } = {}) {
+    src = this.resolve(src);
+    use = this.resolve(use);
+
+    if (sync) {
+      return fs.symlinkSync(src, use);
+    }
+
+    return new Promise<void>((resolve, reject) => {
+      fs.symlink(src, use, (err) => {
+        if (err) {
+          return reject(err);
+        }
+
+        resolve();
+      });
+    });
+  }
+
+  copy(src: string, dir: string, options: {
+    sync: true,
+    umask?: number
+  }): void;
+
+  copy(src: string, dir: string, options?: {
+    sync?: false,
+    umask?: number
+  }): Promise<void>;
+
+  copy(src: string, dir: string, { sync = false, umask = 0o000 }: {
+    sync?: boolean,
+    umask?: number
+  } = {}) {
+    src = this.resolve(src);
+    dir = this.resolve(dir);
+    
+    if (sync) {
+      return recurseSync.copy(src, dir, umask);
+    }
+
+    return new Promise<void>((resolve, reject) => {
+      recurse.copy(src, dir, umask, (err) => {
+        if (err) {
+          return reject(err);
+        }
+
+        resolve();
+      });
+    });
+  }
+
+  rename(src: string, use: string, options: {
+    sync: true
+  }): void;
+
+  rename(src: string, use: string, options?: {
+    sync?: false
+  }): Promise<void>;
+
+  rename(src: string, use: string, { sync = false }: { sync?: boolean } = {}) {
+    src = this.resolve(src);
+    use = this.resolve(use);
+
+    if (sync) {
+      return fs.renameSync(src, use);
+    }
+
+    return new Promise<void>((resolve, reject) => {
+      fs.rename(src, use, (err) => {
+        if (err) {
+          return reject(err);
+        }
+
+        resolve();
+      });
+    });
+  }
+
+  remove(src: string, options: {
+    sync: true
+  }): void;
+
+  remove(src: string, options?: {
+    sync?: false
+  }): Promise<void>;
+
+  remove(src: string, { sync = false }: { sync?: boolean } = {}) {
+    src = this.resolve(src);
+
+    if (sync) {
+      return recurseSync.remove(src);
+    }
+
+    return new Promise<void>((resolve, reject) => {
+      recurse.remove(src, (err) => {
+        if (err) {
+          return reject(err);
+        }
+
+        resolve();
+      });
+    });
+  }
+
+  read(src: string, options: {
+    sync: true,
+    encoding?: BufferEncoding,
+    flag?: Flag
+  }): string;
+
+  read(src: string, options: {
+    sync: true,
+    encoding?: null,
+    flag?: Flag
+  }): Buffer;
+
+  read(src: string, options: {
+    sync?: false,
+    encoding: null,
+    flag?: Flag
+  }): Promise<Buffer>;
+
+  read(src: string, options?: {
+    sync?: false,
+    encoding?: BufferEncoding,
+    flag?: Flag
+  }): Promise<string>;
+
+  read(src: string, { sync = false, encoding = 'utf8', flag = 'r' }: {
+    sync?: boolean,
+    encoding?: BufferEncoding | null,
+    flag?: Flag
+  } = {}) {
+    src = this.resolve(src);
+
+    if (sync) {
+      return fs.readFileSync(src, {
+        encoding,
+        flag
+      });
+    }
+
+    return new Promise((resolve, reject) => {
+      fs.readFile(src, {
+        encoding,
+        flag
+      },
+      (err, raw) => {
+        if (err) {
+          return reject(err);
+        }
+
+        resolve(raw);
+      });
+    });
+  }
+
+  write(src: string, data: Buffer, options: {
+    sync: true,
+    encoding: null,
+    umask?: number,
+    flag?: Flag
+  }): void;
+
+  write(src: string, data: string, options: {
+    sync: true,
+    encoding?: BufferEncoding,
+    umask?: number,
+    flag?: Flag
+  }): void;
+
+  write(src: string, data: Buffer, options: {
+    sync?: false,
+    encoding: null,
+    umask?: number,
+    flag?: Flag
+  }): Promise<void>;
+
+  write(src: string, data: string, options?: {
+    sync?: false,
+    encoding?: BufferEncoding,
+    umask?: number,
+    flag?: Flag
+  }): Promise<void>;
+
+  write(src: string, data: Buffer | string, { sync = false, encoding = 'utf8', umask = 0o000, flag = 'w' }: {
+    sync?: boolean,
+    encoding?: BufferEncoding | null,
+    umask?: number,
+    flag?: Flag
+  } = {}) {
+    src = this.resolve(src);
+
+    const mode = 0o666 - umask;
+
+    if (sync) {
+      return fs.writeFileSync(src, data, {
+        encoding,
+        mode,
+        flag
+      });
+    }
+
+    return new Promise<void>((resolve, reject) => {
+      fs.writeFile(src, data, {
+        encoding,
+        mode,
+        flag
+      },
+      (err) => {
+        if (err) {
+          return reject(err);
+        }
+
+        resolve();
+      });
+    });
+  }
+
+  append(src: string, data: Buffer, options: {
+    sync: true,
+    encoding: null,
+    umask?: number,
+    flag?: Flag
+  }): void;
+
+  append(src: string, data: string, options: {
+    sync: true,
+    encoding?: BufferEncoding,
+    umask?: number,
+    flag?: Flag
+  }): void;
+
+  append(src: string, data: Buffer, options: {
+    sync?: false,
+    encoding: null,
+    umask?: number,
+    flag?: Flag
+  }): Promise<void>;
+
+  append(src: string, data: string, options?: {
+    sync?: false,
+    encoding?: BufferEncoding,
+    umask?: number,
+    flag?: Flag
+  }): Promise<void>;
+
+  append(src: string, data: Buffer | string, { sync = false, encoding = 'utf8', umask = 0o000, flag = 'a' }: {
+    sync?: boolean,
+    encoding?: BufferEncoding | null,
+    umask?: number,
+    flag?: Flag
+  } = {}) {
+    src = this.resolve(src);
+    const mode = 0o666 - umask;
+
+    if (sync) {
+      return fs.appendFileSync(src, data, {
+        encoding,
+        mode,
+        flag
+      });
+    }
+
+    return new Promise<void>((resolve, reject) => {
+      fs.appendFile(src, data, {
+        encoding,
+        mode,
+        flag
+      },
+      (err) => {
+        if (err) {
+          return reject(err);
+        }
+
+        resolve();
+      });
+    });
+  }
+
+  readdir(dir: string, options: {
+    sync: true,
+    encoding?: BufferEncoding | null
+  }): string[];
+
+  readdir(dir: string, options?: {
+    sync?: false,
+    encoding?: BufferEncoding | null
+  }): Promise<string[]>;
+
+  readdir(dir: string, { sync = false, encoding = 'utf8' }: {
+    sync?: boolean,
+    encoding?: BufferEncoding | null
+  } = {}) {
+    dir = this.resolve(dir);
+
+    if (sync) {
+      return fs.readdirSync(dir, {
+        encoding
+      });
+    }
+
+    return new Promise((resolve, reject) => {
+      fs.readdir(dir, { encoding }, (err, list) => {
+        if (err) {
+          return reject(err);
+        }
+
+        resolve(list);
+      });
+    });
+  }
+
+  mkdir(dir: string, options: {
+    sync: true,
+    umask?: number
+  }): void;
+
+  mkdir(dir: string, options?: {
+    sync?: false,
+    umask?: number
+  }): Promise<void>;
+
+  mkdir(dir: string, { umask = 0o000, sync = false }: {
+    umask?: number,
+    sync?: boolean
+  } = {}) {
+    dir = this.resolve(dir);
+
+    if (sync) {
+      return recurseSync.mkdir(dir, umask);
+    }
+
+    return new Promise<void>((resolve, reject) => {
+      recurse.mkdir(dir, umask, (err) => {
+        if (err) {
+          return reject(err);
+        }
+
+        resolve();
+      });
+    });
+  }
+}

package/src/recurse-io-sync.ts

@@ -1,102 +1,108 @@
-import fs from 'fs';
-import path from 'path';
+import fs from 'node:fs';
+import path from 'node:path';
 
-const {sep} = path;
+const { sep } = path;
 
-export default {
-  chmod(src: string, mode: number): void {
-    const stat = fs.statSync(src);
+function chmod(src: string, mode: number) {
+  const stat = fs.statSync(src);
 
-    if (stat.isDirectory()) {
-      const list = fs.readdirSync(src);
+  if (stat.isDirectory()) {
+    const list = fs.readdirSync(src);
 
-      for (const loc of list) {
-        this.chmod(`${src}${sep}${loc}`, mode);
-      }
+    for (const loc of list) {
+      chmod(`${src}${sep}${loc}`, mode);
     }
+  }
 
-    fs.chmodSync(src, mode);
-  },
+  fs.chmodSync(src, mode);
+}
 
-  chown(src: string, uid: number, gid: number): void {
-    const stat = fs.statSync(src);
+function chown(src: string, uid: number, gid: number) {
+  const stat = fs.statSync(src);
 
-    if (stat.isDirectory()) {
-      const list = fs.readdirSync(src);
+  if (stat.isDirectory()) {
+    const list = fs.readdirSync(src);
 
-      for (const loc of list) {
-        this.chown(`${src}${sep}${loc}`, uid, gid);
-      }
+    for (const loc of list) {
+      chown(`${src}${sep}${loc}`, uid, gid);
     }
+  }
 
-    fs.chownSync(src, uid, gid);
-  },
-
-  copy(src: string, dir: string, umask: number): void {
-    const stat = fs.statSync(src);
+  fs.chownSync(src, uid, gid);
+}
 
-    if (stat.isDirectory()) {
-      const list = fs.readdirSync(src);
+function copy(src: string, dir: string, umask: number) {
+  const stat = fs.statSync(src);
 
-      const paths = src.split(sep);
-      const loc = paths[paths.length - 1];
-      const mode = 0o777 - umask;
+  if (stat.isDirectory()) {
+    const list = fs.readdirSync(src);
 
-      dir = `${dir}${sep}${loc}`;
-      fs.mkdirSync(dir, mode);
+    const paths = src.split(sep);
+    const loc = paths[paths.length - 1];
+    const mode = 0o777 - umask;
 
-      for (const loc of list) {
-        this.copy(`${src}${sep}${loc}`, dir, umask);
-      }
-    }
-    else {
-      const loc = path.basename(src);
-      const use = `${dir}${sep}${loc}`;
+    dir = `${dir}${sep}${loc}`;
+    fs.mkdirSync(dir, mode);
 
-      fs.copyFileSync(src, use);
+    for (const loc of list) {
+      copy(`${src}${sep}${loc}`, dir, umask);
     }
-  },
+  }
+  else {
+    const loc = path.basename(src);
+    const use = `${dir}${sep}${loc}`;
 
-  remove(src: string): void {
-    const stat = fs.statSync(src);
+    fs.copyFileSync(src, use);
+  }
+}
 
-    if (stat.isDirectory()) {
-      const list = fs.readdirSync(src);
+function remove(src: string) {
+  const stat = fs.statSync(src);
 
-      for (const loc of list) {
-        this.remove(`${src}${sep}${loc}`);
-      }
+  if (stat.isDirectory()) {
+    const list = fs.readdirSync(src);
 
-      fs.rmdirSync(src);
-    }
-    else {
-      fs.unlinkSync(src);
+    for (const loc of list) {
+      remove(`${src}${sep}${loc}`);
     }
-  },
 
-  mkdir(dir: string, umask: number): void {
-    const mode = 0o777 - umask;
-    const cwd = process.cwd();
-    let use = '';
+    fs.rmdirSync(src);
+  }
+  else {
+    fs.unlinkSync(src);
+  }
+}
 
-    if (dir.indexOf(cwd) === 0) {
-      use = cwd;
-      dir = dir.substr(cwd.length);
-    }
+function mkdir(dir: string, umask: number) {
+  const mode = 0o777 - umask;
+  const cwd = process.cwd();
+  let use = '';
 
-    const ways = dir.split(sep).slice(1);
+  if (dir.indexOf(cwd) === 0) {
+    use = cwd;
+    dir = dir.substr(cwd.length);
+  }
 
-    for (const loc of ways) {
-      use += `${sep}${loc}`;
+  const ways = dir.split(sep).slice(1);
 
-      try {
-        fs.mkdirSync(use, { mode });
-      }
-      catch (err) {
-        if (err.errno !== -17) {
-          throw err;
-        }
+  for (const loc of ways) {
+    use += `${sep}${loc}`;
+
+    try {
+      fs.mkdirSync(use, { mode });
+    }
+    catch (err) {
+      if (err.errno !== -17) {
+        throw err;
       }
     }
   }
 }
+
+export default {
+  chmod,
+  chown,
+  copy,
+  remove,
+  mkdir
+}