Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "pack/version/file"

Index

Functions

Object literals

Functions

Const FileVersionIncrementer

Const FileVersioner

readVersionFile

  • Read version from version file in project. Version file can be .version or VERSION, with the former taking precedence if both exist. If neither exist, "0.0.0" is returned.

    Parameters

    • p: Project

      Project to read version file in

    • log: ProgressLog

      Progress log to write information to

    Returns Promise<string>

    Version as string

versionFilePath

  • versionFilePath(p: Project): Promise<string>

  • Return path to version file in project. Paths interrogated are .version and VERSION. The former takes precedence if neither or both exist.

    Parameters

    • p: Project

      Projecto look for version file in

    Returns Promise<string>

writeVersionFile

  • Write provided version to version file in project. The path to the version file is determined using versionFilePath.

    Parameters

    • p: Project

      Project to write version file to

    • log: ProgressLog

      Progress log to write information to

    • v: string

      Version to write to version file

    Returns Promise<void>

Object literals

Const FileVersionIncrementerRegistration

FileVersionIncrementerRegistration: object

Increment version registration for FileVersionIncrementer.

logInterpreter

logInterpreter: InterpretLog<any> = LogSuppressor

name

name: string = DefaultGoalNameGenerator.generateName("file-version-incrementer")

pushTest

pushTest: PushTest = HasVersionFile

versionIncrementer

versionIncrementer: VersionIncrementer = FileVersionIncrementer

Const FileVersionerRegistration

FileVersionerRegistration: object

Versioner function registration for the Version goal.

logInterpreter

logInterpreter: InterpretLog<any> = LogSuppressor

name

name: string = DefaultGoalNameGenerator.generateName("file-versioner")

pushTest

pushTest: PushTest = HasVersionFile

versioner

versioner: ProjectVersioner = FileVersioner

Const HasVersionFile

HasVersionFile: object

Push test indicating if project has either a .version or VERSION file at the root of the repository.

name

name: string = "HasVersionFile"

mapping

Generated using TypeDoc