Interface: IReviewerProcessor
Makaio Framework / contracts / IReviewerProcessor
Interface: IReviewerProcessor
Section titled “Interface: IReviewerProcessor”Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:160
Reviewer processor capability provider.
Processors handle stateless transformation from raw source data to ReviewFinding arrays. They must be pure transformation logic with no I/O dependencies.
Extends
Section titled “Extends”Properties
Section titled “Properties”botAuthors
Section titled “botAuthors”
readonlybotAuthors: readonlystring[]
Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:172
Bot usernames that produce content for this reviewer
capabilityId
Section titled “capabilityId”
readonlycapabilityId:"reviewer-processor"
Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:162
Must be ‘reviewer-processor’
displayName
Section titled “displayName”
readonlydisplayName:string
Defined in: ../../../packages/contracts/src/capability/types.ts:11
Human-readable name for display in UI
Inherited from
Section titled “Inherited from”ICapabilityProvider.displayName
readonlyid:string
Defined in: ../../../packages/contracts/src/capability/types.ts:9
Unique identifier for this provider instance
Inherited from
Section titled “Inherited from”priority?
Section titled “priority?”
readonlyoptionalpriority?:number
Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:168
Priority for processor resolution (higher wins, default 0)
processorKey
Section titled “processorKey”
readonlyprocessorKey:string
Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:166
Unique processor key (e.g., ‘makaio/coderabbit’)
providerKey?
Section titled “providerKey?”
readonlyoptionalproviderKey?:string
Defined in: ../../../packages/contracts/src/capability/types.ts:17
Stable provider identity used for joins across registries.
Unlike id, this should remain stable across runtime re-registration.
Inherited from
Section titled “Inherited from”ICapabilityProvider.providerKey
reviewer
Section titled “reviewer”
readonlyreviewer:string
Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:164
Reviewer family this processor handles
supersedes?
Section titled “supersedes?”
readonlyoptionalsupersedes?: readonlystring[]
Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:170
Processor keys this one supersedes (diagnostic metadata)
Methods
Section titled “Methods”extractAgentPrompt()?
Section titled “extractAgentPrompt()?”
optionalextractAgentPrompt(body):string|undefined
Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:208
Extract AI-optimized agent prompt from a comment body.
Parameters
Section titled “Parameters”string
Raw comment body text
Returns
Section titled “Returns”string | undefined
Agent-optimized prompt string or undefined if not extractable
parseRateLimit()?
Section titled “parseRateLimit()?”
optionalparseRateLimit(body): {lastUpdatedAt:number;limit:number;remaining:number;resetsAt:number;sourceId:string; } |null
Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:202
Parse rate limit information from a body string.
Parameters
Section titled “Parameters”string
Raw text body potentially containing rate limit information
Returns
Section titled “Returns”Parsed rate limit or null if none found
Type Literal
Section titled “Type Literal”{ lastUpdatedAt: number; limit: number; remaining: number; resetsAt: number; sourceId: string; }
lastUpdatedAt
Section titled “lastUpdatedAt”lastUpdatedAt:
number
Epoch ms when this was last updated
limit:
number
Total limit
remaining
Section titled “remaining”remaining:
number
Remaining review triggers
resetsAt
Section titled “resetsAt”resetsAt:
number
Epoch ms when limit resets
sourceId
Section titled “sourceId”sourceId:
string
Source that this rate limit applies to
null
processCliOutput()?
Section titled “processCliOutput()?”
optionalprocessCliOutput(params):object[]
Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:196
Process CLI output into findings.
Parameters
Section titled “Parameters”params
Section titled “params”Parameters containing source ID, target, and raw CLI output
Returns
Section titled “Returns”Array of review findings extracted from the CLI output
processComments()
Section titled “processComments()”processComments(
params):object[]
Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:178
Process inline review comments into findings.
Parameters
Section titled “Parameters”params
Section titled “params”Parameters containing source ID, target, and raw comments
Returns
Section titled “Returns”Array of review findings extracted from the comments
processIssueComments()?
Section titled “processIssueComments()?”
optionalprocessIssueComments(params):object[]
Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:190
Process issue-level comments into findings.
Parameters
Section titled “Parameters”params
Section titled “params”Parameters containing source ID, target, and raw issue comments
Returns
Section titled “Returns”Array of review findings extracted from the issue comments
processReviewBody()
Section titled “processReviewBody()”processReviewBody(
params):object[]
Defined in: ../../../packages/contracts/src/capabilities/review/types.ts:184
Process review body content into findings.
Parameters
Section titled “Parameters”params
Section titled “params”Parameters containing source ID, target, and raw reviews
Returns
Section titled “Returns”Array of review findings extracted from the review bodies
validate()?
Section titled “validate()?”
optionalvalidate():Promise<{error?:string;valid:boolean; }>
Defined in: ../../../packages/contracts/src/capability/types.ts:22
Optional validation method to check provider configuration/credentials.
Returns
Section titled “Returns”Promise<{ error?: string; valid: boolean; }>
Validation result with optional error message