Volar

https://volarjs.dev
Admin
Volar is an embedded language tooling framework designed to build performant and flexible editing...
Tokens:7,661
Snippets:94
Trust Score:7.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install dependencies for the client

Source: https://volarjs.dev/guides/first-server

Commands to install necessary Volar and VS Code packages using different package managers.

```bash
# Installing dependencies with npm
npm install @volar/language-server @volar/vscode vscode-languageclient @types/vscode ../server
```

```bash
# Installing dependencies with pnpm
pnpm install @volar/language-server @volar/vscode vscode-languageclient @types/vscode ../server
```

```bash
# Installing dependencies with yarn
yarn add @volar/language-server @volar/vscode vscode-languageclient @types/vscode ../server
```

--------------------------------

### Install TypeScript

Source: https://volarjs.dev/guides/first-server

Commands to install TypeScript as a development dependency.

```bash
# Installing TypeScript with npm
npm install --save-dev typescript
```

```bash
# Installing TypeScript with pnpm
pnpm add --save-dev typescript
```

```bash
# Installing TypeScript with yarn
yarn add --dev typescript
```

--------------------------------

### Initialize Volar Language Server

Source: https://volarjs.dev/guides/first-server

Configures the server with language and service plugins, then starts the connection.

```typescript
import { html1LanguagePlugin, Html1Code } from "./languagePlugin";
import { create as createHtmlService } from "volar-service-html";
import { create as createCssService } from "volar-service-css";
import {
  createServer,
  createConnection,
  createSimpleProject,
} from "@volar/language-server/node";


const connection = createConnection();
const server = createServer(connection);


connection.listen();


connection.onInitialize((params) => {
  return server.initialize(
    params,
    createSimpleProject([
      // Language plugins, empty for now
    ]),
    [
      createHtmlService(),
      createCssService(),
    ],
  );
});


connection.onInitialized(server.initialized);
connection.onShutdown(server.shutdown);
```

--------------------------------

### Install language server dependencies

Source: https://volarjs.dev/guides/first-server

Install the required Volar and HTML language service packages using your preferred package manager.

```bash
npm install @volar/language-server @volar/language-core @volar/language-service volar-service-html volar-service-css vscode-html-languageservice
```

```bash
pnpm install @volar/language-server @volar/language-core @volar/language-service volar-service-html volar-service-css vscode-html-languageservice
```

```bash
yarn add @volar/language-server @volar/language-core @volar/language-service volar-service-html volar-service-css vscode-html-languageservice
```

--------------------------------

### Initialize a monorepo project

Source: https://volarjs.dev/guides/first-server

Commands to set up a monorepo structure with server and client packages.

```bash
# create a new monorepo project with npm
npm init -w ./packages/server
npm init -w ./packages/client
```

```bash
# create a new monorepo project with pnpm
mkdir -p ./packages/server ./packages/client
echo -e 'packages:\n  - "packages/*"' > pnpm-workspace.yaml
# Go into both newly created folders in packages and run `pnpm init`
```

```bash
# create a new monorepo project with yarn
yarn init -w ./packages/server
yarn init -w ./packages/client
```

--------------------------------

### Initialize a new project

Source: https://volarjs.dev/guides/first-server

Commands to initialize a new Node.js project using different package managers.

```bash
# create a new project with npm
npm init
```

```bash
# create a new project with pnpm
pnpm init
```

```bash
# create a new project with yarn
yarn init .
```

--------------------------------

### Create server binary entry point

Source: https://volarjs.dev/guides/first-server

Define the executable script that handles version checks and launches the compiled server index.

```javascript
#!/usr/bin/env node
if (process.argv.includes("--version")) {
  const pkgJSON = require("../package.json");
  console.log(`${pkgJSON["version"]}`);
} else {
  require("../out/index.js");
}
```

--------------------------------

### Configure package.json for the server

Source: https://volarjs.dev/guides/first-server

Register the binary file in package.json to make the server command available to users.

```json
{
  "name": "@html1/language-server",
  "version": "0.0.1",
  "bin": {
    "html1-language-server": "./bin/html1-language-server.js",
  },
  "dependencies": {
    // All your dependencies here...
  },
}
```

--------------------------------

### VS Code launch configuration

Source: https://volarjs.dev/guides/first-server

Configuration for launching the extension host for local development.

