load-oxfmt-config 0.7.0 → 0.7.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -3
- package/dist/index.d.mts +9 -5
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -191,7 +191,7 @@ Load and parse oxfmt configuration files, then merge supported `.editorconfig` f
|
|
|
191
191
|
|
|
192
192
|
**Parameters:**
|
|
193
193
|
|
|
194
|
-
- `options` - Optional configuration object (`
|
|
194
|
+
- `options` - Optional configuration object (`LoadOxfmtConfigOptions`)
|
|
195
195
|
|
|
196
196
|
Option fields:
|
|
197
197
|
|
|
@@ -250,7 +250,7 @@ Load and parse oxfmt configuration files, merge supported `.editorconfig` fields
|
|
|
250
250
|
|
|
251
251
|
**Parameters:**
|
|
252
252
|
|
|
253
|
-
- `options` - Optional configuration object (`
|
|
253
|
+
- `options` - Optional configuration object (`LoadOxfmtConfigOptions`)
|
|
254
254
|
|
|
255
255
|
Option fields:
|
|
256
256
|
|
|
@@ -364,7 +364,7 @@ Can be passed multiple times in CLI style.
|
|
|
364
364
|
#### `withNodeModules`
|
|
365
365
|
|
|
366
366
|
- **Type:** `boolean`
|
|
367
|
-
- **Default:** `
|
|
367
|
+
- **Default:** `false`
|
|
368
368
|
|
|
369
369
|
Whether `node_modules` should be included.
|
|
370
370
|
|
|
@@ -500,6 +500,10 @@ Global ignore includes:
|
|
|
500
500
|
Notes:
|
|
501
501
|
|
|
502
502
|
- `node_modules` can be included by passing `withNodeModules: true`.
|
|
503
|
+
|
|
504
|
+
Type compatibility note:
|
|
505
|
+
|
|
506
|
+
- `Options` is still exported as a deprecated alias of `LoadOxfmtConfigOptions`.
|
|
503
507
|
- This package does not read parent `.gitignore` files or global gitignore settings.
|
|
504
508
|
- 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.
|
|
505
509
|
- `ignorePatterns` are always interpreted relative to the resolved oxfmt config directory.
|
package/dist/index.d.mts
CHANGED
|
@@ -39,7 +39,7 @@ interface OxfmtConfigOverride {
|
|
|
39
39
|
*/
|
|
40
40
|
options?: FormatConfig;
|
|
41
41
|
}
|
|
42
|
-
interface
|
|
42
|
+
interface LoadOxfmtConfigOptions {
|
|
43
43
|
/**
|
|
44
44
|
* Path to the configuration file
|
|
45
45
|
*/
|
|
@@ -119,7 +119,7 @@ interface IsOxfmtIgnoredOptions {
|
|
|
119
119
|
ignorePath?: string | string[];
|
|
120
120
|
/**
|
|
121
121
|
* Whether node_modules should be included.
|
|
122
|
-
* @default
|
|
122
|
+
* @default false
|
|
123
123
|
*/
|
|
124
124
|
withNodeModules?: boolean;
|
|
125
125
|
/**
|
|
@@ -161,6 +161,10 @@ interface IsOxfmtIgnoredResult {
|
|
|
161
161
|
* @deprecated Use `OxfmtConfigOverride` instead
|
|
162
162
|
*/
|
|
163
163
|
type FormatOptionOverride = OxfmtConfigOverride;
|
|
164
|
+
/**
|
|
165
|
+
* @deprecated Use `LoadOxfmtConfigOptions` instead.
|
|
166
|
+
*/
|
|
167
|
+
type Options = LoadOxfmtConfigOptions;
|
|
164
168
|
//#endregion
|
|
165
169
|
//#region src/config-file.d.ts
|
|
166
170
|
/**
|
|
@@ -198,7 +202,7 @@ declare function resolveOxfmtrcPath(cwd: string, configPath?: string): Promise<s
|
|
|
198
202
|
* console.log(result.config)
|
|
199
203
|
* ```
|
|
200
204
|
*/
|
|
201
|
-
declare function loadOxfmtConfigResult(options?:
|
|
205
|
+
declare function loadOxfmtConfigResult(options?: LoadOxfmtConfigOptions): Promise<LoadOxfmtConfigResult>;
|
|
202
206
|
//#endregion
|
|
203
207
|
//#region src/ignore.d.ts
|
|
204
208
|
/**
|
|
@@ -238,6 +242,6 @@ declare function isOxfmtIgnored(options: IsOxfmtIgnoredOptions): Promise<IsOxfmt
|
|
|
238
242
|
* const config = await loadOxfmtConfig({ cwd: process.cwd() })
|
|
239
243
|
* ```
|
|
240
244
|
*/
|
|
241
|
-
declare function loadOxfmtConfig(options?:
|
|
245
|
+
declare function loadOxfmtConfig(options?: LoadOxfmtConfigOptions): Promise<OxfmtOptions>;
|
|
242
246
|
//#endregion
|
|
243
|
-
export { EditorconfigOption, FormatOptionOverride, IsOxfmtIgnoredOptions, IsOxfmtIgnoredResult, LoadOxfmtConfigResult, Options, OxfmtConfigOverride, OxfmtOptions, isOxfmtIgnored, loadOxfmtConfig, loadOxfmtConfigResult, resolveOxfmtrcPath };
|
|
247
|
+
export { EditorconfigOption, FormatOptionOverride, IsOxfmtIgnoredOptions, IsOxfmtIgnoredResult, LoadOxfmtConfigOptions, LoadOxfmtConfigResult, Options, OxfmtConfigOverride, OxfmtOptions, isOxfmtIgnored, loadOxfmtConfig, loadOxfmtConfigResult, resolveOxfmtrcPath };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "load-oxfmt-config",
|
|
3
|
-
"version": "0.7.
|
|
3
|
+
"version": "0.7.1",
|
|
4
4
|
"description": "Load oxfmt config files and merge supported .editorconfig options.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"editorconfig",
|
|
@@ -48,16 +48,16 @@
|
|
|
48
48
|
},
|
|
49
49
|
"devDependencies": {
|
|
50
50
|
"@ntnyq/tsconfig": "^3.1.0",
|
|
51
|
-
"@types/node": "^25.6.
|
|
51
|
+
"@types/node": "^25.6.2",
|
|
52
52
|
"@types/picomatch": "^4.0.3",
|
|
53
|
-
"@typescript/native-preview": "^7.0.0-dev.
|
|
54
|
-
"bumpp": "^11.0
|
|
53
|
+
"@typescript/native-preview": "^7.0.0-dev.20260507.1",
|
|
54
|
+
"bumpp": "^11.1.0",
|
|
55
55
|
"husky": "^9.1.7",
|
|
56
56
|
"nano-staged": "^1.0.2",
|
|
57
57
|
"npm-run-all2": "^8.0.4",
|
|
58
58
|
"oxfmt": "^0.48.0",
|
|
59
59
|
"oxlint": "^1.63.0",
|
|
60
|
-
"tsdown": "^0.
|
|
60
|
+
"tsdown": "^0.22.0",
|
|
61
61
|
"vitest": "^4.1.5"
|
|
62
62
|
},
|
|
63
63
|
"peerDependencies": {
|