utils

Interfaces

FileEntry

Defined in: utils.ts:5

Properties

content

content: string

Defined in: utils.ts:7

filePath

filePath: string

Defined in: utils.ts:6

Type Aliases

CollectFilesOptions

CollectFilesOptions = Pick<NormalizedConfig, "include" | "exclude" | "matcher" | "includeNonConflicted" | "debug" | "backupDir"> & { root?: string; }

Defined in: utils.ts:33

Type Declaration

root?

optional root: string

Root directory to start traversal (defaults to process.cwd()).

Variables

DEFAULT_BACKUP_DIR

const DEFAULT_BACKUP_DIR: ".merge-backups" = ".merge-backups"

Defined in: utils.ts:12


DROP

const DROP: typeof DROP

Defined in: utils.ts:11

Sentinel used to explicitly drop a value.


StrategyStatus_CONTINUE

const StrategyStatus_CONTINUE: 1

Defined in: utils.ts:19


StrategyStatus_FAIL

const StrategyStatus_FAIL: 2

Defined in: utils.ts:20


StrategyStatus_OK

const StrategyStatus_OK: 0

Defined in: utils.ts:18

Status codes returned by strategy functions. Using individual constants for optimal bundle size.


StrategyStatus_SKIP

const StrategyStatus_SKIP: 3

Defined in: utils.ts:21

Functions

backupFile()

backupFile(filePath: string, backupDir: string): Promise<string>

Defined in: utils.ts:169

Parameters

filePath

string

backupDir

string = DEFAULT_BACKUP_DIR

Returns

Promise<string>


createSkipDirectoryMatcher()

createSkipDirectoryMatcher(include: string[], exclude: string[], matcher: Matcher): (dirPath: string) => boolean

Defined in: utils.ts:128

Derive directory pruning patterns from include/exclude rules. These patterns are used to avoid walking unnecessary directories.

Parameters

include

string[]

exclude

string[]

matcher

Matcher

Returns

(dirPath: string): boolean

Parameters
dirPath

string

Returns

boolean


hasConflict()

hasConflict(content: string): boolean

Defined in: utils.ts:29

Checks whether the given file contains Git merge conflict markers.

Parameters

content

string

File content to check.

Returns

boolean

true if conflict markers exist, otherwise false.


listMatchingFiles()

listMatchingFiles(options: CollectFilesOptions): Promise<FileEntry[]>

Defined in: utils.ts:50

Recursively collects files that match the provided fileFilter.

  • By default, only conflicted files are returned.
  • If includeNonConflicted is enabled, matching files are always included.

Parameters

options

CollectFilesOptions

Collection options, including fileFilter and traversal root.

Returns

Promise<FileEntry[]>

A promise that resolves with an array of { filePath, content }.


restoreBackups()

restoreBackups(backupDir: string): Promise<void>

Defined in: utils.ts:179

Parameters

backupDir

string = ".merge-backups"

Returns

Promise<void>