@zthun/crumbtrail-fs 1.1.0 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zthun/crumbtrail-fs",
3
- "version": "1.1.0",
3
+ "version": "2.0.1",
4
4
  "description": "A better file system module for node",
5
5
  "author": "Anthony Bonta",
6
6
  "license": "MIT",
@@ -10,11 +10,11 @@
10
10
  "directory": "packages/crumbtrail-fs"
11
11
  },
12
12
  "type": "module",
13
- "types": "./dist/index.d.ts",
13
+ "types": "./dist/index.d.mts",
14
14
  "main": "./dist/index.cjs",
15
15
  "module": "./dist/index.js",
16
16
  "exports": {
17
- "types": "./dist/index.d.ts",
17
+ "types": "./dist/index.d.mts",
18
18
  "require": "./dist/index.cjs",
19
19
  "import": "./dist/index.js"
20
20
  },
@@ -28,16 +28,17 @@
28
28
  "access": "public"
29
29
  },
30
30
  "dependencies": {
31
- "glob": "^11.0.2",
31
+ "glob": "^11.0.3",
32
32
  "lodash-es": "^4.17.21"
33
33
  },
34
34
  "devDependencies": {
35
+ "@zthun/janitor-build-config": "^19.2.2",
35
36
  "vite": "^6.3.5",
36
- "vitest": "^3.1.4"
37
+ "vitest": "^3.2.4"
37
38
  },
38
39
  "files": [
39
40
  "dist"
40
41
  ],
41
42
  "sideEffects": false,
42
- "gitHead": "3e311966e8d62306da2cf5427f4db2cf1a027bf5"
43
+ "gitHead": "63b700b98bb7adee2f16917ec2d4f9d99f261a0c"
43
44
  }
@@ -1,61 +0,0 @@
1
- /**
2
- * Options for where a directory walk starts.
3
- */
4
- export interface ZWalkOptions {
5
- /**
6
- * The starting directory.
7
- *
8
- * The default is the current working directory
9
- *
10
- * @see process.cwd for more information.
11
- */
12
- start?: string;
13
- /**
14
- * The directory to stop at.
15
- *
16
- * The default is the root of the file system.
17
- */
18
- stop?: string;
19
- /**
20
- * The type of mode that the path must support in order
21
- * to be approved.
22
- *
23
- * The default is undefined and left up to the node api.
24
- */
25
- mode?: number;
26
- }
27
- /**
28
- * Walks up a directory tree to search for existence of a given path.
29
- *
30
- * @param search -
31
- * The path to search for. This is the candidate folder path that
32
- * may or may not exist somewhere from the start directory all the
33
- * way up the directory tree.
34
- * @param options -
35
- * The given options for the search.
36
- *
37
- * @returns
38
- * The fully qualified path to the first path that matches the search
39
- * starting at the options start or the current working directory if not
40
- * specified. Returns null if no such directory exists.
41
- *
42
- * @example
43
- *
44
- * ```ts
45
- * import { resolve } from 'path'
46
- *
47
- * // Find any folder named .vscode from the current working directory all the way
48
- * // up the directory tree. Returns null if no vscode directory can be found.
49
- * const vscode = walk('.vscode');
50
- *
51
- * // Walk the directory tree from the current script and find the .config folder.
52
- * const config = walk('.config', { start: __dirname });
53
- *
54
- * // Walk the directory tree from the current script and stop when we reach
55
- * // at most 2 directories up.
56
- * const start = __dirname;
57
- * const stop = resolve(__dirname, '../..');
58
- * const file = walk('path/to/file.json', { start, stop });
59
- * ```
60
- */
61
- export declare function walk(search: string, options?: ZWalkOptions): Promise<string | null>;