tsc-ts 0.0.3 → 0.0.5

package/dist/api/compiler/diagnostics.d.ts

@@ -0,0 +1,167 @@
+import { Locale } from './diagnostic-locales.js';
+import { Diagnostics } from './diagnostic-messages.js';
+export { Diagnostics, Locale };
+export { parseLocale } from './locale.js';
+export declare const enum DiagnosticCategory {
+    Warning = 0,
+    Error = 1,
+    Suggestion = 2,
+    Message = 3
+}
+/** A diagnostic message template, e.g. `Diagnostics.X_0_expected` for `'{0}' expected.`. */
+export type DiagnosticMessage = Diagnostics;
+export declare function categoryName(category: DiagnosticCategory): string;
+export declare function messageCode(message: DiagnosticMessage): number;
+export declare function messageCategory(message: DiagnosticMessage): DiagnosticCategory;
+export declare function messageReportsUnnecessary(message: DiagnosticMessage): boolean;
+export declare function messageElidedInCompatibilityPyramid(message: DiagnosticMessage): boolean;
+export declare function messageReportsDeprecated(message: DiagnosticMessage): boolean;
+/** The message's key, e.g. `_0_expected_1005`, which identifies it in translations and build info. */
+export declare function messageKey(message: DiagnosticMessage): string;
+/** The message's English text. */
+export declare function messageText(message: DiagnosticMessage): string;
+/** Finds a message by its key. */
+export declare function messageForKey(key: string): DiagnosticMessage | undefined;
+/** The message's text in `locale`, with `{n}` placeholders replaced by `args[n]`. */
+export declare function localizeMessage(locale: Locale, message: DiagnosticMessage, args: readonly string[]): string;
+/**
+ * Replaces `{n}` placeholders in `text` with `args[n]`. With no arguments, `text` is returned as is. A
+ * placeholder without an argument stays as it is. tsgo panics there instead ("Invalid formatting
+ * placeholder"), which ends the run before it reports the rest of its diagnostics.
+ */
+export declare function formatMessage(text: string, args: readonly string[]): string;
+/**
+ * Makes this thread compute the caches of files that do not have them yet in copies of its own: the
+ * files may be published (immutable) and shared with other threads. Declaration files leave the
+ * parser without them (`Parser.parseSourceFile`): they make up most of the text of a typical program,
+ * and are rarely checked or pointed into by a diagnostic.
+ */
+export declare function useThreadTextCaches(): void;
+/** The text of a file diagnostics point into. */
+export declare class DiagnosticFile {
+    readonly fileName: string;
+    readonly text: string;
+    private lineStarts;
+    /** Whether this is a thread's copy of a possibly shared file (`threadCopyOf`). */
+    isThreadCopy: boolean;
+    constructor(fileName: string, text: string);
+    /**
+     * Computes the line starts, so that later reads never write to the file. The UTF-8 offsets, which
+     * only incremental builds read (for the diagnostics they store), are computed on first use, in a
+     * thread's copy where the file may be shared (`useThreadTextCaches`).
+     */
+    computeCaches(): void;
+    /**
+     * Like `computeCaches`, from the text's UTF-16 code units `units[0, text.length)`, so the text
+     * itself is neither searched nor copied.
+     */
+    computeCachesFromUnits(units: Uint16Array): void;
+    /** Start offsets of each line, split at CR, LF, CRLF, LS and PS. */
+    getLineStarts(): readonly number[];
+    private nonASCIIStarts;
+    private nonASCIILengths;
+    private extraBytes;
+    private getNonASCIIStarts;
+    /** The number of non-ASCII characters starting before UTF-16 offset `pos`. */
+    private countNonASCIIBefore;
+    /** The UTF-8 offset of UTF-16 offset `pos`, as tsgo counts positions. */
+    toUtf8Offset(pos: number): number;
+    /** The UTF-16 offset of UTF-8 offset `pos`; inside a character, the offset of its start. */
+    fromUtf8Offset(pos: number): number;
+}
+/** What a message chain entry is recomputed from when an incremental build reuses it (`RepopulateInfo`). */
+export declare const enum RepopulateKind {
+    /** How to make a CommonJS file an ES module. */
+    ModeMismatch = 1,
+    /** Where types for a module might come from. */
+    ModuleNotFound = 2
+}
+/**
+ * How to recompute a message chain entry that depends on the program (`package.json` scopes, the
+ * packages, alternate resolutions) when an incremental build reuses the diagnostic, like tsgo's
+ * `RepopulateDiagnosticInfo`.
+ */
+export declare class RepopulateInfo {
+    readonly kind: RepopulateKind;
+    readonly moduleReference: string;
+    /** The resolution mode of the import (a `ModuleKind`). */
+    readonly mode: number;
+    /** The package the types were looked up for, `''` when it is the module reference. */
+    readonly packageName: string;
+    constructor(kind: RepopulateKind, moduleReference?: string, 
+    /** The resolution mode of the import (a `ModuleKind`). */
+    mode?: number, 
+    /** The package the types were looked up for, `''` when it is the module reference. */
+    packageName?: string);
+}
+/**
+ * A diagnostic: a message with arguments, optionally at a span of a file. Positions are UTF-16
+ * offsets; compiler diagnostics have no file and a position of -1.
+ *
+ * `messageChain` holds the elaborations printed indented below the message; they are diagnostics
+ * whose file and position are not printed, but recorded in build info.
+ */
+export declare class Diagnostic {
+    file: DiagnosticFile | undefined;
+    pos: number;
+    end: number;
+    code: number;
+    category: DiagnosticCategory;
+    readonly message: DiagnosticMessage;
+    readonly args: readonly string[];
+    messageChain: Diagnostic[];
+    relatedInformation: Diagnostic[];
+    readonly reportsUnnecessary: boolean;
+    readonly reportsDeprecated: boolean;
+    skippedOnNoEmit: boolean;
+    repopulateInfo: RepopulateInfo | undefined;
+    constructor(file: DiagnosticFile | undefined, pos: number, end: number, message: DiagnosticMessage, args?: readonly string[]);
+    localize(locale: Locale): string;
+    addMessageChain(chain: Diagnostic | undefined): Diagnostic;
+    addRelatedInfo(related: Diagnostic | undefined): Diagnostic;
+    clone(): Diagnostic;
+}
+/** A message with its arguments and no location, such as a module resolution trace. */
+export interface MessageWithArgs {
+    readonly message: DiagnosticMessage;
+    readonly args: readonly string[];
+}
+export declare function messageWithArgs(message: DiagnosticMessage, ...args: string[]): MessageWithArgs;
+/** An entry of `Diagnostic.messageChain`. */
+export type DiagnosticMessageChain = Diagnostic;
+export declare function createDiagnostic(file: DiagnosticFile | undefined, pos: number, end: number, message: DiagnosticMessage, ...args: string[]): Diagnostic;
+/** A diagnostic without a file, such as an options error. */
+export declare function createCompilerDiagnostic(message: DiagnosticMessage, ...args: string[]): Diagnostic;
+/** A diagnostic for `message` that elaborates with `chain`, taking its location and related information. */
+export declare function chainDiagnostic(chain: Diagnostic | undefined, message: DiagnosticMessage, ...args: string[]): Diagnostic;
+/** Orders strings by code point, like Go's byte-wise comparison of UTF-8. */
+export declare function compareCodePoints(a: string, b: string): number;
+/** The order tsc reports diagnostics in: by file, position, code, arguments, then elaboration. */
+export declare function compareDiagnostics(a: Diagnostic, b: Diagnostic): number;
+/** Whether two diagnostics report the same thing, ignoring related information. */
+export declare function equalDiagnosticsNoRelatedInfo(a: Diagnostic, b: Diagnostic): boolean;
+export declare function equalDiagnostics(a: Diagnostic, b: Diagnostic): boolean;
+export interface DiagnosticFormatOptions {
+    readonly locale: Locale;
+    readonly currentDirectory: string;
+    readonly useCaseSensitiveFileNames: boolean;
+    readonly newLine: string;
+}
+/** The message followed by its chain, each level indented by two more spaces. */
+export declare function flattenDiagnosticMessage(diagnostic: Diagnostic, newLine: string, locale: Locale): string;
+/** `file(line,col): error TS1005: message`, as tsc prints without `--pretty`. */
+export declare function formatDiagnostic(diagnostic: Diagnostic, options: DiagnosticFormatOptions): string;
+/** `formatDiagnostic` of each diagnostic. */
+export declare function formatDiagnostics(diagnostics: readonly Diagnostic[], options: DiagnosticFormatOptions): string;
+/** The colored form with source snippets, as tsc prints with `--pretty`. */
+export declare function formatDiagnosticWithColorAndContext(diagnostic: Diagnostic, options: DiagnosticFormatOptions): string;
+export declare function formatDiagnosticsWithColorAndContext(diagnostics: readonly Diagnostic[], options: DiagnosticFormatOptions): string;
+/** A watch or build status line: `time - message`. */
+export declare function formatDiagnosticStatus(time: string, diagnostic: Diagnostic, options: DiagnosticFormatOptions): string;
+/** A watch or build status line with a colored time: `[time] message`. */
+export declare function formatDiagnosticStatusWithColor(time: string, diagnostic: Diagnostic, options: DiagnosticFormatOptions): string;
+/**
+ * The summary tsc prints after diagnostics with `--pretty`, e.g. "Found 2 errors in 2 files."
+ * followed by a table of files; empty when there are no errors.
+ */
+export declare function formatErrorSummary(diagnostics: readonly Diagnostic[], options: DiagnosticFormatOptions): string;