@biomejs/js-api/dist/wasm.d.ts

JavaScript APIs for the Biome package

export type BiomePath = string;
export type ProjectKey = number;
interface UpdateSettingsParams<Configuration> {
    configuration: Configuration;
    projectKey: ProjectKey;
    workspaceDirectory?: BiomePath;
}
type TextRange = [TextSize, TextSize];
type TextSize = number;
interface OpenProjectParams {
    openUninitialized: boolean;
    path: BiomePath;
}
export interface OpenProjectResult {
    /**
     * A unique identifier for this project
     */
    projectKey: ProjectKey;
    /**
     * How to scan this project
     */
    scanKind: ScanKind;
}
type ScanKind = "noScanner" | "knownFiles" | {
    targetedKnownFiles: {
        /**
         * Determines whether the file scanner should descend into subdirectories of the target paths.
         */
        descendFromTargets: boolean;
        /**
* The paths to target by the scanner.

If a target path indicates a folder, all files within are scanned as well.

Target paths must be absolute.
*/
        targetPaths: BiomePath[];
    };
} | "project";
interface OpenFileParams {
    content: FileContent;
    path: BiomePath;
    projectKey: ProjectKey;
}
type FileContent = {
    content: string;
    type: "fromClient";
    version: number;
};
interface CloseFileParams {
    path: BiomePath;
    projectKey: ProjectKey;
}
interface GetFormatterIRParams {
    path: BiomePath;
    projectKey: ProjectKey;
}
interface PullDiagnosticsParams {
    categories: RuleCategories;
    path: BiomePath;
    projectKey: ProjectKey;
    /**
     * When `false` the diagnostics, don't have code frames of the code actions
     * (fixes, suppressions, etc.)
     */
    pullCodeActions: boolean;
}
type RuleCategories = RuleCategory[];
type RuleCategory = "syntax" | "lint" | "action" | "transformation";
interface PullDiagnosticsResult<Diagnostic> {
    diagnostics: Diagnostic[];
    errors: number;
}
interface FormatFileParams {
    path: BiomePath;
    projectKey: ProjectKey;
}
interface FormatRangeParams {
    path: BiomePath;
    projectKey: ProjectKey;
    range: TextRange;
}
interface FixFileParams {
    fixFileMode: FixFileMode;
    path: BiomePath;
    projectKey: ProjectKey;
    ruleCategories: RuleCategories;
    shouldFormat: boolean;
}
export type FixFileMode = "safeFixes" | "safeAndUnsafeFixes" | "applySuppressions";
interface FixFileResult {
    /**
     * New source code for the file with all fixes applied
     */
    code: string;
}
export interface DiagnosticPrinter<Diagnostic> {
    free(): void;
    print_simple(diagnostic: Diagnostic): void;
    print_verbose(diagnostic: Diagnostic): void;
    finish(): string;
}
export interface Workspace<Configuration, Diagnostic> {
    free(): void;
    updateSettings(params: UpdateSettingsParams<Configuration>): void;
    openProject(params: OpenProjectParams): OpenProjectResult;
    openFile(params: OpenFileParams): void;
    closeFile(params: CloseFileParams): void;
    pullDiagnostics(params: PullDiagnosticsParams): PullDiagnosticsResult<Diagnostic>;
    formatRange(params: FormatRangeParams): any;
    formatFile(params: FormatFileParams): any;
    getFormatterIr(params: GetFormatterIRParams): string;
    fixFile(params: FixFileParams): FixFileResult;
}
export interface Module<Configuration, Diagnostic> {
    main: () => void;
    DiagnosticPrinter: new (fileName: string, fileSource: string) => DiagnosticPrinter<Diagnostic>;
    Workspace: new () => Workspace<Configuration, Diagnostic>;
}
/**
 * Catch a WebAssembly error and wrap into a native JS Error
 *
 * @param func The function to execute
 */
export declare function tryCatchWrapper<T>(func: () => T): T;
export {};
//# sourceMappingURL=wasm.d.ts.map