@naturalcycles/nodejs-lib 13.4.0 → 13.6.0

package/dist/fs/fs.util.d.ts

@@ -1,182 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
-import fs from 'node:fs';
-/**
- * fs2 conveniently groups filesystem functions together.
- * Supposed to be almost a drop-in replacement for these things together:
- *
- * 1. node:fs
- * 2. node:fs/promises
- * 3. fs-extra
- */
-export declare const fs2: {
-    readFile: typeof _readFile;
-    readFileSync: typeof _readFileSync;
-    readFileAsBuffer: typeof _readFileAsBuffer;
-    readFileAsBufferSync: typeof _readFileAsBufferSync;
-    readJson: typeof _readJson;
-    readJsonSync: typeof _readJsonSync;
-    writeFile: typeof _writeFile;
-    writeFileSync: typeof _writeFileSync;
-    outputJson: typeof _outputJson;
-    outputJsonSync: typeof _outputJsonSync;
-    writeJson: typeof _writeJson;
-    writeJsonSync: typeof _writeJsonSync;
-    outputFile: typeof _outputFile;
-    outputFileSync: typeof _outputFileSync;
-    pathExists: typeof _pathExists;
-    pathExistsSync: typeof _pathExistsSync;
-    ensureDir: typeof _ensureDir;
-    ensureDirSync: typeof _ensureDirSync;
-    ensureFile: typeof _ensureFile;
-    ensureFileSync: typeof _ensureFileSync;
-    removePath: typeof _removePath;
-    removePathSync: typeof _removePathSync;
-    emptyDir: typeof _emptyDir;
-    emptyDirSync: typeof _emptyDirSync;
-    copyPath: typeof _copyPath;
-    copyPathSync: typeof _copyPathSync;
-    movePath: typeof _movePath;
-    movePathSync: typeof _movePathSync;
-    link: typeof fs.link;
-    open: typeof fs.open;
-    truncate: typeof fs.truncate;
-    write: typeof fs.write;
-    close: typeof fs.close;
-    read: typeof fs.read;
-    rename: typeof fs.rename;
-    writev: typeof fs.writev;
-    renameSync: typeof fs.renameSync;
-    truncateSync: typeof fs.truncateSync;
-    ftruncate: typeof fs.ftruncate;
-    ftruncateSync: typeof fs.ftruncateSync;
-    chown: typeof fs.chown;
-    chownSync: typeof fs.chownSync;
-    fchown: typeof fs.fchown;
-    fchownSync: typeof fs.fchownSync;
-    lchown: typeof fs.lchown;
-    lchownSync: typeof fs.lchownSync;
-    lutimes: typeof fs.lutimes;
-    lutimesSync: typeof fs.lutimesSync;
-    chmod: typeof fs.chmod;
-    chmodSync: typeof fs.chmodSync;
-    fchmod: typeof fs.fchmod;
-    fchmodSync: typeof fs.fchmodSync;
-    lchmod: typeof fs.lchmod;
-    lchmodSync: typeof fs.lchmodSync;
-    stat: typeof fs.stat;
-    fstat: typeof fs.fstat;
-    fstatSync: typeof fs.fstatSync;
-    lstat: typeof fs.lstat;
-    statfs: typeof fs.statfs;
-    statfsSync: typeof fs.statfsSync;
-    linkSync: typeof fs.linkSync;
-    symlink: typeof fs.symlink;
-    symlinkSync: typeof fs.symlinkSync;
-    readlink: typeof fs.readlink;
-    readlinkSync: typeof fs.readlinkSync;
-    realpath: typeof fs.realpath;
-    realpathSync: typeof fs.realpathSync;
-    unlink: typeof fs.unlink;
-    unlinkSync: typeof fs.unlinkSync;
-    rmdir: typeof fs.rmdir;
-    rmdirSync: typeof fs.rmdirSync;
-    rm: typeof fs.rm;
-    rmSync: typeof fs.rmSync;
-    mkdir: typeof fs.mkdir;
-    mkdirSync: typeof fs.mkdirSync;
-    mkdtemp: typeof fs.mkdtemp;
-    mkdtempSync: typeof fs.mkdtempSync;
-    readdir: typeof fs.readdir;
-    readdirSync: typeof fs.readdirSync;
-    closeSync: typeof fs.closeSync;
-    openSync: typeof fs.openSync;
-    utimes: typeof fs.utimes;
-    utimesSync: typeof fs.utimesSync;
-    futimes: typeof fs.futimes;
-    futimesSync: typeof fs.futimesSync;
-    fsync: typeof fs.fsync;
-    fsyncSync: typeof fs.fsyncSync;
-    writeSync: typeof fs.writeSync;
-    readSync: typeof fs.readSync;
-    appendFile: typeof fs.appendFile;
-    appendFileSync: typeof fs.appendFileSync;
-    watchFile: typeof fs.watchFile;
-    unwatchFile: typeof fs.unwatchFile;
-    watch: typeof fs.watch;
-    exists: typeof fs.exists;
-    existsSync: typeof fs.existsSync;
-    access: typeof fs.access;
-    accessSync: typeof fs.accessSync;
-    createReadStream: typeof fs.createReadStream;
-    createWriteStream: typeof fs.createWriteStream;
-    fdatasync: typeof fs.fdatasync;
-    fdatasyncSync: typeof fs.fdatasyncSync;
-    copyFile: typeof fs.copyFile;
-    copyFileSync: typeof fs.copyFileSync;
-    writevSync: typeof fs.writevSync;
-    readv: typeof fs.readv;
-    readvSync: typeof fs.readvSync;
-    openAsBlob: typeof fs.openAsBlob;
-    opendirSync: typeof fs.opendirSync;
-    opendir: typeof fs.opendir;
-    cp: typeof fs.cp;
-    cpSync: typeof fs.cpSync;
-    promises: typeof fs.promises;
-    Stats: typeof fs.Stats;
-    StatsFs: typeof fs.StatsFs;
-    Dirent: typeof fs.Dirent;
-    Dir: typeof fs.Dir;
-    ReadStream: typeof fs.ReadStream;
-    WriteStream: typeof fs.WriteStream;
-    statSync: fs.StatSyncFn;
-    lstatSync: fs.StatSyncFn;
-    constants: typeof fs.constants;
-};
-export interface JsonOptions {
-    spaces?: number;
-}
-/**
- * Convenience wrapper that defaults to utf-8 string output.
- */
-export declare function _readFile(filePath: string): Promise<string>;
-export declare function _readFileAsBuffer(filePath: string): Promise<Buffer>;
-/**
- * Convenience wrapper that defaults to utf-8 string output.
- */
-export declare function _readFileSync(filePath: string): string;
-/**
- * Convenience wrapper that defaults to utf-8 string output.
- */
-export declare function _readFileAsBufferSync(filePath: string): Buffer;
-export declare function _readJson<T = unknown>(filePath: string): Promise<T>;
-export declare function _readJsonSync<T = unknown>(filePath: string): T;
-export declare function _writeFile(filePath: string, data: string | Buffer): Promise<void>;
-export declare function _writeFileSync(filePath: string, data: string | Buffer): void;
-export declare function _outputFile(filePath: string, data: string | Buffer): Promise<void>;
-export declare function _outputFileSync(filePath: string, data: string | Buffer): void;
-export declare function _writeJson(filePath: string, data: any, opt?: JsonOptions): Promise<void>;
-export declare function _writeJsonSync(filePath: string, data: any, opt?: JsonOptions): void;
-export declare function _outputJson(filePath: string, data: any, opt?: JsonOptions): Promise<void>;
-export declare function _outputJsonSync(filePath: string, data: any, opt?: JsonOptions): void;
-export declare function _pathExists(filePath: string): Promise<boolean>;
-export declare function _pathExistsSync(filePath: string): boolean;
-export declare function _ensureDir(dirPath: string): Promise<void>;
-export declare function _ensureDirSync(dirPath: string): void;
-export declare function _ensureFile(filePath: string): Promise<void>;
-export declare function _ensureFileSync(filePath: string): void;
-export declare function _removePath(fileOrDirPath: string): Promise<void>;
-export declare function _removePathSync(fileOrDirPath: string): void;
-export declare function _emptyDir(dirPath: string): Promise<void>;
-export declare function _emptyDirSync(dirPath: string): void;
-/**
- * Cautious, underlying Node function is currently Experimental.
- */
-export declare function _copyPath(src: string, dest: string, opt?: fs.CopyOptions): Promise<void>;
-/**
- * Cautious, underlying Node function is currently Experimental.
- */
-export declare function _copyPathSync(src: string, dest: string, opt?: fs.CopySyncOptions): void;
-export declare function _movePath(src: string, dest: string, opt?: fs.CopyOptions): Promise<void>;
-export declare function _movePathSync(src: string, dest: string, opt?: fs.CopySyncOptions): void;

