versionUtils

Index

Enumerations

• Decision

Type Aliases

• IncrementDecision
• Releases
• VersionFile

Functions

• applyPrerelease
• applyReleases
• applyStrategy
• clearVersionFiles
• getUndecidedDependentWorkspaces
• getUndecidedWorkspaces
• openVersionFile
• requireMoreDecisions
• resolveVersionFiles
• suggestStrategy
• updateVersionFiles
• validateReleaseDecision

Enumerations

Decision

Decision:

DECLINE

DECLINE: decline

MAJOR

MAJOR: major

MINOR

MINOR: minor

PATCH

PATCH: patch

PRERELEASE

PRERELEASE: prerelease

UNDECIDED

UNDECIDED: undecided

Type Aliases

IncrementDecision

IncrementDecision: Exclude<Decision, Decision.UNDECIDED | Decision.DECLINE>

Releases

Releases: Map<Workspace, string>

VersionFile

VersionFile: { changedFiles: Set<PortablePath>; changedWorkspaces: Set<Workspace>; project: Project; releaseRoots: Set<Workspace>; releases: Releases; saveAll: () => Promise<void> } & ({ baseHash: string; baseTitle: string; root: PortablePath } | { baseHash: null; baseTitle: null; root: null })

Functions

applyPrerelease

• applyPrerelease(version: string, __namedParameters: { current: string; prerelease: string }): string

• Parameters

  • version: string

  • __namedParameters: { current: string; prerelease: string }

  Returns string

applyReleases

• applyReleases(project: Project, newVersions: Map<Workspace, string>, __namedParameters: { report: Report }): void

• Parameters

  • project: Project

  • newVersions: Map<Workspace, string>

  • __namedParameters: { report: Report }

  Returns void

applyStrategy

• applyStrategy(version: null | string, strategy: string): string

• Parameters

  • version: null | string

  • strategy: string

  Returns string

clearVersionFiles

• clearVersionFiles(project: Project): Promise<void>

• Parameters

  • project: Project

  Returns Promise<void>

getUndecidedDependentWorkspaces

• getUndecidedDependentWorkspaces(versionFile: Pick<VersionFile, project | releases>, __namedParameters?: { include?: Set<Workspace> }): Workspace[][]

• Parameters

  • versionFile: Pick<VersionFile, project | releases>

  • __namedParameters: { include?: Set<Workspace> } = {}

  Returns Workspace[][]

getUndecidedWorkspaces

• getUndecidedWorkspaces(versionFile: VersionFile): Set<Workspace>

• Parameters

  • versionFile: VersionFile

  Returns Set<Workspace>

openVersionFile

• openVersionFile(project: Project, opts: { allowEmpty: true }): Promise<VersionFile>
• openVersionFile(project: Project, opts?: { allowEmpty?: boolean }): Promise<VersionFile | null>

• Parameters

  • project: Project

  • opts: { allowEmpty: true }

  Returns Promise<VersionFile>

requireMoreDecisions

• requireMoreDecisions(versionFile: VersionFile): boolean

• Parameters

  • versionFile: VersionFile

  Returns boolean

resolveVersionFiles

• resolveVersionFiles(project: Project, __namedParameters?: { prerelease?: null | string }): Promise<Map<Workspace, string>>

• Parameters

  • project: Project

  • __namedParameters: { prerelease?: null | string } = {}

  Returns Promise<Map<Workspace, string>>

suggestStrategy

• suggestStrategy(from: string, to: string): null | MAJOR | MINOR | PATCH | PRERELEASE

• Parameters

  • from: string

  • to: string

  Returns null | MAJOR | MINOR | PATCH | PRERELEASE

updateVersionFiles

• updateVersionFiles(project: Project, workspaces: Workspace[]): Promise<void>

• Parameters

  • project: Project

  • workspaces: Workspace[]

  Returns Promise<void>

validateReleaseDecision

• validateReleaseDecision(decision: unknown): string

• Parameters

  • decision: unknown

  Returns string