feat: support for custom language service plugins

packages/vue-language-server/src/common.ts

@@ -33,8 +33,7 @@ export function createLanguageServer(connection: vscode.Connection, runtimeEnv:
 
 	async function onInitialize(params: vscode.InitializeParams) {
 
-		// @ts-expect-error
-		const options: shared.ServerInitializationOptions = params.initializationOptions;
+		const options: shared.ServerInitializationOptions = params.initializationOptions as any;
 		let folders: string[] = [];
 		let rootUri: URI;
 
@@ -76,6 +75,7 @@ export function createLanguageServer(connection: vscode.Connection, runtimeEnv:
 					return options.documentFeatures?.documentFormatting?.defaultPrintWidth ?? 100;
 				},
 				lsConfigs?.getSettings,
+				folders[0],
 			);
 
 			(await import('./features/documentFeatures')).register(connection, documents, noStateLs);

packages/vue-language-service-types/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-present Johnson Chu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/vue-language-service-types/package.json

@@ -0,0 +1,20 @@
+{
+	"name": "@volar/vue-language-service-types",
+	"version": "0.32.1",
+	"main": "out/index.js",
+	"license": "MIT",
+	"files": [
+		"out/**/*.js",
+		"out/**/*.d.ts"
+	],
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/johnsoncodehk/volar.git",
+		"directory": "packages/vue-language-service-types"
+	},
+	"dependencies": {
+		"@volar/vue-typescript": "0.32.1",
+		"vscode-languageserver-protocol": "^3.17.0-next.12",
+		"vscode-languageserver-textdocument": "^1.0.3"
+	}
+}

packages/vue-language-service-types/src/index.ts

