load-oxfmt-config 0.0.5 → 0.0.6

package/dist/index.d.mts

@@ -18,12 +18,27 @@ interface Options {
 //#endregion
 //#region src/core.d.ts
 /**
- * Load oxfmt configuration by resolving the config file path and parsing its contents.
- * Uses in-memory caches by default; set `useCache` to false to force re-read.
+ * Load oxfmt configuration: resolve the file path, then read and parse it.
+ * Caching is enabled by default; pass `useCache: false` to force a re-read.
+ *
+ * @param options - Optional loader settings (cwd, configPath, useCache).
+ * @returns Parsed oxfmt FormatOptions or an empty object when missing.
+ * @throws {Error} when the config file exists but cannot be parsed.
+ *
+ * @example
+ * ```ts
+ * const config = await loadOxfmtConfig({ cwd: '/project' })
+ * ```
  */
 declare function loadOxfmtConfig(options?: Options): Promise<FormatOptions>;
 /**
- * Resolve the oxfmt config file path, searching upward from the provided cwd when no explicit path is given.
+ * Resolve the oxfmt config file path.
+ * - If `configPath` is provided, absolute paths are returned as-is; relative paths are joined to cwd.
+ * - Otherwise, walk upward from cwd to find known filenames.
+ *
+ * @param cwd - Starting directory for resolution.
+ * @param configPath - Optional explicit path (absolute or relative to cwd).
+ * @returns Absolute path to the config file, or undefined when not found.
  */
 declare function resolveOxfmtrcPath(cwd: string, configPath?: string): Promise<string | undefined>;
 //#endregion

package/dist/index.mjs

@@ -1,5 +1,5 @@
-import { readFile } from "node:fs/promises";
-import { join } from "node:path";
+import { readFile, stat } from "node:fs/promises";
+import { isAbsolute, join } from "node:path";
 import process from "node:process";
 import { parse } from "jsonc-parser";
 
@@ -15,8 +15,17 @@ const OXFMT_CONFIG_FILES = [".oxfmtrc.json", ".oxfmtrc.jsonc"];
 const resolveCache = /* @__PURE__ */ new Map();
 const configCache = /* @__PURE__ */ new Map();
 /**
-* Load oxfmt configuration by resolving the config file path and parsing its contents.
-* Uses in-memory caches by default; set `useCache` to false to force re-read.
+* Load oxfmt configuration: resolve the file path, then read and parse it.
+* Caching is enabled by default; pass `useCache: false` to force a re-read.
+*
+* @param options - Optional loader settings (cwd, configPath, useCache).
+* @returns Parsed oxfmt FormatOptions or an empty object when missing.
+* @throws {Error} when the config file exists but cannot be parsed.
+*
+* @example
+* ```ts
+* const config = await loadOxfmtConfig({ cwd: '/project' })
+* ```
 */
 async function loadOxfmtConfig(options = {}) {
 	const useCache = options.useCache !== false;
@@ -34,16 +43,21 @@ async function loadOxfmtConfig(options = {}) {
 	return cachePromise(configCache, getConfigCacheKey(resolvedPath, resolveKey), loadTask);
 }
 /**
-* Resolve the oxfmt config file path, searching upward from the provided cwd when no explicit path is given.
+* Resolve the oxfmt config file path.
+* - If `configPath` is provided, absolute paths are returned as-is; relative paths are joined to cwd.
+* - Otherwise, walk upward from cwd to find known filenames.
+*
+* @param cwd - Starting directory for resolution.
+* @param configPath - Optional explicit path (absolute or relative to cwd).
+* @returns Absolute path to the config file, or undefined when not found.
 */
 async function resolveOxfmtrcPath(cwd, configPath) {
-	if (configPath) return join(cwd, configPath);
+	if (configPath) return isAbsolute(configPath) ? configPath : join(cwd, configPath);
 	let currentDir = cwd;
 	while (true) {
 		for (const filename of OXFMT_CONFIG_FILES) {
 			const configFilePath = join(currentDir, filename);
 			try {
-				const { stat } = await import("node:fs/promises");
 				if ((await stat(configFilePath)).isFile()) return configFilePath;
 			} catch {}
 		}
@@ -52,6 +66,14 @@ async function resolveOxfmtrcPath(cwd, configPath) {
 		currentDir = parentDir;
 	}
 }
+/**
+* Return a cached promise by key, creating and storing it on miss; failures clear the entry.
+*
+* @param cache - Map used to store inflight/resolved promises.
+* @param key - Cache key.
+* @param factory - Factory to create the promise when missing.
+* @returns Cached or newly created promise.
+*/
 function cachePromise(cache, key, factory) {
 	const cached = cache.get(key);
 	if (cached) return cached;
@@ -62,12 +84,32 @@ function cachePromise(cache, key, factory) {
 	cache.set(key, task);
 	return task;
 }
+/**
+* Build a cache key for config content; prefixes missing entries with `missing:`.
+*
+* @param resolvedPath - Resolved config path or undefined when missing.
+* @param resolveKey - Key used for path resolution caching.
+* @returns Cache key for config content.
+*/
 function getConfigCacheKey(resolvedPath, resolveKey) {
 	return resolvedPath || `missing:${resolveKey}`;
 }
+/**
+* Build a cache key for path resolution (cwd + configPath).
+*
+* @param cwd - Current working directory.
+* @param configPath - Optional config path.
+* @returns Cache key for resolve cache.
+*/
 function getResolveCacheKey(cwd, configPath) {
 	return `${cwd}::${configPath || ""}`;
 }
+/**
+* Read and parse config file, supporting JSON and JSONC.
+*
+* @param resolvedPath - Absolute path to the config file.
+* @returns Parsed FormatOptions object.
+*/
 async function readConfigFromFile(resolvedPath) {
 	const content = await readFile(resolvedPath, "utf-8");
 	if (resolvedPath.endsWith(".jsonc")) return parse(content);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "load-oxfmt-config",
   "type": "module",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "Load .oxfmtrc.json(c) for oxfmt.",
   "keywords": [
     "jsonc-parser",
@@ -38,7 +38,7 @@
   },
   "sideEffects": false,
   "peerDependencies": {
-    "oxfmt": "^0.23.0"
+    "oxfmt": "^0.24.0"
   },
   "dependencies": {
     "jsonc-parser": "^3.3.1"
@@ -47,15 +47,15 @@
     "@ntnyq/eslint-config": "^5.9.0",
     "@ntnyq/prettier-config": "^3.0.1",
     "@ntnyq/tsconfig": "^3.1.0",
-    "@types/node": "^25.0.3",
+    "@types/node": "^25.0.6",
     "bumpp": "^10.3.2",
     "eslint": "^9.39.2",
     "husky": "^9.1.7",
     "nano-staged": "^0.9.0",
     "npm-run-all2": "^8.0.4",
-    "oxfmt": "^0.23.0",
+    "oxfmt": "^0.24.0",
     "prettier": "^3.7.4",
-    "tsdown": "^0.19.0-beta.3",
+    "tsdown": "^0.19.0",
     "typescript": "^5.9.3",
     "vitest": "^4.0.16"
   },