```json
{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Launch Extension",
      "type": "extensionHost",
      "request": "launch",
      "runtimeExecutable": "${execPath}",
      "args": [
        "--disable-updates",
        "--disable-workspace-trust",
        "--profile-temp",
        "--skip-release-notes",
        "--skip-welcome",
        "--extensionDevelopmentPath=${workspaceFolder}/packages/client"
      ],
      "outFiles": ["${workspaceFolder}/packages/client/dist/*.js"]
    }
  ]
}
```

--------------------------------

### Initialize a Volar language server with services

Source: https://volarjs.dev/reference/services

Pass the list of services to the initialize method when setting up the language server.

```typescript
import {
  createConnection,
  createServer,
  createSimpleProjectProviderFactory,
} from "@volar/language-server/node";
import { service } from "./service";


const connection = createConnection();
const server = createServer(connection);


connection.listen();


connection.onInitialize((params) => {
  return server.initialize(params, createSimpleProjectProviderFactory(), {
    // ...
    getServicePlugins() {
      return [service];
    },
  });
});


connection.onInitialized(() => {
  server.initialized();
});
```

--------------------------------

### Implement extension activation logic

Source: https://volarjs.dev/guides/first-server

Boilerplate code to initialize the language client and register it with Volar Labs.

```typescript
import * as serverProtocol from "@volar/language-server/protocol";
import { activateAutoInsertion, createLabsInfo } from "@volar/vscode";
import * as vscode from "vscode";
import * as lsp from "vscode-languageclient/node";


let client: lsp.BaseLanguageClient;


// As its name suggests, this function is called when the extension is activated.
export async function activate(context: vscode.ExtensionContext) {
  const serverModule = vscode.Uri.joinPath(
    context.extensionUri,
    "node_modules",
    "@html1/language-server",
    "dist",
    "server.js",
  );
  const serverOptions: lsp.ServerOptions = {
    run: {
      module: serverModule.fsPath,
      transport: lsp.TransportKind.ipc,
      options: { execArgv: <string[]>[] },
    },
    debug: {
      module: serverModule.fsPath,
      transport: lsp.TransportKind.ipc,
      options: { execArgv: ["--nolazy", "--inspect=" + 6009] },
    },
  };


  // Options to control the language client, in this case we're only interested
  // in HTML1 files. Language servers can also accept initialization options, which
  // are passed to the server when it starts, but we don't have any here.
  const clientOptions: lsp.LanguageClientOptions = {
    documentSelector: [{ language: "html1" }],
    initializationOptions: {},
  };


  // Create the language client with all the options we've defined, and start it.
  client = new lsp.LanguageClient(
    "html1-language-server",
    "HTML1 Language Server",
    serverOptions,
    clientOptions,
  );
  await client.start();


  // Bonus: Add support for auto insertion of closing tags (ex: <div> -> <div></div>)
  activateAutoInsertion("html1", client);


  // Needed code to add support for Volar Labs
  // https://volarjs.dev/core-concepts/volar-labs/
  const labsInfo = createLabsInfo(serverProtocol);
  labsInfo.addLanguageClient(client);
  return labsInfo.extensionExports;
}


// ... and this function is called when the extension is deactivated!
export function deactivate(): Thenable<any> | undefined {
  return client?.stop();
}
```

--------------------------------

### provideInlayHints

Source: https://volarjs.dev/reference/services

This method is called when the user requests inlay hints in the document.

```APIDOC
## provideInlayHints

### Description
This method is called when the user requests inlay hints in the document.

### Signature
(document: TextDocument, token: CancellationToken) => InlayHint[] | Promise<InlayHint[]>
```

--------------------------------

### Configure package.json for VS Code extension

Source: https://volarjs.dev/guides/first-server

Defines the extension metadata, activation events, and language contributions.

```json
{
  "name": "vscode-html1",
  "displayName": "HTML1 Client",
  "description": "A VS Code extension for HTML1.",
  "version": "0.0.1",
  "engines": {
    "vscode": "^1.55.0"
  },
  "activationEvents": ["onLanguage:html1"],
  "main": "./src/extension.js",
  "contributes": {
    "languages": [
      {
        "id": "html1",
        "extensions": [".html1"]
      }
    ]
  }
}
```

--------------------------------

### Define a basic language plugin structure

Source: https://volarjs.dev/reference/languages

The foundational structure for a language definition requires implementing createVirtualCode and updateVirtualCode functions.

