Options
All
  • Public
  • Public/Protected
  • All
Menu

Package plugin-stage

@yarnpkg/plugin-stage

This plugin adds support for the yarn stage command.

Install

yarn plugin import stage

Type aliases

Consensus

Consensus: object

Type declaration

  • useComponent: boolean
  • useThirdPerson: boolean
  • useUpperCase: boolean

FileAction

FileAction: object

Type declaration

Functions

checkConsensus

  • checkConsensus(lines: Array<string>, regex: RegExp): boolean

expandDirectory

  • expandDirectory(initialCwd: PortablePath): (string & object)[]

findConsensus

  • findConsensus(lines: Array<string>): Consensus

findVcsRoot

  • findVcsRoot(cwd: PortablePath, __namedParameters: object): Promise<null | string & object>

genCommitMessage

getCommitPrefix

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

isYarnFile

  • isYarnFile(path: PortablePath, __namedParameters: object): boolean

Object literals

Const Driver

Driver: object

filterChanges

findRoot

  • findRoot(cwd: PortablePath): Promise<null | string & object>

genCommitMessage

  • genCommitMessage(cwd: PortablePath, changeList: Array<stageUtils.FileAction>): Promise<string>

makeCommit

  • makeCommit(cwd: PortablePath, changeList: Array<stageUtils.FileAction>, commitMessage: string): Promise<void>

makeReset

  • makeReset(cwd: PortablePath, changeList: Array<stageUtils.FileAction>): Promise<void>

Const Driver

Driver: object

filterChanges

  • filterChanges(cwd: string, paths: Set<string>, filenames: Set<string>): Promise<never[]>

findRoot

  • findRoot(cwd: PortablePath): Promise<null | string & object>

genCommitMessage

  • genCommitMessage(cwd: PortablePath, changeList: Array<stageUtils.FileAction>): Promise<string>

makeCommit

  • makeCommit(cwd: PortablePath, changeList: Array<stageUtils.FileAction>, commitMessage: string): Promise<void>

makeReset

  • makeReset(cwd: PortablePath, changeList: Array<stageUtils.FileAction>): Promise<void>

makeUpdate

  • makeUpdate(cwd: string, changeList: Array<stageUtils.FileAction>): Promise<void>

Const plugin

plugin: object

commands

commands: StageCommand[] = [stage,]

Generated using TypeDoc