@types/atom/linter/index.d.ts

TypeScript definitions for atom

// Linter 2.x
// https://atom.io/packages/linter

/// <reference path="./config.d.ts" />

import { Disposable, Point, Range, TextEditor } from "../index";

export interface Config {
    name: string;
}

export interface ReplacementSolution {
    title?: string;
    position: Range;
    priority?: number;
    currentText?: string;
    replaceWith: string;
}

export interface CallbackSolution {
    title?: string;
    position: Range;
    priority?: number;
    apply(): any;
}

export interface Message {
    /** The location of the issue (aka where to highlight). */
    location: {
        /** The path to the file to which the message applies. */
        file: string;

        /** The range of the message in the editor. */
        position: Range;
    };

    /** A reference to a different location in the editor. */
    reference?: {
        /** The path to the file being referenced. */
        file: string;

        /** The point being referenced in that file. */
        position?: Point;
    };

    /** An HTTP link to a resource explaining the issue. Default is a google search. */
    url?: string;

    /** The name of the octicon to show in the gutter. */
    icon?: string;

    /** The text for the message. */
    excerpt: string;

    /** The severity level for the message. */
    severity: "error" | "warning" | "info";

    /** Possible solutions (which the user can invoke at will). */
    solutions?: Array<ReplacementSolution | CallbackSolution>;

    /**
     *  Markdown long description of the error. Accepts a callback so that you can
     *  do things like HTTP requests.
     */
    description?: string | (() => Promise<string> | string);

    /** Optionally override the displayed linter name. Defaults to provider name. */
    linterName?: string;
}

export interface IndieDelegate {
    name: string;
    getMessages(): Message[];
    clearMessages(): void;
    setMessages(filePath: string, messages: Message[]): void;
    setAllMessages(messages: Message[]): void;
    onDidUpdate(callback: () => void): Disposable;
    onDidDestroy(callback: () => void): Disposable;
    dispose(): void;
}

export type LintResult = Message[] | null;

export interface LinterProvider {
    name: string;
    scope: "file" | "project";
    lintsOnChange: boolean;
    grammarScopes: string[];
    lint(editor: TextEditor): LintResult | Promise<LintResult>;
}

export type IndieProvider = (register: (config: Config) => IndieDelegate) => void;