visreg-test/dist/utils.d.ts

A visual regression testing solution that offers an easy setup with simple yet powerful customisation options, wrapped up in a convenient CLI runner to make assessing and accepting/rejecting diffs a breeze.

import { VisregViewport } from './types';
import { EndpointTestResult, EndpointTestResultsGroup, SummaryObject } from './visreg';
export declare const projectRoot: string;
export declare const suitesDirectory: string;
export declare const getSuiteDirOrFail: (suiteName?: string) => string;
export declare const pathExists: (dirPath: string) => boolean;
export declare const hasFiles: (dirPath: string) => boolean;
export declare const parseViewport: (viewport: VisregViewport) => VisregViewport;
export declare const createScaffold: () => void;
export declare const removeDirIfEmpty: (dirPath: string) => void;
export declare const printColorText: (text: string, colorCode: string) => void;
export declare const getFileInfo: (filePath: string) => {
    createdAt: Date;
    modifiedAt: Date;
    sizeInBytes: number;
};
export declare const getHumanReadableFileSize: (filePath: string) => string;
export declare const SUITE_SNAPS_DIR: () => string;
export declare const DIFF_DIR: () => string;
export declare const BACKUP_DIFF_DIR: () => string;
export declare const RECEIVED_DIR: () => string;
export declare const BACKUP_RECEIVED_DIR: () => string;
export declare const removeBackups: () => void;
export declare const cleanUp: () => void;
export declare const getFilesInDir: (dirPath: string) => string[];
export declare const getDirectories: (source: string) => string[];
export declare const getSuites: () => string[];
export declare const getFileNameWithoutExtension: (fileName: string) => string;
export declare const getAllDiffingFiles: () => string[];
export declare const getDiffingFilesFromTestResult: () => string[];
export declare const getFileType: (fileName: string) => "baseline" | "received" | "diff";
export declare const isTargettedTest: () => boolean;
export declare const includedInTarget: (fileName: string) => boolean;
export declare const parseCypressSummary: (data: string) => SummaryObject;
export declare const parseAgenda: (data: string) => string[];
export declare const getSkippedEndpoints: (endpointTestResults: EndpointTestResultsGroup, testAgenda: string[]) => EndpointTestResult[];
export declare const getUnchangedEndpoints: (endpointTestResults: EndpointTestResultsGroup) => EndpointTestResult[];
export declare const createFailingEndpointTestResult: (payload: string, errorSignature: RegExp) => {
    userTerminated: boolean;
    failingEndpoints: EndpointTestResult[];
};
export declare const createPassingEndpointTestResult: (payload: string) => EndpointTestResult;