file-parser

Interfaces

ParseConflictOptions

Defined in: file-parser.ts:26

Options for parsing conflicted content.

Extends

Properties

filename

filename: string

Defined in: file-parser.ts:35

filename hint to prioritize parser choice as well as get base and ours from git. Example:

  • config.yaml → try yaml first.
  • data.toml → try toml first.

If extension is unknown, falls back to parsers or "json".

parsers?

optional parsers: "auto" | SupportedParsers | SupportedParsers[]

Defined in: types.ts:245

Parsers to attempt, in order:

  • A single parser ("json", "yaml", custom function, etc.).
  • An array of parsers (e.g. ["yaml", "json5"]).

Defaults to "json".

Inherited from

Config.parsers

ParsedConflict<T>

Defined in: file-parser.ts:12

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

Type Parameters

T

T = unknown

The type of the parsed content.

Properties

base?

optional base: T

Defined in: file-parser.ts:18

Parsed content from the “base” side of the conflict (optional).

format

format: string

Defined in: file-parser.ts:20

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

ours

ours: T

Defined in: file-parser.ts:14

Parsed content from the “ours” side of the conflict.

theirs

theirs: T

Defined in: file-parser.ts:16

Parsed content from the “theirs” side of the conflict.

Functions

normalizeParsers()

normalizeParsers(options: ParseConflictOptions): SupportedParsers[]

Defined in: file-parser.ts:144

Normalize parsers based on filename + options.

Parameters

options

ParseConflictOptions

Returns

SupportedParsers[]

parseConflictContent()

parseConflictContent<T>(content: string, options: ParseConflictOptions): Promise<ParsedConflict<T>>

Defined in: file-parser.ts:55

Parses a conflicted file’s content into separate ours and theirs objects.

  • Preserves non-conflicted lines in both versions.
  • Supports JSON, JSON5, YAML, TOML, and XML.
  • Lazy-loads optional peer dependencies (json5, yaml, toml, fast-xml-parser).
  • Parser order is determined by:
    1. filename extension hint (if provided).
    2. Explicit parsers option.
    3. Default "json".

Type Parameters

T

T = unknown

Expected type of parsed content.

Parameters

content

string

Raw file content containing conflict markers.

options

ParseConflictOptions

Parsing options (parsers + filename hint).

Returns

Promise<ParsedConflict<T>>

Parsed conflict with both sides and detected format.

Throws

If parsing fails or conflict markers are invalid.

parseFormat()

parseFormat(parser: "json" | "json5" | "yaml" | "toml" | "xml", raw: string): Promise<unknown>

Defined in: file-parser.ts:183

Internal parser dispatcher for supported formats.

Parameters

parser
"json" "json5" "yaml" "toml" "xml"
raw

string

Returns

Promise<unknown>

runParser()

runParser(raw: string, parsers: SupportedParsers[]): Promise<[unknown, SupportedParsers]>

Defined in: file-parser.ts:165

Internal helper to try parsers in order.

Parameters

raw

string

parsers

SupportedParsers[]

Returns

Promise<[unknown, SupportedParsers]>