@difizen/libro-language-client 0.1.18

package/es/common/diagnostic.d.ts

@@ -0,0 +1,125 @@
+import type { ClientCapabilities, ServerCapabilities, DocumentSelector, DiagnosticRegistrationOptions, DiagnosticOptions } from '@difizen/vscode-languageserver-protocol';
+import type { CancellationToken, ProviderResult, Diagnostic as VDiagnostic, TextDocument, Event as VEvent } from 'vscode';
+import type { FeatureClient } from './features.js';
+import { TextDocumentLanguageFeature } from './features.js';
+import { EventEmitter, Uri, Disposable } from './vscodeAdaptor/vscodeAdaptor.js';
+export declare namespace vsdiag {
+    enum DocumentDiagnosticReportKind {
+        full = "full",
+        unChanged = "unChanged"
+    }
+    interface FullDocumentDiagnosticReport {
+        kind: DocumentDiagnosticReportKind.full;
+        resultId?: string;
+        items: VDiagnostic[];
+    }
+    interface RelatedFullDocumentDiagnosticReport extends FullDocumentDiagnosticReport {
+        relatedDocuments?: {
+            [uri: string /** DocumentUri */]: FullDocumentDiagnosticReport | UnchangedDocumentDiagnosticReport;
+        };
+    }
+    interface UnchangedDocumentDiagnosticReport {
+        kind: DocumentDiagnosticReportKind.unChanged;
+        resultId: string;
+    }
+    interface RelatedUnchangedDocumentDiagnosticReport extends UnchangedDocumentDiagnosticReport {
+        relatedDocuments?: {
+            [uri: string /** DocumentUri */]: FullDocumentDiagnosticReport | UnchangedDocumentDiagnosticReport;
+        };
+    }
+    type DocumentDiagnosticReport = RelatedFullDocumentDiagnosticReport | RelatedUnchangedDocumentDiagnosticReport;
+    type PreviousResultId = {
+        uri: Uri;
+        value: string;
+    };
+    interface WorkspaceFullDocumentDiagnosticReport extends FullDocumentDiagnosticReport {
+        uri: Uri;
+        version: number | null;
+    }
+    interface WorkspaceUnchangedDocumentDiagnosticReport extends UnchangedDocumentDiagnosticReport {
+        uri: Uri;
+        version: number | null;
+    }
+    type WorkspaceDocumentDiagnosticReport = WorkspaceFullDocumentDiagnosticReport | WorkspaceUnchangedDocumentDiagnosticReport;
+    interface WorkspaceDiagnosticReport {
+        items: WorkspaceDocumentDiagnosticReport[];
+    }
+    interface WorkspaceDiagnosticReportPartialResult {
+        items: WorkspaceDocumentDiagnosticReport[];
+    }
+    interface ResultReporter {
+        (chunk: WorkspaceDiagnosticReportPartialResult | null): void;
+    }
+    interface DiagnosticProvider {
+        onDidChangeDiagnostics: VEvent<void>;
+        provideDiagnostics(document: TextDocument | Uri, previousResultId: string | undefined, token: CancellationToken): ProviderResult<DocumentDiagnosticReport>;
+        provideWorkspaceDiagnostics?(resultIds: PreviousResultId[], token: CancellationToken, resultReporter: ResultReporter): ProviderResult<WorkspaceDiagnosticReport>;
+    }
+}
+export type ProvideDiagnosticSignature = (this: void, document: TextDocument | Uri, previousResultId: string | undefined, token: CancellationToken) => ProviderResult<vsdiag.DocumentDiagnosticReport>;
+export type ProvideWorkspaceDiagnosticSignature = (this: void, resultIds: vsdiag.PreviousResultId[], token: CancellationToken, resultReporter: vsdiag.ResultReporter) => ProviderResult<vsdiag.WorkspaceDiagnosticReport>;
+export type DiagnosticProviderMiddleware = {
+    provideDiagnostics?: (this: void, document: TextDocument | Uri, previousResultId: string | undefined, token: CancellationToken, next: ProvideDiagnosticSignature) => ProviderResult<vsdiag.DocumentDiagnosticReport>;
+    provideWorkspaceDiagnostics?: (this: void, resultIds: vsdiag.PreviousResultId[], token: CancellationToken, resultReporter: vsdiag.ResultReporter, next: ProvideWorkspaceDiagnosticSignature) => ProviderResult<vsdiag.WorkspaceDiagnosticReport>;
+};
+export declare enum DiagnosticPullMode {
+    onType = "onType",
+    onSave = "onSave"
+}
+export type DiagnosticPullOptions = {
+    /**
+     * Whether to pull for diagnostics on document change.
+     */
+    onChange?: boolean;
+    /**
+     * Whether to pull for diagnostics on document save.
+     */
+    onSave?: boolean;
+    /**
+     * An optional filter method that is consulted when triggering a
+     * diagnostic pull during document change or document save.
+     *
+     * The document gets filtered if the method returns `true`.
+     *
+     * @param document The document that changed or got saved.
+     * @param mode The pull mode.
+     * @returns whether the document should be filtered (`true`) or not.
+     */
+    filter?(document: TextDocument, mode: DiagnosticPullMode): boolean;
+    /**
+     * Whether to pull for diagnostics on resources of non instantiated
+     * tabs. If it is set to true it is highly recommended to provide
+     * a match method as well. Otherwise the client will not pull for
+     * tabs if the used document selector specifies a language property
+     * since the language value is not known for resources.
+     */
+    onTabs?: boolean;
+    /**
+     * An optional match method that is consulted when pulling for diagnostics
+     * when only a URI is known (e.g. for not instantiated tabs)
+     *
+     * The method should return `true` if the document selector matches the
+     * given resource. See also the `vscode.languages.match` function.
+     *
+     * @param documentSelector The document selector.
+     * @param resource The resource.
+     * @returns whether the resource is matched by the given document selector.
+     */
+    match?(documentSelector: DocumentSelector, resource: Uri): boolean;
+};
+export type $DiagnosticPullOptions = {
+    diagnosticPullOptions?: DiagnosticPullOptions;
+};
+export type DiagnosticProviderShape = {
+    onDidChangeDiagnosticsEmitter: EventEmitter<void>;
+    diagnostics: vsdiag.DiagnosticProvider;
+};
+export declare class DiagnosticFeature extends TextDocumentLanguageFeature<DiagnosticOptions, DiagnosticRegistrationOptions, DiagnosticProviderShape, DiagnosticProviderMiddleware, $DiagnosticPullOptions> {
+    private tabs;
+    constructor(client: FeatureClient<DiagnosticProviderMiddleware, $DiagnosticPullOptions>);
+    fillClientCapabilities(capabilities: ClientCapabilities): void;
+    initialize(capabilities: ServerCapabilities, documentSelector: DocumentSelector): void;
+    clear(): void;
+    protected registerLanguageProvider(options: DiagnosticRegistrationOptions): [Disposable, DiagnosticProviderShape];
+}
+//# sourceMappingURL=diagnostic.d.ts.map

