patchUtils

Index

Functions

• applyPatchFile
• diffFolders
• ensureUnpatchedDescriptor
• ensureUnpatchedLocator
• extractPackageToDisk
• extractPatchFlags
• isParentRequired
• isPatchDescriptor
• isPatchLocator
• loadPatchFiles
• makeDescriptor
• makeLocator
• makePatchHash
• parseDescriptor
• parseLocator
• parsePatchFile
• unpatchDescriptor
• unpatchLocator

Functions

applyPatchFile

• applyPatchFile(effects: ParsedPatchFile, __namedParameters?: { baseFs?: FakeFS<PortablePath>; dryRun?: boolean; version?: null | string }): Promise<void>

• Parameters

  • effects: ParsedPatchFile

  • __namedParameters: { baseFs?: FakeFS<PortablePath>; dryRun?: boolean; version?: null | string } = {}

  Returns Promise<void>

diffFolders

• diffFolders(folderA: PortablePath, folderB: PortablePath): Promise<string>

• Parameters

  • folderA: PortablePath

  • folderB: PortablePath

  Returns Promise<string>

ensureUnpatchedDescriptor

• ensureUnpatchedDescriptor(descriptor: Descriptor): Descriptor

• Parameters

  • descriptor: Descriptor

  Returns Descriptor

ensureUnpatchedLocator

• ensureUnpatchedLocator(locator: Locator): Locator

• Parameters

  • locator: Locator

  Returns Locator

extractPackageToDisk

• extractPackageToDisk(locator: Locator, __namedParameters: { cache: Cache; project: Project }): Promise<PortablePath>

• Parameters

  • locator: Locator

  • __namedParameters: { cache: Cache; project: Project }

  Returns Promise<PortablePath>

extractPatchFlags

• extractPatchFlags(patchPath: PortablePath): { optional: boolean }

• Parameters

  • patchPath: PortablePath

  Returns { optional: boolean }

  • optional: boolean

isParentRequired

• isParentRequired(patchPath: PortablePath): boolean

• Parameters

  • patchPath: PortablePath

  Returns boolean

isPatchDescriptor

• isPatchDescriptor(descriptor: Descriptor): boolean

• Parameters

  • descriptor: Descriptor

  Returns boolean

isPatchLocator

• isPatchLocator(locator: Locator): boolean

• Parameters

  • locator: Locator

  Returns boolean

loadPatchFiles

• loadPatchFiles(parentLocator: null | Locator, patchPaths: PortablePath[], opts: FetchOptions): Promise<{ optional: boolean; source: null | string }[]>

• Parameters

  • parentLocator: null | Locator

  • patchPaths: PortablePath[]

  • opts: FetchOptions

  Returns Promise<{ optional: boolean; source: null | string }[]>

makeDescriptor

• makeDescriptor(ident: Ident, __namedParameters: Pick<{ parentLocator: null | Locator; patchPaths: PortablePath[]; sourceDescriptor: Descriptor; sourceVersion: null | string }, parentLocator | patchPaths | sourceDescriptor>): Descriptor

• Parameters

  • ident: Ident

  • __namedParameters: Pick<{ parentLocator: null | Locator; patchPaths: PortablePath[]; sourceDescriptor: Descriptor; sourceVersion: null | string }, parentLocator | patchPaths | sourceDescriptor>

  Returns Descriptor

makeLocator

• makeLocator(ident: Ident, __namedParameters: Omit<{ parentLocator: null | Locator; patchPaths: PortablePath[]; sourceLocator: Locator; sourceVersion: null | string }, sourceVersion | sourceLocator> & { patchHash: string; sourcePackage: Package }): Locator

• Parameters

  • ident: Ident

  • __namedParameters: Omit<{ parentLocator: null | Locator; patchPaths: PortablePath[]; sourceLocator: Locator; sourceVersion: null | string }, sourceVersion | sourceLocator> & { patchHash: string; sourcePackage: Package }

  Returns Locator

makePatchHash

• makePatchHash(patchFiles: { optional: boolean; source: null | string }[], sourceVersion: null | string): string

• Parameters

  • patchFiles: { optional: boolean; source: null | string }[]

  • sourceVersion: null | string

  Returns string

parseDescriptor

• parseDescriptor(descriptor: Descriptor): { parentLocator: null | Locator; patchPaths: PortablePath[]; sourceDescriptor: Descriptor; sourceVersion: null | string }

• Parameters

  • descriptor: Descriptor

  Returns { parentLocator: null | Locator; patchPaths: PortablePath[]; sourceDescriptor: Descriptor; sourceVersion: null | string }

  • parentLocator: null | Locator

  • patchPaths: PortablePath[]

  • sourceDescriptor: Descriptor

  • sourceVersion: null | string

parseLocator

• parseLocator(locator: Locator): { parentLocator: null | Locator; patchPaths: PortablePath[]; sourceLocator: Locator; sourceVersion: null | string }

• Parameters

  • locator: Locator

  Returns { parentLocator: null | Locator; patchPaths: PortablePath[]; sourceLocator: Locator; sourceVersion: null | string }

  • parentLocator: null | Locator

  • patchPaths: PortablePath[]

  • sourceLocator: Locator

  • sourceVersion: null | string

parsePatchFile

• parsePatchFile(file: string): ParsedPatchFile

• Parameters

  • file: string

  Returns ParsedPatchFile

unpatchDescriptor

• unpatchDescriptor(descriptor: Descriptor): Descriptor

• Parameters

  • descriptor: Descriptor

  Returns Descriptor

unpatchLocator

• unpatchLocator(locator: Locator): Locator

• Parameters

  • locator: Locator

  Returns Locator