Class DefaultWorkspaceManager

The workspace manager is responsible for finding source files in the workspace. This service is shared between all languages of a language server.

Implements

WorkspaceManager

Index

Constructors

constructor

new DefaultWorkspaceManager(
services: LangiumSharedCoreServices,
): DefaultWorkspaceManager
Parameters
- services: LangiumSharedCoreServices
Returns DefaultWorkspaceManager
- Defined in packages/langium/src/workspace/workspace-manager.ts:106

Properties

`Protected` `Readonly`_ready

_ready: Deferred<void> = ...

`Protected` `Readonly`documentBuilder

documentBuilder: DocumentBuilder

`Protected` `Readonly`fileSystemProvider

fileSystemProvider: FileSystemProvider

`Protected` `Optional`folders

folders?: WorkspaceFolder[]

initialBuildOptions

initialBuildOptions: BuildOptions = {}

The options used for the initial workspace build.

`Protected` `Readonly`langiumDocuments

langiumDocuments: LangiumDocuments

`Protected` `Readonly`mutex

mutex: WorkspaceLock

`Protected` `Readonly`serviceRegistry

serviceRegistry: ServiceRegistry

Accessors

ready

get ready(): Promise<void>
A promise that resolves when the workspace manager is ready to be used. Use this to ensure that the workspace manager has finished its initialization.

Returns Promise<void>
Implementation of WorkspaceManager.ready
- Defined in packages/langium/src/workspace/workspace-manager.ts:114

workspaceFolders

get workspaceFolders(): readonly WorkspaceFolder[] | undefined
The workspace folders of the current workspace. Available only after the ready promise resolves.

Returns readonly WorkspaceFolder[] | undefined
Implementation of WorkspaceManager.workspaceFolders
- Defined in packages/langium/src/workspace/workspace-manager.ts:118

Methods

`Protected`getRootFolder

getRootFolder(workspaceFolder: WorkspaceFolder): URI
Determine the root folder of the source documents in the given workspace folder. The default implementation returns the URI of the workspace folder, but you can override this to return a subfolder like src instead.
Parameters
- workspaceFolder: WorkspaceFolder
Returns URI
- Defined in packages/langium/src/workspace/workspace-manager.ts:192

initialize

initialize(params: InitializeParams): void
When used in a language server context, this method is called when the server receives the initialize request.
Parameters
- params: InitializeParams
Returns void
Implementation of WorkspaceManager.initialize
- Defined in packages/langium/src/workspace/workspace-manager.ts:122

initialized

initialized(_params: InitializedParams): Promise<void>
When used in a language server context, this method is called when the server receives the initialized notification.
Parameters
- _params: InitializedParams
Returns Promise<void>
Implementation of WorkspaceManager.initialized
- Defined in packages/langium/src/workspace/workspace-manager.ts:126

initializeWorkspace

initializeWorkspace(
folders: WorkspaceFolder[],
cancelToken?: Cancellation.CancellationToken,
): Promise<void>
Does the initial indexing of workspace folders. Collects information about exported and referenced AstNodes in each language file and stores it locally.
Parameters
- folders: WorkspaceFolder[]
  The set of workspace folders to be indexed.
- cancelToken: Cancellation.CancellationToken = CancellationToken.None
  A cancellation token that can be used to cancel the operation.
Returns Promise<void>

Throws
OperationCancelled if a cancellation event has been detected
Implementation of WorkspaceManager.initializeWorkspace
- Defined in packages/langium/src/workspace/workspace-manager.ts:132

`Protected`loadAdditionalDocuments

loadAdditionalDocuments(
_folders: WorkspaceFolder[],
_collector: (document: LangiumDocument) => void,
): Promise<void>
Load all additional documents that shall be visible in the context of the given workspace folders and add them to the collector. This can be used to include built-in libraries of your language, which can be either loaded from provided files or constructed in memory.
Parameters
- _folders: WorkspaceFolder[]
- _collector: (document: LangiumDocument) => void
Returns Promise<void>
- Defined in packages/langium/src/workspace/workspace-manager.ts:183

`Protected`loadWorkspaceDocuments

loadWorkspaceDocuments(
uris: Stream<URI>,
collector: (document: LangiumDocument) => void,
): Promise<void>
Parameters
- uris: Stream<URI>
- collector: (document: LangiumDocument) => void
Returns Promise<void>
- Defined in packages/langium/src/workspace/workspace-manager.ts:171

`Protected`performStartup

performStartup(folders: WorkspaceFolder[]): Promise<LangiumDocument<AstNode>[]>
Performs the uninterruptable startup sequence of the workspace manager. This methods loads all documents in the workspace and other documents and returns them.
Parameters
- folders: WorkspaceFolder[]
Returns Promise<LangiumDocument<AstNode>[]>
- Defined in packages/langium/src/workspace/workspace-manager.ts:144

searchFolder

searchFolder(uri: URI): Promise<URI[]>
Searches for workspace files in the given folder and its subdirectories. Note that this method does not create documents for the found files.
Parameters
- uri: URI
  The URI of the folder to search in.
Returns Promise<URI[]>
A promise that resolves to an array of URIs of the found files.
Implementation of WorkspaceManager.searchFolder
- Defined in packages/langium/src/workspace/workspace-manager.ts:217

shouldIncludeEntry

shouldIncludeEntry(entry: FileSystemNode): boolean
Determine whether the given folder entry shall be included while indexing the workspace.
Parameters
- entry: FileSystemNode
Returns boolean
Implementation of WorkspaceManager.shouldIncludeEntry
- Defined in packages/langium/src/workspace/workspace-manager.ts:226

`Protected`traverseFolder

traverseFolder(folderPath: URI, uris: URI[]): Promise<void>
Traverse the file system folder identified by the given URI and its subfolders. All contained files that match the file extensions are added to the uris array.
Parameters
- folderPath: URI
- uris: URI[]
Returns Promise<void>
- Defined in packages/langium/src/workspace/workspace-manager.ts:200

Class DefaultWorkspaceManager

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns DefaultWorkspaceManager

Properties

Protected Readonly_ready

Protected ReadonlydocumentBuilder

Protected ReadonlyfileSystemProvider

Protected Optionalfolders

initialBuildOptions

Protected ReadonlylangiumDocuments

Protected Readonlymutex

Protected ReadonlyserviceRegistry

Accessors

ready

Returns Promise<void>

workspaceFolders

Returns readonly WorkspaceFolder[] | undefined

Methods

ProtectedgetRootFolder

Parameters

Returns URI

initialize

Parameters

Returns void

initialized

Parameters

Returns Promise<void>

initializeWorkspace

Parameters

Returns Promise<void>

Throws

ProtectedloadAdditionalDocuments

Parameters

Returns Promise<void>

ProtectedloadWorkspaceDocuments

Parameters

Returns Promise<void>

ProtectedperformStartup

Parameters

Returns Promise<LangiumDocument<AstNode>[]>

searchFolder

Parameters

Returns Promise<URI[]>

shouldIncludeEntry

Parameters

Returns boolean

ProtectedtraverseFolder

Parameters

Returns Promise<void>

Settings

On This Page

`Protected` `Readonly`_ready

`Protected` `Readonly`documentBuilder

`Protected` `Readonly`fileSystemProvider

`Protected` `Optional`folders

`Protected` `Readonly`langiumDocuments

`Protected` `Readonly`mutex

`Protected` `Readonly`serviceRegistry

`Protected`getRootFolder

`Protected`loadAdditionalDocuments

`Protected`loadWorkspaceDocuments

`Protected`performStartup

`Protected`traverseFolder