```typescript
export const language = {
  createVirtualCode(fileId, languageId, snapshot) {
    // Create a virtual code object
  },
  updateVirtualCode(_fileId, languageCode, snapshot) {
    // Update the virtual code object
  },
};
```

--------------------------------

### provideHover

Source: https://volarjs.dev/reference/services

Called when the user requests hover information at a specific position.

```APIDOC
## provideHover

### Signature
`(document: TextDocument, position: Position, token: CancellationToken) => Hover | Promise<Hover>`

### Description
This method is called when the user requests hover information at a specific position in the document.
```

--------------------------------

### Configure tsconfig.json for the client

Source: https://volarjs.dev/guides/first-server

Sets up TypeScript compilation options, extending the base configuration and defining output directories.

```json
{
  "extends": "../../tsconfig.base.json",
  "compilerOptions": {
    "outDir": "out",
    "rootDir": "src",
  },
  "include": ["src"],
}
```

--------------------------------

### resolveInlayHint

Source: https://volarjs.dev/reference/services

This method is called when the user selects an inlay hint from the list of inlay hints. It allows you to provide additional information for the selected inlay hint.

```APIDOC
## resolveInlayHint

### Description
This method is called when the user selects an inlay hint from the list of inlay hints. It allows you to provide additional information for the selected inlay hint.

### Signature
(hint: InlayHint, token: CancellationToken) => InlayHint | Promise<InlayHint>
```

--------------------------------

### Base TypeScript configuration

Source: https://volarjs.dev/guides/first-server

A shared base configuration file for the project.

```json
{
  "compilerOptions": {
    "module": "nodenext"
  }
}
```

--------------------------------

### provideDocumentHighlights

Source: https://volarjs.dev/reference/services

Called when the user requests highlights for a symbol.

```APIDOC
## provideDocumentHighlights

### Signature
`(document: TextDocument, position: Position, token: CancellationToken) => DocumentHighlight[] | Promise<DocumentHighlight[]>`

### Description
This method is called when the user requests highlights for a symbol at a specific position in the document.
```

--------------------------------

### provideOnTypeFormattingEdits

Source: https://volarjs.dev/reference/services

Called when the user types a specific character in the document.

```APIDOC
## provideOnTypeFormattingEdits

### Signature
`(document: TextDocument, position: Position, ch: string, options: FormattingOptions, token: CancellationToken) => TextEdit[] | Promise<TextEdit[]>`

### Description
This method is called when the user types a specific character in the document.
```

--------------------------------

### provideDocumentColors

Source: https://volarjs.dev/reference/services

Called when the user requests colors in the document.

```APIDOC
## provideDocumentColors

### Signature
`(document: TextDocument, token: CancellationToken) => ColorInformation[] | Promise<ColorInformation[]>`

### Description
This method is called when the user requests colors in the document.
```

--------------------------------

### provideDocumentLinks

Source: https://volarjs.dev/reference/services

Called when the user requests links in the document.

```APIDOC
## provideDocumentLinks

### Signature
`(document: TextDocument, token: CancellationToken) => DocumentLink[] | Promise<DocumentLink[]>`

### Description
This method is called when the user requests links in the document.
```

--------------------------------

### provideColorPresentations

Source: https://volarjs.dev/reference/services

Called when the user selects a color to provide additional information.

```APIDOC
## provideColorPresentations

### Signature
`(color: Color, document: TextDocument, range: Range, token: CancellationToken) => ColorPresentation[] | Promise<ColorPresentation[]>`

### Description
This method is called when the user selects a color from the list of colors. It allows you to provide additional information for the selected color.
```

--------------------------------

### Implement provideCompletionItems in a service plugin

Source: https://volarjs.dev/reference/services

Define a service plugin that implements the provideCompletionItems method to return completion suggestions.

```typescript
import { CompletionItemKind } from '@volar/language-server';


export const service = {
  name: 'my-service',
  create(context): ServicePluginInstance {
    return {
      provideCompletionItems(document, position, token) {
        return {
          isIncomplete: true,
          items: [
            {
              label: 'Hello',
              kind: CompletionItemKind.Text,
              isIncomplete: false
            },
            {
              label: 'World',
              kind: CompletionItemKind.Text,
              isIncomplete: false
            },
          ]
        }
      },
    };
  },
} satisfies ServicePlugin;
```

--------------------------------

### provideCodeLens

