normalizer

Interfaces

NormalizedConfig<T, TContext>

Defined in: normalizer.ts:35

Extends

• Omit<Config<T, TContext>, "byStrategy" | "rules" | "defaultStrategy" | "customStrategies">

Type Parameters

T

T extends string = AllStrategies

TContext

TContext = unknown

Properties

autoStage?

optional autoStage: boolean

Defined in: types.ts:251

Whether to automatically stage resolved files. Default: true.

Inherited from

Config.autoStage

backupDir?

optional backupDir: string

Defined in: types.ts:236

Directory for backing up original files before modification.

Inherited from

Config.backupDir

customStrategies

customStrategies: Record<string, StrategyFn<TContext>>

Defined in: normalizer.ts:44

debug?

optional debug: boolean

Defined in: types.ts:227

Enable debug mode for verbose logs and traceability (slower).

Inherited from

Config.debug

exclude

exclude: string[]

Defined in: normalizer.ts:43

File exclusion globs.

Overrides

Config.exclude

include

include: string[]

Defined in: normalizer.ts:42

File inclusion globs.

Overrides

Config.include

includeNonConflicted?

optional includeNonConflicted: boolean

Defined in: types.ts:224

Whether to include files that do not contain conflicts. Useful if strategies (e.g., “drop”) should apply even to clean files. Default: false.

Inherited from

Config.includeNonConflicted

loggerConfig?

optional loggerConfig: LoggerConfig

Defined in: types.ts:233

Logger configuration.

Inherited from

Config.loggerConfig

matcher

matcher: Matcher

Defined in: normalizer.ts:41

Glob matcher: "micromatch", "picomatch", or a custom implementation. Defaults to internal minimal matcher

Overrides

Config.matcher

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

pluginConfig?

optional pluginConfig: Partial<PluginConfigs>

Defined in: types.ts:257

Plugin-specific configuration passed to plugin.init().

Inherited from

Config.pluginConfig

plugins?

optional plugins: string[]

Defined in: types.ts:254

NPM package names of strategy plugins to load.

Inherited from

Config.plugins

rules

rules: NormalizedRules

Defined in: normalizer.ts:40

writeConflictSidecar?

optional writeConflictSidecar: boolean

Defined in: types.ts:230

Whether to write sidecar files with unresolved conflicts.

Inherited from

Config.writeConflictSidecar

---

NormalizedRules

Defined in: normalizer.ts:28

Properties

default

default: StrategyItem[]

Defined in: normalizer.ts:32

exact

exact: Record<string, StrategyList[]>

Defined in: normalizer.ts:29

exactFields

exactFields: Record<string, StrategyList[]>

Defined in: normalizer.ts:30

patterns

patterns: Record<string, StrategyList[]>

Defined in: normalizer.ts:31

---

StrategyItem

Defined in: normalizer.ts:17

Properties

important

important: boolean

Defined in: normalizer.ts:19

name

name: string

Defined in: normalizer.ts:18

---

StrategyList

Defined in: normalizer.ts:22

Properties

order

order: number

Defined in: normalizer.ts:24

source

source: string

Defined in: normalizer.ts:25

strategies

strategies: StrategyItem[]

Defined in: normalizer.ts:23

Variables

DEFAULT_CONFIG

const DEFAULT_CONFIG: { debug: boolean; defaultStrategy: string[]; exclude: string[]; include: string[]; writeConflictSidecar: boolean; }

Defined in: normalizer.ts:48

Defaults

Type Declaration

debug

debug: boolean = false

defaultStrategy

defaultStrategy: string[]

exclude

exclude: string[]

Add **/ prefix to ensure proper handling in monorepo

include

include: string[]

writeConflictSidecar

writeConflictSidecar: boolean = false

Functions

normalizeConfig()

normalizeConfig<T>(config: Config<T>): Promise<NormalizedConfig<AllStrategies, unknown>>

Defined in: normalizer.ts:60

Normalize user config into fully expanded and classified form.

Type Parameters

T

T extends string = AllStrategies

Parameters

config

Config<T>

Returns

Promise<NormalizedConfig<AllStrategies, unknown>>