"api-helper/project/withProject"

Index

Interfaces

ChildProcessOnProject

Type aliases

ProjectAwareGoalInvocation

Functions

Type aliases

ProjectAwareGoalInvocation

ProjectAwareGoalInvocation: GoalInvocation & ProjectListenerInvocation & ChildProcessOnProject

Type providing access to the GoalInvocation, Project and running child process in the context of the project.

Functions

doWithProject

doWithProject(action: (pa: ProjectAwareGoalInvocation) => Promise<void | ExecuteGoalResult>, cloneOptions?: CloneOptions & { readOnly: boolean }): ExecuteGoal

- Defined in lib/api-helper/project/withProject.ts:95
Convenience method to create goal implementations that require a local clone of the project.

Parameters
- action: (pa: ProjectAwareGoalInvocation) => Promise<void | ExecuteGoalResult>
  - - (pa: ProjectAwareGoalInvocation): Promise<void | ExecuteGoalResult>
    - Parameters
      - pa: ProjectAwareGoalInvocation
      Returns Promise<void | ExecuteGoalResult>
- Default value cloneOptions: CloneOptions & { readOnly: boolean } = { readOnly: false }
Returns ExecuteGoal

pagiExec

pagiExec(p: GitProject): (cmd: string, args?: string | string[], opts?: SpawnSyncOptions) => Promise<ExecPromiseResult>

- Defined in lib/api-helper/project/withProject.ts:128
Return exec function for project-aware goal invocations.

Parameters
- p: GitProject
Returns (cmd: string, args?: string | string[], opts?: SpawnSyncOptions) => Promise<ExecPromiseResult>
- - (cmd: string, args?: string | string[], opts?: SpawnSyncOptions): Promise<ExecPromiseResult>
  - Parameters
    - cmd: string
    - Optional args: string | string[]
    - Optional opts: SpawnSyncOptions
    Returns Promise<ExecPromiseResult>

pagiSpawn

pagiSpawn(p: GitProject, log: ProgressLog): (cmd: string, args?: string | string[], opts?: Partial<SpawnLogOptions>) => Promise<SpawnLogResult>

- Defined in lib/api-helper/project/withProject.ts:112
Return spawn function for project-aware goal invocations.

Parameters
- p: GitProject
- log: ProgressLog
Returns (cmd: string, args?: string | string[], opts?: Partial<SpawnLogOptions>) => Promise<SpawnLogResult>
- - (cmd: string, args?: string | string[], opts?: Partial<SpawnLogOptions>): Promise<SpawnLogResult>
  - Parameters
    - cmd: string
    - Optional args: string | string[]
    - Optional opts: Partial<SpawnLogOptions>
    Returns Promise<SpawnLogResult>

toProjectAwareGoalInvocation

toProjectAwareGoalInvocation(project: GitProject, gi: GoalInvocation): ProjectAwareGoalInvocation

- Defined in lib/api-helper/project/withProject.ts:82
Convenience method to create project aware goal invocations with spawn and exec functions that, by default, use the cloned project base directory as the current working directory.

Parameters
- project: GitProject
  
  locally cloned project
- gi: GoalInvocation
  
  SDM goal invocation
Returns ProjectAwareGoalInvocation

goal invocation made project aware

Index

Interfaces

Type aliases

Functions

Type aliases

ProjectAwareGoalInvocation

Functions

doWithProject

Parameters

action: (pa: ProjectAwareGoalInvocation) => Promise<void | ExecuteGoalResult>

Parameters

pa: ProjectAwareGoalInvocation

Returns Promise<void | ExecuteGoalResult>

Default value cloneOptions: CloneOptions & { readOnly: boolean } = { readOnly: false }

Returns ExecuteGoal

pagiExec

Parameters

p: GitProject

Returns (cmd: string, args?: string | string[], opts?: SpawnSyncOptions) => Promise<ExecPromiseResult>

Parameters

cmd: string

Optional args: string | string[]

Optional opts: SpawnSyncOptions

Returns Promise<ExecPromiseResult>

pagiSpawn

Parameters

p: GitProject

log: ProgressLog

Returns (cmd: string, args?: string | string[], opts?: Partial<SpawnLogOptions>) => Promise<SpawnLogResult>

Parameters

cmd: string

Optional args: string | string[]

Optional opts: Partial<SpawnLogOptions>

Returns Promise<SpawnLogResult>

toProjectAwareGoalInvocation

Parameters

project: GitProject

gi: GoalInvocation

Returns ProjectAwareGoalInvocation