@smthrs/std 0.0.0-stage → 1.0.0-rc.12

package/dist/cjs/NodeLanguageServer.d.ts

@@ -0,0 +1,128 @@
+/**
+ * Host-backed Language Server Protocol client over the permission-checked
+ * process spawner.
+ *
+ * LSP is framed JSON-RPC over ordinary stdio pipes, so the client spawns
+ * through `@smthrs/kernel`'s `ChildProcessSpawner`; a terminal is never
+ * involved.
+ *
+ * @since 1.0.0
+ */
+import * as ChildProcessSpawner from "@smthrs/kernel/ChildProcessSpawner";
+import { Effect, Layer, type Scope } from "effect";
+import * as LanguageServer from "./LanguageServer.ts";
+import * as StdError from "./StdError.ts";
+/**
+ * Maximum frames buffered for a language server's standard input.
+ *
+ * Bounded offers apply backpressure, and each offer uses the request timeout
+ * so a server that stops reading produces a typed timeout instead of an
+ * unbounded queue or a new hang.
+ *
+ * @category constants
+ * @since 1.0.0
+ */
+export declare const MAX_QUEUED_FRAMES = 256;
+/**
+ * Maximum concurrent JSON-RPC requests awaiting a response.
+ *
+ * Every entry already has a timeout, and process exit or stdout closure fails
+ * all entries. This cap is the last-resort bound for a host that fans out
+ * requests without limit.
+ *
+ * @category constants
+ * @since 1.0.0
+ */
+export declare const MAX_PENDING_REQUESTS = 512;
+/**
+ * One host language-server process.
+ *
+ * Response headers may contain at most 8 KiB, and response bodies may contain
+ * at most 8 MiB.
+ *
+ * @category models
+ * @since 1.0.0
+ */
+export interface Config {
+    /**
+     * The file extensions this server answers for, such as `[".ts", ".tsx"]`.
+     * A server without `extensions` answers every file no other server claims.
+     */
+    readonly extensions?: ReadonlyArray<string> | undefined;
+    readonly command: string;
+    readonly args?: ReadonlyArray<string> | undefined;
+    readonly cwd: string;
+    readonly environment?: Readonly<Record<string, string>> | undefined;
+    /**
+     * Sent as `initializationOptions` on `initialize`. A host pins where the
+     * server loads its own code from here, for example
+     * `{ tsserver: { path: "<host copy>/tsserver.js" } }` for
+     * typescript-language-server, which otherwise runs the workspace's own
+     * `node_modules/typescript`.
+     */
+    readonly initializationOptions?: unknown;
+    readonly timeoutMs?: number | undefined;
+    /**
+     * How long `diagnostics` waits for a server without pull diagnostics to
+     * publish for the latest synced text, then fails with `timeout`. Defaults to
+     * 5 seconds. typescript-language-server publishes nothing for a change that
+     * leaves a file with no problems, so such a change always waits this long.
+     */
+    readonly settleMs?: number | undefined;
+    /**
+     * After a publish, how long `diagnostics` waits for a later one before
+     * answering, within `settleMs`. A server may publish syntax errors before
+     * semantic ones: typescript-language-server does on the first open of a
+     * file. Defaults to 300 milliseconds.
+     */
+    readonly quietMs?: number | undefined;
+}
+/**
+ * Constructs scoped host language-server clients, one process per config, and
+ * routes each file to the server whose `extensions` include its extension, or
+ * else to the server that declares none. `workspaceSymbols` asks every server
+ * and concatenates their answers.
+ *
+ * Every client opens a file on its first `sync` and sends the full text on
+ * each later one. `diagnostics` pulls `textDocument/diagnostic`; a server that
+ * answers `MethodNotFound` is read from its `textDocument/publishDiagnostics`
+ * notifications instead, waiting up to `settleMs` for the latest synced text.
+ *
+ * Fails with `permission_denied`, before spawning, when the resolved program or
+ * a file or directory named by an argument lies under `config.cwd`, or when the command is a
+ * launcher (a shell, `env`, a package runner such as `npx` or `pnpm`, or `node`
+ * and `bun` given inline code or a preload) whose arguments choose what runs.
+ *
+ * @category constructors
+ * @since 1.0.0
+ */
+export declare const make: (config: Config | ReadonlyArray<Config>) => Effect.Effect<LanguageServer.LanguageServer, StdError.StdError, ChildProcessSpawner.ChildProcessSpawner | Scope.Scope>;
+/**
+ * {@link make}, starting each server when the first request for one of its
+ * files arrives rather than up front, so a host can bind servers it may never
+ * need. A server starts with the services and authority of the fiber that
+ * built this service, not those of the request that first needs it. A server
+ * that fails to start fails that request and every later one for its files.
+ * `refresh` and `close` never start a server.
+ *
+ * The workspace-program refusals of {@link make} still apply up front.
+ *
+ * @category constructors
+ * @since 1.0.0
+ */
+export declare const makeLazy: (config: Config | ReadonlyArray<Config>) => Effect.Effect<LanguageServer.LanguageServer, StdError.StdError, ChildProcessSpawner.ChildProcessSpawner | Scope.Scope>;
+/**
+ * Provides a scoped host language-server implementation.
+ *
+ * @category layers
+ * @since 1.0.0
+ */
+export declare const layer: (config: Config | ReadonlyArray<Config>) => Layer.Layer<LanguageServer.LanguageServer, StdError.StdError, ChildProcessSpawner.ChildProcessSpawner>;
+/**
+ * Provides {@link makeLazy}.
+ *
+ * @category layers
+ * @since 1.0.0
+ */
+export declare const layerLazy: (config: Config | ReadonlyArray<Config>) => Layer.Layer<LanguageServer.LanguageServer, StdError.StdError, ChildProcessSpawner.ChildProcessSpawner>;
+//# sourceMappingURL=NodeLanguageServer.d.ts.map

