@augment-vir/node 30.6.2 → 30.7.0

package/dist/augments/fs/dir-contents.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Nested contents read from a file system directory.
+ *
+ * @category Node : File
+ * @category Package : @augment-vir/node
+ * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
+ */
+export type DirContents = {
+    [Path in string]: string | DirContents;
+};
+/**
+ * Read all contents within a directory and store them in an object. Optionally recursive.
+ *
+ * @category Node : File
+ * @category Package : @augment-vir/node
+ * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
+ */
+export declare function readAllDirContents(dir: string, { recursive, excludeList, }: {
+    recursive?: boolean;
+    excludeList?: ReadonlyArray<string | RegExp> | undefined;
+}): Promise<DirContents>;
+/**
+ * Deletes and entire directory and resets it to the given contents.
+ *
+ * @category Node : File
+ * @category Package : @augment-vir/node
+ * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
+ */
+export declare function resetDirContents(rootDir: string, contents: Readonly<DirContents>): Promise<void>;
+/**
+ * Write {@link DirContents} to a directory.
+ *
+ * @category Node : File
+ * @category Package : @augment-vir/node
+ * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
+ */
+export declare function writeDirContents(rootDir: string, contents: Readonly<DirContents>): Promise<void>;

package/dist/augments/fs/dir-contents.js

@@ -0,0 +1,77 @@
+import { check } from '@augment-vir/assert';
+import { getObjectTypedEntries } from '@augment-vir/common';
+import { readdir, readFile, rm, stat } from 'node:fs/promises';
+import { join } from 'node:path';
+import { writeFileAndDir } from './write.js';
+/**
+ * Read all contents within a directory and store them in an object. Optionally recursive.
+ *
+ * @category Node : File
+ * @category Package : @augment-vir/node
+ * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
+ */
+export async function readAllDirContents(dir, { recursive = false, excludeList, }) {
+    const fileNames = (await readdir(dir)).sort();
+    const allFileContents = await Promise.all(fileNames.map(async (fileName) => {
+        const filePath = join(dir, fileName);
+        if (excludeList?.some((excludeItem) => {
+            if (check.isString(excludeItem)) {
+                return filePath.includes(excludeItem);
+            }
+            else {
+                return filePath.match(excludeItem);
+            }
+        })) {
+            return undefined;
+        }
+        const isFile = (await stat(filePath)).isFile();
+        const contents = isFile
+            ? (await readFile(filePath)).toString()
+            : recursive
+                ? await readAllDirContents(filePath, { recursive, excludeList })
+                : undefined;
+        if (check.isObject(contents) && !Object.keys(contents).length) {
+            return undefined;
+        }
+        return contents;
+    }));
+    return fileNames.reduce((accum, fileName, index) => {
+        if (allFileContents[index] != undefined) {
+            const fileContents = allFileContents[index];
+            accum[fileName] = fileContents;
+        }
+        return accum;
+    }, {});
+}
+/**
+ * Deletes and entire directory and resets it to the given contents.
+ *
+ * @category Node : File
+ * @category Package : @augment-vir/node
+ * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
+ */
+export async function resetDirContents(rootDir, contents) {
+    await rm(rootDir, {
+        force: true,
+        recursive: true,
+    });
+    await writeDirContents(rootDir, contents);
+}
+/**
+ * Write {@link DirContents} to a directory.
+ *
+ * @category Node : File
+ * @category Package : @augment-vir/node
+ * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
+ */
+export async function writeDirContents(rootDir, contents) {
+    await Promise.all(getObjectTypedEntries(contents).map(async ([relativePath, content,]) => {
+        const fullPath = join(rootDir, relativePath);
+        if (check.isString(content)) {
+            await writeFileAndDir(fullPath, content);
+        }
+        else {
+            await writeDirContents(fullPath, content);
+        }
+    }));
+}

package/dist/file-paths.mock.d.ts

@@ -2,6 +2,7 @@ export declare const monoRepoDirPath: string;
 export declare const notCommittedDirPath: string;
 export declare const nodePackageDir: string;
 export declare const testFilesDir: string;
+export declare const dirContentsTestDir: string;
 export declare const longRunningFilePath: string;
 export declare const longRunningFileWithStderr: string;
 export declare const workspaceQueryDir: string;

package/dist/file-paths.mock.js

@@ -4,6 +4,7 @@ export const notCommittedDirPath = join(monoRepoDirPath, '.not-committed');
 export const nodePackageDir = dirname(import.meta.dirname);
 export const testFilesDir = join(nodePackageDir, 'test-files');
 const longRunningFileDir = join(testFilesDir, 'long-running-test-file');
+export const dirContentsTestDir = join(testFilesDir, 'dir-contents-test');
 export const longRunningFilePath = join(longRunningFileDir, 'long-running-file.ts');
 export const longRunningFileWithStderr = join(longRunningFileDir, 'long-running-file-with-stderr.ts');
 export const workspaceQueryDir = join(testFilesDir, 'workspace-query');

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './augments/docker.js';
+export * from './augments/fs/dir-contents.js';
 export * from './augments/fs/download.js';
 export * from './augments/fs/json.js';
 export * from './augments/fs/read-dir.js';

package/dist/index.js

@@ -1,4 +1,5 @@
 export * from './augments/docker.js';
+export * from './augments/fs/dir-contents.js';
 export * from './augments/fs/download.js';
 export * from './augments/fs/json.js';
 export * from './augments/fs/read-dir.js';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/node",
-    "version": "30.6.2",
+    "version": "30.7.0",
     "description": "A collection of augments, helpers types, functions, and classes only for Node.js (backend) JavaScript environments.",
     "keywords": [
         "augment",
@@ -37,16 +37,16 @@
         "test:update": "npm test"
     },
     "dependencies": {
-        "@augment-vir/assert": "^30.6.2",
-        "@augment-vir/common": "^30.6.2",
-        "@date-vir/duration": "^6.0.1",
+        "@augment-vir/assert": "^30.7.0",
+        "@augment-vir/common": "^30.7.0",
+        "@date-vir/duration": "^7.0.1",
         "ansi-styles": "^6.2.1",
         "terminate": "^2.8.0",
         "type-fest": "^4.26.1",
         "typed-event-target": "^4.0.2"
     },
     "devDependencies": {
-        "@augment-vir/test": "^30.6.2",
+        "@augment-vir/test": "^30.7.0",
         "@prisma/client": "^5.22.0",
         "@types/node": "^22.9.0",
         "@web/dev-server-esbuild": "^1.0.3",