Microsoft/vscode
1
0
Fork 0
mirror of https://github.com/microsoft/vscode.git synced 2025-12-24 12:19:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

DiagnosticsSupport for json and html

Browse Source
This commit is contained in:
Martin Aeschlimann
2022-05-19 22:27:28 +02:00
parent aacb387ef1
commit 49944b1501
6 changed files with 87 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
extensions/css-language-features/server/src/cssServer.ts
View File

@@ -57,7 +57,7 @@ export function startServer(connection: Connection, runtime: RuntimeEnvironment)
let dataProvidersReady: Promise<any> = Promise.resolve(); let dataProvidersReady: Promise<any> = Promise.resolve();
let diagnosticPushSupport: DiagnosticsSupport | undefined; let diagnosticsSupport: DiagnosticsSupport | undefined;
const languageServices: { [id: string]: LanguageService } = {}; const languageServices: { [id: string]: LanguageService } = {};
@@ -103,9 +103,9 @@ export function startServer(connection: Connection, runtime: RuntimeEnvironment)
const pullDiagnosticSupport = getClientCapability('textDocument.diagnostic', undefined); const pullDiagnosticSupport = getClientCapability('textDocument.diagnostic', undefined);
if (pullDiagnosticSupport === undefined) { if (pullDiagnosticSupport === undefined) {
diagnosticPushSupport = registerDiagnosticsPushSupport(documents, connection, runtime, validateTextDocument); diagnosticsSupport = registerDiagnosticsPushSupport(documents, connection, runtime, validateTextDocument);
} else { } else {
diagnosticPushSupport = registerDiagnosticsPullSupport(documents, connection, runtime, validateTextDocument); diagnosticsSupport = registerDiagnosticsPullSupport(documents, connection, runtime, validateTextDocument);
} }
const capabilities: ServerCapabilities = { const capabilities: ServerCapabilities = {
@@ -173,7 +173,7 @@ export function startServer(connection: Connection, runtime: RuntimeEnvironment)
} }
// reset all document settings // reset all document settings
documentSettings = {}; documentSettings = {};
diagnosticPushSupport?.requestRefresh(); diagnosticsSupport?.requestRefresh();
} }
async function validateTextDocument(textDocument: TextDocument): Promise<Diagnostic[]> { async function validateTextDocument(textDocument: TextDocument): Promise<Diagnostic[]> {

5
extensions/css-language-features/server/src/utils/validation.ts
View File

@@ -58,8 +58,6 @@ export function registerDiagnosticsPushSupport(documents: TextDocuments<TextDocu
}, validationDelayMs); }, validationDelayMs);
} }
documents.all().forEach(triggerValidation);
return { return {
requestRefresh: () => { requestRefresh: () => {
documents.all().forEach(triggerValidation); documents.all().forEach(triggerValidation);
@@ -85,7 +83,7 @@ export function registerDiagnosticsPullSupport(documents: TextDocuments<TextDocu
}; };
} }
connection.languages.diagnostics.on(async (params: DocumentDiagnosticParams, token: CancellationToken) => { const registration = connection.languages.diagnostics.on(async (params: DocumentDiagnosticParams, token: CancellationToken) => {
return runSafeAsync(runtime, async () => { return runSafeAsync(runtime, async () => {
const document = documents.get(params.textDocument.uri); const document = documents.get(params.textDocument.uri);
if (document) { if (document) {
@@ -103,6 +101,7 @@ export function registerDiagnosticsPullSupport(documents: TextDocuments<TextDocu
return { return {
requestRefresh, requestRefresh,
dispose: () => { dispose: () => {
registration.dispose();
} }
}; };

58
extensions/html-language-features/server/src/htmlServer.ts
View File

@@ -19,6 +19,7 @@ import { pushAll } from './utils/arrays';
import { getDocumentContext } from './utils/documentContext'; import { getDocumentContext } from './utils/documentContext';
import { URI } from 'vscode-uri'; import { URI } from 'vscode-uri';
import { formatError, runSafe } from './utils/runner'; import { formatError, runSafe } from './utils/runner';
import { DiagnosticsSupport, registerDiagnosticsPullSupport, registerDiagnosticsPushSupport } from './utils/validation';
import { getFoldingRanges } from './modes/htmlFolding'; import { getFoldingRanges } from './modes/htmlFolding';
import { fetchHTMLDataProviders } from './customData'; import { fetchHTMLDataProviders } from './customData';
@@ -92,6 +93,8 @@ export function startServer(connection: Connection, runtime: RuntimeEnvironment)
let languageModes: LanguageModes; let languageModes: LanguageModes;
let diagnosticsSupport: DiagnosticsSupport | undefined;
let clientSnippetSupport = false; let clientSnippetSupport = false;
let dynamicFormatterRegistration = false; let dynamicFormatterRegistration = false;
let scopedSettingsSupport = false; let scopedSettingsSupport = false;
@@ -180,6 +183,14 @@ export function startServer(connection: Connection, runtime: RuntimeEnvironment)
workspaceFoldersSupport = getClientCapability('workspace.workspaceFolders', false); workspaceFoldersSupport = getClientCapability('workspace.workspaceFolders', false);
foldingRangeLimit = getClientCapability('textDocument.foldingRange.rangeLimit', Number.MAX_VALUE); foldingRangeLimit = getClientCapability('textDocument.foldingRange.rangeLimit', Number.MAX_VALUE);
formatterMaxNumberOfEdits = initializationOptions?.customCapabilities?.rangeFormatting?.editLimit || Number.MAX_VALUE; formatterMaxNumberOfEdits = initializationOptions?.customCapabilities?.rangeFormatting?.editLimit || Number.MAX_VALUE;
const pullDiagnosticSupport = getClientCapability('textDocument.diagnostic', undefined);
if (pullDiagnosticSupport === undefined) {
diagnosticsSupport = registerDiagnosticsPushSupport(documents, connection, runtime, validateTextDocument);
} else {
diagnosticsSupport = registerDiagnosticsPullSupport(documents, connection, runtime, validateTextDocument);
}
const capabilities: ServerCapabilities = { const capabilities: ServerCapabilities = {
textDocumentSync: TextDocumentSyncKind.Incremental, textDocumentSync: TextDocumentSyncKind.Incremental,
completionProvider: clientSnippetSupport ? { resolveProvider: true, triggerCharacters: ['.', ':', '<', '"', '=', '/'] } : undefined, completionProvider: clientSnippetSupport ? { resolveProvider: true, triggerCharacters: ['.', ':', '<', '"', '=', '/'] } : undefined,
@@ -196,7 +207,12 @@ export function startServer(connection: Connection, runtime: RuntimeEnvironment)
foldingRangeProvider: true, foldingRangeProvider: true,
selectionRangeProvider: true, selectionRangeProvider: true,
renameProvider: true, renameProvider: true,
linkedEditingRangeProvider: true linkedEditingRangeProvider: true,
diagnosticProvider: {
documentSelector: null,
interFileDependencies: false,
workspaceDiagnostics: false
}
}; };
return { capabilities }; return { capabilities };
}); });
@@ -217,7 +233,7 @@ export function startServer(connection: Connection, runtime: RuntimeEnvironment)
} }
} }
workspaceFolders = updatedFolders.concat(toAdd); workspaceFolders = updatedFolders.concat(toAdd);
documents.all().forEach(triggerValidation); diagnosticsSupport?.requestRefresh();
}); });
} }
}); });
@@ -228,7 +244,7 @@ export function startServer(connection: Connection, runtime: RuntimeEnvironment)
connection.onDidChangeConfiguration((change) => { connection.onDidChangeConfiguration((change) => {
globalSettings = change.settings as Settings; globalSettings = change.settings as Settings;
documentSettings = {}; // reset all document settings documentSettings = {}; // reset all document settings
documents.all().forEach(triggerValidation); diagnosticsSupport?.requestRefresh();
// dynamically enable & disable the formatter // dynamically enable & disable the formatter
if (dynamicFormatterRegistration) { if (dynamicFormatterRegistration) {
@@ -248,37 +264,6 @@ export function startServer(connection: Connection, runtime: RuntimeEnvironment)
} }
}); });
const pendingValidationRequests: { [uri: string]: Disposable } = {};
const validationDelayMs = 500;
// The content of a text document has changed. This event is emitted
// when the text document first opened or when its content has changed.
documents.onDidChangeContent(change => {
triggerValidation(change.document);
});
// a document has closed: clear all diagnostics
documents.onDidClose(event => {
cleanPendingValidation(event.document);
connection.sendDiagnostics({ uri: event.document.uri, diagnostics: [] });
});
function cleanPendingValidation(textDocument: TextDocument): void {
const request = pendingValidationRequests[textDocument.uri];
if (request) {
request.dispose();
delete pendingValidationRequests[textDocument.uri];
}
}
function triggerValidation(textDocument: TextDocument): void {
cleanPendingValidation(textDocument);
pendingValidationRequests[textDocument.uri] = runtime.timer.setTimeout(() => {
delete pendingValidationRequests[textDocument.uri];
validateTextDocument(textDocument);
}, validationDelayMs);
}
function isValidationEnabled(languageId: string, settings: Settings = globalSettings) { function isValidationEnabled(languageId: string, settings: Settings = globalSettings) {
const validationSettings = settings && settings.html && settings.html.validate; const validationSettings = settings && settings.html && settings.html.validate;
if (validationSettings) { if (validationSettings) {
@@ -287,7 +272,7 @@ export function startServer(connection: Connection, runtime: RuntimeEnvironment)
return true; return true;
} }
async function validateTextDocument(textDocument: TextDocument) { async function validateTextDocument(textDocument: TextDocument): Promise<Diagnostic[]> {
try { try {
const version = textDocument.version; const version = textDocument.version;
const diagnostics: Diagnostic[] = []; const diagnostics: Diagnostic[] = [];
@@ -301,12 +286,13 @@ export function startServer(connection: Connection, runtime: RuntimeEnvironment)
pushAll(diagnostics, await mode.doValidation(latestTextDocument, settings)); pushAll(diagnostics, await mode.doValidation(latestTextDocument, settings));
} }
} }
connection.sendDiagnostics({ uri: latestTextDocument.uri, diagnostics }); return diagnostics;
} }
} }
} catch (e) { } catch (e) {
connection.console.error(formatError(`Error while validating ${textDocument.uri}`, e)); connection.console.error(formatError(`Error while validating ${textDocument.uri}`, e));
} }
return [];
} }
connection.onCompletion(async (textDocumentPosition, token) => { connection.onCompletion(async (textDocumentPosition, token) => {

50
extensions/html-language-features/server/src/utils/validation.ts
View File

@@ -3,15 +3,18 @@
* Licensed under the MIT License. See License.txt in the project root for license information. * Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/ *--------------------------------------------------------------------------------------------*/
import { Connection, Diagnostic, Disposable, TextDocuments } from 'vscode-languageserver'; import { CancellationToken, Connection, Diagnostic, Disposable, DocumentDiagnosticParams, DocumentDiagnosticReport, DocumentDiagnosticReportKind, TextDocuments } from 'vscode-languageserver';
import { TextDocument } from 'vscode-html-languageservice'; import { TextDocument } from 'vscode-html-languageservice';
import { formatError } from './runner'; import { formatError, runSafe } from './runner';
import { RuntimeEnvironment } from '../htmlServer'; import { RuntimeEnvironment } from '../htmlServer';
export type Validator = (textDocument: TextDocument) => Promise<Diagnostic[]>; export type Validator = (textDocument: TextDocument) => Promise<Diagnostic[]>;
export type DiagnosticPushSupport = { dispose(): void; triggerValidation(textDocument: TextDocument): void }; export type DiagnosticsSupport = {
dispose(): void;
requestRefresh(): void;
};
export function registerDiagnosticPushSupport(documents: TextDocuments<TextDocument>, connection: Connection, runtime: RuntimeEnvironment, validate: Validator): DiagnosticPushSupport { export function registerDiagnosticsPushSupport(documents: TextDocuments<TextDocument>, connection: Connection, runtime: RuntimeEnvironment, validate: Validator): DiagnosticsSupport {
const pendingValidationRequests: { [uri: string]: Disposable } = {}; const pendingValidationRequests: { [uri: string]: Disposable } = {};
const validationDelayMs = 500; const validationDelayMs = 500;
@@ -55,10 +58,10 @@ export function registerDiagnosticPushSupport(documents: TextDocuments<TextDocum
}, validationDelayMs); }, validationDelayMs);
} }
documents.all().forEach(triggerValidation);
return { return {
triggerValidation, requestRefresh: () => {
documents.all().forEach(triggerValidation);
},
dispose: () => { dispose: () => {
disposables.forEach(d => d.dispose()); disposables.forEach(d => d.dispose());
disposables.length = 0; disposables.length = 0;
@@ -70,3 +73,36 @@ export function registerDiagnosticPushSupport(documents: TextDocuments<TextDocum
} }
}; };
} }
export function registerDiagnosticsPullSupport(documents: TextDocuments<TextDocument>, connection: Connection, runtime: RuntimeEnvironment, validate: Validator): DiagnosticsSupport {
function newDocumentDiagnosticReport(diagnostics: Diagnostic[]): DocumentDiagnosticReport {
return {
kind: DocumentDiagnosticReportKind.Full,
items: diagnostics
};
}
const registration = connection.languages.diagnostics.on(async (params: DocumentDiagnosticParams, token: CancellationToken) => {
return runSafe(runtime, async () => {
const document = documents.get(params.textDocument.uri);
if (document) {
return newDocumentDiagnosticReport(await validate(document));
}
return newDocumentDiagnosticReport([]);
}, newDocumentDiagnosticReport([]), `Error while computing diagnostics for ${params.textDocument.uri}`, token);
});
function requestRefresh(): void {
connection.languages.diagnostics.refresh();
}
return {
requestRefresh,
dispose: () => {
registration.dispose();
}
};
}

