@hydranium/core 1.0.0-next.4 → 1.0.0-next.42
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/documents/ast-document-manager.d.ts +42 -5
- package/lib/documents/ast-document-manager.d.ts.map +1 -1
- package/lib/documents/ast-document-manager.js +9 -12
- package/lib/documents/ast-document-manager.js.map +1 -1
- package/lib/documents/hydranium-text-documents.d.ts.map +1 -1
- package/lib/documents/hydranium-text-documents.js +41 -9
- package/lib/documents/hydranium-text-documents.js.map +1 -1
- package/lib/documents/language-client-text-shadow.d.ts +24 -1
- package/lib/documents/language-client-text-shadow.d.ts.map +1 -1
- package/lib/documents/language-client-text-shadow.js +36 -2
- package/lib/documents/language-client-text-shadow.js.map +1 -1
- package/lib/documents/self-save-registry.d.ts +37 -6
- package/lib/documents/self-save-registry.d.ts.map +1 -1
- package/lib/documents/self-save-registry.js +28 -15
- package/lib/documents/self-save-registry.js.map +1 -1
- package/lib/index.d.ts +2 -0
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +5 -0
- package/lib/index.js.map +1 -1
- package/lib/langium/ast-extension/ast-node-builder.d.ts +32 -9
- package/lib/langium/ast-extension/ast-node-builder.d.ts.map +1 -1
- package/lib/langium/ast-extension/ast-node-builder.js +60 -22
- package/lib/langium/ast-extension/ast-node-builder.js.map +1 -1
- package/lib/langium/bootstrap.d.ts.map +1 -1
- package/lib/langium/bootstrap.js +16 -9
- package/lib/langium/bootstrap.js.map +1 -1
- package/lib/langium/document-builder/build-pipeline-integration.d.ts +13 -1
- package/lib/langium/document-builder/build-pipeline-integration.d.ts.map +1 -1
- package/lib/langium/document-builder/build-pipeline-integration.js +1 -1
- package/lib/langium/document-builder/build-pipeline-integration.js.map +1 -1
- package/lib/langium/document-builder/build-session.d.ts +93 -0
- package/lib/langium/document-builder/build-session.d.ts.map +1 -0
- package/lib/langium/document-builder/build-session.js +72 -0
- package/lib/langium/document-builder/build-session.js.map +1 -0
- package/lib/langium/document-builder/document-builder.d.ts +150 -7
- package/lib/langium/document-builder/document-builder.d.ts.map +1 -1
- package/lib/langium/document-builder/document-builder.js +298 -11
- package/lib/langium/document-builder/document-builder.js.map +1 -1
- package/lib/langium/document-builder/index.d.ts +1 -0
- package/lib/langium/document-builder/index.d.ts.map +1 -1
- package/lib/langium/document-builder/index.js +1 -0
- package/lib/langium/document-builder/index.js.map +1 -1
- package/lib/langium/integration-services.d.ts +45 -1
- package/lib/langium/integration-services.d.ts.map +1 -1
- package/lib/langium/integration-services.js +10 -5
- package/lib/langium/integration-services.js.map +1 -1
- package/lib/langium/integrity/integrity-service.d.ts +5 -0
- package/lib/langium/integrity/integrity-service.d.ts.map +1 -1
- package/lib/langium/integrity/integrity-service.js +34 -1
- package/lib/langium/integrity/integrity-service.js.map +1 -1
- package/lib/langium/keys/containment.d.ts +64 -0
- package/lib/langium/keys/containment.d.ts.map +1 -0
- package/lib/langium/keys/containment.js +53 -0
- package/lib/langium/keys/containment.js.map +1 -0
- package/lib/langium/keys/index.d.ts +1 -0
- package/lib/langium/keys/index.d.ts.map +1 -1
- package/lib/langium/keys/index.js +1 -0
- package/lib/langium/keys/index.js.map +1 -1
- package/lib/langium/keys/name-based-key-provider.d.ts +4 -0
- package/lib/langium/keys/name-based-key-provider.d.ts.map +1 -1
- package/lib/langium/keys/name-based-key-provider.js +4 -0
- package/lib/langium/keys/name-based-key-provider.js.map +1 -1
- package/lib/langium/model-service/model-service.d.ts +103 -7
- package/lib/langium/model-service/model-service.d.ts.map +1 -1
- package/lib/langium/model-service/model-service.js +70 -89
- package/lib/langium/model-service/model-service.js.map +1 -1
- package/lib/langium/module.d.ts +82 -13
- package/lib/langium/module.d.ts.map +1 -1
- package/lib/langium/module.js +21 -12
- package/lib/langium/module.js.map +1 -1
- package/lib/langium/naming/name-provider.d.ts +10 -0
- package/lib/langium/naming/name-provider.d.ts.map +1 -1
- package/lib/langium/naming/name-provider.js.map +1 -1
- package/lib/langium/naming/name-separator-validation.d.ts +23 -0
- package/lib/langium/naming/name-separator-validation.d.ts.map +1 -1
- package/lib/langium/naming/name-separator-validation.js +30 -1
- package/lib/langium/naming/name-separator-validation.js.map +1 -1
- package/lib/langium/residency/cst-residency-service.d.ts +31 -9
- package/lib/langium/residency/cst-residency-service.d.ts.map +1 -1
- package/lib/langium/residency/cst-residency-service.js +13 -56
- package/lib/langium/residency/cst-residency-service.js.map +1 -1
- package/lib/langium/scope/hydranium-scope-provider.d.ts +32 -13
- package/lib/langium/scope/hydranium-scope-provider.d.ts.map +1 -1
- package/lib/langium/scope/hydranium-scope-provider.js +37 -20
- package/lib/langium/scope/hydranium-scope-provider.js.map +1 -1
- package/lib/langium/shared-services.d.ts +15 -2
- package/lib/langium/shared-services.d.ts.map +1 -1
- package/lib/langium/shared-services.js.map +1 -1
- package/lib/langium/transfer/transfer-encoder.d.ts +33 -2
- package/lib/langium/transfer/transfer-encoder.d.ts.map +1 -1
- package/lib/langium/transfer/transfer-encoder.js +14 -3
- package/lib/langium/transfer/transfer-encoder.js.map +1 -1
- package/lib/langium/validation/document-validator.d.ts +145 -6
- package/lib/langium/validation/document-validator.d.ts.map +1 -1
- package/lib/langium/validation/document-validator.js +211 -4
- package/lib/langium/validation/document-validator.js.map +1 -1
- package/lib/langium/workspace/document-uri-policy.d.ts +3 -4
- package/lib/langium/workspace/document-uri-policy.d.ts.map +1 -1
- package/lib/langium/workspace/document-uri-policy.js +3 -4
- package/lib/langium/workspace/document-uri-policy.js.map +1 -1
- package/lib/langium/workspace/hydranium-langium-document-factory.d.ts +25 -0
- package/lib/langium/workspace/hydranium-langium-document-factory.d.ts.map +1 -1
- package/lib/langium/workspace/hydranium-langium-document-factory.js +25 -0
- package/lib/langium/workspace/hydranium-langium-document-factory.js.map +1 -1
- package/lib/langium/workspace/hydranium-workspace-manager.d.ts +21 -1
- package/lib/langium/workspace/hydranium-workspace-manager.d.ts.map +1 -1
- package/lib/langium/workspace/hydranium-workspace-manager.js +28 -0
- package/lib/langium/workspace/hydranium-workspace-manager.js.map +1 -1
- package/lib/langium/workspace/in-memory-file-system-provider.d.ts +8 -0
- package/lib/langium/workspace/in-memory-file-system-provider.d.ts.map +1 -1
- package/lib/langium/workspace/in-memory-file-system-provider.js +11 -2
- package/lib/langium/workspace/in-memory-file-system-provider.js.map +1 -1
- package/lib/langium/workspace/initialize-workspace.d.ts +22 -2
- package/lib/langium/workspace/initialize-workspace.d.ts.map +1 -1
- package/lib/langium/workspace/initialize-workspace.js +13 -5
- package/lib/langium/workspace/initialize-workspace.js.map +1 -1
- package/lib/langium/workspace/langium-documents.d.ts +79 -17
- package/lib/langium/workspace/langium-documents.d.ts.map +1 -1
- package/lib/langium/workspace/langium-documents.js +83 -28
- package/lib/langium/workspace/langium-documents.js.map +1 -1
- package/lib/locale/index.d.ts +10 -0
- package/lib/locale/index.d.ts.map +1 -0
- package/lib/locale/index.js +10 -0
- package/lib/locale/index.js.map +1 -0
- package/lib/locale/server-locale.d.ts +73 -0
- package/lib/locale/server-locale.d.ts.map +1 -0
- package/lib/locale/server-locale.js +61 -0
- package/lib/locale/server-locale.js.map +1 -0
- package/lib/lsp/hydranium-document-update-handler.js +1 -1
- package/lib/lsp/hydranium-document-update-handler.js.map +1 -1
- package/lib/messages/carriers.d.ts +54 -0
- package/lib/messages/carriers.d.ts.map +1 -0
- package/lib/messages/carriers.js +62 -0
- package/lib/messages/carriers.js.map +1 -0
- package/lib/messages/index.d.ts +25 -0
- package/lib/messages/index.d.ts.map +1 -0
- package/lib/messages/index.js +25 -0
- package/lib/messages/index.js.map +1 -0
- package/lib/messages/renderer.d.ts +136 -0
- package/lib/messages/renderer.d.ts.map +1 -0
- package/lib/messages/renderer.js +159 -0
- package/lib/messages/renderer.js.map +1 -0
- package/lib/node/node-file-system-provider.d.ts.map +1 -1
- package/lib/node/node-file-system-provider.js +1 -40
- package/lib/node/node-file-system-provider.js.map +1 -1
- package/lib/node/rename-over-open-readers.d.ts +52 -0
- package/lib/node/rename-over-open-readers.d.ts.map +1 -0
- package/lib/node/rename-over-open-readers.js +66 -0
- package/lib/node/rename-over-open-readers.js.map +1 -0
- package/lib/testing/fake-document.d.ts +14 -3
- package/lib/testing/fake-document.d.ts.map +1 -1
- package/lib/testing/fake-document.js +18 -3
- package/lib/testing/fake-document.js.map +1 -1
- package/lib/testing/make-noop-shared-services.d.ts +14 -0
- package/lib/testing/make-noop-shared-services.d.ts.map +1 -1
- package/lib/testing/make-noop-shared-services.js +28 -2
- package/lib/testing/make-noop-shared-services.js.map +1 -1
- package/lib/testing/make-test-services.d.ts +31 -4
- package/lib/testing/make-test-services.d.ts.map +1 -1
- package/lib/testing/make-test-services.js +19 -3
- package/lib/testing/make-test-services.js.map +1 -1
- package/lib/testing/playwright/server-log-capture.d.ts +14 -4
- package/lib/testing/playwright/server-log-capture.d.ts.map +1 -1
- package/lib/testing/playwright/server-log-capture.js +21 -4
- package/lib/testing/playwright/server-log-capture.js.map +1 -1
- package/lib/testing/playwright/server-log-rename-reporter.d.ts.map +1 -1
- package/lib/testing/playwright/server-log-rename-reporter.js +10 -1
- package/lib/testing/playwright/server-log-rename-reporter.js.map +1 -1
- package/lib/testing/stub-ast-document-manager.d.ts +3 -4
- package/lib/testing/stub-ast-document-manager.d.ts.map +1 -1
- package/lib/testing/stub-ast-document-manager.js +2 -5
- package/lib/testing/stub-ast-document-manager.js.map +1 -1
- package/lib/testing/stub-document-builder.d.ts +8 -0
- package/lib/testing/stub-document-builder.d.ts.map +1 -1
- package/lib/testing/stub-document-builder.js +22 -3
- package/lib/testing/stub-document-builder.js.map +1 -1
- package/lib/testing/stub-model-service.d.ts +1 -1
- package/lib/testing/stub-model-service.d.ts.map +1 -1
- package/lib/testing/stub-model-service.js +2 -2
- package/lib/testing/stub-model-service.js.map +1 -1
- package/package.json +17 -8
- package/src/documents/ast-document-manager.ts +55 -14
- package/src/documents/hydranium-text-documents.ts +41 -9
- package/src/documents/language-client-text-shadow.ts +38 -2
- package/src/documents/self-save-registry.ts +52 -13
- package/src/index.ts +5 -0
- package/src/langium/ast-extension/ast-node-builder.ts +66 -22
- package/src/langium/bootstrap.ts +16 -9
- package/src/langium/document-builder/build-pipeline-integration.ts +14 -1
- package/src/langium/document-builder/build-session.ts +87 -0
- package/src/langium/document-builder/document-builder.ts +339 -11
- package/src/langium/document-builder/index.ts +1 -0
- package/src/langium/integration-services.ts +67 -6
- package/src/langium/integrity/integrity-service.ts +35 -1
- package/src/langium/keys/containment.ts +87 -0
- package/src/langium/keys/index.ts +1 -0
- package/src/langium/keys/name-based-key-provider.ts +4 -0
- package/src/langium/model-service/model-service.ts +145 -22
- package/src/langium/module.ts +99 -19
- package/src/langium/naming/name-provider.ts +10 -0
- package/src/langium/naming/name-separator-validation.ts +34 -5
- package/src/langium/residency/cst-residency-service.ts +36 -12
- package/src/langium/scope/hydranium-scope-provider.ts +40 -22
- package/src/langium/shared-services.ts +19 -2
- package/src/langium/transfer/transfer-encoder.ts +45 -3
- package/src/langium/validation/document-validator.ts +255 -8
- package/src/langium/workspace/document-uri-policy.ts +3 -4
- package/src/langium/workspace/hydranium-langium-document-factory.ts +34 -0
- package/src/langium/workspace/hydranium-workspace-manager.ts +30 -1
- package/src/langium/workspace/in-memory-file-system-provider.ts +13 -3
- package/src/langium/workspace/initialize-workspace.ts +34 -5
- package/src/langium/workspace/langium-documents.ts +106 -33
- package/src/locale/index.ts +10 -0
- package/src/locale/server-locale.ts +86 -0
- package/src/lsp/hydranium-document-update-handler.ts +1 -1
- package/src/messages/carriers.ts +78 -0
- package/src/messages/index.ts +27 -0
- package/src/messages/renderer.ts +204 -0
- package/src/node/node-file-system-provider.ts +1 -41
- package/src/node/rename-over-open-readers.ts +78 -0
- package/src/testing/fake-document.ts +22 -4
- package/src/testing/make-noop-shared-services.ts +50 -2
- package/src/testing/make-test-services.ts +49 -7
- package/src/testing/playwright/server-log-capture.ts +24 -5
- package/src/testing/playwright/server-log-rename-reporter.ts +12 -1
- package/src/testing/stub-ast-document-manager.ts +5 -10
- package/src/testing/stub-document-builder.ts +32 -3
- package/src/testing/stub-model-service.ts +2 -2
|
@@ -105,10 +105,9 @@ export class DefaultDocumentUriPolicy implements DocumentUriPolicy {
|
|
|
105
105
|
/**
|
|
106
106
|
* No filesystem access, so existence cannot be checked — every URI is
|
|
107
107
|
* treated as loadable and returned unchanged. A later load that misses
|
|
108
|
-
* therefore reaches the filesystem and throws, which
|
|
109
|
-
*
|
|
110
|
-
*
|
|
111
|
-
* is what makes a missing file a placeholder rather than an error.
|
|
108
|
+
* therefore reaches the filesystem and throws, which reports the miss with
|
|
109
|
+
* the reason the read failed. Under a policy that CAN check, the miss is
|
|
110
|
+
* caught earlier and reported without one.
|
|
112
111
|
*/
|
|
113
112
|
loadUri(uri: URI | string): URI | undefined {
|
|
114
113
|
return UriUtils.toUri(uri);
|
|
@@ -15,6 +15,7 @@ import {
|
|
|
15
15
|
type ParseResult,
|
|
16
16
|
type URI
|
|
17
17
|
} from '@hydranium/langium';
|
|
18
|
+
import { type ExtendedServiceRegistry } from '../service-registry.js';
|
|
18
19
|
import { type Serializer } from '../serialization/serializer.js';
|
|
19
20
|
|
|
20
21
|
/** Structural view of the per-language serializer slot on the resolved services. */
|
|
@@ -49,6 +50,39 @@ interface WithSerializer {
|
|
|
49
50
|
* node identity is preserved.
|
|
50
51
|
*/
|
|
51
52
|
export class HydraniumLangiumDocumentFactory extends DefaultLangiumDocumentFactory {
|
|
53
|
+
/**
|
|
54
|
+
* Narrows the inherited Langium `ServiceRegistry` field to the framework's
|
|
55
|
+
* {@link ExtendedServiceRegistry}, so the by-id lookup below needs no
|
|
56
|
+
* per-callsite cast. The framework's shared module binds that class.
|
|
57
|
+
*/
|
|
58
|
+
declare protected readonly serviceRegistry: ExtendedServiceRegistry;
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* Parse `text` for `uri` under the grammar `languageId` names, instead of
|
|
62
|
+
* the one `uri` routes to.
|
|
63
|
+
*
|
|
64
|
+
* For a URI that routes to no grammar at all: a directory, or any other URI
|
|
65
|
+
* that names no file and so carries no extension. Langium's ladder ends at
|
|
66
|
+
* the extension, so it reports `no services for the extension ''` from
|
|
67
|
+
* inside the parse — naming neither the URI nor the caller that could have
|
|
68
|
+
* said which grammar it meant.
|
|
69
|
+
*
|
|
70
|
+
* The caller supplies the language because nothing else can. A URI with no
|
|
71
|
+
* extension carries no routing signal, and choosing on its behalf would be a
|
|
72
|
+
* guess the moment a second grammar is registered — which is why this takes
|
|
73
|
+
* the id rather than falling back to a sole registered language.
|
|
74
|
+
*
|
|
75
|
+
* @throws when `languageId` names no registered grammar.
|
|
76
|
+
*/
|
|
77
|
+
fromStringInLanguage<T extends AstNode = AstNode>(text: string, uri: URI, languageId: string): LangiumDocument<T> {
|
|
78
|
+
const services = this.serviceRegistry.getServicesById(languageId);
|
|
79
|
+
if (!services) {
|
|
80
|
+
throw new Error(`No grammar is registered for the language id '${languageId}' (parsing ${uri.toString()}).`);
|
|
81
|
+
}
|
|
82
|
+
const parseResult: ParseResult<T> = services.parser.LangiumParser.parse<T>(text);
|
|
83
|
+
return this.createLangiumDocument<T>(parseResult, uri, undefined, text);
|
|
84
|
+
}
|
|
85
|
+
|
|
52
86
|
override fromModel<T extends AstNode = AstNode>(model: T, uri: URI): LangiumDocument<T> {
|
|
53
87
|
// Make the code-built AST as structurally complete as a parsed one — the
|
|
54
88
|
// parser links containers, `fromModel` does not. In place (identity kept).
|
|
@@ -9,9 +9,10 @@
|
|
|
9
9
|
|
|
10
10
|
import { Deferred, type Logger, type Tracer } from '@hydranium/protocol';
|
|
11
11
|
import { DefaultWorkspaceManager, DocumentState, type LangiumDocument, UriUtils, type URI } from '@hydranium/langium';
|
|
12
|
-
import { type CancellationToken } from 'vscode-languageserver';
|
|
12
|
+
import { type CancellationToken, type InitializeParams } from 'vscode-languageserver';
|
|
13
13
|
import type { WorkspaceFolder } from 'vscode-languageserver-types';
|
|
14
14
|
import { type LogNameOptions, resolveLogFilePlaceholder, toLogFileWorkspaceToken } from '../diagnostics/logger.js';
|
|
15
|
+
import type { ServerLocale } from '../../locale/server-locale.js';
|
|
15
16
|
import type { ProjectChangeEvent } from '../project/project-change-event.js';
|
|
16
17
|
import type { ProjectManager } from '../project/project-manager.js';
|
|
17
18
|
import type { ServerSharedServicesMinimal } from '../shared-services.js';
|
|
@@ -156,6 +157,8 @@ export class HydraniumWorkspaceManager extends DefaultWorkspaceManager {
|
|
|
156
157
|
readonly workspaceInitialized: Promise<unknown> = this.workspaceInitializedDeferred.promise;
|
|
157
158
|
|
|
158
159
|
protected readonly uriPolicy: DocumentUriPolicy;
|
|
160
|
+
/** Handed the client's locale at init; read by whoever renders in it. */
|
|
161
|
+
protected readonly serverLocale: ServerLocale;
|
|
159
162
|
protected readonly writableFileSystemProvider: WritableFileSystemProvider;
|
|
160
163
|
protected readonly additionalDocuments: Record<string, AdditionalDocumentContribution>;
|
|
161
164
|
/** Registry consulted by {@link warnIfUnroutable} to check a seeded document routes. */
|
|
@@ -166,6 +169,7 @@ export class HydraniumWorkspaceManager extends DefaultWorkspaceManager {
|
|
|
166
169
|
this.projectManager = services.workspace.ProjectManager;
|
|
167
170
|
this.projectManager.onProjectsChanged(event => this.onProjectsChanged(event));
|
|
168
171
|
this.uriPolicy = services.workspace.DocumentUriPolicy;
|
|
172
|
+
this.serverLocale = services.ServerLocale;
|
|
169
173
|
this.writableFileSystemProvider = services.workspace.FileSystemProvider;
|
|
170
174
|
this.additionalDocuments = services.additionalDocuments;
|
|
171
175
|
this.languageRegistry = services.ServiceRegistry;
|
|
@@ -360,6 +364,31 @@ export class HydraniumWorkspaceManager extends DefaultWorkspaceManager {
|
|
|
360
364
|
}
|
|
361
365
|
}
|
|
362
366
|
|
|
367
|
+
/**
|
|
368
|
+
* Forward the locale the client declared, then Langium's own read of the
|
|
369
|
+
* params. `DefaultWorkspaceManager.initialize` reads `workspaceFolders`
|
|
370
|
+
* alone, so `params.locale` would otherwise be discarded — and this is the
|
|
371
|
+
* only place it arrives, which the headless init seams route through too.
|
|
372
|
+
*
|
|
373
|
+
* **The ABSENT case is reported from here rather than from `ServerLocale`,
|
|
374
|
+
* because this is the only end that can see it.** `accept` is not called
|
|
375
|
+
* when no locale was declared — nor should it be, since `''` is a claim
|
|
376
|
+
* about a language rather than the absence of one — so a log written there
|
|
377
|
+
* covers one of the two outcomes and leaves the other looking like a server
|
|
378
|
+
* that never reached init. Both lines are at `info` for the reason `accept`
|
|
379
|
+
* gives: the framework ships no catalogue, so an undeclared locale and an
|
|
380
|
+
* untranslated code produce the same English and the log is what separates
|
|
381
|
+
* them.
|
|
382
|
+
*/
|
|
383
|
+
override initialize(params: InitializeParams): void {
|
|
384
|
+
if (params.locale) {
|
|
385
|
+
this.serverLocale.accept(params.locale);
|
|
386
|
+
} else {
|
|
387
|
+
this.tracer.info("no locale declared at init — rendering messages in the framework's English");
|
|
388
|
+
}
|
|
389
|
+
super.initialize(params);
|
|
390
|
+
}
|
|
391
|
+
|
|
363
392
|
/**
|
|
364
393
|
* Override of Langium's workspace setup to resolve / reject
|
|
365
394
|
* {@link workspaceInitializedDeferred} once setup completes. Adopters with
|
|
@@ -8,12 +8,22 @@
|
|
|
8
8
|
********************************************************************************/
|
|
9
9
|
|
|
10
10
|
import { type FileSystemNode, URI } from '@hydranium/langium';
|
|
11
|
-
import { type Tracer } from '@hydranium/protocol';
|
|
11
|
+
import { defineMessage, type Tracer } from '@hydranium/protocol';
|
|
12
12
|
import { type WritableFileSystemProvider } from '../../documents/ast-document-manager.js';
|
|
13
13
|
import { type LogNameOptions } from '../diagnostics/logger.js';
|
|
14
14
|
import { serverSharedFactory, type ServerSharedServicesMinimal } from '../shared-services.js';
|
|
15
15
|
import { serveVirtualDocument } from './virtual-document.js';
|
|
16
16
|
|
|
17
|
+
/**
|
|
18
|
+
* The browser host's spelling of "the document is not there". Its Node
|
|
19
|
+
* counterpart is `NO_LOADABLE_CONTENT`: this provider has no `realpath`, so the
|
|
20
|
+
* URI policy cannot answer the existence question ahead of the read and the miss
|
|
21
|
+
* surfaces here instead.
|
|
22
|
+
*/
|
|
23
|
+
export const NO_SUCH_FILE = defineMessage('hydranium/core/no-such-file', 'No such file: {uri}');
|
|
24
|
+
|
|
25
|
+
export const NO_SUCH_PATH = defineMessage('hydranium/core/no-such-path', 'No such file or directory: {uri}');
|
|
26
|
+
|
|
17
27
|
/**
|
|
18
28
|
* File content keyed by path, for seeding an {@link InMemoryFileSystemProvider}.
|
|
19
29
|
*
|
|
@@ -127,7 +137,7 @@ export class InMemoryFileSystemProvider implements WritableFileSystemProvider {
|
|
|
127
137
|
}
|
|
128
138
|
const content = this.files.get(normalize(uri));
|
|
129
139
|
if (content === undefined) {
|
|
130
|
-
throw new Error(
|
|
140
|
+
throw new Error(NO_SUCH_FILE.format({ uri: uri.toString() }));
|
|
131
141
|
}
|
|
132
142
|
return content;
|
|
133
143
|
}
|
|
@@ -152,7 +162,7 @@ export class InMemoryFileSystemProvider implements WritableFileSystemProvider {
|
|
|
152
162
|
if (this.hasChildren(path)) {
|
|
153
163
|
return { isFile: false, isDirectory: true, uri };
|
|
154
164
|
}
|
|
155
|
-
throw new Error(
|
|
165
|
+
throw new Error(NO_SUCH_PATH.format({ uri: uri.toString() }));
|
|
156
166
|
}
|
|
157
167
|
|
|
158
168
|
exists(uri: URI): Promise<boolean> {
|
|
@@ -18,6 +18,25 @@ import type { ServerSharedServicesMinimal } from '../shared-services.js';
|
|
|
18
18
|
/** A workspace folder root accepted by the headless init seams: a filesystem path or a {@link URI}. */
|
|
19
19
|
export type WorkspaceFolderInput = string | URI;
|
|
20
20
|
|
|
21
|
+
/**
|
|
22
|
+
* Options for the headless init seams.
|
|
23
|
+
*
|
|
24
|
+
* **Optional, and the parameter is optional too**, so that no existing caller
|
|
25
|
+
* has to change to gain a field it does not set.
|
|
26
|
+
*/
|
|
27
|
+
export interface ProgrammaticInitOptions {
|
|
28
|
+
/**
|
|
29
|
+
* The locale to render user-facing server messages in — the headless
|
|
30
|
+
* equivalent of LSP `initialize`'s `locale`, for a head with no LSP
|
|
31
|
+
* connection (`startStdioServer`, the CLI subcommands, a test harness).
|
|
32
|
+
*
|
|
33
|
+
* Omitted means no locale, which the default renderer resolves as the
|
|
34
|
+
* framework's English. That is the correct answer for a headless tool: it
|
|
35
|
+
* has no reading user to have a language.
|
|
36
|
+
*/
|
|
37
|
+
readonly locale?: string;
|
|
38
|
+
}
|
|
39
|
+
|
|
21
40
|
/**
|
|
22
41
|
* Normalize the seam's flexible folder argument to LSP {@link WorkspaceFolder}s.
|
|
23
42
|
* A `string` is resolved to an absolute filesystem path and wrapped as a
|
|
@@ -58,17 +77,25 @@ function toWorkspaceFolders(folders: WorkspaceFolderInput | ReadonlyArray<Worksp
|
|
|
58
77
|
*
|
|
59
78
|
* @param services the shared services tree the workspace manager lives on
|
|
60
79
|
* @param folders one or more workspace roots (filesystem paths or URIs)
|
|
80
|
+
* @param options the message locale, when the caller has one
|
|
61
81
|
*/
|
|
62
82
|
export async function initializeWorkspaceProgrammatically(
|
|
63
83
|
services: ServerSharedServicesMinimal,
|
|
64
|
-
folders: WorkspaceFolderInput | ReadonlyArray<WorkspaceFolderInput
|
|
84
|
+
folders: WorkspaceFolderInput | ReadonlyArray<WorkspaceFolderInput>,
|
|
85
|
+
options: ProgrammaticInitOptions = {}
|
|
65
86
|
): Promise<void> {
|
|
66
87
|
const workspaceFolders = toWorkspaceFolders(folders);
|
|
67
88
|
const manager = services.workspace.WorkspaceManager;
|
|
68
|
-
// `
|
|
89
|
+
// `locale` goes through the synthesized params rather than a direct
|
|
90
|
+
// `acceptLocale` call, so this seam and a real LSP `initialize` reach the
|
|
91
|
+
// slot by the SAME path — an adopter overriding the capture in
|
|
92
|
+
// `HydraniumWorkspaceManager.initialize` is honoured headlessly too, which a
|
|
93
|
+
// second write site here would silently bypass.
|
|
94
|
+
//
|
|
95
|
+
// `initialize` records the folders (DefaultWorkspaceManager reads only that
|
|
69
96
|
// field); `initialized` runs `mutex.write(initializeWorkspace)` and resolves
|
|
70
97
|
// once discovery + the init build settle, so awaiting it is the ready gate.
|
|
71
|
-
manager.initialize({ workspaceFolders } as InitializeParams);
|
|
98
|
+
manager.initialize({ workspaceFolders, locale: options.locale } as InitializeParams);
|
|
72
99
|
await manager.initialized({} as InitializedParams);
|
|
73
100
|
}
|
|
74
101
|
|
|
@@ -91,12 +118,14 @@ export async function initializeWorkspaceProgrammatically(
|
|
|
91
118
|
*
|
|
92
119
|
* @param services the shared services tree the workspace manager lives on
|
|
93
120
|
* @param folders one or more workspace roots (filesystem paths or URIs)
|
|
121
|
+
* @param options the message locale, when the caller has one
|
|
94
122
|
*/
|
|
95
123
|
export async function buildWorkspaceProgrammatically(
|
|
96
124
|
services: ServerSharedServicesMinimal,
|
|
97
|
-
folders: WorkspaceFolderInput | ReadonlyArray<WorkspaceFolderInput
|
|
125
|
+
folders: WorkspaceFolderInput | ReadonlyArray<WorkspaceFolderInput>,
|
|
126
|
+
options: ProgrammaticInitOptions = {}
|
|
98
127
|
): Promise<void> {
|
|
99
|
-
await initializeWorkspaceProgrammatically(services, folders);
|
|
128
|
+
await initializeWorkspaceProgrammatically(services, folders, options);
|
|
100
129
|
const documents = services.workspace.LangiumDocuments.all.toArray();
|
|
101
130
|
await services.workspace.DocumentBuilder.build(documents, { validation: true });
|
|
102
131
|
}
|
|
@@ -7,14 +7,49 @@
|
|
|
7
7
|
* SPDX-License-Identifier: MIT
|
|
8
8
|
********************************************************************************/
|
|
9
9
|
|
|
10
|
-
import { type
|
|
11
|
-
import {
|
|
10
|
+
import { type AstNode, DefaultLangiumDocuments, type LangiumDocument, type LangiumDocuments, type URI } from '@hydranium/langium';
|
|
11
|
+
import { defineMessage } from '@hydranium/protocol';
|
|
12
12
|
import { type ServerSharedServicesMinimal } from '../shared-services.js';
|
|
13
13
|
import { type DocumentUriPolicy } from './document-uri-policy.js';
|
|
14
|
+
import { type HydraniumLangiumDocumentFactory } from './hydranium-langium-document-factory.js';
|
|
14
15
|
|
|
15
16
|
/**
|
|
16
|
-
*
|
|
17
|
-
*
|
|
17
|
+
* The document a caller asked to load is not there.
|
|
18
|
+
*
|
|
19
|
+
* User-facing, and the Node host's spelling of it: `loadUri` returns `undefined`
|
|
20
|
+
* exactly when the URI policy's `realpath` reports the path absent. A host whose
|
|
21
|
+
* provider has no `realpath` never reaches this — the miss surfaces from the
|
|
22
|
+
* provider instead, so the same condition has one declaration per host.
|
|
23
|
+
*/
|
|
24
|
+
export const NO_LOADABLE_CONTENT = defineMessage('hydranium/core/no-loadable-content', 'No loadable content for {uri}');
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* A stand-in was asked for at a URI that routes to no grammar, and no language
|
|
28
|
+
* id was given to route it instead.
|
|
29
|
+
*
|
|
30
|
+
* User-facing, and raised BEFORE the parse: left to Langium's ladder the same
|
|
31
|
+
* condition surfaces as `no services for the extension ''`, which names neither
|
|
32
|
+
* the URI nor the argument that would have answered.
|
|
33
|
+
*/
|
|
34
|
+
export const NO_LANGUAGE_FOR_STAND_IN = defineMessage(
|
|
35
|
+
'hydranium/core/no-language-for-stand-in',
|
|
36
|
+
'No grammar routes {uri}; pass a languageId to say which one the stand-in should parse with'
|
|
37
|
+
);
|
|
38
|
+
|
|
39
|
+
/**
|
|
40
|
+
* The registry surface the framework adds on top of Langium's
|
|
41
|
+
* {@link LangiumDocuments}. Declared separately from the implementing class so
|
|
42
|
+
* the shared-services slot can narrow to it: the class takes the services tree
|
|
43
|
+
* as its constructor parameter, so naming the CLASS there would make that type
|
|
44
|
+
* depend on itself.
|
|
45
|
+
*/
|
|
46
|
+
export interface HydraniumDocumentRegistry extends LangiumDocuments {
|
|
47
|
+
createEmptyDocument(uri: URI, languageId?: string): LangiumDocument<AstNode>;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* Default `LangiumDocuments` for `@hydranium/core` consumers, extending
|
|
52
|
+
* Langium's {@link DefaultLangiumDocuments} with:
|
|
18
53
|
*
|
|
19
54
|
* 1. **Identity via the {@link DocumentUriPolicy} seam.**
|
|
20
55
|
* `getOrCreateDocument` resolves the requested URI through the seam — the
|
|
@@ -24,31 +59,78 @@ import { type DocumentUriPolicy } from './document-uri-policy.js';
|
|
|
24
59
|
* `LangiumDocuments` override. The default resolves to the URI unchanged
|
|
25
60
|
* (`DefaultDocumentUriPolicy`), matching Langium's own keying.
|
|
26
61
|
*
|
|
27
|
-
* 2.
|
|
28
|
-
* document
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
62
|
+
* 2. **A load that finds nothing rejects**, rather than answering with a
|
|
63
|
+
* transient empty document. An empty AST validates clean, so a placeholder
|
|
64
|
+
* hands the caller something that silently is not the file, and a caller
|
|
65
|
+
* that wants a document for a URI with no content on disk cannot use one
|
|
66
|
+
* anyway: it is unregistered, so no build, index or save can see it, and
|
|
67
|
+
* `LangiumDocumentFactory.update` reads from disk. Content that legitimately
|
|
68
|
+
* lives outside the filesystem belongs in a virtual document, which carries
|
|
69
|
+
* real source text.
|
|
35
70
|
*/
|
|
36
|
-
export
|
|
71
|
+
export class HydraniumLangiumDocuments extends DefaultLangiumDocuments implements HydraniumDocumentRegistry {
|
|
37
72
|
/** Document-identity seam, shared with the text store, event filters, and builder. */
|
|
38
73
|
protected readonly uriPolicy: DocumentUriPolicy;
|
|
39
|
-
|
|
74
|
+
|
|
75
|
+
/**
|
|
76
|
+
* Narrows the inherited Langium factory field to the framework's, so the
|
|
77
|
+
* language-explicit `fromStringInLanguage` below needs no cast. The
|
|
78
|
+
* framework's shared module binds that class.
|
|
79
|
+
*/
|
|
80
|
+
declare protected readonly langiumDocumentFactory: HydraniumLangiumDocumentFactory;
|
|
40
81
|
|
|
41
82
|
constructor(protected override readonly services: ServerSharedServicesMinimal) {
|
|
42
83
|
super(services);
|
|
43
84
|
this.uriPolicy = services.workspace.DocumentUriPolicy;
|
|
44
|
-
this.tracer = services.Tracer.for('LangiumDocuments');
|
|
45
85
|
}
|
|
46
86
|
|
|
47
87
|
/**
|
|
48
|
-
* Build a transient
|
|
49
|
-
*
|
|
88
|
+
* Build a transient document for `uri` by parsing empty text with the
|
|
89
|
+
* grammar `languageId` names, or the one `uri` routes to when it is
|
|
90
|
+
* omitted, so the root is that language's entry type with every containment
|
|
91
|
+
* list initialised.
|
|
92
|
+
*
|
|
93
|
+
* For callers that need a document at a URI with no content on disk — the
|
|
94
|
+
* scope provider querying before a file exists is the case it was added for.
|
|
95
|
+
* `getOrCreateDocument` deliberately does NOT fall back to this: fabricating
|
|
96
|
+
* a document behind a caller that asked to LOAD one hands back something
|
|
97
|
+
* that silently is not the file, whereas calling this is a caller saying it
|
|
98
|
+
* wants a stand-in.
|
|
99
|
+
*
|
|
100
|
+
* **Pass `languageId` whenever the URI names no file.** The create-element
|
|
101
|
+
* flow this exists for asks at the DIRECTORY a file is about to be written
|
|
102
|
+
* into, and a directory URI has no extension for the routing ladder to end
|
|
103
|
+
* on — so omitting the id there fails inside the parse, on an empty
|
|
104
|
+
* extension rather than on the URI. A caller in that position always knows
|
|
105
|
+
* its language: {@link HydraniumScopeProvider} is bound per grammar, and a
|
|
106
|
+
* request that names no document at all still carries the AST type
|
|
107
|
+
* `ExtendedServiceRegistry.soleServicesByType` routes on.
|
|
108
|
+
*
|
|
109
|
+
* The result is not registered, so nothing downstream can see it, and
|
|
110
|
+
* `LangiumDocumentFactory.update` would read from disk. It is a probe, not a
|
|
111
|
+
* document under construction; content that must survive belongs in a
|
|
112
|
+
* virtual document, which carries real source text.
|
|
113
|
+
*
|
|
114
|
+
* Building the root by hand instead needs the entry type name and a cast
|
|
115
|
+
* past the generated types, and leaves those lists `undefined`. A grammar
|
|
116
|
+
* whose entry rule opens with mandatory syntax yields a parse error here,
|
|
117
|
+
* and it is kept: `AstReflection.isComplete` is `false` for such a root
|
|
118
|
+
* however it is built, so the error states the same thing.
|
|
50
119
|
*/
|
|
51
|
-
|
|
120
|
+
createEmptyDocument(uri: URI, languageId?: string): LangiumDocument<AstNode> {
|
|
121
|
+
if (languageId !== undefined) {
|
|
122
|
+
return this.langiumDocumentFactory.fromStringInLanguage('', uri, languageId);
|
|
123
|
+
}
|
|
124
|
+
if (!this.services.ServiceRegistry.getServicesFor(uri)) {
|
|
125
|
+
// Reported here rather than left to the parse, which ends on the empty
|
|
126
|
+
// extension and so names neither the URI nor the id that would have
|
|
127
|
+
// answered.
|
|
128
|
+
throw new Error(NO_LANGUAGE_FOR_STAND_IN.format({ uri: uri.toString() }));
|
|
129
|
+
}
|
|
130
|
+
// The two-argument overload is synchronous; passing a cancellation token
|
|
131
|
+
// selects the promise-returning one, which this contract cannot await.
|
|
132
|
+
return this.langiumDocumentFactory.fromString('', uri);
|
|
133
|
+
}
|
|
52
134
|
|
|
53
135
|
override async getOrCreateDocument(uri: URI): Promise<LangiumDocument<AstNode>> {
|
|
54
136
|
const resolved = this.uriPolicy.loadUri(uri);
|
|
@@ -68,27 +150,18 @@ export abstract class AbstractHydraniumLangiumDocuments extends DefaultLangiumDo
|
|
|
68
150
|
return await super.getOrCreateDocument(resolved);
|
|
69
151
|
} catch (error: unknown) {
|
|
70
152
|
// Load lost a race with a concurrent create — return that document.
|
|
153
|
+
// Checked before propagating, so a race is not reported as a
|
|
154
|
+
// missing file; cancellation carries no document and falls through.
|
|
71
155
|
const reentrant = this.getDocument(resolved);
|
|
72
156
|
if (reentrant) {
|
|
73
157
|
this.services.workspace.CstResidencyService.rehydrate(reentrant);
|
|
74
158
|
return reentrant;
|
|
75
159
|
}
|
|
76
|
-
|
|
77
|
-
// below still runs, because the file-not-found case is the ordinary
|
|
78
|
-
// one here and no provider-independent way to recognise it exists:
|
|
79
|
-
// Node's provider throws `ENOENT`, the in-memory one a bare `Error`,
|
|
80
|
-
// and the provider is a seam an adopter rebinds. Discriminating on
|
|
81
|
-
// message text across that seam would be a worse defect than the
|
|
82
|
-
// one it fixes. So the failure is TRACED rather than propagated —
|
|
83
|
-
// an unreadable-but-present file still degrades to an empty
|
|
84
|
-
// document, but it stops doing so silently.
|
|
85
|
-
this.tracer
|
|
86
|
-
.with(resolved.toString())
|
|
87
|
-
.debug(`Load failed, falling back to an empty document: ${error instanceof Error ? error.message : String(error)}`);
|
|
160
|
+
throw error;
|
|
88
161
|
}
|
|
89
162
|
}
|
|
90
|
-
//
|
|
91
|
-
//
|
|
92
|
-
|
|
163
|
+
// The seam reports no loadable content, so there is nothing to read and
|
|
164
|
+
// no error from a read to carry.
|
|
165
|
+
throw new Error(NO_LOADABLE_CONTENT.format({ uri: uri.toString() }));
|
|
93
166
|
}
|
|
94
167
|
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/********************************************************************************
|
|
2
|
+
* Copyright (c) 2026 CrossBreeze, EclipseSource and others.
|
|
3
|
+
*
|
|
4
|
+
* This program and the accompanying materials are made available under the
|
|
5
|
+
* terms of the MIT License which is available in the project root.
|
|
6
|
+
*
|
|
7
|
+
* SPDX-License-Identifier: MIT
|
|
8
|
+
********************************************************************************/
|
|
9
|
+
|
|
10
|
+
export * from './server-locale.js';
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
/********************************************************************************
|
|
2
|
+
* Copyright (c) 2026 CrossBreeze, EclipseSource and others.
|
|
3
|
+
*
|
|
4
|
+
* This program and the accompanying materials are made available under the
|
|
5
|
+
* terms of the MIT License which is available in the project root.
|
|
6
|
+
*
|
|
7
|
+
* SPDX-License-Identifier: MIT
|
|
8
|
+
********************************************************************************/
|
|
9
|
+
|
|
10
|
+
import type { Tracer } from '@hydranium/protocol';
|
|
11
|
+
import { type LogNameOptions } from '../langium/diagnostics/logger.js';
|
|
12
|
+
import type { ServerSharedServicesMinimal } from '../langium/shared-services.js';
|
|
13
|
+
|
|
14
|
+
/** Construction options for {@link ServerLocale}. */
|
|
15
|
+
export type ServerLocaleOptions = LogNameOptions;
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* The locale contract the `ServerLocale` slot holds, implemented by
|
|
19
|
+
* {@link DefaultServerLocale}.
|
|
20
|
+
*
|
|
21
|
+
* An interface rather than the class, so the slot is compared STRUCTURALLY —
|
|
22
|
+
* a class-typed slot carries its `protected` members into every assignability
|
|
23
|
+
* check, compared nominally, which makes it unsatisfiable across two physical
|
|
24
|
+
* copies of this package and unreplaceable by an adopter's own declaration.
|
|
25
|
+
*/
|
|
26
|
+
export interface ServerLocale {
|
|
27
|
+
/** The locale, or `undefined` when no init supplied one — the framework's English. */
|
|
28
|
+
readonly value: string | undefined;
|
|
29
|
+
accept(locale: string): void;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* The locale the server was handed at init, for whoever needs to render in the
|
|
34
|
+
* reading user's language. Held apart from the message renderer that reads it,
|
|
35
|
+
* so replacing the renderer cannot drop locale handling.
|
|
36
|
+
*
|
|
37
|
+
* A plain string in and out. A consumer that must react to a change rather than
|
|
38
|
+
* read the current value wraps this itself — nothing does today, and both real
|
|
39
|
+
* hosts respawn the server on a display-language switch.
|
|
40
|
+
*/
|
|
41
|
+
export class DefaultServerLocale implements ServerLocale {
|
|
42
|
+
protected readonly tracer: Tracer;
|
|
43
|
+
protected current: string | undefined;
|
|
44
|
+
|
|
45
|
+
constructor(services: ServerSharedServicesMinimal, options: ServerLocaleOptions = {}) {
|
|
46
|
+
this.tracer = services.Tracer.for(options.logName ?? 'ServerLocale').trace('instantiated');
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
/** The locale, or `undefined` when no init supplied one — which means the framework's English. */
|
|
50
|
+
get value(): string | undefined {
|
|
51
|
+
return this.current;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* Take the locale an init declared.
|
|
56
|
+
*
|
|
57
|
+
* **One locale per process, and the reason the OTHER heads need none of
|
|
58
|
+
* their own.** The data and GLSP heads publish a port over the LSP
|
|
59
|
+
* connection and are reached by forwarding a socket to it, so they are the
|
|
60
|
+
* same process as the LSP head that was handed this locale — there is no
|
|
61
|
+
* topology in which one of them serves a second frontend. The Theia backend
|
|
62
|
+
* is the case that would break it, and it holds no locale precisely because
|
|
63
|
+
* it serves every frontend at once; nothing there writes here.
|
|
64
|
+
*
|
|
65
|
+
* The framework accepts a locale and never sources one, and neither
|
|
66
|
+
* validates nor normalises the tag: rejecting an unfamiliar one would be
|
|
67
|
+
* selecting a locale.
|
|
68
|
+
*
|
|
69
|
+
* Override to ignore the argument, which is how a host pins a locale it
|
|
70
|
+
* already knows but has no LSP client to declare.
|
|
71
|
+
*
|
|
72
|
+
* **The line is at `info`, which is a deliberate exception to the
|
|
73
|
+
* per-service default.** A locale is written once per process and it is the
|
|
74
|
+
* one setting that silently changes every user-facing sentence the server
|
|
75
|
+
* produces, so a reader trying to explain an unexpected language has nothing
|
|
76
|
+
* else to look at: the framework ships no catalogue, so "no entry for this
|
|
77
|
+
* code" and "no locale declared" both render the English and are
|
|
78
|
+
* indistinguishable in the output. At `debug` the line is below the default
|
|
79
|
+
* threshold and therefore absent from exactly the log someone would be
|
|
80
|
+
* reading.
|
|
81
|
+
*/
|
|
82
|
+
accept(locale: string): void {
|
|
83
|
+
this.current = locale;
|
|
84
|
+
this.tracer.info(`rendering messages in locale '${locale}'`);
|
|
85
|
+
}
|
|
86
|
+
}
|
|
@@ -257,7 +257,7 @@ export class HydraniumDocumentUpdateHandler extends DefaultDocumentUpdateHandler
|
|
|
257
257
|
}
|
|
258
258
|
const uri = UriUtils.toUri(change.uri);
|
|
259
259
|
const mtimeMs = await this.fileSystemProvider.mtimeMs?.(uri);
|
|
260
|
-
if (mtimeMs !== undefined && this.selfSaveRegistry.
|
|
260
|
+
if (mtimeMs !== undefined && this.selfSaveRegistry.isRegistered(uri.fsPath, mtimeMs)) {
|
|
261
261
|
return undefined;
|
|
262
262
|
}
|
|
263
263
|
return change;
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
/********************************************************************************
|
|
2
|
+
* Copyright (c) 2026 CrossBreeze, EclipseSource and others.
|
|
3
|
+
*
|
|
4
|
+
* This program and the accompanying materials are made available under the
|
|
5
|
+
* terms of the MIT License which is available in the project root.
|
|
6
|
+
*
|
|
7
|
+
* SPDX-License-Identifier: MIT
|
|
8
|
+
********************************************************************************/
|
|
9
|
+
|
|
10
|
+
import {
|
|
11
|
+
hasMessageIdentity,
|
|
12
|
+
messageData,
|
|
13
|
+
type HydraniumMessageData,
|
|
14
|
+
type MessageDefinition,
|
|
15
|
+
type ParamsArg,
|
|
16
|
+
type ResolvedMessage
|
|
17
|
+
} from '@hydranium/protocol';
|
|
18
|
+
import type { AstNode, DiagnosticData, DiagnosticInfo, Properties, ValidationAcceptor } from '@hydranium/langium';
|
|
19
|
+
import { Diagnostic } from 'vscode-languageserver-protocol';
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* Raise a validation diagnostic from a declaration, so the call site never
|
|
23
|
+
* restates the code or the sentence.
|
|
24
|
+
*
|
|
25
|
+
* `code` is omitted from `info` because this owns it — the framework claims LSP
|
|
26
|
+
* `Diagnostic.code` for framework codes, which collides with no adopter today
|
|
27
|
+
* and is a stated rule rather than an accident. `data` is deliberately NOT
|
|
28
|
+
* omitted: Langium owns `data.code` for code-action dispatch, so a caller has to
|
|
29
|
+
* be able to request a quick fix. The identity is merged OVER whatever they
|
|
30
|
+
* pass, which makes the two conventions co-exist rather than compete.
|
|
31
|
+
*
|
|
32
|
+
* `data` admits adopter-owned keys beside Langium's, which is why the index
|
|
33
|
+
* signature is there rather than a bare `Partial<DiagnosticData>`. Langium's
|
|
34
|
+
* shape is closed, and a diagnostic that carries a COMPANION payload for its own
|
|
35
|
+
* surface to read — the field a form must highlight, say — has nowhere else to
|
|
36
|
+
* put it: an encoder projecting that payload reads `diagnostic.data`, so the
|
|
37
|
+
* narrower type made the identity and the companion mutually exclusive.
|
|
38
|
+
*
|
|
39
|
+
* The identity lands in both `code` and `data.hydranium` on purpose. `code` is
|
|
40
|
+
* what survives to the editor surface; Theia's converter drops `data` before the
|
|
41
|
+
* squiggle, so a parameterised diagnostic falls back to the server's English
|
|
42
|
+
* there while any adopter-owned surface can still render the parameterised form
|
|
43
|
+
* from the marker store.
|
|
44
|
+
*
|
|
45
|
+
* `DiagnosticInfo` must be Langium's own type: a `Parameters<ValidationAcceptor>[2]`
|
|
46
|
+
* shortcut compiles but loses the `property?: Properties<N>` relation. The `data`
|
|
47
|
+
* re-type has to be an intersection rather than an `Omit` alone, because Langium
|
|
48
|
+
* declares `data?: unknown` and an `unknown` cannot be spread.
|
|
49
|
+
*/
|
|
50
|
+
export function acceptMessage<S extends string, N extends AstNode, P extends Properties<N> = Properties<N>>(
|
|
51
|
+
accept: ValidationAcceptor,
|
|
52
|
+
severity: 'error' | 'warning' | 'info' | 'hint',
|
|
53
|
+
message: MessageDefinition<S>,
|
|
54
|
+
info: Omit<DiagnosticInfo<N, P>, 'code' | 'data'> & { data?: Partial<DiagnosticData> & Record<string, unknown> },
|
|
55
|
+
...params: ParamsArg<S>
|
|
56
|
+
): void {
|
|
57
|
+
const data: HydraniumMessageData & Partial<DiagnosticData> & Record<string, unknown> = {
|
|
58
|
+
...info.data,
|
|
59
|
+
...messageData(message, ...params)
|
|
60
|
+
};
|
|
61
|
+
accept(severity, message.format(...params), { ...info, code: message.code, data });
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
/**
|
|
65
|
+
* Recover the identity from a published diagnostic, for a surface that
|
|
66
|
+
* identifies or renders diagnostics itself.
|
|
67
|
+
*
|
|
68
|
+
* `Diagnostic.message` is `string | MarkupContent` in LSP 3.17+, so the text
|
|
69
|
+
* comes from upstream's own `Diagnostic.getMessageString` rather than a
|
|
70
|
+
* hand-rolled narrowing — consuming the library in its style, and one fewer
|
|
71
|
+
* place restating the union.
|
|
72
|
+
*/
|
|
73
|
+
export function resolvedFromDiagnostic(diagnostic: Diagnostic): ResolvedMessage | undefined {
|
|
74
|
+
if (!hasMessageIdentity(diagnostic.data)) {
|
|
75
|
+
return undefined;
|
|
76
|
+
}
|
|
77
|
+
return { ...diagnostic.data.hydranium, text: Diagnostic.getMessageString(diagnostic) };
|
|
78
|
+
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/********************************************************************************
|
|
2
|
+
* Copyright (c) 2026 CrossBreeze, EclipseSource and others.
|
|
3
|
+
*
|
|
4
|
+
* This program and the accompanying materials are made available under the
|
|
5
|
+
* terms of the MIT License which is available in the project root.
|
|
6
|
+
*
|
|
7
|
+
* SPDX-License-Identifier: MIT
|
|
8
|
+
********************************************************************************/
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Every user-facing message `@hydranium/core` raises, plus the carrier helpers
|
|
12
|
+
* that attach an identity to one.
|
|
13
|
+
*
|
|
14
|
+
* Declarations stay beside their call sites and are re-exported here, so this is
|
|
15
|
+
* enumeration rather than centralization: a code's package segment has to name
|
|
16
|
+
* the package that raises it. The English is a fallback, not a contract; the
|
|
17
|
+
* code is the contract, and renaming one is a breaking change.
|
|
18
|
+
*/
|
|
19
|
+
|
|
20
|
+
export * from './carriers.js';
|
|
21
|
+
export * from './renderer.js';
|
|
22
|
+
|
|
23
|
+
export { MODEL_UPDATE_EDIT } from '../langium/model-service/model-service.js';
|
|
24
|
+
export { SEPARATOR_IN_NAME } from '../langium/naming/name-separator-validation.js';
|
|
25
|
+
export { LEXING_ERROR, UNRESOLVED_REFERENCE } from '../langium/validation/document-validator.js';
|
|
26
|
+
export { NO_LOADABLE_CONTENT } from '../langium/workspace/langium-documents.js';
|
|
27
|
+
export { NO_SUCH_FILE, NO_SUCH_PATH } from '../langium/workspace/in-memory-file-system-provider.js';
|