Skip to content

Commit 45d00f4

Browse files
committed
upgrade deps && docs [skip ci]
1 parent 9afc574 commit 45d00f4

24 files changed

+284
-217
lines changed

docs/cli.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ nav_order: 2
1212

1313
> **findGitRoot**(): `string`
1414
15-
Defined in: [cli.ts:15](https://github.com/react18-tools/git-json-resolver/blob/c32c446f3456c8b10ea1a76708d6e28d4435684a/lib/src/cli.ts#L15)
15+
Defined in: [cli.ts:15](https://github.com/react18-tools/git-json-resolver/blob/9afc574ba0e78c5147c107dece96697303cc4a06/lib/src/cli.ts#L15)
1616

1717
Find Git root directory
1818

@@ -26,7 +26,7 @@ Find Git root directory
2626

2727
> **initConfig**(`targetDir`: `string`): `void`
2828
29-
Defined in: [cli.ts:45](https://github.com/react18-tools/git-json-resolver/blob/c32c446f3456c8b10ea1a76708d6e28d4435684a/lib/src/cli.ts#L45)
29+
Defined in: [cli.ts:45](https://github.com/react18-tools/git-json-resolver/blob/9afc574ba0e78c5147c107dece96697303cc4a06/lib/src/cli.ts#L45)
3030

3131
Write a starter config file
3232

@@ -46,7 +46,7 @@ Write a starter config file
4646

4747
> **loadConfigFile**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`Config`](types/README.md#config)\<[`InbuiltMergeStrategies`](types/README.md#inbuiltmergestrategies), `unknown`\>\>\>
4848
49-
Defined in: [cli.ts:26](https://github.com/react18-tools/git-json-resolver/blob/c32c446f3456c8b10ea1a76708d6e28d4435684a/lib/src/cli.ts#L26)
49+
Defined in: [cli.ts:26](https://github.com/react18-tools/git-json-resolver/blob/9afc574ba0e78c5147c107dece96697303cc4a06/lib/src/cli.ts#L26)
5050

5151
Load configuration file (js/ts) from current dir or Git root.
5252

@@ -60,7 +60,7 @@ Load configuration file (js/ts) from current dir or Git root.
6060

6161
> **parseArgs**(`argv`: `string`[]): \{ `init?`: `boolean`; `overrides`: [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`Config`](types/README.md#config)\>; \}
6262
63-
Defined in: [cli.ts:66](https://github.com/react18-tools/git-json-resolver/blob/c32c446f3456c8b10ea1a76708d6e28d4435684a/lib/src/cli.ts#L66)
63+
Defined in: [cli.ts:66](https://github.com/react18-tools/git-json-resolver/blob/9afc574ba0e78c5147c107dece96697303cc4a06/lib/src/cli.ts#L66)
6464

6565
CLI argument parser (minimal, no external deps).
6666

docs/conflict-helper.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ nav_order: 4
1212

1313
> **reconstructConflict**(`merged`: `any`, `ours`: `any`, `theirs`: `any`, `format`: `string`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\>
1414
15-
Defined in: [conflict-helper.ts:31](https://github.com/react18-tools/git-json-resolver/blob/c32c446f3456c8b10ea1a76708d6e28d4435684a/lib/src/conflict-helper.ts#L31)
15+
Defined in: [conflict-helper.ts:31](https://github.com/react18-tools/git-json-resolver/blob/9afc574ba0e78c5147c107dece96697303cc4a06/lib/src/conflict-helper.ts#L31)
1616

1717
Build conflict markers into serialized string
1818

docs/file-parser.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ nav_order: 6
1010

1111
### ParseConflictOptions
1212

13-
Defined in: [file-parser.ts:24](https://github.com/react18-tools/git-json-resolver/blob/c32c446f3456c8b10ea1a76708d6e28d4435684a/lib/src/file-parser.ts#L24)
13+
Defined in: [file-parser.ts:24](https://github.com/react18-tools/git-json-resolver/blob/9afc574ba0e78c5147c107dece96697303cc4a06/lib/src/file-parser.ts#L24)
1414

1515
Options for parsing conflicted content.
1616

@@ -20,7 +20,7 @@ Options for parsing conflicted content.
2020

2121
> `optional` **filename**: `string`
2222
23-
Defined in: [file-parser.ts:42](https://github.com/react18-tools/git-json-resolver/blob/c32c446f3456c8b10ea1a76708d6e28d4435684a/lib/src/file-parser.ts#L42)
23+
Defined in: [file-parser.ts:42](https://github.com/react18-tools/git-json-resolver/blob/9afc574ba0e78c5147c107dece96697303cc4a06/lib/src/file-parser.ts#L42)
2424

2525
Optional filename hint to prioritize parser choice.
2626
Example:
@@ -34,7 +34,7 @@ If extension is unknown, falls back to `parsers` or `"json"`.
3434

3535
> `optional` **parsers**: [`SupportedParsers`](#supportedparsers) \| `"auto"` \| [`SupportedParsers`](#supportedparsers)[]
3636
37-
Defined in: [file-parser.ts:32](https://github.com/react18-tools/git-json-resolver/blob/c32c446f3456c8b10ea1a76708d6e28d4435684a/lib/src/file-parser.ts#L32)
37+
Defined in: [file-parser.ts:32](https://github.com/react18-tools/git-json-resolver/blob/9afc574ba0e78c5147c107dece96697303cc4a06/lib/src/file-parser.ts#L32)
3838

3939
Parsers to attempt, in order:
4040

@@ -47,7 +47,7 @@ Defaults to `"json"`.
4747

4848
### ParsedConflict\<T\>
4949

50-
Defined in: [file-parser.ts:6](https://github.com/react18-tools/git-json-resolver/blob/c32c446f3456c8b10ea1a76708d6e28d4435684a/lib/src/file-parser.ts#L6)
50+
Defined in: [file-parser.ts:6](https://github.com/react18-tools/git-json-resolver/blob/9afc574ba0e78c5147c107dece96697303cc4a06/lib/src/file-parser.ts#L6)
5151

5252
Represents a parsed conflict from a file with `ours` and `theirs` versions.
5353

@@ -65,23 +65,23 @@ The type of the parsed content.
6565

6666
> **format**: `string`
6767
68-
Defined in: [file-parser.ts:12](https://github.com/react18-tools/git-json-resolver/blob/c32c446f3456c8b10ea1a76708d6e28d4435684a/lib/src/file-parser.ts#L12)
68+
Defined in: [file-parser.ts:12](https://github.com/react18-tools/git-json-resolver/blob/9afc574ba0e78c5147c107dece96697303cc4a06/lib/src/file-parser.ts#L12)
6969

7070
Format used to parse the content (`json`, `yaml`, `toml`, `xml`, or `custom`).
7171

7272
##### ours
7373

7474
> **ours**: `T`
7575
76-
Defined in: [file-parser.ts:8](https://github.com/react18-tools/git-json-resolver/blob/c32c446f3456c8b10ea1a76708d6e28d4435684a/lib/src/file-parser.ts#L8)
76+
Defined in: [file-parser.ts:8](https://github.com/react18-tools/git-json-resolver/blob/9afc574ba0e78c5147c107dece96697303cc4a06/lib/src/file-parser.ts#L8)
7777

7878
Parsed content from the "ours" side of the conflict.
7979

8080
##### theirs
8181

8282
> **theirs**: `T`
8383
84-
Defined in: [file-parser.ts:10](https://github.com/react18-tools/git-json-resolver/blob/c32c446f3456c8b10ea1a76708d6e28d4435684a/lib/src/file-parser.ts#L10)
84+
Defined in: [file-parser.ts:10](https://github.com/react18-tools/git-json-resolver/blob/9afc574ba0e78c5147c107dece96697303cc4a06/lib/src/file-parser.ts#L10)
8585

8686
Parsed content from the "theirs" side of the conflict.
8787

@@ -91,7 +91,7 @@ Parsed content from the "theirs" side of the conflict.
9191

9292
> **Parser** = \{ `name`: `string`; `parser`: (`input`: `string`) => `unknown`; \}
9393
94-
Defined in: [file-parser.ts:16](https://github.com/react18-tools/git-json-resolver/blob/c32c446f3456c8b10ea1a76708d6e28d4435684a/lib/src/file-parser.ts#L16)
94+
Defined in: [file-parser.ts:16](https://github.com/react18-tools/git-json-resolver/blob/9afc574ba0e78c5147c107dece96697303cc4a06/lib/src/file-parser.ts#L16)
9595

9696
A parser function that takes a raw string and returns parsed content.
9797

@@ -101,13 +101,13 @@ A parser function that takes a raw string and returns parsed content.
101101

102102
> **name**: `string`
103103
104-
Defined in: [file-parser.ts:16](https://github.com/react18-tools/git-json-resolver/blob/c32c446f3456c8b10ea1a76708d6e28d4435684a/lib/src/file-parser.ts#L16)
104+
Defined in: [file-parser.ts:16](https://github.com/react18-tools/git-json-resolver/blob/9afc574ba0e78c5147c107dece96697303cc4a06/lib/src/file-parser.ts#L16)
105105

106106
##### parser()
107107

108108
> **parser**: (`input`: `string`) => `unknown`
109109
110-
Defined in: [file-parser.ts:16](https://github.com/react18-tools/git-json-resolver/blob/c32c446f3456c8b10ea1a76708d6e28d4435684a/lib/src/file-parser.ts#L16)
110+
Defined in: [file-parser.ts:16](https://github.com/react18-tools/git-json-resolver/blob/9afc574ba0e78c5147c107dece96697303cc4a06/lib/src/file-parser.ts#L16)
111111

112112
###### Parameters
113113

@@ -125,7 +125,7 @@ Defined in: [file-parser.ts:16](https://github.com/react18-tools/git-json-resolv
125125

126126
> **SupportedParsers** = `"json"` \| `"json5"` \| `"yaml"` \| `"toml"` \| `"xml"` \| [`Parser`](#parser)
127127
128-
Defined in: [file-parser.ts:19](https://github.com/react18-tools/git-json-resolver/blob/c32c446f3456c8b10ea1a76708d6e28d4435684a/lib/src/file-parser.ts#L19)
128+
Defined in: [file-parser.ts:19](https://github.com/react18-tools/git-json-resolver/blob/9afc574ba0e78c5147c107dece96697303cc4a06/lib/src/file-parser.ts#L19)
129129

130130
Built-in parser identifiers or a custom parser function.
131131

@@ -135,7 +135,7 @@ Built-in parser identifiers or a custom parser function.
135135

136136
> **parseConflictContent**\<`T`\>(`content`: `string`, `options`: [`ParseConflictOptions`](#parseconflictoptions)): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`ParsedConflict`](#parsedconflict)\<`T`\>\>
137137
138-
Defined in: [file-parser.ts:62](https://github.com/react18-tools/git-json-resolver/blob/c32c446f3456c8b10ea1a76708d6e28d4435684a/lib/src/file-parser.ts#L62)
138+
Defined in: [file-parser.ts:62](https://github.com/react18-tools/git-json-resolver/blob/9afc574ba0e78c5147c107dece96697303cc4a06/lib/src/file-parser.ts#L62)
139139

140140
Parses a conflicted file's content into separate `ours` and `theirs` objects.
141141

docs/file-serializer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ nav_order: 8
1212

1313
> **serialize**(`format`: `string`, `value`: `unknown`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\>
1414
15-
Defined in: [file-serializer.ts:1](https://github.com/react18-tools/git-json-resolver/blob/c32c446f3456c8b10ea1a76708d6e28d4435684a/lib/src/file-serializer.ts#L1)
15+
Defined in: [file-serializer.ts:1](https://github.com/react18-tools/git-json-resolver/blob/9afc574ba0e78c5147c107dece96697303cc4a06/lib/src/file-serializer.ts#L1)
1616

1717
#### Parameters
1818

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ This library is licensed under the MPL-2.0 open-source license.
160160
- [file-serializer](file-serializer.md)
161161
- [file-serializer.test](file-serializer.test.md)
162162
- [index](index.md)
163-
- [logger](logger/README.md)
163+
- [logger](logger.md)
164164
- [matcher](matcher.md)
165165
- [matcher.test](matcher.test.md)
166166
- [merger](merger/README.md)

docs/logger/README.md renamed to docs/logger.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,18 @@
11
---
22
layout: default
3-
title: README
4-
parent: Logger
5-
nav_order: 21
3+
title: Logger
4+
nav_order: 10
65
---
76

87
# logger
98

10-
## Modules
11-
12-
- [\<internal\>](-internal-.md)
13-
149
## Variables
1510

1611
### globalLogger
1712

1813
> `const` **globalLogger**: \{ `debug`: (`fileId`: `string`, `msg`: `string`) => `void`; `error`: (`fileId`: `string`, `msg`: `string`) => `void`; `flush`: () => `void`; `info`: (`fileId`: `string`, `msg`: `string`) => `void`; `warn`: (`fileId`: `string`, `msg`: `string`) => `void`; \}
1914
20-
Defined in: [logger.ts:91](https://github.com/react18-tools/git-json-resolver/blob/c32c446f3456c8b10ea1a76708d6e28d4435684a/lib/src/logger.ts#L91)
15+
Defined in: [logger.ts:78](https://github.com/react18-tools/git-json-resolver/blob/9afc574ba0e78c5147c107dece96697303cc4a06/lib/src/logger.ts#L78)
2116

2217
#### Type Declaration
2318

@@ -105,15 +100,15 @@ Defined in: [logger.ts:91](https://github.com/react18-tools/git-json-resolver/bl
105100

106101
### createLogger()
107102

108-
> **createLogger**(`config`: [`LoggerConfig`](-internal-.md#loggerconfig)): \{ `debug`: (`fileId`: `string`, `msg`: `string`) => `void`; `error`: (`fileId`: `string`, `msg`: `string`) => `void`; `flush`: () => `void`; `info`: (`fileId`: `string`, `msg`: `string`) => `void`; `warn`: (`fileId`: `string`, `msg`: `string`) => `void`; \}
103+
> **createLogger**(`config`: [`LoggerConfig`](types/README.md#loggerconfig-1)): \{ `debug`: (`fileId`: `string`, `msg`: `string`) => `void`; `error`: (`fileId`: `string`, `msg`: `string`) => `void`; `flush`: () => `void`; `info`: (`fileId`: `string`, `msg`: `string`) => `void`; `warn`: (`fileId`: `string`, `msg`: `string`) => `void`; \}
109104
110-
Defined in: [logger.ts:24](https://github.com/react18-tools/git-json-resolver/blob/c32c446f3456c8b10ea1a76708d6e28d4435684a/lib/src/logger.ts#L24)
105+
Defined in: [logger.ts:11](https://github.com/react18-tools/git-json-resolver/blob/9afc574ba0e78c5147c107dece96697303cc4a06/lib/src/logger.ts#L11)
111106

112107
#### Parameters
113108

114109
##### config
115110

116-
[`LoggerConfig`](-internal-.md#loggerconfig) = `{}`
111+
[`LoggerConfig`](types/README.md#loggerconfig-1) = `{}`
117112

118113
#### Returns
119114

docs/logger/-internal-.md

Lines changed: 0 additions & 64 deletions
This file was deleted.

docs/logger/index.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/matcher.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: default
33
title: Matcher
4-
nav_order: 10
4+
nav_order: 11
55
---
66

77
# matcher
@@ -10,7 +10,7 @@ nav_order: 10
1010

1111
### Matcher
1212

13-
Defined in: [matcher.ts:13](https://github.com/react18-tools/git-json-resolver/blob/c32c446f3456c8b10ea1a76708d6e28d4435684a/lib/src/matcher.ts#L13)
13+
Defined in: [matcher.ts:13](https://github.com/react18-tools/git-json-resolver/blob/9afc574ba0e78c5147c107dece96697303cc4a06/lib/src/matcher.ts#L13)
1414

1515
Matcher abstraction + adapters for micromatch/picomatch (optional).
1616

@@ -29,7 +29,7 @@ Micromatch/Picomatch can be loaded at runtime as optional peers.
2929

3030
> **isMatch**: (`str`: `string`, `patterns`: `string`[]) => `boolean`
3131
32-
Defined in: [matcher.ts:17](https://github.com/react18-tools/git-json-resolver/blob/c32c446f3456c8b10ea1a76708d6e28d4435684a/lib/src/matcher.ts#L17)
32+
Defined in: [matcher.ts:17](https://github.com/react18-tools/git-json-resolver/blob/9afc574ba0e78c5147c107dece96697303cc4a06/lib/src/matcher.ts#L17)
3333

3434
Returns true if `str` matches at least one of the provided glob `patterns`.
3535

@@ -53,7 +53,7 @@ Returns true if `str` matches at least one of the provided glob `patterns`.
5353

5454
> `const` **basicMatcher**: [`Matcher`](#matcher)
5555
56-
Defined in: [matcher.ts:28](https://github.com/react18-tools/git-json-resolver/blob/c32c446f3456c8b10ea1a76708d6e28d4435684a/lib/src/matcher.ts#L28)
56+
Defined in: [matcher.ts:28](https://github.com/react18-tools/git-json-resolver/blob/9afc574ba0e78c5147c107dece96697303cc4a06/lib/src/matcher.ts#L28)
5757

5858
Minimal homegrown matcher (default).
5959
Supports:
@@ -69,7 +69,7 @@ Supports:
6969

7070
> **loadMatcher**(`name`: `"micromatch"` \| `"picomatch"`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Matcher`](#matcher)\>
7171
72-
Defined in: [matcher.ts:41](https://github.com/react18-tools/git-json-resolver/blob/c32c446f3456c8b10ea1a76708d6e28d4435684a/lib/src/matcher.ts#L41)
72+
Defined in: [matcher.ts:41](https://github.com/react18-tools/git-json-resolver/blob/9afc574ba0e78c5147c107dece96697303cc4a06/lib/src/matcher.ts#L41)
7373

7474
Attempts to load a named matcher adapter.
7575

docs/matcher.test.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: default
33
title: Matcher.Test
4-
nav_order: 11
4+
nav_order: 12
55
---
66

77
# matcher.test

0 commit comments

Comments
 (0)