Merge pull request #769 from MatrixAI/feature-eng-363-implement-utility-that-generates-a-file-tree-from-a-path

Implementing file system pattern walker

Author: tegefaulkes

package-lock.json

@@ -104,7 +104,8 @@
     "prompts": "^2.4.1",
     "resource-counter": "^1.2.4",
     "sodium-native": "^3.4.1",
-    "threads": "^1.6.5"
+    "threads": "^1.6.5",
+    "minimatch": "^10.0.1"
   },
   "devDependencies": {
     "@fast-check/jest": "^1.1.0",
@@ -116,6 +117,7 @@
     "@types/pako": "^1.0.2",
     "@types/prompts": "^2.0.13",
     "@types/readable-stream": "^2.3.11",
+    "@types/minimatch": "^5.1.2",
     "@typescript-eslint/eslint-plugin": "^5.61.0",
     "@typescript-eslint/parser": "^5.61.0",
     "benny": "^3.7.1",

package.json

@@ -134,6 +134,49 @@ type VaultName = string;
 
 type VaultActions = Partial<Record<VaultAction, null>>;
 
+type FileTree = Array<TreeNode>;
+type TreeNode = DirectoryNode | FileNode;
+type FilePath = string;
+type INode = number;
+type CNode = number;
+
+type StatEncoded = {
+  isSymbolicLink: boolean;
+  type: 'FILE' | 'DIRECTORY' | 'OTHER';
+  dev: number;
+  ino: number;
+  mode: number;
+  nlink: number;
+  uid: number;
+  gid: number;
+  rdev: number;
+  size: number;
+  blksize: number;
+  blocks: number;
+  atime: number;
+  mtime: number;
+  ctime: number;
+  birthtime: number;
+};
+
+type DirectoryNode = {
+  type: 'directory';
+  path: FilePath;
+  iNode: INode;
+  parent: INode;
+  children: Array<INode>;
+  stat?: StatEncoded;
+};
+
+type FileNode = {
+  type: 'file';
+  path: FilePath;
+  iNode: INode;
+  parent: INode;
+  cNode: CNode;
+  stat?: StatEncoded;
+};
+
 export { vaultActions };
 
 export type {
@@ -148,6 +191,14 @@ export type {
   FileSystemWritable,
   VaultName,
   VaultActions,
+  FileTree,
+  TreeNode,
+  FilePath,
+  INode,
+  CNode,
+  StatEncoded,
+  DirectoryNode,
+  FileNode,
 };
 
 export { tagLast, refs };