Module "api-helper/listener/executeAutoInspects"

Index

Interfaces

AutoInspectOptions

Functions

Functions

applyCodeInspections

applyCodeInspections(goalInvocation: GoalInvocation, options: AutoInspectOptions): (project: GitProject) => Promise<ExecuteGoalResult>

- Defined in lib/api-helper/listener/executeAutoInspects.ts:141
Apply code inspections

Parameters
- goalInvocation: GoalInvocation
- options: AutoInspectOptions
Returns (project: GitProject) => Promise<ExecuteGoalResult>
- - (project: GitProject): Promise<ExecuteGoalResult>
  - Parameters
    - project: GitProject
    Returns Promise<ExecuteGoalResult>

consolidate

consolidate(reviews: ProjectReview[], repoId: RepoRef): ProjectReview

- Defined in lib/api-helper/listener/executeAutoInspects.ts:271
Parameters
- reviews: ProjectReview[]
- repoId: RepoRef
Returns ProjectReview

createParametersInvocation

createParametersInvocation(goalInvocation: GoalInvocation, autoInspect: AutoInspectRegistration<any, any>): ParametersInvocation<any>

- Defined in lib/api-helper/listener/executeAutoInspects.ts:253
Parameters
- goalInvocation: GoalInvocation
- autoInspect: AutoInspectRegistration<any, any>
Returns ParametersInvocation<any>

describeComment

describeComment(c: ReviewComment): string

- Defined in lib/api-helper/listener/executeAutoInspects.ts:211
Parameters
- c: ReviewComment
Returns string

describeProjectReview

describeProjectReview(inspectionName: string, pr: ProjectReview): string

- Defined in lib/api-helper/listener/executeAutoInspects.ts:205
Parameters
- inspectionName: string
- pr: ProjectReview
Returns string

executeAutoInspects

executeAutoInspects(options: AutoInspectOptions): ExecuteGoal

- Defined in lib/api-helper/listener/executeAutoInspects.ts:69
Execute auto inspections and route or react to review results using review listeners

Parameters
- options: AutoInspectOptions
Returns ExecuteGoal

gatherResponsesFromReviewListeners

gatherResponsesFromReviewListeners(progressLog: ProgressLog, reviews: ProjectReview[], reviewListeners: ReviewListenerRegistration[], pli: PushListenerInvocation): Promise<PushImpactResponse[]>

- Defined in lib/api-helper/listener/executeAutoInspects.ts:220
Parameters
- progressLog: ProgressLog
- reviews: ProjectReview[]
- reviewListeners: ReviewListenerRegistration[]
- pli: PushListenerInvocation
Returns Promise<PushImpactResponse[]>

isProjectReview

isProjectReview(o: any): o is ProjectReview

- Defined in lib/api-helper/listener/executeAutoInspects.ts:266
Parameters
- o: any
Returns o is ProjectReview

responseFromOneListener

responseFromOneListener(progressLog: ProgressLog, rli: ReviewListenerInvocation): (l: ReviewListenerRegistration) => Promise<PushImpactResponse>

- Defined in lib/api-helper/listener/executeAutoInspects.ts:230
Parameters
- progressLog: ProgressLog
- rli: ReviewListenerInvocation
Returns (l: ReviewListenerRegistration) => Promise<PushImpactResponse>
- - (l: ReviewListenerRegistration): Promise<PushImpactResponse>
  - Parameters
    - l: ReviewListenerRegistration
    Returns Promise<PushImpactResponse>

sendErrorsToSlack

sendErrorsToSlack(errors: ReviewerError[], addressChannels: AddressChannels): Promise<void>

- Defined in lib/api-helper/listener/executeAutoInspects.ts:278
Parameters
- errors: ReviewerError[]
- addressChannels: AddressChannels
Returns Promise<void>

Generated using TypeDoc