@microsoft/compose-language-service
Version:
Language service for Docker Compose documents
54 lines • 2.69 kB
JavaScript
/*!--------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See LICENSE in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import * as vscode from 'vscode';
/**
* This class will note the features covered by an alternate YAML language service,
* that the compose language service can disable
*/
export class AlternateYamlLanguageServiceClientFeature {
clear() {
this.dispose();
}
getState() {
return {
kind: 'static'
};
}
createAlternateYamlLanguageServiceClientCapabilities() {
// If RedHat YAML's extension or Docker's extension is present, we can disable many of the compose language service features
const redhat = vscode.extensions.getExtension('redhat.vscode-yaml') !== undefined;
const docker = vscode.extensions.getExtension('docker.docker') !== undefined;
if (redhat || docker) {
return {
syntaxValidation: redhat || docker,
schemaValidation: redhat && !docker, // RedHat YAML auto-disables its Compose schema detection when Docker DX is present, and Docker DX does not provide Compose schema validation
basicCompletions: redhat || docker,
advancedCompletions: false, // The other extensions do not have advanced completions for Compose docs
hover: redhat || docker, // Compose spec has descriptions
imageLinks: false, // Keep Compose image links local so private registries aren't incorrectly linked to Docker Hub (see #179)
serviceStartupCodeLens: false, // The other extensions do not provide any code lens
formatting: false, // The other extensions do support formatting, but we enable it regardless so that an explicitly-chosen formatter always works
};
}
return null;
}
fillClientCapabilities(capabilities) {
const altYamlClientCapabilities = this.createAlternateYamlLanguageServiceClientCapabilities();
if (altYamlClientCapabilities !== null) {
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
capabilities.experimental = {
...capabilities.experimental,
alternateYamlLanguageService: altYamlClientCapabilities,
};
}
}
initialize() {
// Noop
}
dispose() {
// Noop
}
}
//# sourceMappingURL=AlternateYamlLanguageServiceClientFeature.js.map