All files / src Context.ts

0% Statements 0/1
0% Branches 0/1
0% Functions 0/1
0% Lines 0/1

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55                                                                                                             
/*!
 * Copyright 2019 Palantir Technologies, Inc.
 *
 * Licensed under the MIT license. See LICENSE file in the project root for details.
 *
 */
 
import { Host, PackageJson } from "@monorepolint/utils";
import { ResolvedConfig } from "./Config.js";
import { WorkspaceContext } from "./WorkspaceContext.js";
export interface Failure {
  message: string;
  file?: string;
  longMessage?: string | null;
  fixer?: () => void;
}
 
export interface AddErrorOptions extends Failure {
  file: string;
}
 
export interface AddErrorAsyncOptions extends AddErrorOptions {
  fixer?: () => Promise<void>;
}
 
export interface AddErrorSyncOrAsyncOptions extends AddErrorOptions {
  fixer?: AddErrorAsyncOptions["fixer"] | AddErrorOptions["fixer"];
}
 
export interface Context {
  readonly depth: number;
  readonly failed: boolean;
  readonly packageDir: string;
  readonly parent?: Context;
  readonly resolvedConfig: ResolvedConfig;
  readonly host: Host;
 
  getName(): string;
 
  getPackageJsonPath(): string;
 
  getPackageJson(): PackageJson;
  addWarning(opts: Failure): void;
  addError(opts: AddErrorOptions): void;
  addErrorAsync(opts: AddErrorAsyncOptions): Promise<void>;
 
  isFailure(): boolean;
 
  finish(): void;
 
  setFailed(): void;
 
  getWorkspaceContext(): WorkspaceContext;
}