Module "api-helper/listener/executeAutofixes"

Index

Interfaces

GoalInvocationParameters

Type aliases

ExtractAuthor

Variables

Functions

Type aliases

ExtractAuthor

ExtractAuthor: (gi: GoalInvocation) => Promise<{ email: string; name: string } | undefined>

Extract author information from the current goal invocation

Type declaration

- (gi: GoalInvocation): Promise<{ email: string; name: string } | undefined>
- Parameters
  - gi: GoalInvocation
  Returns Promise<{ email: string; name: string } | undefined>

Variables

Const AutofixProgressReporter

AutofixProgressReporter: ReportProgress = testProgressReporter(...AutofixProgressTests)

Default ReportProgress for running autofixes

Const AutofixProgressTests

AutofixProgressTests: ProgressTest[] = [{test: /About to transform .* autofix '(.*)'/i,phase: "$1",}]

Functions

Const DefaultExtractAuthor

DefaultExtractAuthor(gi: GoalInvocation): Promise<{ email: any; name: any }>

- Defined in lib/api-helper/listener/executeAutofixes.ts:311
Parameters
- gi: GoalInvocation
Returns Promise<{ email: any; name: any }>

Const NoOpExtractAuthor

NoOpExtractAuthor(): Promise<any>

- Defined in lib/api-helper/listener/executeAutofixes.ts:307
Returns Promise<any>

detailMessage

detailMessage(appliedAutofixes: AutofixRegistration[]): string

- Defined in lib/api-helper/listener/executeAutofixes.ts:198
Parameters
- appliedAutofixes: AutofixRegistration[]
Returns string

executeAutofixes

executeAutofixes(registrations: AutofixRegistration[], transformPresentation?: TransformPresentation<GoalInvocationParameters>, extractAuthor?: ExtractAuthor): ExecuteGoal

- Defined in lib/api-helper/listener/executeAutofixes.ts:66
Execute autofixes against this push Throw an error on failure

Parameters
- registrations: AutofixRegistration[]
- Optional transformPresentation: TransformPresentation<GoalInvocationParameters>
- Default value extractAuthor: ExtractAuthor = NoOpExtractAuthor
Returns ExecuteGoal

ExecuteGoal

filterImmediateAutofixes

filterImmediateAutofixes(autofixes: AutofixRegistration[], gi: GoalInvocation): AutofixRegistration[]

- Defined in lib/api-helper/listener/executeAutofixes.ts:275
Filter any provided autofixes whose results were included in the commits of the current push.

Parameters
- autofixes: AutofixRegistration[]
- gi: GoalInvocation
Returns AutofixRegistration[]

generateCommitMessageForAutofix

generateCommitMessageForAutofix(autofix: AutofixRegistration): string

- Defined in lib/api-helper/listener/executeAutofixes.ts:287
Generate a commit message for the provided autofix.

Parameters
- autofix: AutofixRegistration
Returns string

isNewBranch

isNewBranch(editMode: EditMode, branch: string): boolean

- Defined in lib/api-helper/listener/executeAutofixes.ts:191
Check if this autofix is going to commit to a new branch

Parameters
- editMode: EditMode
- branch: string
Returns boolean

runOne

runOne(gi: GoalInvocation, cri: PushImpactListenerInvocation, autofix: AutofixRegistration, extractAuthor: ExtractAuthor): Promise<EditResult>

- Defined in lib/api-helper/listener/executeAutofixes.ts:207
Parameters
- gi: GoalInvocation
- cri: PushImpactListenerInvocation
- autofix: AutofixRegistration
- extractAuthor: ExtractAuthor
Returns Promise<EditResult>

Generated using TypeDoc