@@ -0,0 +1,80 @@
+import type { EmbeddedDocumentSourceMap } from '@volar/vue-typescript';
+import type * as vscode from 'vscode-languageserver-protocol';
+import type { TextDocument } from 'vscode-languageserver-textdocument';
+
+type NotNullableResult<T> = T | Thenable<T>;
+type NullableResult<T> = NotNullableResult<T | undefined | null>;
+
+export type SemanticToken = [number, number, number, number, number];
+
+export interface ExecuteCommandContext {
+    token: vscode.CancellationToken;
+    workDoneProgress: {
+        begin(title: string, percentage?: number, message?: string, cancellable?: boolean): void;
+        report(percentage: number): void;
+        report(message: string): void;
+        report(percentage: number, message: string): void;
+        done(): void;
+    };
+    sendNotification<P>(type: vscode.NotificationType<P>, params: P): Promise<void>;
+    applyEdit(paramOrEdit: vscode.ApplyWorkspaceEditParams | vscode.WorkspaceEdit): Promise<vscode.ApplyWorkspaceEditResult>;
+}
+
+export type EmbeddedLanguagePlugin = {
+    doValidation?(document: TextDocument, options: {
+        semantic?: boolean;
+        syntactic?: boolean;
+        suggestion?: boolean;
+        declaration?: boolean;
+    }): NullableResult<vscode.Diagnostic[]>;
+    doComplete?(document: TextDocument, position: vscode.Position, context?: vscode.CompletionContext): NullableResult<vscode.CompletionList>,
+    doCompleteResolve?(item: vscode.CompletionItem, newPosition?: vscode.Position): NotNullableResult<vscode.CompletionItem>,
+    doHover?(document: TextDocument, position: vscode.Position): NullableResult<vscode.Hover>,
+    findDefinition?(document: TextDocument, position: vscode.Position): NullableResult<vscode.LocationLink[]>;
+    findTypeDefinition?(document: TextDocument, position: vscode.Position): NullableResult<vscode.LocationLink[]>;
+    findImplementations?(document: TextDocument, position: vscode.Position): NullableResult<vscode.LocationLink[]>;
+    findReferences?(document: TextDocument, position: vscode.Position): NullableResult<vscode.Location[]>;
+    findDocumentHighlights?(document: TextDocument, position: vscode.Position): NullableResult<vscode.DocumentHighlight[]>;
+    findDocumentLinks?(document: TextDocument): NullableResult<vscode.DocumentLink[]>;
+    findDocumentSymbols?(document: TextDocument): NullableResult<vscode.SymbolInformation[]>;
+    findDocumentSemanticTokens?(document: TextDocument, range?: vscode.Range, cancleToken?: vscode.CancellationToken): NullableResult<SemanticToken[]>;
+    findWorkspaceSymbols?(query: string): NullableResult<vscode.SymbolInformation[]>;
+    doCodeActions?(document: TextDocument, range: vscode.Range, context: vscode.CodeActionContext): NullableResult<vscode.CodeAction[]>;
+    doCodeActionResolve?(codeAction: vscode.CodeAction): NotNullableResult<vscode.CodeAction>;
+    doCodeLens?(document: TextDocument): NullableResult<vscode.CodeLens[]>;
+    doCodeLensResolve?(codeLens: vscode.CodeLens): NotNullableResult<vscode.CodeLens>;
+    doExecuteCommand?(command: string, args: any[], context: ExecuteCommandContext): NotNullableResult<void>;
+    findDocumentColors?(document: TextDocument): NullableResult<vscode.ColorInformation[]>;
+    getColorPresentations?(document: TextDocument, color: vscode.Color, range: vscode.Range): NullableResult<vscode.ColorPresentation[]>;
+    doRenamePrepare?(document: TextDocument, position: vscode.Position): NullableResult<vscode.Range | vscode.ResponseError<void>>;
+    doRename?(document: TextDocument, position: vscode.Position, newName: string): NullableResult<vscode.WorkspaceEdit>;
+    doFileRename?(oldUri: string, newUri: string): NullableResult<vscode.WorkspaceEdit>;
+    getFoldingRanges?(document: TextDocument): NullableResult<vscode.FoldingRange[]>;
+    getSelectionRanges?(document: TextDocument, positions: vscode.Position[]): NullableResult<vscode.SelectionRange[]>;
+    getSignatureHelp?(document: TextDocument, position: vscode.Position, context?: vscode.SignatureHelpContext): NullableResult<vscode.SignatureHelp>;
+    format?(document: TextDocument, range: vscode.Range | undefined, options: vscode.FormattingOptions): NullableResult<vscode.TextEdit[]>;
+
+    callHierarchy?: {
+        doPrepare(document: TextDocument, position: vscode.Position): NullableResult<vscode.CallHierarchyItem[]>;
+        getIncomingCalls(item: vscode.CallHierarchyItem): NotNullableResult<vscode.CallHierarchyIncomingCall[]>;
+        getOutgoingCalls(item: vscode.CallHierarchyItem): NotNullableResult<vscode.CallHierarchyOutgoingCall[]>;
+    },
+
+    // html
+    findLinkedEditingRanges?(document: TextDocument, position: vscode.Position): NullableResult<vscode.LinkedEditingRanges>;
+    doAutoInsert?(document: TextDocument, position: vscode.Position, context: {
+        lastChange: {
+            range: vscode.Range;
+            rangeOffset: number;
+            rangeLength: number;
+            text: string;
+        },
+    }): NullableResult<string | vscode.TextEdit>;
+
+    /**
+     * TODO: only support to doCompleteResolve for now
+     */
+    resolveEmbeddedRange?(range: vscode.Range, sourceMap: EmbeddedDocumentSourceMap): vscode.Range | undefined;
+
+    // findMatchingTagPosition?(document: TextDocument, position: vscode.Position, htmlDocument: HTMLDocument): vscode.Position | null;
+};

packages/vue-language-service-types/tsconfig.build.json

@@ -0,0 +1,19 @@
+{
+	"extends": "../../tsconfig.base.json",
+	"compilerOptions": {
+		"outDir": "out",
+		"rootDir": "src",
+	},
+	"include": [
+		"src"
+	],
+	"exclude": [
+		"node_modules",
+		".vscode-test"
+	],
+	"references": [
+		{
+			"path": "../vue-typescript/tsconfig.build.json"
+		},
+	],
+}

packages/vue-language-service/package.json

