RecommendationSummary
import type { RecommendationSummary } from "https://aws-api.deno.dev/v0.4/services/codegurureviewer.ts?docs=full";
Information about recommendations.
interface RecommendationSummary {
Description?: string | null;
EndLine?: number | null;
FilePath?: string | null;
RecommendationCategory?: RecommendationCategory | null;
RecommendationId?: string | null;
RuleMetadata?: RuleMetadata | null;
Severity?: Severity | null;
StartLine?: number | null;
}§Properties
§
Description?: string | null
[src]A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line.
§
EndLine?: number | null
[src]Last line where the recommendation is applicable in the source commit or source branch. For a single line comment the start line and end line values are the same.
§
RecommendationCategory?: RecommendationCategory | null
[src]The type of a recommendation.
§
RecommendationId?: string | null
[src]The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.
§
RuleMetadata?: RuleMetadata | null
[src]Metadata about a rule. Rule metadata includes an ID, a name, a list of tags, and a short and long description. CodeGuru Reviewer uses rules to analyze code. A rule's recommendation is included in analysis results if code is detected that violates the rule.