Source: https://volarjs.dev/reference/services

Called when the user requests code lenses in the document.

```APIDOC
## provideCodeLens

### Signature
`(document: TextDocument, token: CancellationToken) => CodeLens[] | Promise<CodeLens[]>`

### Description
This method is called when the user requests code lenses in the document.
```

--------------------------------

### provideDocumentFormattingEdits

Source: https://volarjs.dev/reference/services

Called when the user requests formatting for the entire document.

```APIDOC
## provideDocumentFormattingEdits

### Signature
`(document: TextDocument, options: FormattingOptions, token: CancellationToken) => TextEdit[] | Promise<TextEdit[]>`

### Description
This method is called when the user requests formatting for the entire document.
```

--------------------------------

### provideCodeActions

Source: https://volarjs.dev/reference/services

Called when the user requests code actions for a specific range in the document.

```APIDOC
## provideCodeActions

### Signature
`(document: TextDocument, range: Range, context: CodeActionContext, token: CancellationToken) => CodeAction[] | Promise<CodeAction[]>`

### Description
This method is called when the user requests code actions for a specific range in the document, such as fixing issues or improving code.
```

--------------------------------

### provideDefinition

Source: https://volarjs.dev/reference/services

Called when the user requests the definition of a symbol.

```APIDOC
## provideDefinition

### Signature
`(document: TextDocument, position: Position, token: CancellationToken) => Location | Location[] | Promise<Location | Location[]>`

### Description
This method is called when the user requests the definition of a symbol at a specific position in the document.
```

--------------------------------

### Implement a VirtualCode class

Source: https://volarjs.dev/reference/languages

Define a class implementing the VirtualCode interface to manage file snapshots and state, enabling easier type checking and extensibility.

```typescript
import type { LanguagePlugin, VirtualCode } from '@volar/language-core';


export const language = {
  createVirtualCode(fileId, languageId, snapshot) {
    if (languageId !== 'my-language')
      return;


    return new MyLanguageVirtualCode(snapshot);
  },
  updateVirtualCode(_fileId, languageCode, snapshot) {
    languageCode.update(snapshot);
    return languageCode;
  },
} satisfies LanguagePlugin<MyLanguageVirtualCode>;


export class MyLanguageVirtualCode implements VirtualCode {
  id = 'root';
  languageId = 'my-language';
  mappings = []


  constructor(
    public snapshot: ts.IScriptSnapshot
  ) {
    this.onSnapshotUpdated();
  }


  public update(newSnapshot: ts.IScriptSnapshot) {
    this.snapshot = newSnapshot;
    this.onSnapshotUpdated();
  }


  onSnapshotUpdated() {
    // Update the virtual code object
  }
}
```

--------------------------------

### provideSignatureHelp

Source: https://volarjs.dev/reference/services

Called when the user requests signature help at a specific position.

```APIDOC
## provideSignatureHelp

### Signature
`(document: TextDocument, position: Position, token: CancellationToken) => SignatureHelp | Promise<SignatureHelp>`

### Description
This method is called when the user requests signature help at a specific position in the document.
```

--------------------------------

### resolveDocumentLink

Source: https://volarjs.dev/reference/services

Called when the user selects a link to provide additional information.

```APIDOC
## resolveDocumentLink

### Signature
`(link: DocumentLink, token: CancellationToken) => DocumentLink | Promise<DocumentLink>`

### Description
This method is called when the user selects a link from the list of links. It allows you to provide additional information for the selected link.
```

--------------------------------

### provideReferences

Source: https://volarjs.dev/reference/services

Called when the user requests references to a symbol.

```APIDOC
## provideReferences

### Signature
`(document: TextDocument, position: Position, context: ReferenceContext, token: CancellationToken) => Location[] | Promise<Location[]>`

### Description
This method is called when the user requests references to a symbol at a specific position in the document.
```

--------------------------------

### provideCompletionItems

Source: https://volarjs.dev/reference/services

Called when the user requests completions at a specific position in the document.

```APIDOC
## provideCompletionItems

### Signature
`(document: TextDocument, position: Position, token: CancellationToken) => CompletionItem[] | Promise<CompletionItem[]>`

### Description
This method is called when the user requests completions at a specific position in the document.
```

--------------------------------

### provideDocumentRangeFormattingEdits

Source: https://volarjs.dev/reference/services

Called when the user requests formatting for a specific range in the document.