@@ -26,6 +26,7 @@
 		"@volar/transforms": "0.32.1",
 		"@volar/typescript-language-service": "0.32.1",
 		"@volar/vue-code-gen": "0.32.1",
+		"@volar/vue-language-service-types": "0.32.1",
 		"@volar/vue-typescript": "0.32.1",
 		"@vscode/emmet-helper": "^2.8.3",
 		"@vue/reactivity": "^3.2.27",

packages/vue-language-service/src/commonPlugins/css.ts

@@ -1,4 +1,4 @@
-import { EmbeddedLanguagePlugin } from '../utils/definePlugin';
+import { EmbeddedLanguagePlugin } from '@volar/vue-language-service-types';
 import type * as css from 'vscode-css-languageservice';
 import type { TextDocument } from 'vscode-languageserver-textdocument';
 import * as shared from '@volar/shared';

packages/vue-language-service/src/commonPlugins/directiveComment.ts

@@ -1,4 +1,4 @@
-import { EmbeddedLanguagePlugin } from '../utils/definePlugin';
+import { EmbeddedLanguagePlugin } from '@volar/vue-language-service-types';
 import * as ts2 from '@volar/typescript-language-service';
 import { isTsDocument } from './typescript';
 

packages/vue-language-service/src/commonPlugins/emmet.ts

@@ -1,4 +1,4 @@
-import { EmbeddedLanguagePlugin } from '../utils/definePlugin';
+import { EmbeddedLanguagePlugin } from '@volar/vue-language-service-types';
 import * as emmet from '@vscode/emmet-helper';
 
 export const triggerCharacters = []; // TODO

packages/vue-language-service/src/commonPlugins/html.ts

@@ -1,4 +1,4 @@
-import { EmbeddedLanguagePlugin } from '../utils/definePlugin';
+import { EmbeddedLanguagePlugin } from '@volar/vue-language-service-types';
 import * as html from 'vscode-html-languageservice';
 import { TextDocument } from 'vscode-languageserver-textdocument';
 

packages/vue-language-service/src/commonPlugins/jsDoc.ts

@@ -1,4 +1,4 @@
-import { EmbeddedLanguagePlugin } from '../utils/definePlugin';
+import { EmbeddedLanguagePlugin } from '@volar/vue-language-service-types';
 import * as ts2 from '@volar/typescript-language-service';
 import { isTsDocument } from './typescript';
 

packages/vue-language-service/src/commonPlugins/json.ts

@@ -1,6 +1,6 @@
 import * as json from 'vscode-json-languageservice';
 import { TextDocument } from 'vscode-languageserver-textdocument';
-import { EmbeddedLanguagePlugin } from '../utils/definePlugin';
+import { EmbeddedLanguagePlugin } from '@volar/vue-language-service-types';
 import * as vscode from 'vscode-languageserver-protocol';
 
 // https://github.com/microsoft/vscode/blob/09850876e652688fb142e2e19fd00fd38c0bc4ba/extensions/json-language-features/server/src/jsonServer.ts#L150

packages/vue-language-service/src/commonPlugins/prettier.ts

@@ -1,6 +1,6 @@
 import * as prettier from 'prettier';
 import * as vscode from 'vscode-languageserver-protocol';
-import { EmbeddedLanguagePlugin } from '../utils/definePlugin';
+import { EmbeddedLanguagePlugin } from '@volar/vue-language-service-types';
 
 export default function (allowLanguageIds: prettier.BuiltInParserName[]): EmbeddedLanguagePlugin {
 
@@ -18,7 +18,7 @@ export default function (allowLanguageIds: prettier.BuiltInParserName[]): Embedd
             });
 
             if (newStyleText === document.getText())
