@effected/xdg 0.1.8 → 0.1.9

package/XdgConfig.js

@@ -5,27 +5,6 @@ import { Effect, FileSystem, Option, Path } from "effect";
 import { Walker } from "@effected/walker";
 
 //#region src/XdgConfig.ts
-/**
-* Search the app's XDG config search path for `filename`.
-*
-* @remarks
-* Probes the app's own config directory first, then each `$XDG_CONFIG_DIRS`
-* entry namespaced — `~/.config/myapp/rc`, then `/etc/xdg/myapp/rc`. v3 probed
-* only the first of those; the system search path is half the XDG spec and it
-* was missing.
-*
-* The scan runs through `Walker.firstMatch`, so a failure on one candidate means
-* "this candidate did not match" and the search continues to the next. That is a
-* bug fixed, not a refactor: v3 wrapped the whole resolver in a single
-* `catchAll`, so an unreadable `/etc/xdg` aborted the probe and hid a perfectly
-* readable `~/.config`. Not-found and cannot-look stay indistinguishable to the
-* caller, which is the resolver contract — `resolve`'s error channel is `never`.
-*
-* Place it **before** `nativeResolver` in a chain, so an existing
-* `~/.config/<app>` still wins over the OS-native directory.
-*
-* @public
-*/
 const resolver = (options) => ({
 	name: "xdg",
 	resolve: Effect.gen(function* () {
@@ -36,24 +15,6 @@ const resolver = (options) => ({
 		return yield* Walker.firstMatch(candidates, (candidate) => fs.exists(candidate));
 	})
 });
-/**
-* Probe the OS-native config directory for `filename`.
-*
-* @remarks
-* Resolves the native config directory for `namespace`
-* (`~/Library/Application Support/<ns>` on macOS, `%APPDATA%\<ns>` on Windows)
-* and checks whether `filename` is there. On Linux and everywhere else
-* {@link NativeDirs.resolve} yields `Option.none()`, so this resolver returns
-* `Option.none()` without probing at all — the XDG resolver already owns
-* `~/.config` there.
-*
-* Takes `namespace` rather than reading it off {@link AppDirs}: the native
-* directory is a property of the OS convention, not of however the app happened
-* to configure its XDG directories, and a caller may well probe a *different*
-* namespace than the one their `AppDirs` was built for.
-*
-* @public
-*/
 const nativeResolver = (options) => ({
 	name: "native",
 	resolve: Effect.gen(function* () {
@@ -71,31 +32,6 @@ const nativeResolver = (options) => ({
 		return yield* Walker.firstMatch([path.join(native.value.config, options.filename)], (candidate) => fs.exists(candidate));
 	})
 });
-/**
-* The default save target for a config file: `<app config dir>/<filename>`.
-*
-* @remarks
-* Drops straight into `ConfigFileOptions.defaultPath`, whose slot is typed
-* `Effect<string, never, RR>`. That infallible channel is the whole reason
-* {@link AppDirs} resolves at layer-construction time: with v3's per-access
-* resolution this could fail, and a consumer had to `orDie` it into the slot.
-*
-* It does **not** create the directory — `ConfigFile.save` already `mkdir -p`s
-* the parent of whatever path it is given.
-*
-* @example
-* ```ts
-* const layer = ConfigFile.layer(AppConfig, {
-* 	schema: AppShape,
-* 	codec: JsonCodec,
-* 	strategy: MergeStrategy.firstMatch<AppShape>(),
-* 	resolvers: [XdgConfig.resolver({ filename: "config.json" })],
-* 	defaultPath: XdgConfig.savePath("config.json"),
-* });
-* ```
-*
-* @public
-*/
 const savePath = (filename) => Effect.gen(function* () {
 	const appDirs = yield* AppDirs;
 	return (yield* Path.Path).join(appDirs.dirs.config, filename);
@@ -105,10 +41,69 @@ const savePath = (filename) => Effect.gen(function* () {
 *
 * @public
 */
-const XdgConfig = {
-	resolver,
-	nativeResolver,
-	savePath
+var XdgConfig = class {
+	constructor() {}
+	/**
+	* Search the app's XDG config search path for `filename`.
+	*
+	* @remarks
+	* Probes the app's own config directory first, then each `$XDG_CONFIG_DIRS`
+	* entry namespaced — `~/.config/myapp/rc`, then `/etc/xdg/myapp/rc`. v3 probed
+	* only the first of those; the system search path is half the XDG spec and it
+	* was missing.
+	*
+	* The scan runs through `Walker.firstMatch`, so a failure on one candidate means
+	* "this candidate did not match" and the search continues to the next. That is a
+	* bug fixed, not a refactor: v3 wrapped the whole resolver in a single
+	* `catchAll`, so an unreadable `/etc/xdg` aborted the probe and hid a perfectly
+	* readable `~/.config`. Not-found and cannot-look stay indistinguishable to the
+	* caller, which is the resolver contract — `resolve`'s error channel is `never`.
+	*
+	* Place it **before** {@link XdgConfig.nativeResolver} in a chain, so an
+	* existing `~/.config/<app>` still wins over the OS-native directory.
+	*/
+	static resolver = resolver;
+	/**
+	* Probe the OS-native config directory for `filename`.
+	*
+	* @remarks
+	* Resolves the native config directory for `namespace`
+	* (`~/Library/Application Support/<ns>` on macOS, `%APPDATA%\<ns>` on Windows)
+	* and checks whether `filename` is there. On Linux and everywhere else
+	* {@link NativeDirs.resolve} yields `Option.none()`, so this resolver returns
+	* `Option.none()` without probing at all — the XDG resolver already owns
+	* `~/.config` there.
+	*
+	* Takes `namespace` rather than reading it off {@link AppDirs}: the native
+	* directory is a property of the OS convention, not of however the app happened
+	* to configure its XDG directories, and a caller may well probe a *different*
+	* namespace than the one their `AppDirs` was built for.
+	*/
+	static nativeResolver = nativeResolver;
+	/**
+	* The default save target for a config file: `<app config dir>/<filename>`.
+	*
+	* @remarks
+	* Drops straight into `ConfigFileOptions.defaultPath`, whose slot is typed
+	* `Effect<string, never, RR>`. That infallible channel is the whole reason
+	* {@link AppDirs} resolves at layer-construction time: with v3's per-access
+	* resolution this could fail, and a consumer had to `orDie` it into the slot.
+	*
+	* It does **not** create the directory — `ConfigFile.save` already `mkdir -p`s
+	* the parent of whatever path it is given.
+	*
+	* @example
+	* ```ts
+	* const layer = ConfigFile.layer(AppConfig, {
+	* 	schema: AppShape,
+	* 	codec: JsonCodec,
+	* 	strategy: MergeStrategy.firstMatch<AppShape>(),
+	* 	resolvers: [XdgConfig.resolver({ filename: "config.json" })],
+	* 	defaultPath: XdgConfig.savePath("config.json"),
+	* });
+	* ```
+	*/
+	static savePath = savePath;
 };
 
 //#endregion

package/index.d.ts

@@ -377,16 +377,75 @@ declare class NativeDirs extends NativeDirs_base {
  *
  * @public
  */
-declare const XdgConfig: {
-  readonly resolver: (options: {
+declare class XdgConfig {
+  private constructor();
+  /**
+   * Search the app's XDG config search path for `filename`.
+   *
+   * @remarks
+   * Probes the app's own config directory first, then each `$XDG_CONFIG_DIRS`
+   * entry namespaced — `~/.config/myapp/rc`, then `/etc/xdg/myapp/rc`. v3 probed
+   * only the first of those; the system search path is half the XDG spec and it
+   * was missing.
+   *
+   * The scan runs through `Walker.firstMatch`, so a failure on one candidate means
+   * "this candidate did not match" and the search continues to the next. That is a
+   * bug fixed, not a refactor: v3 wrapped the whole resolver in a single
+   * `catchAll`, so an unreadable `/etc/xdg` aborted the probe and hid a perfectly
+   * readable `~/.config`. Not-found and cannot-look stay indistinguishable to the
+   * caller, which is the resolver contract — `resolve`'s error channel is `never`.
+   *
+   * Place it **before** {@link XdgConfig.nativeResolver} in a chain, so an
+   * existing `~/.config/<app>` still wins over the OS-native directory.
+   */
+  static readonly resolver: (options: {
     readonly filename: string;
   }) => ConfigResolver<AppDirs | FileSystem.FileSystem | Path.Path>;
-  readonly nativeResolver: (options: {
+  /**
+   * Probe the OS-native config directory for `filename`.
+   *
+   * @remarks
+   * Resolves the native config directory for `namespace`
+   * (`~/Library/Application Support/<ns>` on macOS, `%APPDATA%\<ns>` on Windows)
+   * and checks whether `filename` is there. On Linux and everywhere else
+   * {@link NativeDirs.resolve} yields `Option.none()`, so this resolver returns
+   * `Option.none()` without probing at all — the XDG resolver already owns
+   * `~/.config` there.
+   *
+   * Takes `namespace` rather than reading it off {@link AppDirs}: the native
+   * directory is a property of the OS convention, not of however the app happened
+   * to configure its XDG directories, and a caller may well probe a *different*
+   * namespace than the one their `AppDirs` was built for.
+   */
+  static readonly nativeResolver: (options: {
     readonly namespace: string;
     readonly filename: string;
   }) => ConfigResolver<Xdg | FileSystem.FileSystem | Path.Path>;
-  readonly savePath: (filename: string) => Effect.Effect<string, never, AppDirs | Path.Path>;
-};
+  /**
+   * The default save target for a config file: `<app config dir>/<filename>`.
+   *
+   * @remarks
+   * Drops straight into `ConfigFileOptions.defaultPath`, whose slot is typed
+   * `Effect<string, never, RR>`. That infallible channel is the whole reason
+   * {@link AppDirs} resolves at layer-construction time: with v3's per-access
+   * resolution this could fail, and a consumer had to `orDie` it into the slot.
+   *
+   * It does **not** create the directory — `ConfigFile.save` already `mkdir -p`s
+   * the parent of whatever path it is given.
+   *
+   * @example
+   * ```ts
+   * const layer = ConfigFile.layer(AppConfig, {
+   * 	schema: AppShape,
+   * 	codec: JsonCodec,
+   * 	strategy: MergeStrategy.firstMatch<AppShape>(),
+   * 	resolvers: [XdgConfig.resolver({ filename: "config.json" })],
+   * 	defaultPath: XdgConfig.savePath("config.json"),
+   * });
+   * ```
+   */
+  static readonly savePath: (filename: string) => Effect.Effect<string, never, AppDirs | Path.Path>;
+}
 //#endregion
 export { AppDirKind, type AppDirOverrides, AppDirs, AppDirsError, type AppDirsOptions, type AppDirsShape, CurrentPlatform, NativeDirs, ResolvedAppDirs, Xdg, XdgConfig, XdgEnvError, XdgPaths, XdgPlatform };
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@effected/xdg",
-	"version": "0.1.8",
+	"version": "0.1.9",
 	"private": false,
 	"description": "XDG Base Directory resolution for Effect: environment paths, app-namespaced directories, native OS conventions and config-file resolvers.",
 	"keywords": [
@@ -38,8 +38,8 @@
 		"./package.json": "./package.json"
 	},
 	"peerDependencies": {
-		"@effected/config-file": "~0.1.8",
-		"@effected/walker": "~0.3.2",
+		"@effected/config-file": "~0.2.0",
+		"@effected/walker": "~0.3.3",
 		"effect": "4.0.0-beta.101"
 	},
 	"engines": {