```APIDOC
## provideDocumentRangeFormattingEdits

### Signature
`(document: TextDocument, range: Range, options: FormattingOptions, token: CancellationToken) => TextEdit[] | Promise<TextEdit[]>`

### Description
This method is called when the user requests formatting for a specific range in the document.
```

--------------------------------

### provideCallHierarchyIncomingCalls

Source: https://volarjs.dev/reference/services

Called when the user requests incoming calls for a symbol.

```APIDOC
## provideCallHierarchyIncomingCalls

### Signature
`(document: TextDocument, position: Position, token: CancellationToken) => CallHierarchyIncomingCall[] | Promise<CallHierarchyIncomingCall[]>`

### Description
This method is called when the user requests incoming calls for a symbol at a specific position in the document.
```

--------------------------------

### provideSelectionRanges

Source: https://volarjs.dev/reference/services

Called when the user requests selection ranges at specific positions.

```APIDOC
## provideSelectionRanges

### Signature
`(document: TextDocument, positions: Position[], token: CancellationToken) => SelectionRange[] | Promise<SelectionRange[]>`

### Description
This method is called when the user requests selection ranges at specific positions in the document.
```

--------------------------------

### resolveCodeLens

Source: https://volarjs.dev/reference/services

Called when the user selects a code lens to provide additional information.

```APIDOC
## resolveCodeLens

### Signature
`(codeLens: CodeLens, token: CancellationToken) => CodeLens | Promise<CodeLens>`

### Description
This method is called when the user selects a code lens from the list of code lenses. It allows you to provide additional information for the selected code lens.
```

--------------------------------

### Define a Language Plugin

Source: https://volarjs.dev/guides/first-server

Basic structure for a language plugin implementing the LanguagePlugin interface.

```typescript
import type { LanguagePlugin } from "@volar/language-core";
import type { URI } from "vscode-uri";


export const language = {
  getLanguageId(uri) {
    if (uri.path.endsWith('.html1')) {
      return 'html1';
    }
  },
  createVirtualCode(uri, languageId, snapshot) {
    // Create a virtual code object
  },
  updateVirtualCode(uri, languageCode, snapshot) {
    // Update the virtual code object
  },
} satisfies LanguagePlugin<URI>;
```

--------------------------------

### resolveCompletionItem

Source: https://volarjs.dev/reference/services

Called when the user selects a completion item to provide additional information.

```APIDOC
## resolveCompletionItem

### Signature
`(item: CompletionItem, token: CancellationToken) => CompletionItem | Promise<CompletionItem>`

### Description
This method is called when the user selects a completion item from the list of completions. It allows you to provide additional information for the selected completion item.
```

--------------------------------

### resolveCodeAction

Source: https://volarjs.dev/reference/services

Called when the user selects a code action to provide additional information.

```APIDOC
## resolveCodeAction

### Signature
`(action: CodeAction, token: CancellationToken) => CodeAction | Promise<CodeAction>`

### Description
This method is called when the user selects a code action from the list of code actions.
```

--------------------------------

### Define a Volar service

Source: https://volarjs.dev/reference/services

Implement a service by exporting an object with a name and a create method that returns an instance with LSP-mapped feature methods.

```typescript
export const service = {
  name: 'my-service', // The name of the service, this is used to identify the service in the logs and in Volar Labs
  create(context): ServicePluginInstance {
    return {
      provideHover(document, position, token) {
        // Implement hover support here
      },
      // More methods...
    };
  },
} satisfies ServicePlugin;
```

--------------------------------

### provideFoldingRanges

Source: https://volarjs.dev/reference/services

Called when the user requests folding ranges in the document.

```APIDOC
## provideFoldingRanges

### Signature
`(document: TextDocument, context: FoldingContext, token: CancellationToken) => FoldingRange[] | Promise<FoldingRange[]>`

### Description
This method is called when the user requests folding ranges in the document.
```

--------------------------------

### provideCallHierarchyOutgoingCalls

Source: https://volarjs.dev/reference/services

Called when the user requests outgoing calls for a symbol.

```APIDOC
## provideCallHierarchyOutgoingCalls

### Signature
`(document: TextDocument, position: Position, token: CancellationToken) => CallHierarchyOutgoingCall[] | Promise<CallHierarchyOutgoingCall[]>`

### Description
This method is called when the user requests outgoing calls for a symbol at a specific position in the document.
```

