Class DefaultRenameProvider

Language-specific service for handling rename requests and prepare rename requests.

Implements

RenameProvider

Index

Constructors

Properties

grammarConfig nameProvider references

Methods

isNameNode prepareRename rename renameNodeRange

Constructors

constructor

new DefaultRenameProvider(services: LangiumServices): DefaultRenameProvider
Parameters
- services: LangiumServices
Returns DefaultRenameProvider
- Defined in packages/langium/src/lsp/rename-provider.ts:57

Properties

`Protected` `Readonly`grammarConfig

grammarConfig: GrammarConfig

`Protected` `Readonly`nameProvider

nameProvider: NameProvider

`Protected` `Readonly`references

references: References

Methods

`Protected`isNameNode

isNameNode(leafNode: undefined | CstNode): undefined | boolean
Parameters
- leafNode: undefined | CstNode
Returns undefined | boolean
- Defined in packages/langium/src/lsp/rename-provider.ts:116

prepareRename

prepareRename(
    document: LangiumDocument,
    params: TextDocumentPositionParams,
    _cancelToken?: Cancellation.CancellationToken,
): MaybePromise<undefined | Range>
Handle a prepare rename request.
Parameters
- document: LangiumDocument
  The document in which the prepare rename request was triggered.
- params: TextDocumentPositionParams
  The prepare rename parameters.
- Optional_cancelToken: Cancellation.CancellationToken
Returns MaybePromise<undefined | Range>
A range that describes the range of the symbol to be renamed.

Throws
OperationCancelled if cancellation is detected during execution

Throws
ResponseError if an error is detected that should be sent as response to the client
Implementation of RenameProvider.prepareRename
- Defined in packages/langium/src/lsp/rename-provider.ts:95

rename

rename(
    document: LangiumDocument,
    params: RenameParams,
    _cancelToken?: Cancellation.CancellationToken,
): Promise<undefined | WorkspaceEdit>
Handle a rename request.
Parameters
- document: LangiumDocument
  The document in which the rename request was triggered.
- params: RenameParams
  The rename parameters.
- Optional_cancelToken: Cancellation.CancellationToken
Returns Promise<undefined | WorkspaceEdit>
A workspace edit that describes the changes to be applied to the workspace.

Throws
OperationCancelled if cancellation is detected during execution

Throws
ResponseError if an error is detected that should be sent as response to the client
Implementation of RenameProvider.rename
- Defined in packages/langium/src/lsp/rename-provider.ts:63

`Protected`renameNodeRange

renameNodeRange(doc: LangiumDocument, position: Position): undefined | Range
Parameters
- doc: LangiumDocument
- position: Position
Returns undefined | Range
- Defined in packages/langium/src/lsp/rename-provider.ts:99