@effected/config-file 0.20.1 → 0.21.0

package/ConfigResolver.js

@@ -111,8 +111,8 @@ var ConfigResolver = class {
 		};
 	})));
 	/**
-	* Ascends from `cwd` (or the process cwd) toward `stopAt`, resolving the
-	* first `subpaths/filename` combination found at each level.
+	* Ascends from `cwd` (or the process cwd) toward `stopAt` or `ceiling`,
+	* resolving the first `subpaths/filename` combination found at each level.
 	*
 	* @remarks
 	* `filenames` replaces `filename` with a per-directory candidate list: every
@@ -130,7 +130,7 @@ var ConfigResolver = class {
 		const path = yield* Path.Path;
 		const subpaths = options.subpaths ?? ["."];
 		const filenames = options.filenames ?? [options.filename];
-		const dirs = yield* Walker.ascend(cwdOf(options.cwd), { ...options.stopAt !== void 0 && { stopAt: options.stopAt } });
+		const dirs = options.ceiling !== void 0 ? yield* Walker.ascendWithin(cwdOf(options.cwd), Option.some(options.ceiling)) : yield* Walker.ascend(cwdOf(options.cwd), { ...options.stopAt !== void 0 && { stopAt: options.stopAt } });
 		const candidates = [];
 		for (const dir of dirs) for (const sub of subpaths) for (const filename of filenames) candidates.push({
 			path: path.join(dir, sub, filename),

package/index.d.ts

@@ -411,16 +411,53 @@ interface ConfigProbe {
  * (`".config/app.toml"`), which is how a mixed convention is spelled without a
  * `subpaths` cross product.
  *
+ * At most one of `stopAt` (a lexical ceiling) and `ceiling` (a physical
+ * one) is given. Bound the walk by a path git answered — `Git.repoRoot` — with
+ * `ceiling`; `stopAt` never matches a symlink-resolved spelling of the start.
+ *
  * @public
  */
-type UpwardWalkOptions = {
+type UpwardWalkOptions = ({
   /** The single file name probed at each ancestor directory. */
   readonly filename: string;
   readonly filenames?: undefined;
+} | {
+  /**
+   * The candidate file names probed at each ancestor directory, in order,
+   * before the walk ascends.
+   */
+  readonly filenames: ReadonlyArray<string>;
+  readonly filename?: undefined;
+}) & ({
+  /**
+   * An absolute ceiling the walk stops at, inclusive, compared
+   * LEXICALLY (`Walker.ascend`'s `stopAt`).
+   *
+   * @remarks
+   * A ceiling spelled differently from the walk's own path never
+   * matches, and the walk runs on to the filesystem root. That is
+   * every physical path — `Git.repoRoot`'s answer from a symlinked or
+   * macOS-tmpdir start — so bound by such a path with `ceiling`.
+   */
+  readonly stopAt?: string;
+  readonly ceiling?: undefined;
+} | {
+  /**
+   * A ceiling the walk stops at, inclusive, compared PHYSICALLY: the
+   * nearest ancestor whose real path is the ceiling's real path
+   * (`Walker.ascendWithin`).
+   *
+   * @remarks
+   * For a ceiling that may be spelled differently from the walk's own
+   * path, above all `Git.repoRoot`'s symlink-resolved answer. Omit it
+   * to walk to the filesystem root. A relative ceiling is a defect.
+   * Cannot be combined with `stopAt`.
+   */
+  readonly ceiling?: string;
+  readonly stopAt?: undefined;
+}) & {
   /** Where the walk starts. Defaults to the process cwd. */
   readonly cwd?: string;
-  /** An absolute ceiling the walk stops at, inclusive. */
-  readonly stopAt?: string;
   /** Directories probed under each ancestor, in order. Defaults to `["."]`. */
   readonly subpaths?: ReadonlyArray<string>;
   /**
@@ -433,21 +470,6 @@ type UpwardWalkOptions = {
    * identifies the matching candidate rather than the resolver.
    */
   readonly name?: string;
-} | {
-  /**
-   * The candidate file names probed at each ancestor directory, in order,
-   * before the walk ascends.
-   */
-  readonly filenames: ReadonlyArray<string>;
-  readonly filename?: undefined;
-  /** Where the walk starts. Defaults to the process cwd. */
-  readonly cwd?: string;
-  /** An absolute ceiling the walk stops at, inclusive. */
-  readonly stopAt?: string;
-  /** Directories probed under each ancestor, in order. Defaults to `["."]`. */
-  readonly subpaths?: ReadonlyArray<string>;
-  /** The resolver's reported name. Defaults to `"walk"`. */
-  readonly name?: string;
 };
 /**
  * Built-in resolvers, in the order a typical chain uses them.
@@ -464,8 +486,8 @@ export declare class ConfigResolver {
     readonly filename: string;
   }) => ConfigResolver<FileSystem.FileSystem | Path.Path>;
   /**
-   * Ascends from `cwd` (or the process cwd) toward `stopAt`, resolving the
-   * first `subpaths/filename` combination found at each level.
+   * Ascends from `cwd` (or the process cwd) toward `stopAt` or `ceiling`,
+   * resolving the first `subpaths/filename` combination found at each level.
    *
    * @remarks
    * `filenames` replaces `filename` with a per-directory candidate list: every

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@effected/config-file",
-	"version": "0.20.1",
+	"version": "0.21.0",
 	"private": false,
 	"description": "Composable config file loading for Effect: JSON, JSONC, YAML and TOML codecs, resolution strategies, and merge behaviors.",
 	"keywords": [
@@ -58,10 +58,10 @@
 		"./package.json": "./package.json"
 	},
 	"peerDependencies": {
-		"@effected/glob": "^0.14.0",
-		"@effected/jsonc": "^0.20.0",
+		"@effected/glob": "^0.15.0",
+		"@effected/jsonc": "^0.20.1",
 		"@effected/toml": "^0.16.0",
-		"@effected/walker": "^0.20.1",
+		"@effected/walker": "^0.21.0",
 		"@effected/yaml": "^0.25.1",
 		"effect": "^4.0.0"
 	},