Module "operations/review/ReviewResult"

Index

Classes

DefaultReviewComment

Interfaces

Type aliases

Severity

Functions

Type aliases

Severity

Severity: "error" | "warn" | "info"

Functions

clean

clean(repoId: RepoRef): ProjectReview

- Defined in lib/operations/review/ReviewResult.ts:91
Give a project a clean bill of health, with no comments

Parameters
- repoId: RepoRef
  
  identification of project
Returns ProjectReview

reviewCommentSorter

reviewCommentSorter(a: ReviewComment, b: ReviewComment): number

- Defined in lib/operations/review/ReviewResult.ts:109
Function suitable for use by Array.prototype.sort() to sort review comments by severity, category, subcategory, and sourceLocation path and offset. Items with the same severity, category, and subcategory without a location are sorted before those having a location.

Parameters
- a: ReviewComment
  
  First element to compare.
- b: ReviewComment
  
  Second element to compare.
Returns number

-1 if a sorts first, 1 if b sorts first, and 0 if they are equivalent.

Generated using TypeDoc