@jsenv/filesystem 4.6.9 → 4.7.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/filesystem",
-  "version": "4.6.9",
+  "version": "4.7.1",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -33,7 +33,7 @@
   },
   "dependencies": {
     "@jsenv/urls": "2.2.7",
-    "@jsenv/url-meta": "8.4.0",
+    "@jsenv/url-meta": "8.4.1",
     "@jsenv/abort": "4.3.0",
     "@jsenv/utils": "2.1.1"
   }

package/src/list/visit_structure_sync.js

@@ -0,0 +1,99 @@
+import { URL_META } from "@jsenv/url-meta";
+import { urlToRelativeUrl } from "@jsenv/urls";
+
+import { assertAndNormalizeDirectoryUrl } from "../path_and_url/directory_url_validation.js";
+import { comparePathnames } from "../path_and_url/compare_pathnames.js";
+import { readEntryStatSync } from "../read_write/stat/read_entry_stat_sync.js";
+import { readDirectorySync } from "../read_write/read_directory_sync.js";
+
+export const visitStructureSync = ({
+  directoryUrl,
+  associations,
+  predicate,
+  callback = () => {},
+}) => {
+  const rootDirectoryUrl = assertAndNormalizeDirectoryUrl(directoryUrl);
+  if (typeof predicate !== "function") {
+    throw new TypeError(`predicate must be a function, got ${predicate}`);
+  }
+  associations = URL_META.resolveAssociations(associations, rootDirectoryUrl);
+  const matchingFileResultArray = [];
+  const visitDirectory = (directoryUrl) => {
+    const directoryItems = readDirectorySync(directoryUrl);
+    for (const directoryItem of directoryItems) {
+      const directoryChildNodeUrl = `${directoryUrl}${directoryItem}`;
+      let directoryChildNodeStats;
+      try {
+        directoryChildNodeStats = readEntryStatSync(directoryChildNodeUrl, {
+          // we ignore symlink because recursively traversed
+          // so symlinked file will be discovered.
+          // Moreover if they lead outside of directoryPath it can become a problem
+          // like infinite recursion of whatever.
+          // that we could handle using an object of pathname already seen but it will be useless
+          // because directoryPath is recursively traversed
+          followLink: false,
+        });
+      } catch (e) {
+        if (e && e.code === "ENOENT") {
+          continue;
+        }
+        throw e;
+      }
+      if (directoryChildNodeStats.isDirectory()) {
+        const subDirectoryUrl = `${directoryChildNodeUrl}/`;
+        if (
+          !URL_META.urlChildMayMatch({
+            url: subDirectoryUrl,
+            associations,
+            predicate,
+          })
+        ) {
+          continue;
+        }
+        callback({
+          url: subDirectoryUrl,
+          relativeUrl: urlToRelativeUrl(subDirectoryUrl, rootDirectoryUrl),
+          stats: directoryChildNodeStats,
+          isDirectory: true,
+        });
+        visitDirectory(subDirectoryUrl);
+        continue;
+      }
+      if (directoryChildNodeStats.isFile()) {
+        const meta = URL_META.applyAssociations({
+          url: directoryChildNodeUrl,
+          associations,
+        });
+        if (!predicate(meta)) {
+          continue;
+        }
+        const relativeUrl = urlToRelativeUrl(
+          directoryChildNodeUrl,
+          rootDirectoryUrl,
+        );
+        matchingFileResultArray.push({
+          url: new URL(relativeUrl, rootDirectoryUrl).href,
+          relativeUrl: decodeURIComponent(relativeUrl),
+          meta,
+          fileStats: directoryChildNodeStats,
+        });
+        callback({
+          url: directoryChildNodeUrl,
+          relativeUrl,
+          stats: directoryChildNodeStats,
+          isDirectory: false,
+        });
+        continue;
+      }
+    }
+  };
+  visitDirectory(rootDirectoryUrl);
+  // When we operate on thoose files later it feels more natural
+  // to perform operation in the same order they appear in the filesystem.
+  // It also allow to get a predictable return value.
+  // For that reason we sort matchingFileResultArray
+  matchingFileResultArray.sort((leftFile, rightFile) => {
+    return comparePathnames(leftFile.relativeUrl, rightFile.relativeUrl);
+  });
+  return matchingFileResultArray;
+};

package/src/main.js

@@ -20,6 +20,7 @@ export { ensureWindowsDriveLetter } from "./path_and_url/ensure_windows_drive_le
 export { collectDirectoryMatchReport } from "./list/collect_directory_match_report.js";
 export { collectFiles } from "./list/collect_files.js";
 export { listFilesMatching } from "./list/list_files_matching.js";
+export { visitStructureSync } from "./list/visit_structure_sync.js";
 
 // read and write
 export { ensureParentDirectories } from "./read_write/ensure_parent_directories.js";

package/src/read_write/write_file_structure_sync.js

@@ -1,9 +1,13 @@
 import { ensureEmptyDirectorySync } from "../remove/ensure_empty_directory_sync.js";
+import { readFileStructureSync } from "./read_file_structure_sync.js";
 import { writeFileSync } from "./write_file_sync.js";
 
 export const writeFileStructureSync = (directoryUrl, fileStructure) => {
   ensureEmptyDirectorySync(directoryUrl);
   if (fileStructure) {
+    if (typeof fileStructure === "string" || fileStructure instanceof URL) {
+      fileStructure = readFileStructureSync(fileStructure);
+    }
     Object.keys(fileStructure).forEach((relativeUrl) => {
       const fileUrl = new URL(relativeUrl, directoryUrl);
       const fileContent = fileStructure[relativeUrl];

package/src/remove/clear_directory_sync.js

@@ -6,14 +6,22 @@ import { removeEntrySync } from "./remove_entry_sync.js";
 export const clearDirectorySync = (initialDirectoryUrl, pattern = "**/*") => {
   const associations = URL_META.resolveAssociations(
     {
-      clear: {
-        [pattern]: true,
-        "**/.*": false,
-        "**/.*/": false,
-        ...(pattern.includes("node_modules")
-          ? {}
-          : { "**/node_modules/": false }),
-      },
+      clear:
+        typeof pattern === "string"
+          ? {
+              [pattern]: true,
+              "**/.*": false,
+              "**/.*/": false,
+              ...(pattern.includes("node_modules")
+                ? {}
+                : { "**/node_modules/": false }),
+            }
+          : {
+              "**/.*": false,
+              "**/.*/": false,
+              "**/node_modules/": false,
+              ...pattern,
+            },
     },
     initialDirectoryUrl,
   );