package/dist/fs/fs.util.js

@@ -1,285 +0,0 @@
-"use strict";
-/*
-
-Why?
-
-Convenience re-export/re-implementation of most common fs functions from
-node:fs, node:fs/promises and fs-extra
-
-Defaults to string input/output, as it's used in 80% of time. For the rest - you can use native fs.
-
-Allows to import it easier, so you don't have to choose between the 3 import locations.
-That's why function names are slightly renamed, to avoid conflict.
-
-Credit to: fs-extra (https://github.com/jprichardson/node-fs-extra)
-
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports._movePathSync = exports._movePath = exports._copyPathSync = exports._copyPath = exports._emptyDirSync = exports._emptyDir = exports._removePathSync = exports._removePath = exports._ensureFileSync = exports._ensureFile = exports._ensureDirSync = exports._ensureDir = exports._pathExistsSync = exports._pathExists = exports._outputJsonSync = exports._outputJson = exports._writeJsonSync = exports._writeJson = exports._outputFileSync = exports._outputFile = exports._writeFileSync = exports._writeFile = exports._readJsonSync = exports._readJson = exports._readFileAsBufferSync = exports._readFileSync = exports._readFileAsBuffer = exports._readFile = exports.fs2 = void 0;
-const tslib_1 = require("tslib");
-const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
-const promises_1 = tslib_1.__importDefault(require("node:fs/promises"));
-const node_path_1 = tslib_1.__importDefault(require("node:path"));
-const js_lib_1 = require("@naturalcycles/js-lib");
-/**
- * fs2 conveniently groups filesystem functions together.
- * Supposed to be almost a drop-in replacement for these things together:
- *
- * 1. node:fs
- * 2. node:fs/promises
- * 3. fs-extra
- */
-exports.fs2 = {
-    // "Omit" is here to workaround this TS error:
-    // Exported variable 'fs2' has or is using name 'StreamOptions' from external module "fs" but cannot be named.
-    ...node_fs_1.default,
-    readFile: _readFile,
-    readFileSync: _readFileSync,
-    readFileAsBuffer: _readFileAsBuffer,
-    readFileAsBufferSync: _readFileAsBufferSync,
-    readJson: _readJson,
-    readJsonSync: _readJsonSync,
-    writeFile: _writeFile,
-    writeFileSync: _writeFileSync,
-    outputJson: _outputJson,
-    outputJsonSync: _outputJsonSync,
-    writeJson: _writeJson,
-    writeJsonSync: _writeJsonSync,
-    outputFile: _outputFile,
-    outputFileSync: _outputFileSync,
-    pathExists: _pathExists,
-    pathExistsSync: _pathExistsSync,
-    ensureDir: _ensureDir,
-    ensureDirSync: _ensureDirSync,
-    ensureFile: _ensureFile,
-    ensureFileSync: _ensureFileSync,
-    removePath: _removePath,
-    removePathSync: _removePathSync,
-    emptyDir: _emptyDir,
-    emptyDirSync: _emptyDirSync,
-    copyPath: _copyPath,
-    copyPathSync: _copyPathSync,
-    movePath: _movePath,
-    movePathSync: _movePathSync,
-};
-/**
- * Convenience wrapper that defaults to utf-8 string output.
- */
-async function _readFile(filePath) {
-    return await promises_1.default.readFile(filePath, 'utf8');
-}
-exports._readFile = _readFile;
-async function _readFileAsBuffer(filePath) {
-    return await promises_1.default.readFile(filePath);
-}
-exports._readFileAsBuffer = _readFileAsBuffer;
-/**
- * Convenience wrapper that defaults to utf-8 string output.
- */
-function _readFileSync(filePath) {
-    return node_fs_1.default.readFileSync(filePath, 'utf8');
-}
-exports._readFileSync = _readFileSync;
-/**
- * Convenience wrapper that defaults to utf-8 string output.
- */
-function _readFileAsBufferSync(filePath) {
-    return node_fs_1.default.readFileSync(filePath);
-}
-exports._readFileAsBufferSync = _readFileAsBufferSync;
-async function _readJson(filePath) {
-    const str = await promises_1.default.readFile(filePath, 'utf8');
-    return (0, js_lib_1._jsonParse)(str);
-}
-exports._readJson = _readJson;
-function _readJsonSync(filePath) {
-    const str = node_fs_1.default.readFileSync(filePath, 'utf8');
-    return (0, js_lib_1._jsonParse)(str);
-}
-exports._readJsonSync = _readJsonSync;
-async function _writeFile(filePath, data) {
-    await promises_1.default.writeFile(filePath, data);
-}
-exports._writeFile = _writeFile;
-function _writeFileSync(filePath, data) {
-    node_fs_1.default.writeFileSync(filePath, data);
-}
-exports._writeFileSync = _writeFileSync;
-async function _outputFile(filePath, data) {
-    const dirPath = node_path_1.default.dirname(filePath);
-    if (!(await _pathExists(dirPath))) {
-        await _ensureDir(dirPath);
-    }
-    await promises_1.default.writeFile(filePath, data);
-}
-exports._outputFile = _outputFile;
-function _outputFileSync(filePath, data) {
-    const dirPath = node_path_1.default.dirname(filePath);
-    if (!node_fs_1.default.existsSync(dirPath)) {
-        _ensureDirSync(dirPath);
-    }
-    node_fs_1.default.writeFileSync(filePath, data);
-}
-exports._outputFileSync = _outputFileSync;
-function stringify(data, opt) {
-    // If pretty-printing is enabled (spaces) - also add a newline at the end (to match our prettier config)
-    return JSON.stringify(data, null, opt?.spaces) + (opt?.spaces ? '\n' : '');
-}
-async function _writeJson(filePath, data, opt) {
-    const str = stringify(data, opt);
-    await promises_1.default.writeFile(filePath, str);
-}
-exports._writeJson = _writeJson;
-function _writeJsonSync(filePath, data, opt) {
-    const str = stringify(data, opt);
-    node_fs_1.default.writeFileSync(filePath, str);
-}
-exports._writeJsonSync = _writeJsonSync;
-async function _outputJson(filePath, data, opt) {
-    const str = stringify(data, opt);
-    await _outputFile(filePath, str);
-}
-exports._outputJson = _outputJson;
-function _outputJsonSync(filePath, data, opt) {
-    const str = stringify(data, opt);
-    _outputFileSync(filePath, str);
-}
-exports._outputJsonSync = _outputJsonSync;
-async function _pathExists(filePath) {
-    try {
-        await promises_1.default.access(filePath);
-        return true;
-    }
-    catch {
-        return false;
-    }
-}
-exports._pathExists = _pathExists;
-function _pathExistsSync(filePath) {
-    return node_fs_1.default.existsSync(filePath);
-}
-exports._pathExistsSync = _pathExistsSync;
-async function _ensureDir(dirPath) {
-    await promises_1.default.mkdir(dirPath, {
-        mode: 0o777,
-        recursive: true,
-    });
-}
-exports._ensureDir = _ensureDir;
-function _ensureDirSync(dirPath) {
-    node_fs_1.default.mkdirSync(dirPath, {
-        mode: 0o777,
-        recursive: true,
-    });
-}
-exports._ensureDirSync = _ensureDirSync;
-async function _ensureFile(filePath) {
-    let stats;
-    try {
-        stats = await promises_1.default.stat(filePath);
-    }
-    catch { }
-    if (stats?.isFile())
-        return;
-    const dir = node_path_1.default.dirname(filePath);
-    try {
-        if (!(await promises_1.default.stat(dir)).isDirectory()) {
-            // parent is not a directory
-            // This is just to cause an internal ENOTDIR error to be thrown
-            await promises_1.default.readdir(dir);
-        }
-    }
-    catch (err) {
-        // If the stat call above failed because the directory doesn't exist, create it
-        if (err?.code === 'ENOENT')
-            return await _ensureDir(dir);
-        throw err;
-    }
-    await promises_1.default.writeFile(filePath, '');
-}
-exports._ensureFile = _ensureFile;
-function _ensureFileSync(filePath) {
-    let stats;
-    try {
-        stats = node_fs_1.default.statSync(filePath);
-    }
-    catch { }
-    if (stats?.isFile())
-        return;
-    const dir = node_path_1.default.dirname(filePath);
-    try {
-        if (!node_fs_1.default.statSync(dir).isDirectory()) {
-            // parent is not a directory
-            // This is just to cause an internal ENOTDIR error to be thrown
-            node_fs_1.default.readdirSync(dir);
-        }
-    }
-    catch (err) {
-        // If the stat call above failed because the directory doesn't exist, create it
-        if (err?.code === 'ENOENT')
-            return _ensureDirSync(dir);
-        throw err;
-    }
-    node_fs_1.default.writeFileSync(filePath, '');
-}
-exports._ensureFileSync = _ensureFileSync;
-async function _removePath(fileOrDirPath) {
-    await promises_1.default.rm(fileOrDirPath, { recursive: true, force: true });
-}
-exports._removePath = _removePath;
-function _removePathSync(fileOrDirPath) {
-    node_fs_1.default.rmSync(fileOrDirPath, { recursive: true, force: true });
-}
-exports._removePathSync = _removePathSync;
-async function _emptyDir(dirPath) {
-    let items;
-    try {
-        items = await promises_1.default.readdir(dirPath);
-    }
-    catch {
-        return await _ensureDir(dirPath);
-    }
-    await Promise.all(items.map(item => _removePath(node_path_1.default.join(dirPath, item))));
-}
-exports._emptyDir = _emptyDir;
-function _emptyDirSync(dirPath) {
-    let items;
-    try {
-        items = node_fs_1.default.readdirSync(dirPath);
-    }
-    catch {
-        return _ensureDirSync(dirPath);
-    }
-    items.forEach(item => _removePathSync(node_path_1.default.join(dirPath, item)));
-}
-exports._emptyDirSync = _emptyDirSync;
-/**
- * Cautious, underlying Node function is currently Experimental.
- */
-async function _copyPath(src, dest, opt) {
-    await promises_1.default.cp(src, dest, {
-        recursive: true,
-        ...opt,
-    });
-}
-exports._copyPath = _copyPath;
-/**
- * Cautious, underlying Node function is currently Experimental.
- */
-function _copyPathSync(src, dest, opt) {
-    node_fs_1.default.cpSync(src, dest, {
-        recursive: true,
-        ...opt,
-    });
-}
-exports._copyPathSync = _copyPathSync;
-async function _movePath(src, dest, opt) {
-    await _copyPath(src, dest, opt);
-    await _removePath(src);
-}
-exports._movePath = _movePath;
-function _movePathSync(src, dest, opt) {
-    _copyPathSync(src, dest, opt);
-    _removePathSync(src);
-}
-exports._movePathSync = _movePathSync;