@ts-common/azure-js-dev-tools/dist/lib/checkEverything.d.ts

Developer dependencies for TypeScript related projects

/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for
 * license information.
 */
import { Logger } from "@azure/logger-js";
import { CheckForOnlyCallsOptions } from "./checkForOnlyCalls";
import { CheckForSkipCallsOptions } from "./checkForSkipCalls";
import { CheckPackageJsonVersionOptions } from "./checkPackageJsonVersion";
import { CheckForUnstagedChangesOptions } from "./checkForUnstagedChanges";
/**
 * An additional check that can be run.
 */
export interface AdditionalCheck {
    /**
     * The name of the additional check.
     */
    name: string;
    /**
     * The implementation of the additional check.
     */
    check: () => number | Promise<number>;
}
export interface CheckEverythingOptions {
    /**
     * The Logger to use for each of the repository checks. If no Logger is specified, then a default
     * Logger will be used.
     */
    logger?: Logger;
    /**
     * The options to provide to the package.json version check, or false to disable the check.
     */
    checkPackageJsonVersionOptions?: CheckPackageJsonVersionOptions | false;
    /**
     * The options to provide to the check for only() calls check, or false to disable the check.
     */
    checkForOnlyCallsOptions?: CheckForOnlyCallsOptions | false;
    /**
     * The options to provide to the check for skip() calls check, or false to disable the check.
     */
    checkForSkipCallsOptions?: CheckForSkipCallsOptions | false;
    /**
     * The options to provide to the check for unstaged changes check, or false to disable the check.
     */
    checkForUnstagedChangesOptions?: CheckForUnstagedChangesOptions | false;
    /**
     * Additional checks that can be run as a part of check everything.
     */
    additionalChecks?: AdditionalCheck | AdditionalCheck[];
}
/**
 * Run all of the repository checks.
 * @returns The number of repository checks that failed.
 */
export declare function checkEverything(options?: CheckEverythingOptions): Promise<number>;
//# sourceMappingURL=checkEverything.d.ts.map