load-oxfmt-config 0.5.0 → 0.6.0

package/README.md

@@ -191,66 +191,77 @@ Load and parse oxfmt configuration files, then merge supported `.editorconfig` f
 
 **Parameters:**
 
-- `options` - Optional configuration object
+- `options` - Optional configuration object (`Options`)
 
-**Returns:** `Promise<OxfmtOptions>` - Parsed and merged oxfmt configuration object. Returns empty object `{}` if no supported config file is found.
+Option fields:
 
-### `loadOxfmtConfigResult(options?)`
+#### `cwd`
 
-Load and parse oxfmt configuration files, merge supported `.editorconfig` fields, and return metadata for the resolved config file.
+- **Type:** `string`
+- **Default:** `process.cwd()`
 
-**Parameters:**
+Current working directory to start searching for config files. The loader will walk up from this directory to find a config file.
 
-- `options` - Optional configuration object (same as `loadOxfmtConfig`)
+#### `configPath`
 
-**Returns:** `Promise<LoadOxfmtConfigResult>`
+- **Type:** `string`
+- **Default:** `undefined`
 
-- `config` - Parsed and merged oxfmt configuration object
-- `filepath` - Resolved config absolute path (undefined when not found)
-- `dirname` - Config directory (undefined when not found)
+Explicit path to the config file:
 
-**Throws:** Error if config file exists but cannot be parsed.
+- **Relative path:** Resolved relative to `cwd`
+- **Absolute path:** Used as-is
+- **When provided:** Skips auto-discovery and uses this path directly
 
-### `resolveOxfmtrcPath(cwd, configPath?)`
+#### `useCache`
 
-Resolve the absolute path to oxfmt config file.
+- **Type:** `boolean`
+- **Default:** `true`
 
-**Parameters:**
+Enable in-memory caching for both path resolution and parsed config contents. When enabled:
 
-- `cwd` - Starting directory for resolution
-- `configPath` - Optional explicit path (absolute or relative to cwd)
+- 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
 
-**Returns:** `Promise<string | undefined>` - Absolute path to config file, or `undefined` if not found.
+Set to `false` to force reload from disk on every call.
 
-### `isOxfmtIgnored(options)`
+#### `editorconfig`
 
-Resolve whether a file should be ignored with oxfmt CLI-like semantics.
+- **Type:** `boolean | EditorconfigOption`
+- **Default:** `true`
 
-**Returns:** `Promise<IsOxfmtIgnoredResult>`
+Control how `.editorconfig` files are read and merged:
 