package/dist/cjs/NodeLanguageServer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NodeLanguageServer.d.ts","sourceRoot":"","sources":["../../src/NodeLanguageServer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,OAAO,KAAK,mBAAmB,MAAM,oCAAoC,CAAA;AACzE,OAAO,EAAmB,MAAM,EAAS,KAAK,EAAiB,KAAK,KAAK,EAAqB,MAAM,QAAQ,CAAA;AAM5G,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AACrD,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AAEzC;;;;;;;;;GASG;AACH,eAAO,MAAM,iBAAiB,MAAM,CAAA;AAEpC;;;;;;;;;GASG;AACH,eAAO,MAAM,oBAAoB,MAAM,CAAA;AAavC;;;;;;;;GAQG;AACH,MAAM,WAAW,MAAM;IACrB;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;IACvD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;IACjD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,WAAW,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,SAAS,CAAA;IACnE;;;;;;OAMG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAA;IACxC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACvC;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACtC;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACtC;AAs7BD;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,IAAI,GACf,QAAQ,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,KACrC,MAAM,CAAC,MAAM,CACd,cAAc,CAAC,cAAc,EAC7B,QAAQ,CAAC,QAAQ,EACjB,mBAAmB,CAAC,mBAAmB,GAAG,KAAK,CAAC,KAAK,CAMnD,CAAA;AAEJ;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,QAAQ,GACnB,QAAQ,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,KACrC,MAAM,CAAC,MAAM,CACd,cAAc,CAAC,cAAc,EAC7B,QAAQ,CAAC,QAAQ,EACjB,mBAAmB,CAAC,mBAAmB,GAAG,KAAK,CAAC,KAAK,CA0BnD,CAAA;AAEJ;;;;;GAKG;AACH,eAAO,MAAM,KAAK,GAChB,QAAQ,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,KACrC,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,cAAc,EAAE,QAAQ,CAAC,QAAQ,EAAE,mBAAmB,CAAC,mBAAmB,CAC7C,CAAA;AAE3D;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GACpB,QAAQ,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,KACrC,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,cAAc,EAAE,QAAQ,CAAC,QAAQ,EAAE,mBAAmB,CAAC,mBAAmB,CACzC,CAAA"}