-                return;
+                return [];
 
             const cssEdit = vscode.TextEdit.replace(
                 vscode.Range.create(

packages/vue-language-service/src/commonPlugins/prettyhtml.ts

@@ -1,6 +1,6 @@
 import * as prettyhtml from '@starptech/prettyhtml';
 import * as vscode from 'vscode-languageserver-protocol';
-import { EmbeddedLanguagePlugin } from '../utils/definePlugin';
+import { EmbeddedLanguagePlugin } from '@volar/vue-language-service-types';
 
 export default function (host: {
     getPrintWidth: (uri: string) => number | Promise<number>,
@@ -13,14 +13,14 @@ export default function (host: {
             if (document.languageId !== 'html')
                 return;
 
-            let newHtml = prettyhtml(document.getText(), {
+            const newHtml = prettyhtml(document.getText(), {
                 tabWidth: options.tabSize,
                 useTabs: !options.insertSpaces,
                 printWidth: await host.getPrintWidth(document.uri),
             }).contents;
 
             if (newHtml === document.getText())
-                return;
+                return [];
 
             const htmlEdit = vscode.TextEdit.replace(
                 vscode.Range.create(

packages/vue-language-service/src/commonPlugins/pug.ts

@@ -1,4 +1,4 @@
-import { EmbeddedLanguagePlugin } from '../utils/definePlugin';
+import { EmbeddedLanguagePlugin } from '@volar/vue-language-service-types';
 import * as html from 'vscode-html-languageservice';
 import { TextDocument } from 'vscode-languageserver-textdocument';
 import * as pug from '@volar/pug-language-service';

packages/vue-language-service/src/commonPlugins/pugBeautify.ts

@@ -1,5 +1,5 @@
 import * as vscode from 'vscode-languageserver-protocol';
-import { EmbeddedLanguagePlugin } from '../utils/definePlugin';
+import { EmbeddedLanguagePlugin } from '@volar/vue-language-service-types';
 
 const pugBeautify = require('@johnsoncodehk/pug-beautify');
 
@@ -28,7 +28,7 @@ export default function (): EmbeddedLanguagePlugin {
             });
 
             if (newPugCode === document.getText())
-                return;
+                return [];
 
             const pugEdit = vscode.TextEdit.replace(
                 vscode.Range.create(

packages/vue-language-service/src/commonPlugins/sassFormatter.ts

@@ -1,6 +1,6 @@
 import { SassFormatter } from 'sass-formatter';
 import * as vscode from 'vscode-languageserver-protocol';
-import { EmbeddedLanguagePlugin } from '../utils/definePlugin';
+import { EmbeddedLanguagePlugin } from '@volar/vue-language-service-types';
 
 export default function (): EmbeddedLanguagePlugin {
 
@@ -21,7 +21,7 @@ export default function (): EmbeddedLanguagePlugin {
             const newStyleText = SassFormatter.Format(document.getText(), _options);
 
             if (newStyleText === document.getText())
-                return;
+                return [];
 
             const cssEdit = vscode.TextEdit.replace(
                 vscode.Range.create(

packages/vue-language-service/src/commonPlugins/typescript.ts

@@ -1,5 +1,5 @@
 import { TextDocument } from 'vscode-languageserver-textdocument';
-import { EmbeddedLanguagePlugin } from '../utils/definePlugin';
+import { EmbeddedLanguagePlugin } from '@volar/vue-language-service-types';
 import type * as ts from 'typescript/lib/tsserverlibrary';
 import * as ts2 from '@volar/typescript-language-service';
 

packages/vue-language-service/src/documentFeatures/autoInsert.ts

@@ -1,7 +1,7 @@
 import type { DocumentServiceRuntimeContext } from '../types';
 import { documentArgFeatureWorker } from '../utils/featureWorkers';
 import type { TextDocument } from 'vscode-languageserver-textdocument';
-import { EmbeddedLanguagePlugin } from '../utils/definePlugin';
+import { EmbeddedLanguagePlugin } from '@volar/vue-language-service-types';
 import * as vscode from 'vscode-languageserver-protocol';
 
 export function register(context: DocumentServiceRuntimeContext) {

packages/vue-language-service/src/documentFeatures/format.ts

@@ -136,7 +136,7 @@ export function register(context: DocumentServiceRuntimeContext) {
 
 				const edits = await plugin.format(document, undefined, options);
 
-				if (!edits || edits.length === 0)
+				if (!edits)
 					continue;
 
 				return edits;