package/es/common/diagnostic.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"diagnostic.d.ts","sourceRoot":"","sources":["../../src/common/diagnostic.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EAEhB,6BAA6B,EAI7B,iBAAiB,EAClB,MAAM,yCAAyC,CAAC;AAiBjD,OAAO,KAAK,EACV,iBAAiB,EACjB,cAAc,EACd,UAAU,IAAI,WAAW,EACzB,YAAY,EACZ,KAAK,IAAI,MAAM,EAIhB,MAAM,QAAQ,CAAC;AAEhB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,2BAA2B,EAAwB,MAAM,eAAe,CAAC;AAElF,OAAO,EAML,YAAY,EACZ,GAAG,EAKH,UAAU,EACX,MAAM,kCAAkC,CAAC;AAS1C,yBAAiB,MAAM,CAAC;IACtB,KAAY,4BAA4B;QACtC,IAAI,SAAS;QACb,SAAS,cAAc;KACxB;IAED,UAAiB,4BAA4B;QAC3C,IAAI,EAAE,4BAA4B,CAAC,IAAI,CAAC;QACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,KAAK,EAAE,WAAW,EAAE,CAAC;KACtB;IAED,UAAiB,mCACf,SAAQ,4BAA4B;QACpC,gBAAgB,CAAC,EAAE;YACjB,CAAC,GAAG,EAAE,MAAM,CAAC,kBAAkB,GAC3B,4BAA4B,GAC5B,iCAAiC,CAAC;SACvC,CAAC;KACH;IAED,UAAiB,iCAAiC;QAChD,IAAI,EAAE,4BAA4B,CAAC,SAAS,CAAC;QAC7C,QAAQ,EAAE,MAAM,CAAC;KAClB;IAED,UAAiB,wCACf,SAAQ,iCAAiC;QACzC,gBAAgB,CAAC,EAAE;YACjB,CAAC,GAAG,EAAE,MAAM,CAAC,kBAAkB,GAC3B,4BAA4B,GAC5B,iCAAiC,CAAC;SACvC,CAAC;KACH;IACD,KAAY,wBAAwB,GAChC,mCAAmC,GACnC,wCAAwC,CAAC;IAE7C,KAAY,gBAAgB,GAAG;QAC7B,GAAG,EAAE,GAAG,CAAC;QACT,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;IAEF,UAAiB,qCACf,SAAQ,4BAA4B;QACpC,GAAG,EAAE,GAAG,CAAC;QACT,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB;IAED,UAAiB,0CACf,SAAQ,iCAAiC;QACzC,GAAG,EAAE,GAAG,CAAC;QACT,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB;IAED,KAAY,iCAAiC,GACzC,qCAAqC,GACrC,0CAA0C,CAAC;IAE/C,UAAiB,yBAAyB;QACxC,KAAK,EAAE,iCAAiC,EAAE,CAAC;KAC5C;IAED,UAAiB,sCAAsC;QACrD,KAAK,EAAE,iCAAiC,EAAE,CAAC;KAC5C;IAED,UAAiB,cAAc;QAC7B,CAAC,KAAK,EAAE,sCAAsC,GAAG,IAAI,GAAG,IAAI,CAAC;KAC9D;IAED,UAAiB,kBAAkB;QACjC,sBAAsB,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QACrC,kBAAkB,CAChB,QAAQ,EAAE,YAAY,GAAG,GAAG,EAC5B,gBAAgB,EAAE,MAAM,GAAG,SAAS,EACpC,KAAK,EAAE,iBAAiB,GACvB,cAAc,CAAC,wBAAwB,CAAC,CAAC;QAC5C,2BAA2B,CAAC,CAC1B,SAAS,EAAE,gBAAgB,EAAE,EAC7B,KAAK,EAAE,iBAAiB,EACxB,cAAc,EAAE,cAAc,GAC7B,cAAc,CAAC,yBAAyB,CAAC,CAAC;KAC9C;CACF;AAED,MAAM,MAAM,0BAA0B,GAAG,CACvC,IAAI,EAAE,IAAI,EACV,QAAQ,EAAE,YAAY,GAAG,GAAG,EAC5B,gBAAgB,EAAE,MAAM,GAAG,SAAS,EACpC,KAAK,EAAE,iBAAiB,KACrB,cAAc,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAAC;AAErD,MAAM,MAAM,mCAAmC,GAAG,CAChD,IAAI,EAAE,IAAI,EACV,SAAS,EAAE,MAAM,CAAC,gBAAgB,EAAE,EACpC,KAAK,EAAE,iBAAiB,EACxB,cAAc,EAAE,MAAM,CAAC,cAAc,KAClC,cAAc,CAAC,MAAM,CAAC,yBAAyB,CAAC,CAAC;AAEtD,MAAM,MAAM,4BAA4B,GAAG;IACzC,kBAAkB,CAAC,EAAE,CACnB,IAAI,EAAE,IAAI,EACV,QAAQ,EAAE,YAAY,GAAG,GAAG,EAC5B,gBAAgB,EAAE,MAAM,GAAG,SAAS,EACpC,KAAK,EAAE,iBAAiB,EACxB,IAAI,EAAE,0BAA0B,KAC7B,cAAc,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAAC;IACrD,2BAA2B,CAAC,EAAE,CAC5B,IAAI,EAAE,IAAI,EACV,SAAS,EAAE,MAAM,CAAC,gBAAgB,EAAE,EACpC,KAAK,EAAE,iBAAiB,EACxB,cAAc,EAAE,MAAM,CAAC,cAAc,EACrC,IAAI,EAAE,mCAAmC,KACtC,cAAc,CAAC,MAAM,CAAC,yBAAyB,CAAC,CAAC;CACvD,CAAC;AAEF,oBAAY,kBAAkB;IAC5B,MAAM,WAAW;IACjB,MAAM,WAAW;CAClB;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;;;;;;;;OASG;IACH,MAAM,CAAC,CAAC,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC;IAEnE;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;;;;;;;;;OAUG;IACH,KAAK,CAAC,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,QAAQ,EAAE,GAAG,GAAG,OAAO,CAAC;CACpE,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;CAC/C,CAAC;AAuuBF,MAAM,MAAM,uBAAuB,GAAG;IACpC,6BAA6B,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC;IAClD,WAAW,EAAE,MAAM,CAAC,kBAAkB,CAAC;CACxC,CAAC;AAkWF,qBAAa,iBAAkB,SAAQ,2BAA2B,CAChE,iBAAiB,EACjB,6BAA6B,EAC7B,uBAAuB,EACvB,4BAA4B,EAC5B,sBAAsB,CACvB;IACC,OAAO,CAAC,IAAI,CAAmB;gBAG7B,MAAM,EAAE,aAAa,CAAC,4BAA4B,EAAE,sBAAsB,CAAC;IAKtE,sBAAsB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAW9D,UAAU,CACf,YAAY,EAAE,kBAAkB,EAChC,gBAAgB,EAAE,gBAAgB,GACjC,IAAI;IAiBS,KAAK,IAAI,IAAI;IAQ7B,SAAS,CAAC,wBAAwB,CAChC,OAAO,EAAE,6BAA6B,GACrC,CAAC,UAAU,EAAE,uBAAuB,CAAC;CAWzC"}