UNPKG

1.56 kBTypeScriptView Raw
1/**
2 * @license
3 * Copyright 2018 Palantir Technologies, Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17import { Logger } from "./runner";
18import { LintError } from "./verify/lintError";
19export interface TestOutput {
20 skipped: false;
21 errorsFromLinter: LintError[];
22 errorsFromMarkup: LintError[];
23 fixesFromLinter: string;
24 fixesFromMarkup: string;
25 markupFromLinter: string;
26 markupFromMarkup: string;
27}
28export interface SkippedTest {
29 skipped: true;
30 requirement: string;
31}
32export interface TestResult {
33 directory: string;
34 results: {
35 [fileName: string]: TestOutput | SkippedTest;
36 };
37}
38export declare function runTests(patterns: string[], rulesDirectory?: string | string[]): TestResult[];
39export declare function runTest(testDirectory: string, rulesDirectory?: string | string[]): TestResult;
40export declare function consoleTestResultsHandler(testResults: TestResult[], logger: Logger): boolean;
41export declare function consoleTestResultHandler(testResult: TestResult, logger: Logger): boolean;