-`ignorePath` accepts either a single path (`string`) or multiple paths (`string[]`).
+- **`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:
 
-- `ignored` - Whether the file is ignored
-- `reason` - One of:
-  - `default-dir`
-  - `lockfile`
-  - `gitignore`
-  - `prettierignore`
-  - `ignore-path`
-  - `config-ignore-patterns`
+| 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:**
 
-## Options
+- `options` - Optional configuration object (`Options`)
 
-All options are optional.
+Option fields:
 
-### `cwd`
+#### `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`
+#### `configPath`
 
 - **Type:** `string`
 - **Default:** `undefined`
@@ -261,7 +272,7 @@ Explicit path to the config file:
 - **Absolute path:** Used as-is
 - **When provided:** Skips auto-discovery and uses this path directly
 
-### `useCache`
+#### `useCache`
 
 - **Type:** `boolean`
 - **Default:** `true`
@@ -274,7 +285,7 @@ Enable in-memory caching for both path resolution and parsed config contents. Wh
 
 Set to `false` to force reload from disk on every call.
 
-### `editorconfig`
+#### `editorconfig`
 
 - **Type:** `boolean | EditorconfigOption`
 - **Default:** `true`
@@ -290,6 +301,105 @@ Control how `.editorconfig` files are read and merged:
 | `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<LoadOxfmtConfigResult>`
+
+- `config` - Parsed and merged oxfmt configuration object
+- `filepath` - Resolved config absolute path (undefined when not found)
+- `dirname` - Config directory (undefined when not found)
+
+**Throws:** Error if config file exists but cannot be parsed.
+
+### `resolveOxfmtrcPath(cwd, configPath?)`
+
+Resolve the absolute path to oxfmt config file.
+
+**Parameters:**
+
+- `cwd` - Starting directory for resolution
+- `configPath` - Optional explicit path (absolute or relative to cwd)
+
+**Returns:** `Promise<string | undefined>` - Absolute path to config file, or `undefined` if not found.
+
+### `isOxfmtIgnored(options)`
+
+Resolve whether a file should be ignored with oxfmt CLI-like semantics.
+
+**Parameters:**
+
+- `options` - Required configuration object (`IsOxfmtIgnoredOptions`)
+
+Option fields:
+
+#### `cwd`
+
+- **Type:** `string`
+- **Default:** `process.cwd()`
+
+Current working directory.
+Also the base directory for default `.gitignore`/`.prettierignore` lookup.
+
+#### `filepath`
+
+- **Type:** `string`
+- **Default:** required
+
+File path to test.
+
+#### `configPath`
+
+- **Type:** `string`
+- **Default:** `undefined`
+
+Explicit oxfmt config path.
+When provided, nested config lookup is disabled (same as oxfmt CLI `-c`).
+
+#### `ignorePath`
+
+- **Type:** `string | string[]`
+- **Default:** `undefined`
+
+Ignore files to use instead of cwd `.gitignore`/`.prettierignore`.
+Can be passed multiple times in CLI style.
+
+#### `withNodeModules`
+
+- **Type:** `boolean`
+- **Default:** `true`
+
+Whether `node_modules` should be included.
+
+#### `disableNestedConfig`
+
+- **Type:** `boolean`
+- **Default:** `false`
+
+Disable nested config lookup.
+
+#### `useCache`
+
+- **Type:** `boolean`
+- **Default:** `true`
+
+Whether to use in-memory cache.
+
+#### `includeConfigIgnorePatterns`
+
+- **Type:** `boolean`
+- **Default:** `true`
+
+Whether to include ignore patterns defined in the resolved config file.
+
+**Returns:** `Promise<IsOxfmtIgnoredResult>`
+
+- `ignored` - Whether the file is ignored
+- `reason` - One of:
+  - `default-dir`
+  - `lockfile`
+  - `gitignore`
+  - `prettierignore`
+  - `ignore-path`
+  - `config-ignore-patterns`
+
 ## Config File Discovery
 
 When `configPath` is not provided, the loader automatically searches for config files:
@@ -368,6 +478,8 @@ Only `[*]` is treated as a global section to match oxfmt. Other sections such as
 1. Global ignore
 2. Ignore patterns from the resolved oxfmt config (`ignorePatterns`)
 
+Set `includeConfigIgnorePatterns: false` to keep only global ignore behavior (skip config `ignorePatterns`).
+
 Global ignore includes:
 
 - Default ignored directories: `.git`, `.svn`, `.jj`, `node_modules`
@@ -382,6 +494,7 @@ Notes:
 - 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.
 - Nested config behavior follows oxfmt semantics:
   - default: nearest config from target file directory upward
   - `disableNestedConfig: true`: resolve from `cwd` only

package/dist/index.d.mts

@@ -119,16 +119,24 @@ interface IsOxfmtIgnoredOptions {
   ignorePath?: string | string[];
   /**
    * Whether node_modules should be included.
+   * @default true
    */
   withNodeModules?: boolean;
   /**
    * Disable nested config lookup.
+   * @default false
    */
   disableNestedConfig?: boolean;
   /**
    * Whether to use in-memory cache.
+   * @default true
    */
   useCache?: boolean;
+  /**
+   * Whether to include ignore patterns defined in the config file.
+   * @default true
+   */
+  includeConfigIgnorePatterns?: boolean;
 }
 /**
  * Ignore resolution result.

package/dist/index.mjs

@@ -554,6 +554,7 @@ function matchConfigIgnorePatterns(filepath, configDir, patterns) {
 */
 async function isOxfmtIgnored(options) {
 	const useCache = options.useCache !== false;
+	const includeConfigIgnorePatterns = options.includeConfigIgnorePatterns !== false;
 	const cwd = resolve(options.cwd ?? process.cwd());
 	const filepath = isAbsolute(options.filepath) ? resolve(options.filepath) : resolve(cwd, options.filepath);
 	if (isDefaultIgnoredDir(filepath, options.withNodeModules ? { withNodeModules: true } : {})) return {
@@ -580,7 +581,7 @@ async function isOxfmtIgnored(options) {
 		editorconfig: false,
 		useCache
 	});
-	if (configResult.dirname && configResult.config.ignorePatterns && configResult.config.ignorePatterns.length > 0 && matchConfigIgnorePatterns(filepath, configResult.dirname, configResult.config.ignorePatterns)) return {
+	if (includeConfigIgnorePatterns && configResult.dirname && configResult.config.ignorePatterns && configResult.config.ignorePatterns.length > 0 && matchConfigIgnorePatterns(filepath, configResult.dirname, configResult.config.ignorePatterns)) return {
 		ignored: true,
 		reason: "config-ignore-patterns"
 	};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "load-oxfmt-config",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Load oxfmt config files and merge supported .editorconfig options.",
   "keywords": [
     "editorconfig",