load-oxfmt-config 0.7.2 → 0.8.0

package/README.md

@@ -38,19 +38,19 @@ pnpm add load-oxfmt-config
 Load config from current directory or parent directories:
 
 ```ts
-import { loadOxfmtConfigResult } from 'load-oxfmt-config'
+import { loadOxfmtConfig } from 'load-oxfmt-config'
 
 // Automatically searches for oxfmt config files and the nearest .editorconfig
-const result = await loadOxfmtConfigResult()
+const result = await loadOxfmtConfig()
 console.log(result.config) // { printWidth: 80, ... }
 ```
 
 ### Merge With `.editorconfig`
 
 ```ts
-import { loadOxfmtConfigResult } from 'load-oxfmt-config'
+import { loadOxfmtConfig } from 'load-oxfmt-config'
 
-const result = await loadOxfmtConfigResult({ cwd: '/path/to/project' })
+const result = await loadOxfmtConfig({ cwd: '/path/to/project' })
 
 // Returns one merged static config object
 console.log(result.config)
@@ -66,9 +66,9 @@ console.log(result.config)
 ### Specify Working Directory
 
 ```ts
-import { loadOxfmtConfigResult } from 'load-oxfmt-config'
+import { loadOxfmtConfig } from 'load-oxfmt-config'
 
