@atomist/sdm/lib/api-helper/code/review/patternMatchReviewer.d.ts

Atomist Software Delivery Machine SDK

import { Severity } from "@atomist/automation-client/lib/operations/review/ReviewResult";
import { PushTest } from "../../../api/mapping/PushTest";
import { ReviewerRegistration } from "../../../api/registration/ReviewerRegistration";
/**
 * Antipattern we'll look for. Can be defined as a regex or a string.
 */
export interface AntiPattern {
    name: string;
    antiPattern: RegExp | string;
    comment: string;
}
export interface PatternMatchReviewerOptions {
    /**
     * PushTest to narrow review applicability
     */
    pushTest?: PushTest;
    /**
     * Glob pattern for files to check
     */
    globPattern: string;
    category?: string;
    subcategory?: string;
    severity?: Severity;
}
/**
 * Return a ReviewerRegistration that objects to the given antipatterns and looks in the specified files
 * @param {string} name
 * @param opts targeting options
 * @param {AntiPattern} antiPatterns
 * @return {ReviewerRegistration}
 */
export declare function patternMatchReviewer(name: string, opts: PatternMatchReviewerOptions, ...antiPatterns: AntiPattern[]): ReviewerRegistration;
//# sourceMappingURL=patternMatchReviewer.d.ts.map