--------------------------------

### provideDocumentSemanticTokens

Source: https://volarjs.dev/reference/services

Called when the user requests semantic tokens in the document.

```APIDOC
## provideDocumentSemanticTokens

### Signature
`(document: TextDocument, token: CancellationToken) => SemanticTokens | Promise<SemanticTokens>`

### Description
This method is called when the user requests semantic tokens in the document.
```

--------------------------------

### provideDocumentSemanticTokensEdits

Source: https://volarjs.dev/reference/services

Called when the user requests semantic tokens edits in the document.

```APIDOC
## provideDocumentSemanticTokensEdits

### Signature
`(document: TextDocument, previousResultId: string, token: CancellationToken) => SemanticTokens | SemanticTokensEdits | Promise<SemanticTokens | SemanticTokensEdits>`

### Description
This method is called when the user requests semantic tokens edits in the document.
```

--------------------------------

### provideCallHierarchyItems

Source: https://volarjs.dev/reference/services

Called when the user requests call hierarchy items for a symbol.

```APIDOC
## provideCallHierarchyItems

### Signature
`(document: TextDocument, position: Position, token: CancellationToken) => CallHierarchyItem[] | Promise<CallHierarchyItem[]>`

### Description
This method is called when the user requests call hierarchy items for a symbol at a specific position in the document.
```

--------------------------------

### provideDocumentSymbols

Source: https://volarjs.dev/reference/services

Called when the user requests symbols in the document.

```APIDOC
## provideDocumentSymbols

### Signature
`(document: TextDocument, token: CancellationToken) => SymbolInformation[] | Promise<SymbolInformation[]>`

### Description
This method is called when the user requests symbols in the document.
```

--------------------------------

### provideLinkedEditingRanges

Source: https://volarjs.dev/reference/services

Called when the user requests linked editing ranges at a specific position.

```APIDOC
## provideLinkedEditingRanges

### Signature
`(document: TextDocument, position: Position, token: CancellationToken) => LinkedEditingRanges | Promise<LinkedEditingRanges>`

### Description
This method is called when the user requests linked editing ranges at a specific position in the document.
```

--------------------------------

### Support embedded languages in VirtualCode

Source: https://volarjs.dev/reference/languages

Include an embeddedCodes property in the VirtualCode class to manage nested language instances.

```typescript
import type { LanguagePlugin, VirtualCode } from '@volar/language-core';


export const language = {
  createVirtualCode(fileId, languageId, snapshot) {
    if (languageId !== 'my-language')
      return;


    return new MyLanguageVirtualCode(snapshot);
  },
  updateVirtualCode(_fileId, languageCode, snapshot) {
    languageCode.update(snapshot);
    return languageCode;
  },
} satisfies LanguagePlugin<MyLanguageVirtualCode>;


export class MyLanguageVirtualCode implements VirtualCode {
  id = 'root';
  languageId = 'my-language';
  mappings = []
  embeddedCodes: VirtualCode[] = []


  constructor(
    public snapshot: ts.IScriptSnapshot
  ) {
    this.onSnapshotUpdated();
  }


  public update(newSnapshot: ts.IScriptSnapshot) {
    this.snapshot = newSnapshot;
    this.onSnapshotUpdated();
  }


  onSnapshotUpdated() {
    const snapshotContent = this.snapshot.getText(0, this.snapshot.getLength());


    // Find embedded languages
    const embeddedLanguages = findEmbeddedLanguages(snapshotContent);


    // Create virtual code objects for embedded languages
    this.embeddedCodes = embeddedLanguages.map(embeddedLanguage => {
      return {
        id: embeddedLanguage.id,
        languageId: embeddedLanguage.languageId,
        mappings: [],
        snapshot: {
            getText: (start, end) => embeddedLanguage.content.substring(start, end),
            getLength: () => embeddedLanguage.content.length,
            getChangeRange: () => undefined,
          }
      }
    });
  }
}
```

--------------------------------

### provideRenameEdits

Source: https://volarjs.dev/reference/services

Called when the user requests to rename a symbol at a specific position.

```APIDOC
## provideRenameEdits

### Signature
`(document: TextDocument, position: Position, newName: string, token: CancellationToken) => WorkspaceEdit | Promise<WorkspaceEdit>`

### Description
This method is called when the user requests to rename a symbol at a specific position in the document.
```
Tokens:
Raw