-const result = await loadOxfmtConfigResult({
+const result = await loadOxfmtConfig({
   cwd: '/path/to/project',
 })
 ```
@@ -76,9 +76,9 @@ const result = await loadOxfmtConfigResult({
 ### Get Config Metadata
 
 ```ts
-import { loadOxfmtConfigResult } from 'load-oxfmt-config'
+import { loadOxfmtConfig } from 'load-oxfmt-config'
 
-const result = await loadOxfmtConfigResult({ cwd: '/path/to/project' })
+const result = await loadOxfmtConfig({ cwd: '/path/to/project' })
 
 console.log(result.config) // merged oxfmt options
 console.log(result.filepath) // /path/to/project/.oxfmtrc.json (or undefined)
@@ -102,16 +102,16 @@ console.log(result)
 ### Explicit Config Path
 
 ```ts
-import { loadOxfmtConfigResult } from 'load-oxfmt-config'
+import { loadOxfmtConfig } from 'load-oxfmt-config'
 
 // Relative path (resolved relative to cwd)
-const result = await loadOxfmtConfigResult({
+const result = await loadOxfmtConfig({
   configPath: 'configs/.oxfmtrc.json',
   cwd: '/path/to/project',
 })
 
 // Absolute path
-const absoluteResult = await loadOxfmtConfigResult({
+const absoluteResult = await loadOxfmtConfig({
   configPath: '/absolute/path/to/.oxfmtrc.json',
 })
 ```
@@ -119,10 +119,10 @@ const absoluteResult = await loadOxfmtConfigResult({
 ### Disable `.editorconfig`
 
 ```ts
-import { loadOxfmtConfigResult } from 'load-oxfmt-config'
+import { loadOxfmtConfig } from 'load-oxfmt-config'
 
 // Skip .editorconfig reading entirely
-const result = await loadOxfmtConfigResult({
+const result = await loadOxfmtConfig({
   editorconfig: false,
 })
 ```
@@ -130,10 +130,10 @@ const result = await loadOxfmtConfigResult({
 ### Limit `.editorconfig` to `cwd`
 
 ```ts
-import { loadOxfmtConfigResult } from 'load-oxfmt-config'
+import { loadOxfmtConfig } from 'load-oxfmt-config'
 
 // Only look in the cwd directory itself, no upward traversal
-const result = await loadOxfmtConfigResult({
+const result = await loadOxfmtConfig({
   editorconfig: { onlyCwd: true },
 })
 ```
@@ -141,10 +141,10 @@ const result = await loadOxfmtConfigResult({
 ### Override `.editorconfig` Search Directory
 
 ```ts
-import { loadOxfmtConfigResult } from 'load-oxfmt-config'
+import { loadOxfmtConfig } from 'load-oxfmt-config'
 
 // Search .editorconfig from a custom directory instead of the config file's directory
-const result = await loadOxfmtConfigResult({
+const result = await loadOxfmtConfig({
   editorconfig: {
     cwd: '/path/to/editorconfig-dir',
   },
@@ -154,23 +154,14 @@ const result = await loadOxfmtConfigResult({
 ### Disable Caching
 
 ```ts
-import { loadOxfmtConfigResult } from 'load-oxfmt-config'
+import { loadOxfmtConfig } from 'load-oxfmt-config'
 
 // Force reload from disk, bypassing cache
-const result = await loadOxfmtConfigResult({
+const result = await loadOxfmtConfig({
   useCache: false,
 })
 ```
 
-### Legacy API (Deprecated)
-
-```ts
-import { loadOxfmtConfig } from 'load-oxfmt-config'
-
-// Deprecated: prefer loadOxfmtConfigResult
-const config = await loadOxfmtConfig({ cwd: '/path/to/project' })
-```
-
 ### Path Resolution Only
 
 ```ts
@@ -185,67 +176,6 @@ console.log(configPath) // '/path/to/.oxfmtrc.json' or undefined
 
 ### `loadOxfmtConfig(options?)`
 
-> Deprecated. Prefer `loadOxfmtConfigResult(options?)`.
-
-Load and parse oxfmt configuration files, then merge supported `.editorconfig` fields into the returned result.
-
-**Parameters:**
-
-- `options` - Optional configuration object (`LoadOxfmtConfigOptions`)
-
-Option fields:
-
-#### `cwd`
-
-- **Type:** `string`
-- **Default:** `process.cwd()`
-
-Current working directory to start searching for config files. The loader will walk up from this directory to find a config file.
-
-#### `configPath`
-
-- **Type:** `string`
-- **Default:** `undefined`
-
-Explicit path to the config file:
-
-- **Relative path:** Resolved relative to `cwd`
-- **Absolute path:** Used as-is
-- **When provided:** Skips auto-discovery and uses this path directly
-
-#### `useCache`
-
-- **Type:** `boolean`
-- **Default:** `true`
-
-Enable in-memory caching for both path resolution and parsed config contents. When enabled:
-
-- Config file paths are cached to avoid repeated filesystem lookups
-- Parsed config objects are cached to avoid re-parsing
-- Subsequent calls with the same parameters return cached results instantly
-
-Set to `false` to force reload from disk on every call.
-
-#### `editorconfig`
-
-- **Type:** `boolean | EditorconfigOption`
-- **Default:** `true`
-
-Control how `.editorconfig` files are read and merged:
-
-- **`true`** — Read and merge the nearest `.editorconfig`, walking up from the config file's directory (or `cwd` when no config path is given).
-- **`false`** — Disable `.editorconfig` reading entirely.
-- **`EditorconfigOption`** — Enable with additional settings:
-
-| Property  | Type      | Default     | Description                                                                                                           |
-| --------- | --------- | ----------- | --------------------------------------------------------------------------------------------------------------------- |
-| `onlyCwd` | `boolean` | `false`     | When `true`, only look for `.editorconfig` in `cwd` itself — no upward traversal.                                     |
-| `cwd`     | `string`  | `undefined` | Override the directory from which `.editorconfig` resolution starts, instead of the config file's directory or `cwd`. |
-
-**Returns:** `Promise<OxfmtOptions>` - Parsed and merged oxfmt configuration object. Returns empty object `{}` if no supported config file is found.
-
-### `loadOxfmtConfigResult(options?)`
-
 Load and parse oxfmt configuration files, merge supported `.editorconfig` fields, and return metadata for the resolved config file.
 
 **Parameters:**
@@ -336,7 +266,7 @@ Option fields:
 - **Default:** `process.cwd()`
 
 Current working directory.
-Also the base directory for default `.gitignore`/`.prettierignore` lookup.
+Also the base directory for default `.prettierignore` lookup.
 
 #### `filepath`
 
@@ -358,7 +288,7 @@ When provided, nested config lookup is disabled (same as oxfmt CLI `-c`).
 - **Type:** `string | string[]`
 - **Default:** `undefined`
 
-Ignore files to use instead of cwd `.gitignore`/`.prettierignore`.
+Ignore files to use instead of default `.gitignore` hierarchy + cwd `.prettierignore`.
 Can be passed multiple times in CLI style.
 
 #### `withNodeModules`
@@ -404,6 +334,7 @@ When `false`, `isOxfmtIgnored()` only applies global ignore and skips config loa
   - `default-dir`
   - `lockfile`
   - `gitignore`
+  - `git-info-exclude`
   - `prettierignore`
   - `ignore-path`
   - `config-ignore-patterns`
@@ -495,16 +426,15 @@ Global ignore includes:
 - Default lockfiles: `package-lock.json`, `npm-shrinkwrap.json`, `pnpm-lock.yaml`, `yarn.lock`, `bun.lock`, `bun.lockb`
 - Ignore files:
   - If `ignorePath` is provided: use those files only (multiple supported)
-  - If `ignorePath` is not provided: use `.gitignore` and `.prettierignore` from `cwd`
+  - If `ignorePath` is not provided:
+    - Read `.gitignore` from the file's directory upward until the git repo boundary
+    - Read `<repo>/.git/info/exclude` when inside a git repo
+    - Read `.prettierignore` from `cwd`
 
 Notes:
 
 - `node_modules` can be included by passing `withNodeModules: true`.
 
-Type compatibility note:
-
-- `Options` is still exported as a deprecated alias of `LoadOxfmtConfigOptions`.
-- This package does not read parent `.gitignore` files or global gitignore settings.
 - The default lockfile list mirrors oxfmt documentation intent (`package-lock.json`, `pnpm-lock.yaml`, etc.) and common ecosystem lockfiles. It is not guaranteed to be a complete internal oxfmt list.
 - `ignorePatterns` are always interpreted relative to the resolved oxfmt config directory.
 - `includeConfigIgnorePatterns` defaults to `true` to preserve current behavior.
@@ -527,15 +457,15 @@ This means explicit oxfmt config values always win over `.editorconfig` fallback
 
 ## Limitations
 
-`loadOxfmtConfigResult()` (and the deprecated `loadOxfmtConfig()`) returns a static merged `OxfmtOptions` shape. That means `.editorconfig` support is represented as merged root + overrides config data, not as per-file runtime evaluation. In practice this works well for common root settings and section-based overrides, but it is not a full replacement for oxfmt's own file-by-file config resolution.
+`loadOxfmtConfig()` returns a static merged `OxfmtOptions` shape. That means `.editorconfig` support is represented as merged root + overrides config data, not as per-file runtime evaluation. In practice this works well for common root settings and section-based overrides, but it is not a full replacement for oxfmt's own file-by-file config resolution.
 
 ## Error Handling
 
 ```ts
-import { loadOxfmtConfigResult } from 'load-oxfmt-config'
+import { loadOxfmtConfig } from 'load-oxfmt-config'
 
 try {
-  const result = await loadOxfmtConfigResult()
+  const result = await loadOxfmtConfig()
   console.log(result.config)
 } catch (error) {
   // Thrown when config file exists but contains invalid JSON/JSONC

package/dist/index.d.mts

@@ -100,7 +100,7 @@ interface LoadOxfmtConfigResult {
 interface IsOxfmtIgnoredOptions {
   /**
    * Current working directory.
-   * Also the base directory for default .gitignore/.prettierignore lookup.
+   * Also the base directory for default `.prettierignore` lookup.
    */
   cwd?: string;
   /**
@@ -113,7 +113,7 @@ interface IsOxfmtIgnoredOptions {
    */
   configPath?: string;
   /**
-   * Ignore files to use instead of cwd .gitignore/.prettierignore.
+   * Ignore files to use instead of default `.gitignore` hierarchy + cwd `.prettierignore`.
    * Can be passed multiple times in CLI style.
    */
   ignorePath?: string | string[];
@@ -155,16 +155,8 @@ interface IsOxfmtIgnoredResult {
   /**
    * Matched ignore source.
    */
-  reason?: 'default-dir' | 'lockfile' | 'gitignore' | 'prettierignore' | 'ignore-path' | 'config-ignore-patterns';
+  reason?: 'default-dir' | 'lockfile' | 'gitignore' | 'git-info-exclude' | 'prettierignore' | 'ignore-path' | 'config-ignore-patterns';
 }
-/**
- * @deprecated Use `OxfmtConfigOverride` instead
- */
-type FormatOptionOverride = OxfmtConfigOverride;
-/**
- * @deprecated Use `LoadOxfmtConfigOptions` instead.
- */
-type Options = LoadOxfmtConfigOptions;
 //#endregion
 //#region src/config-file.d.ts
 /**
@@ -196,13 +188,13 @@ declare function resolveOxfmtrcPath(cwd: string, configPath?: string): Promise<s
  *
  * @example
  * ```ts
- * import { loadOxfmtConfigResult } from 'load-oxfmt-config'
+ * import { loadOxfmtConfig } from 'load-oxfmt-config'
  *
- * const result = await loadOxfmtConfigResult({ cwd: process.cwd() })
+ * const result = await loadOxfmtConfig({ cwd: process.cwd() })
  * console.log(result.config)
  * ```
  */
-declare function loadOxfmtConfigResult(options?: LoadOxfmtConfigOptions): Promise<LoadOxfmtConfigResult>;
+declare function loadOxfmtConfig(options?: LoadOxfmtConfigOptions): Promise<LoadOxfmtConfigResult>;
 //#endregion
 //#region src/ignore.d.ts
 /**
@@ -223,25 +215,4 @@ declare function loadOxfmtConfigResult(options?: LoadOxfmtConfigOptions): Promis
  */
 declare function isOxfmtIgnored(options: IsOxfmtIgnoredOptions): Promise<IsOxfmtIgnoredResult>;
 //#endregion
-//#region src/legacy.d.ts
-/**
- * Legacy API that returns only the merged config object.
- *
- * Prefer using `loadOxfmtConfigResult` when you also need resolved config metadata.
- *
- * @deprecated Prefer `loadOxfmtConfigResult`.
- *
- * @param options - Loader options.
- * @returns Parsed and merged oxfmt options.
- *
- * @example
- * ```ts
- * import { loadOxfmtConfig } from 'load-oxfmt-config'
- *
- * // Deprecated: prefer loadOxfmtConfigResult.
- * const config = await loadOxfmtConfig({ cwd: process.cwd() })
- * ```
- */
-declare function loadOxfmtConfig(options?: LoadOxfmtConfigOptions): Promise<OxfmtOptions>;
-//#endregion
-export { EditorconfigOption, FormatOptionOverride, IsOxfmtIgnoredOptions, IsOxfmtIgnoredResult, LoadOxfmtConfigOptions, LoadOxfmtConfigResult, Options, OxfmtConfigOverride, OxfmtOptions, isOxfmtIgnored, loadOxfmtConfig, loadOxfmtConfigResult, resolveOxfmtrcPath };
+export { EditorconfigOption, IsOxfmtIgnoredOptions, IsOxfmtIgnoredResult, LoadOxfmtConfigOptions, LoadOxfmtConfigResult, OxfmtConfigOverride, OxfmtOptions, isOxfmtIgnored, loadOxfmtConfig, resolveOxfmtrcPath };

package/dist/index.mjs

@@ -53,10 +53,6 @@ const DEFAULT_IGNORED_LOCKFILES = [
 	"bun.lockb"
 ];
 /**
-* Default ignore files loaded from cwd when --ignore-path is not provided.
-*/
-const DEFAULT_IGNORE_FILES = [".gitignore", ".prettierignore"];
-/**
 * Supported EditorConfig filename.
 */
 const EDITORCONFIG_FILE = ".editorconfig";
@@ -394,13 +390,13 @@ const configCache = /* @__PURE__ */ new Map();
 *
 * @example
 * ```ts
-* import { loadOxfmtConfigResult } from 'load-oxfmt-config'
+* import { loadOxfmtConfig } from 'load-oxfmt-config'
 *
-* const result = await loadOxfmtConfigResult({ cwd: process.cwd() })
+* const result = await loadOxfmtConfig({ cwd: process.cwd() })
 * console.log(result.config)
 * ```
 */
-async function loadOxfmtConfigResult(options = {}) {
+async function loadOxfmtConfig(options = {}) {
 	const useCache = options.useCache !== false;
 	const cwd = resolve(options.cwd || process.cwd());
 	const editorconfig = options.editorconfig ?? true;
@@ -500,12 +496,13 @@ function relativeSafe(from, to) {
 * @param filepath - Absolute file path.
 * @param ignoreFilePath - Ignore file path.
 * @param useCache - Whether to use matcher cache.
+* @param baseDir - Base directory for relative path calculation, defaults to ignore file directory.
 * @returns True when ignored by this file.
 */
-async function matchIgnoreFile(filepath, ignoreFilePath, useCache) {
+async function matchIgnoreFile(filepath, ignoreFilePath, useCache, baseDir) {
 	const matcher = await loadIgnoreMatcher(ignoreFilePath, useCache);
 	if (!matcher) return false;
-	const relativeToIgnore = relativeSafe(dirname(ignoreFilePath), filepath);
+	const relativeToIgnore = relativeSafe(baseDir ?? dirname(ignoreFilePath), filepath);
 	if (relativeToIgnore === ".." || relativeToIgnore.startsWith("../")) return false;
 	return matcher.ignores(relativeToIgnore);
 }
@@ -520,6 +517,62 @@ function resolveIgnoreFilePath(path, cwd) {
 	return isAbsolute(path) ? path : resolve(cwd, path);
 }
 /**
+* Check whether a directory looks like a git repo root.
+*
+* A `.git` entry can be either a directory (regular repo) or a file (worktree/submodule).
+*
+* @param dir - Directory to inspect.
+* @returns True when `.git` exists under the directory.
+*/
+async function hasGitEntry(dir) {
+	try {
+		await stat(join(dir, ".git"));
+		return true;
+	} catch (error) {
+		const code = error.code;
+		if (code === "ENOENT" || code === "ENOTDIR") return false;
+		throw error;
+	}
+}
+/**
+* Find the nearest git repo root by walking up from a start directory.
+*
+* @param fromDir - Directory to start from.
+* @returns Repo root directory, or undefined when no git boundary is found.
+*/
+async function findGitRepoRoot(fromDir) {
+	let current = fromDir;
+	while (true) {
+		if (await hasGitEntry(current)) return current;
+		const parent = dirname(current);
+		if (parent === current) return;
+		current = parent;
+	}
+}
+/**
+* Collect `.gitignore` files from file directory up to git repo boundary.
+*
+* @param filepath - Absolute file path to test.
+* @returns Collected ignore files and repo root when found.
+*/
+async function collectGitignorePaths(filepath) {
+	const fileDir = dirname(filepath);
+	const repoRoot = await findGitRepoRoot(fileDir);
+	const paths = [];
+	let current = fileDir;
+	while (true) {
+		paths.push(join(current, ".gitignore"));
+		if (repoRoot && current === repoRoot) break;
+		const parent = dirname(current);
+		if (parent === current) break;
+		current = parent;
+	}
+	return {
+		paths,
+		repoRoot
+	};
+}
+/**
 * Match `ignorePatterns` from config with support for negated patterns.
 *
 * @param filepath - Absolute file path.
@@ -575,12 +628,25 @@ async function isOxfmtIgnored(options) {
 			ignored: true,
 			reason: "ignore-path"
 		};
-	} else for (const ignoreFile of DEFAULT_IGNORE_FILES) if (await matchIgnoreFile(filepath, resolve(cwd, ignoreFile), useCache)) return {
-		ignored: true,
-		reason: ignoreFile === ".gitignore" ? "gitignore" : "prettierignore"
-	};
+	} else {
+		const { paths: gitignorePaths, repoRoot } = await collectGitignorePaths(filepath);
+		for (const ignorePath of gitignorePaths) if (await matchIgnoreFile(filepath, ignorePath, useCache)) return {
+			ignored: true,
+			reason: "gitignore"
+		};
+		if (repoRoot) {
+			if (await matchIgnoreFile(filepath, join(repoRoot, ".git", "info", "exclude"), useCache, repoRoot)) return {
+				ignored: true,
+				reason: "git-info-exclude"
+			};
+		}
+		if (await matchIgnoreFile(filepath, resolve(cwd, ".prettierignore"), useCache)) return {
+			ignored: true,
+			reason: "prettierignore"
+		};
+	}
 	if (!loadConfigForIgnorePatterns) return { ignored: false };
-	const configResult = await loadOxfmtConfigResult({
+	const configResult = await loadOxfmtConfig({
 		cwd: options.configPath || options.disableNestedConfig ? cwd : dirname(filepath),
 		...options.configPath ? { configPath: options.configPath } : {},
 		editorconfig: false,
@@ -593,27 +659,4 @@ async function isOxfmtIgnored(options) {
 	return { ignored: false };
 }
 //#endregion
-//#region src/legacy.ts
-/**
-* Legacy API that returns only the merged config object.
-*
-* Prefer using `loadOxfmtConfigResult` when you also need resolved config metadata.
-*
-* @deprecated Prefer `loadOxfmtConfigResult`.
-*
-* @param options - Loader options.
-* @returns Parsed and merged oxfmt options.
-*
-* @example
-* ```ts
-* import { loadOxfmtConfig } from 'load-oxfmt-config'
-*
-* // Deprecated: prefer loadOxfmtConfigResult.
-* const config = await loadOxfmtConfig({ cwd: process.cwd() })
-* ```
-*/
-async function loadOxfmtConfig(options = {}) {
-	return (await loadOxfmtConfigResult(options)).config;
-}
-//#endregion
-export { isOxfmtIgnored, loadOxfmtConfig, loadOxfmtConfigResult, resolveOxfmtrcPath };
+export { isOxfmtIgnored, loadOxfmtConfig, resolveOxfmtrcPath };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "load-oxfmt-config",
-  "version": "0.7.2",
+  "version": "0.8.0",
   "description": "Load oxfmt config files and merge supported .editorconfig options.",
   "keywords": [
     "editorconfig",
@@ -48,20 +48,20 @@
   },
   "devDependencies": {
     "@ntnyq/tsconfig": "^3.1.0",
-    "@types/node": "^25.6.2",
+    "@types/node": "^25.7.0",
     "@types/picomatch": "^4.0.3",
-    "@typescript/native-preview": "^7.0.0-dev.20260508.1",
+    "@typescript/native-preview": "^7.0.0-dev.20260511.1",
     "bumpp": "^11.1.0",
     "husky": "^9.1.7",
     "nano-staged": "^1.0.2",
     "npm-run-all2": "^8.0.4",
-    "oxfmt": "^0.48.0",
-    "oxlint": "^1.63.0",
+    "oxfmt": "^0.49.0",
+    "oxlint": "^1.64.0",
     "tsdown": "^0.22.0",
-    "vitest": "^4.1.5"
+    "vitest": "^4.1.6"
   },
   "peerDependencies": {
-    "oxfmt": ">=0.41.0"
+    "oxfmt": ">=0.49.0"
   },
   "nano-staged": {
     "*.{js,ts,mjs,tsx}": "oxlint --fix",