Updates to compose language service packaging structure (#174)

Author: bwateratmsft

CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.5.0 - 9 February 2026
+### Breaking Changes
+* `TelemetryEvent`, `AlternateYamlLanguageServiceClientCapabilities`, and `DocumentSettings*` types have moved from `lib/client/*` to `@microsoft/compose-language-service/client`.
+
+### Added
+* An entrypoint was added for `client`. This is intended for use by any client to help with interacting with this language service.
+* An entrypoint was added for `vscode`. This is intended for use by VS Code in particular to help with interacting with this language service.
+* An ESM build of the entire package is now included, in addition to the prior CJS build.
+
 ## 0.4.0 - 17 April 2025
 ### Breaking Changes
 * The service startup CodeLens has changed the command it will call to `vscode-containers.compose.up`.

package-lock.json

@@ -1,7 +1,7 @@
 {
     "name": "@microsoft/compose-language-service",
     "author": "Microsoft Corporation",
-    "version": "0.4.0",
+    "version": "0.5.0",
     "publisher": "ms-azuretools",
     "description": "Language service for Docker Compose documents",
     "license": "MIT",
@@ -17,9 +17,25 @@
         "vscode",
         "docker"
     ],
-    "module": "dist/esm/server.js",
     "main": "dist/cjs/server.js",
     "types": "dist/esm/server.d.ts",
+    "exports": {
+        ".": {
+            "import": "./dist/esm/server.js",
+            "require": "./dist/cjs/server.js",
+            "types": "./dist/esm/server.d.ts"
+        },
+        "./client": {
+            "import": "./dist/esm/client/index.js",
+            "require": "./dist/cjs/client/index.js",
+            "types": "./dist/esm/client/index.d.ts"
+        },
+        "./vscode": {
+            "import": "./dist/esm/vscode/index.js",
+            "require": "./dist/cjs/vscode/index.js",
+            "types": "./dist/esm/vscode/index.d.ts"
+        }
+    },
     "bin": {
         "docker-compose-langserver": "./bin/docker-compose-langserver"
     },
@@ -35,11 +51,14 @@
         "node": ">=22"
     },
     "devDependencies": {
-        "@microsoft/vscode-azext-eng": "1.0.0-alpha.8",
-        "@types/node": "22.x"
+        "@microsoft/vscode-azext-eng": "1.0.0-alpha.12",
+        "@types/node": "22.x",
+        "@types/vscode": "1.105.0",
+        "vscode-languageclient": "^10.0.0-next.19"
     },
     "dependencies": {
-        "vscode-languageserver": "^9.0.1",
+        "vscode-languageserver": "^10.0.0-next.16",
+        "vscode-languageserver-protocol": "^3.17.6-next.16",
         "vscode-languageserver-textdocument": "^1.0.12",
         "yaml": "^2.8.2"
     },

package.json

@@ -0,0 +1,10 @@
+/*!--------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See LICENSE in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+export * from '../common/AlternateYamlLanguageServiceClientCapabilities';
+export * from '../common/ComposeLanguageClientCapabilities';
+export * from '../common/DocumentSettingsClientCapabilities';
+export * from '../common/TelemetryEvent';
+export * from '../common/TextDocumentParams';

src/client/index.ts

@@ -4,7 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 import type { ClientCapabilities } from 'vscode-languageserver-protocol';
-import type { DocumentSettingsClientCapabilities } from './DocumentSettings';
+import type { DocumentSettingsClientCapabilities } from './DocumentSettingsClientCapabilities';
 import type { AlternateYamlLanguageServiceClientCapabilities } from './AlternateYamlLanguageServiceClientCapabilities';
 
 export type ComposeLanguageClientCapabilities = Omit<ClientCapabilities, 'experimental'> & {

…YamlLanguageServiceClientCapabilities.ts …YamlLanguageServiceClientCapabilities.tssrc/client/AlternateYamlLanguageServiceClientCapabilities.ts renamed to src/common/AlternateYamlLanguageServiceClientCapabilities.ts src/client/AlternateYamlLanguageServiceClientCapabilities.ts renamed to src/common/AlternateYamlLanguageServiceClientCapabilities.ts

@@ -4,7 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { NotificationType, RequestType } from 'vscode-languageserver-protocol';
-import { TextDocumentParams } from '../service/ExtendedParams';
+import type { TextDocumentParams } from './TextDocumentParams';
 
 export type DocumentSettingsClientCapabilities = {
     readonly request: boolean,
@@ -27,7 +27,7 @@ export type DocumentSettingsParams = TextDocumentParams;
 // eslint-disable-next-line @typescript-eslint/no-namespace
 export namespace DocumentSettingsRequest {
     export const method = '$/textDocument/documentSettings' as const;
-    export const type = new RequestType<DocumentSettingsParams, DocumentSettings | null, never>(method);
+    export const type = new RequestType<DocumentSettingsParams, DocumentSettings | null | undefined, never>(method);
 }
 
 export type DocumentSettingsNotificationParams = DocumentSettingsParams & DocumentSettings;

src/client/ClientCapabilities.ts …mon/ComposeLanguageClientCapabilities.tssrc/client/ClientCapabilities.ts renamed to src/common/ComposeLanguageClientCapabilities.ts src/client/ClientCapabilities.ts renamed to src/common/ComposeLanguageClientCapabilities.ts

@@ -0,0 +1,10 @@
+/*!--------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See LICENSE in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import type { TextDocumentIdentifier } from 'vscode-languageserver-protocol';
+
+export interface TextDocumentParams { // This interface ought to exist in `vscode-languageserver`, like `TextDocumentPositionParams`, but here we are...
+    textDocument: TextDocumentIdentifier;
+}

src/client/DocumentSettings.ts …on/DocumentSettingsClientCapabilities.tssrc/client/DocumentSettings.ts renamed to src/common/DocumentSettingsClientCapabilities.ts src/client/DocumentSettings.ts renamed to src/common/DocumentSettingsClientCapabilities.ts

@@ -6,7 +6,7 @@
 import { ErrorCodes, Position, Range, ResponseError, TextDocumentIdentifier, TextDocumentsConfiguration } from 'vscode-languageserver';
 import { DocumentUri, TextDocument } from 'vscode-languageserver-textdocument';
 import { Document as YamlDocument, isDocument, Node as YamlNode, parseDocument, ScalarTag, Tags } from 'yaml';
-import { CRLF, DocumentSettings, DocumentSettingsParams, DocumentSettingsRequest, LF } from '../client/DocumentSettings';
+import { CRLF, DocumentSettings, DocumentSettingsRequest, LF } from '../common/DocumentSettingsClientCapabilities';
 import { ExtendedPositionParams, PositionInfo } from './ExtendedParams';
 import { getCurrentContext } from './utils/ActionContext';
 import { Lazy } from './utils/Lazy';
@@ -74,7 +74,7 @@ export class ComposeDocument {
             const ctx = getCurrentContext();
 
             if (ctx.clientCapabilities?.experimental?.documentSettings?.request) {
-                const result = await ctx.connection.sendRequest<DocumentSettingsParams, DocumentSettings | null, never>(DocumentSettingsRequest.type, { textDocument: this.id });
+                const result = await ctx.connection.sendRequest(DocumentSettingsRequest.type, { textDocument: this.id });
                 if (result) {
                     this.documentSettings = result;
                 }