stageUtils

Index

Enumerations

• ActionType

Type Aliases

• Consensus
• FileAction

Functions

• checkConsensus
• expandDirectory
• findConsensus
• findVcsRoot
• genCommitMessage
• getCommitPrefix
• isYarnFile

Enumerations

ActionType

ActionType:

ADD

ADD: 2

CREATE

CREATE: 0

DELETE

DELETE: 1

MODIFY

MODIFY: 4

REMOVE

REMOVE: 3

Type Aliases

Consensus

Consensus: { useComponent: boolean; useThirdPerson: boolean; useUpperCase: boolean }

Type declaration

• useComponent: boolean

• useThirdPerson: boolean

• useUpperCase: boolean

FileAction

FileAction: { action: ActionType; path: PortablePath }

Type declaration

• action: ActionType

• path: PortablePath

Functions

checkConsensus

• checkConsensus(lines: string[], regex: RegExp): boolean

• Parameters

  • lines: string[]

  • regex: RegExp

  Returns boolean

expandDirectory

• expandDirectory(initialCwd: PortablePath): PortablePath[]

• Parameters

  • initialCwd: PortablePath

  Returns PortablePath[]

findConsensus

• findConsensus(lines: string[]): Consensus

• Parameters

  • lines: string[]

  Returns Consensus

findVcsRoot

• findVcsRoot(cwd: PortablePath, __namedParameters: { marker: Filename }): Promise<null | PortablePath>

• Parameters

  • cwd: PortablePath

  • __namedParameters: { marker: Filename }

  Returns Promise<null | PortablePath>

genCommitMessage

• genCommitMessage(consensus: Consensus, actions: [ActionType, string][]): string

• Parameters

  • consensus: Consensus

  • actions: [ActionType, string][]

  Returns string

getCommitPrefix

• getCommitPrefix(consensus: Consensus): | chore(yarn):

• Parameters

  • consensus: Consensus

  Returns | chore(yarn):

isYarnFile

• isYarnFile(path: PortablePath, __namedParameters: { names: Set<string>; roots: Set<string> }): boolean

• Parameters

  • path: PortablePath

  • __namedParameters: { names: Set<string>; roots: Set<string> }

  Returns boolean