Skip to content

Commit 9b7eef9

Browse files
committed
upgrade deps && docs [skip ci]
1 parent b16e9f0 commit 9b7eef9

28 files changed

+227
-143
lines changed

docs/cli.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,79 @@ nav_order: 2
55
---
66

77
# cli
8+
9+
## Functions
10+
11+
### findGitRoot()
12+
13+
> **findGitRoot**(): `string`
14+
15+
Defined in: [cli.ts:15](https://github.com/react18-tools/git-json-resolver/blob/b16e9f00b0c7f0f44241518b44b07a7c1b0a0401/lib/src/cli.ts#L15)
16+
17+
Find Git root directory
18+
19+
#### Returns
20+
21+
`string`
22+
23+
---
24+
25+
### initConfig()
26+
27+
> **initConfig**(`targetDir`: `string`): `void`
28+
29+
Defined in: [cli.ts:45](https://github.com/react18-tools/git-json-resolver/blob/b16e9f00b0c7f0f44241518b44b07a7c1b0a0401/lib/src/cli.ts#L45)
30+
31+
Write a starter config file
32+
33+
#### Parameters
34+
35+
##### targetDir
36+
37+
`string`
38+
39+
#### Returns
40+
41+
`void`
42+
43+
---
44+
45+
### loadConfigFile()
46+
47+
> **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`\>\>\>
48+
49+
Defined in: [cli.ts:26](https://github.com/react18-tools/git-json-resolver/blob/b16e9f00b0c7f0f44241518b44b07a7c1b0a0401/lib/src/cli.ts#L26)
50+
51+
Load configuration file (js/ts) from current dir or Git root.
52+
53+
#### Returns
54+
55+
[`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`\>\>\>
56+
57+
---
58+
59+
### parseArgs()
60+
61+
> **parseArgs**(`argv`: `string`[]): \{ `init?`: `boolean`; `overrides`: [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`Config`](types/README.md#config)\>; \}
62+
63+
Defined in: [cli.ts:66](https://github.com/react18-tools/git-json-resolver/blob/b16e9f00b0c7f0f44241518b44b07a7c1b0a0401/lib/src/cli.ts#L66)
64+
65+
CLI argument parser (minimal, no external deps).
66+
67+
#### Parameters
68+
69+
##### argv
70+
71+
`string`[]
72+
73+
#### Returns
74+
75+
\{ `init?`: `boolean`; `overrides`: [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`Config`](types/README.md#config)\>; \}
76+
77+
##### init?
78+
79+
> `optional` **init**: `boolean`
80+
81+
##### overrides
82+
83+
> **overrides**: [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`Config`](types/README.md#config)\>

docs/cli.test.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
layout: default
3+
title: Cli.Test
4+
nav_order: 3
5+
---
6+
7+
# cli.test

docs/conflict-helper.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: default
33
title: Conflict Helper
4-
nav_order: 3
4+
nav_order: 4
55
---
66

77
# conflict-helper
@@ -12,7 +12,7 @@ nav_order: 3
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/983ecea05a6699ed0124b500e82e9f563b676c3f/lib/src/conflict-helper.ts#L31)
15+
Defined in: [conflict-helper.ts:31](https://github.com/react18-tools/git-json-resolver/blob/b16e9f00b0c7f0f44241518b44b07a7c1b0a0401/lib/src/conflict-helper.ts#L31)
1616

1717
Build conflict markers into serialized string
1818

docs/conflict-helper.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: Conflict Helper.Test
4-
nav_order: 4
4+
nav_order: 5
55
---
66

77
# conflict-helper.test

docs/file-parser.md

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

77
# file-parser
@@ -10,7 +10,7 @@ nav_order: 5
1010

1111
### ParseConflictOptions
1212

13-
Defined in: [file-parser.ts:24](https://github.com/react18-tools/git-json-resolver/blob/983ecea05a6699ed0124b500e82e9f563b676c3f/lib/src/file-parser.ts#L24)
13+
Defined in: [file-parser.ts:24](https://github.com/react18-tools/git-json-resolver/blob/b16e9f00b0c7f0f44241518b44b07a7c1b0a0401/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/983ecea05a6699ed0124b500e82e9f563b676c3f/lib/src/file-parser.ts#L42)
23+
Defined in: [file-parser.ts:42](https://github.com/react18-tools/git-json-resolver/blob/b16e9f00b0c7f0f44241518b44b07a7c1b0a0401/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/983ecea05a6699ed0124b500e82e9f563b676c3f/lib/src/file-parser.ts#L32)
37+
Defined in: [file-parser.ts:32](https://github.com/react18-tools/git-json-resolver/blob/b16e9f00b0c7f0f44241518b44b07a7c1b0a0401/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/983ecea05a6699ed0124b500e82e9f563b676c3f/lib/src/file-parser.ts#L6)
50+
Defined in: [file-parser.ts:6](https://github.com/react18-tools/git-json-resolver/blob/b16e9f00b0c7f0f44241518b44b07a7c1b0a0401/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/983ecea05a6699ed0124b500e82e9f563b676c3f/lib/src/file-parser.ts#L12)
68+
Defined in: [file-parser.ts:12](https://github.com/react18-tools/git-json-resolver/blob/b16e9f00b0c7f0f44241518b44b07a7c1b0a0401/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/983ecea05a6699ed0124b500e82e9f563b676c3f/lib/src/file-parser.ts#L8)
76+
Defined in: [file-parser.ts:8](https://github.com/react18-tools/git-json-resolver/blob/b16e9f00b0c7f0f44241518b44b07a7c1b0a0401/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/983ecea05a6699ed0124b500e82e9f563b676c3f/lib/src/file-parser.ts#L10)
84+
Defined in: [file-parser.ts:10](https://github.com/react18-tools/git-json-resolver/blob/b16e9f00b0c7f0f44241518b44b07a7c1b0a0401/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/983ecea05a6699ed0124b500e82e9f563b676c3f/lib/src/file-parser.ts#L16)
94+
Defined in: [file-parser.ts:16](https://github.com/react18-tools/git-json-resolver/blob/b16e9f00b0c7f0f44241518b44b07a7c1b0a0401/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/983ecea05a6699ed0124b500e82e9f563b676c3f/lib/src/file-parser.ts#L16)
104+
Defined in: [file-parser.ts:16](https://github.com/react18-tools/git-json-resolver/blob/b16e9f00b0c7f0f44241518b44b07a7c1b0a0401/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/983ecea05a6699ed0124b500e82e9f563b676c3f/lib/src/file-parser.ts#L16)
110+
Defined in: [file-parser.ts:16](https://github.com/react18-tools/git-json-resolver/blob/b16e9f00b0c7f0f44241518b44b07a7c1b0a0401/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/983ecea05a6699ed0124b500e82e9f563b676c3f/lib/src/file-parser.ts#L19)
128+
Defined in: [file-parser.ts:19](https://github.com/react18-tools/git-json-resolver/blob/b16e9f00b0c7f0f44241518b44b07a7c1b0a0401/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/983ecea05a6699ed0124b500e82e9f563b676c3f/lib/src/file-parser.ts#L62)
138+
Defined in: [file-parser.ts:62](https://github.com/react18-tools/git-json-resolver/blob/b16e9f00b0c7f0f44241518b44b07a7c1b0a0401/lib/src/file-parser.ts#L62)
139139

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

docs/file-parser.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: File Parser.Test
4-
nav_order: 6
4+
nav_order: 7
55
---
66

77
# file-parser.test

docs/file-serializer.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: default
33
title: File Serializer
4-
nav_order: 7
4+
nav_order: 8
55
---
66

77
# file-serializer
@@ -12,7 +12,7 @@ nav_order: 7
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/983ecea05a6699ed0124b500e82e9f563b676c3f/lib/src/file-serializer.ts#L1)
15+
Defined in: [file-serializer.ts:1](https://github.com/react18-tools/git-json-resolver/blob/b16e9f00b0c7f0f44241518b44b07a7c1b0a0401/lib/src/file-serializer.ts#L1)
1616

1717
#### Parameters
1818

docs/file-serializer.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: File Serializer.Test
4-
nav_order: 8
4+
nav_order: 9
55
---
66

77
# file-serializer.test

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,7 @@ This library is licensed under the MPL-2.0 open-source license.
152152
## Modules
153153

154154
- [cli](cli.md)
155+
- [cli.test](cli.test.md)
155156
- [conflict-helper](conflict-helper.md)
156157
- [conflict-helper.test](conflict-helper.test.md)
157158
- [file-parser](file-parser.md)

docs/logger/-internal-.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
title: Internal
44
parent: Logger
5-
nav_order: 19
5+
nav_order: 20
66
---
77

88
# \<internal\>
@@ -11,15 +11,15 @@ nav_order: 19
1111

1212
### LoggerConfig
1313

14-
Defined in: [logger.ts:8](https://github.com/react18-tools/git-json-resolver/blob/983ecea05a6699ed0124b500e82e9f563b676c3f/lib/src/logger.ts#L8)
14+
Defined in: [logger.ts:8](https://github.com/react18-tools/git-json-resolver/blob/b16e9f00b0c7f0f44241518b44b07a7c1b0a0401/lib/src/logger.ts#L8)
1515

1616
#### Properties
1717

1818
##### levels?
1919

2020
> `optional` **levels**: \{ `file?`: [`LogLevel`](#loglevel)[]; `stdout?`: [`LogLevel`](#loglevel)[]; \}
2121
22-
Defined in: [logger.ts:12](https://github.com/react18-tools/git-json-resolver/blob/983ecea05a6699ed0124b500e82e9f563b676c3f/lib/src/logger.ts#L12)
22+
Defined in: [logger.ts:12](https://github.com/react18-tools/git-json-resolver/blob/b16e9f00b0c7f0f44241518b44b07a7c1b0a0401/lib/src/logger.ts#L12)
2323

2424
###### file?
2525

@@ -33,32 +33,32 @@ Defined in: [logger.ts:12](https://github.com/react18-tools/git-json-resolver/bl
3333

3434
> `optional` **logDir**: `string`
3535
36-
Defined in: [logger.ts:10](https://github.com/react18-tools/git-json-resolver/blob/983ecea05a6699ed0124b500e82e9f563b676c3f/lib/src/logger.ts#L10)
36+
Defined in: [logger.ts:10](https://github.com/react18-tools/git-json-resolver/blob/b16e9f00b0c7f0f44241518b44b07a7c1b0a0401/lib/src/logger.ts#L10)
3737

3838
##### mode?
3939

4040
> `optional` **mode**: [`Mode`](#mode-1)
4141
42-
Defined in: [logger.ts:9](https://github.com/react18-tools/git-json-resolver/blob/983ecea05a6699ed0124b500e82e9f563b676c3f/lib/src/logger.ts#L9)
42+
Defined in: [logger.ts:9](https://github.com/react18-tools/git-json-resolver/blob/b16e9f00b0c7f0f44241518b44b07a7c1b0a0401/lib/src/logger.ts#L9)
4343

4444
##### singleFile?
4545

4646
> `optional` **singleFile**: `boolean`
4747
48-
Defined in: [logger.ts:11](https://github.com/react18-tools/git-json-resolver/blob/983ecea05a6699ed0124b500e82e9f563b676c3f/lib/src/logger.ts#L11)
48+
Defined in: [logger.ts:11](https://github.com/react18-tools/git-json-resolver/blob/b16e9f00b0c7f0f44241518b44b07a7c1b0a0401/lib/src/logger.ts#L11)
4949

5050
## Type Aliases
5151

5252
### LogLevel
5353

5454
> **LogLevel** = `"info"` \| `"warn"` \| `"error"` \| `"debug"`
5555
56-
Defined in: [logger.ts:4](https://github.com/react18-tools/git-json-resolver/blob/983ecea05a6699ed0124b500e82e9f563b676c3f/lib/src/logger.ts#L4)
56+
Defined in: [logger.ts:4](https://github.com/react18-tools/git-json-resolver/blob/b16e9f00b0c7f0f44241518b44b07a7c1b0a0401/lib/src/logger.ts#L4)
5757

5858
---
5959

6060
### Mode
6161

6262
> **Mode** = `"memory"` \| `"stream"`
6363
64-
Defined in: [logger.ts:6](https://github.com/react18-tools/git-json-resolver/blob/983ecea05a6699ed0124b500e82e9f563b676c3f/lib/src/logger.ts#L6)
64+
Defined in: [logger.ts:6](https://github.com/react18-tools/git-json-resolver/blob/b16e9f00b0c7f0f44241518b44b07a7c1b0a0401/lib/src/logger.ts#L6)

0 commit comments

Comments
 (0)