Module "api-helper/command/transform/chattyDryRunAwareEditor"
Functions
chattyDryRunAwareEditor
Parameters
underlyingEditor: AnyProjectEditor
Returns ProjectEditor
isChatty
Parameters
Returns boolean
isDryRun
isDryRun( params: any ) : boolean
Parameters
Returns boolean
sendDryRunSummaryMessage
Parameters
codeTransformName: string
id: RepoRef
diff: string
params: any
ctx: HandlerContext
sendDryRunUpdateMessage
Parameters
codeTransformName: string
id: RepoRef
params: any
ctx: HandlerContext
sendFailureMessage
sendFailureMessage( codeTransformName: string , id: RepoRef , params: any , editResult: EditResult , ctx: HandlerContext , ctr: CodeTransformRegistration ) : Promise < void >
Parameters
codeTransformName: string
id: RepoRef
params: any
editResult: EditResult
ctx: HandlerContext
sendNoUpdateMessage
Parameters
codeTransformName: string
id: RepoRef
params: any
ctx: HandlerContext
sendSuccessMessage
Parameters
codeTransformName: string
id: RepoRef
params: any
ctx: HandlerContext
slug
slug( id: RepoRef ) : string
Parameters
Returns string
Legend
Namespace Object literal Variable Function Function with type parameter Type alias Type alias with type parameter
Interface Interface with type parameter
Class Class with type parameter
Wrap this editor to make it chatty, so it responds to Slack if there's nothing to do. It also honors the dryRun parameter flag to just capture the git diff and send it back to Slack instead of pushing changes to Git.