36
extensions/json-language-features/server/src/jsonServer.ts
View File

@@ -9,7 +9,7 @@ import {
DocumentRangeFormattingRequest, Disposable, ServerCapabilities, TextDocumentSyncKind, TextEdit, DocumentFormattingRequest, TextDocumentIdentifier, FormattingOptions, Diagnostic DocumentRangeFormattingRequest, Disposable, ServerCapabilities, TextDocumentSyncKind, TextEdit, DocumentFormattingRequest, TextDocumentIdentifier, FormattingOptions, Diagnostic
} from 'vscode-languageserver'; } from 'vscode-languageserver';
import { formatError, runSafe, runSafeAsync } from './utils/runner'; import { runSafe, runSafeAsync } from './utils/runner';
import { DiagnosticsSupport, registerDiagnosticsPullSupport, registerDiagnosticsPushSupport } from './utils/validation'; import { DiagnosticsSupport, registerDiagnosticsPullSupport, registerDiagnosticsPushSupport } from './utils/validation';
import { TextDocument, JSONDocument, JSONSchema, getLanguageService, DocumentLanguageSettings, SchemaConfiguration, ClientCapabilities, Range, Position } from 'vscode-json-languageservice'; import { TextDocument, JSONDocument, JSONSchema, getLanguageService, DocumentLanguageSettings, SchemaConfiguration, ClientCapabilities, Range, Position } from 'vscode-json-languageservice';
import { getLanguageModelCache } from './languageModelCache'; import { getLanguageModelCache } from './languageModelCache';
@@ -114,7 +114,7 @@ export function startServer(connection: Connection, runtime: RuntimeEnvironment)
let resultLimit = Number.MAX_VALUE; let resultLimit = Number.MAX_VALUE;
let formatterMaxNumberOfEdits = Number.MAX_VALUE; let formatterMaxNumberOfEdits = Number.MAX_VALUE;
let diagnosticSupport: DiagnosticsSupport | undefined; let diagnosticsSupport: DiagnosticsSupport | undefined;
// After the server has started the client sends an initialize request. The server receives // After the server has started the client sends an initialize request. The server receives
@@ -154,9 +154,9 @@ export function startServer(connection: Connection, runtime: RuntimeEnvironment)
const pullDiagnosticSupport = getClientCapability('textDocument.diagnostic', undefined); const pullDiagnosticSupport = getClientCapability('textDocument.diagnostic', undefined);
if (pullDiagnosticSupport === undefined) { if (pullDiagnosticSupport === undefined) {
diagnosticSupport = registerDiagnosticsPushSupport(documents, connection, runtime, validateTextDocument); diagnosticsSupport = registerDiagnosticsPushSupport(documents, connection, runtime, validateTextDocument);
} else { } else {
diagnosticSupport = registerDiagnosticsPullSupport(documents, connection, runtime, validateTextDocument); diagnosticsSupport = registerDiagnosticsPullSupport(documents, connection, runtime, validateTextDocument);
} }
@@ -301,25 +301,18 @@ export function startServer(connection: Connection, runtime: RuntimeEnvironment)
needsRevalidation = languageService.resetSchema(uriOrUris); needsRevalidation = languageService.resetSchema(uriOrUris);
} }
if (needsRevalidation) { if (needsRevalidation) {
for (const doc of documents.all()) { diagnosticsSupport?.requestRefresh();
triggerValidation(doc);
}
} }
}); });
// Retry schema validation on all open documents // Retry schema validation on all open documents
connection.onRequest(ForceValidateRequest.type, uri => { connection.onRequest(ForceValidateRequest.type, async uri => {
return new Promise<Diagnostic[]>(resolve => { const document = documents.get(uri);
const document = documents.get(uri); if (document) {
if (document) { updateConfiguration();
updateConfiguration(); return await validateTextDocument(document);
validateTextDocument(document, diagnostics => { }
resolve(diagnostics); return [];
});
} else {
resolve([]);
}
});
}); });
connection.onRequest(LanguageStatusRequest.type, async uri => { connection.onRequest(LanguageStatusRequest.type, async uri => {
@@ -365,8 +358,7 @@ export function startServer(connection: Connection, runtime: RuntimeEnvironment)
} }
languageService.configure(languageSettings); languageService.configure(languageSettings);
// Revalidate any open text documents diagnosticsSupport?.requestRefresh();
documents.all().forEach(triggerValidation);
} }
async function validateTextDocument(textDocument: TextDocument): Promise<Diagnostic[]> { async function validateTextDocument(textDocument: TextDocument): Promise<Diagnostic[]> {
@@ -387,7 +379,7 @@ export function startServer(connection: Connection, runtime: RuntimeEnvironment)
} }
}); });
if (hasChanges) { if (hasChanges) {
documents.all().forEach(triggerValidation); diagnosticsSupport?.requestRefresh();
} }
}); });

5
extensions/json-language-features/server/src/utils/validation.ts
View File

@@ -58,8 +58,6 @@ export function registerDiagnosticsPushSupport(documents: TextDocuments<TextDocu
}, validationDelayMs); }, validationDelayMs);
} }
documents.all().forEach(triggerValidation);
return { return {
requestRefresh: () => { requestRefresh: () => {
documents.all().forEach(triggerValidation); documents.all().forEach(triggerValidation);
@@ -85,7 +83,7 @@ export function registerDiagnosticsPullSupport(documents: TextDocuments<TextDocu
}; };
} }
connection.languages.diagnostics.on(async (params: DocumentDiagnosticParams, token: CancellationToken) => { const registration = connection.languages.diagnostics.on(async (params: DocumentDiagnosticParams, token: CancellationToken) => {
return runSafeAsync(runtime, async () => { return runSafeAsync(runtime, async () => {
const document = documents.get(params.textDocument.uri); const document = documents.get(params.textDocument.uri);
if (document) { if (document) {
@@ -103,6 +101,7 @@ export function registerDiagnosticsPullSupport(documents: TextDocuments<TextDocu
return { return {
requestRefresh, requestRefresh,
dispose: () => { dispose: () => {
registration.dispose();
} }
}; };