ace-linters/types/javascript-service.d.ts

Ace linters is lsp client for Ace editor. It comes with large number of preconfigured easy to use in browser servers.

import * as lsp from 'vscode-languageserver-protocol';
import { TextDocumentIdentifier, TextDocumentItem } from 'vscode-languageserver-protocol';
import { TextDocument } from 'vscode-languageserver-textdocument';

export interface LanguageService {
	documents: {
		[documentUri: string]: TextDocument;
	};
	serviceName: string;
	mode: string;
	globalOptions: any;
	serviceData: LanguageClientConfig | ServiceConfig;
	serviceCapabilities: lsp.ServerCapabilities;
	workspaceUri?: string;
	format(document: lsp.TextDocumentIdentifier, range: lsp.Range, options: lsp.FormattingOptions): Promise<lsp.TextEdit[]>;
	doHover(document: lsp.TextDocumentIdentifier, position: lsp.Position): Promise<lsp.Hover | null>;
	doValidation(document: lsp.TextDocumentIdentifier): Promise<lsp.Diagnostic[]>;
	doComplete(document: lsp.TextDocumentIdentifier, position: lsp.Position): Promise<lsp.CompletionItem[] | lsp.CompletionList | null>;
	doResolve(item: lsp.CompletionItem): Promise<lsp.CompletionItem | null>;
	setValue(identifier: lsp.VersionedTextDocumentIdentifier, value: string): any;
	applyDeltas(identifier: lsp.VersionedTextDocumentIdentifier, deltas: lsp.TextDocumentContentChangeEvent[]): any;
	addDocument(document: TextDocumentItem): any;
	setOptions(documentUri: string, options: ServiceOptions, merge?: boolean): any;
	setGlobalOptions(options: ServiceOptions): any;
	getDocument(uri: string): TextDocument;
	removeDocument(document: TextDocumentIdentifier): any;
	renameDocument(document: TextDocumentIdentifier, newDocumentUri: string): any;
	getDocumentValue(uri: string): string | undefined;
	provideSignatureHelp(document: lsp.TextDocumentIdentifier, position: lsp.Position): Promise<lsp.SignatureHelp | null>;
	findDocumentHighlights(document: lsp.TextDocumentIdentifier, position: lsp.Position): Promise<lsp.DocumentHighlight[]>;
	getSemanticTokens(document: lsp.TextDocumentIdentifier, range: lsp.Range): Promise<lsp.SemanticTokens | null>;
	getCodeActions(document: lsp.TextDocumentIdentifier, range: lsp.Range, context: lsp.CodeActionContext): Promise<(lsp.Command | lsp.CodeAction)[] | null>;
	executeCommand(command: string, args?: lsp.LSPAny[]): Promise<any | null>;
	sendAppliedResult(result: lsp.ApplyWorkspaceEditResult, callbackId: number): void;
	dispose(): Promise<void>;
	closeConnection(): Promise<void>;
	setWorkspace(workspaceUri: string): void;
}
export interface ServiceOptions {
	[name: string]: any;
}
export interface ServiceOptionsWithErrorMessages {
	errorMessagesToIgnore?: RegExp[];
	errorMessagesToTreatAsWarning?: RegExp[];
	errorMessagesToTreatAsInfo?: RegExp[];
}
export interface JavascriptServiceOptions extends ServiceOptionsWithErrorMessages {
	env?: {
		[name: string]: boolean;
	} | undefined;
	extends?: string | string[] | undefined;
	globals?: {
		[name: string]: boolean | "off" | "readonly" | "readable" | "writable" | "writeable";
	} | undefined;
	noInlineConfig?: boolean | undefined;
	overrides?: Array<any> | undefined;
	parser?: string | undefined;
	parserOptions?: {
		[option: string]: any;
	} | undefined;
	plugins?: string[] | undefined;
	processor?: string | undefined;
	reportUnusedDisableDirectives?: boolean | undefined;
	settings?: {
		[name: string]: any;
	} | undefined;
	rules?: {
		[rule: string]: any;
	};
}
export type ServiceFeatures = {
	[feature in SupportedFeatures]?: boolean;
};
export type SupportedFeatures = "hover" | "completion" | "completionResolve" | "format" | "diagnostics" | "signatureHelp" | "documentHighlight" | "semanticTokens" | "codeAction" | "executeCommand";
export interface ServiceConfig extends BaseConfig {
	className: string;
	options?: ServiceOptions;
}
export interface BaseConfig {
	initializationOptions?: ServiceOptions;
	options?: ServiceOptions;
	serviceInstance?: LanguageService;
	modes: string;
	className?: string;
	features?: ServiceFeatures;
	module: () => any;
	id?: string;
}
export interface WebWorkerConnection {
	type: "webworker";
	worker: Worker;
}
export interface SocketConnection {
	type: "socket";
	socket: WebSocket;
}
export interface StdioConnection {
	type: "stdio";
	command: string;
}
export interface IpcConnection {
	type: "ipc";
	ipcPath: string;
}
export type ConnectionType = WebWorkerConnection | SocketConnection | StdioConnection | IpcConnection;
export type LanguageClientConfig = BaseConfig & ConnectionType;
export interface FilterDiagnosticsOptions {
	errorCodesToIgnore?: string[];
	errorCodesToTreatAsWarning?: string[];
	errorCodesToTreatAsInfo?: string[];
	errorMessagesToIgnore?: RegExp[];
	errorMessagesToTreatAsWarning?: RegExp[];
	errorMessagesToTreatAsInfo?: RegExp[];
}
declare abstract class BaseService<OptionsType extends ServiceOptions = ServiceOptions> implements LanguageService {
	serviceName: string;
	mode: string;
	documents: {
		[documentUri: lsp.DocumentUri]: TextDocument;
	};
	options: {
		[documentUri: string]: OptionsType;
	};
	globalOptions: OptionsType;
	serviceData: ServiceConfig;
	serviceCapabilities: lsp.ServerCapabilities;
	workspaceUri?: string;
	clientCapabilities: lsp.ClientCapabilities;
	protected constructor(mode: string, workspaceUri?: string);
	addDocument(document: lsp.TextDocumentItem): void;
	getDocument(uri: string): TextDocument;
	removeDocument(document: lsp.TextDocumentIdentifier): void;
	renameDocument(document: lsp.TextDocumentIdentifier, newDocumentUri: string): void;
	getDocumentValue(uri: string): string | undefined;
	setValue(identifier: lsp.VersionedTextDocumentIdentifier, value: string): void;
	setGlobalOptions(options: OptionsType): void;
	setWorkspace(workspaceUri: string): void;
	setOptions(documentUri: string, options: OptionsType, merge?: boolean): void;
	getOption<T extends keyof OptionsType>(documentUri: string, optionName: T): OptionsType[T];
	applyDeltas(identifier: lsp.VersionedTextDocumentIdentifier, deltas: lsp.TextDocumentContentChangeEvent[]): void;
	doComplete(document: any, position: lsp.Position): Promise<lsp.CompletionItem[] | lsp.CompletionList | null>;
	doHover(document: any, position: lsp.Position): Promise<lsp.Hover | null>;
	doResolve(item: lsp.CompletionItem): Promise<lsp.CompletionItem | null>;
	doValidation(document: lsp.TextDocumentIdentifier): Promise<lsp.Diagnostic[]>;
	format(document: lsp.TextDocumentIdentifier, range: lsp.Range, options: lsp.FormattingOptions): Promise<lsp.TextEdit[]>;
	provideSignatureHelp(document: lsp.TextDocumentIdentifier, position: lsp.Position): Promise<lsp.SignatureHelp | null>;
	findDocumentHighlights(document: lsp.TextDocumentIdentifier, position: lsp.Position): Promise<lsp.DocumentHighlight[]>;
	get optionsToFilterDiagnostics(): FilterDiagnosticsOptions;
	getSemanticTokens(document: lsp.TextDocumentIdentifier, range: lsp.Range): Promise<lsp.SemanticTokens | null>;
	dispose(): Promise<void>;
	closeConnection(): Promise<void>;
	getCodeActions(document: lsp.TextDocumentIdentifier, range: lsp.Range, context: lsp.CodeActionContext): Promise<(lsp.Command | lsp.CodeAction)[] | null>;
	executeCommand(command: string, args?: any[]): Promise<any | null>;
	sendAppliedResult(result: lsp.ApplyWorkspaceEditResult, callbackId: number): void;
}
export declare class JavascriptService extends BaseService<JavascriptServiceOptions> implements LanguageService {
	private $service;
	$defaultEnv: {
		browser: boolean;
		amd: boolean;
		builtin: boolean;
		node: boolean;
		jasmine: boolean;
		mocha: boolean;
		es6: boolean;
		jquery: boolean;
		meteor: boolean;
	};
	$defaultParserOptions: {
		ecmaFeatures: {
			globalReturn: boolean;
			jsx: boolean;
			experimentalObjectRestSpread: boolean;
		};
		allowImportExportEverywhere: boolean;
		allowAwaitOutsideFunction: boolean;
		ecmaVersion: number;
	};
	$defaultRules: {
		"handle-callback-err": number;
		"no-debugger": number;
		"no-undef": number;
		"no-inner-declarations": (string | number)[];
		"no-native-reassign": number;
		"no-new-func": number;
		"no-new-wrappers": number;
		"no-cond-assign": (string | number)[];
		"no-dupe-keys": number;
		"no-eval": number;
		"no-func-assign": number;
		"no-extra-semi": number;
		"no-invalid-regexp": number;
		"no-irregular-whitespace": number;
		"no-negated-in-lhs": number;
		"no-regex-spaces": number;
		"quote-props": number;
		"no-unreachable": number;
		"use-isnan": number;
		"valid-typeof": number;
		"no-redeclare": number;
		"no-with": number;
		radix: number;
		"no-delete-var": number;
		"no-label-var": number;
		"no-console": number;
		"no-shadow-restricted-names": number;
		"no-new-require": number;
	};
	serviceCapabilities: {
		diagnosticProvider: {
			interFileDependencies: boolean;
			workspaceDiagnostics: boolean;
		};
	};
	constructor(mode: string);
	get config(): {
		rules: {
			[rule: string]: any;
		} | {
			"handle-callback-err": number;
			"no-debugger": number;
			"no-undef": number;
			"no-inner-declarations": (string | number)[];
			"no-native-reassign": number;
			"no-new-func": number;
			"no-new-wrappers": number;
			"no-cond-assign": (string | number)[];
			"no-dupe-keys": number;
			"no-eval": number;
			"no-func-assign": number;
			"no-extra-semi": number;
			"no-invalid-regexp": number;
			"no-irregular-whitespace": number;
			"no-negated-in-lhs": number;
			"no-regex-spaces": number;
			"quote-props": number;
			"no-unreachable": number;
			"use-isnan": number;
			"valid-typeof": number;
			"no-redeclare": number;
			"no-with": number;
			radix: number;
			"no-delete-var": number;
			"no-label-var": number;
			"no-console": number;
			"no-shadow-restricted-names": number;
			"no-new-require": number;
		};
		env: {
			[name: string]: boolean;
		} | {
			browser: boolean;
			amd: boolean;
			builtin: boolean;
			node: boolean;
			jasmine: boolean;
			mocha: boolean;
			es6: boolean;
			jquery: boolean;
			meteor: boolean;
		};
		globals: {
			[name: string]: boolean | "readonly" | "off" | "readable" | "writable" | "writeable";
		};
		parserOptions: {
			[option: string]: any;
		} | {
			ecmaFeatures: {
				globalReturn: boolean;
				jsx: boolean;
				experimentalObjectRestSpread: boolean;
			};
			allowImportExportEverywhere: boolean;
			allowAwaitOutsideFunction: boolean;
			ecmaVersion: number;
		};
	};
	doValidation(document: lsp.TextDocumentIdentifier): Promise<lsp.Diagnostic[]>;
}

export {};