cspell-lib 9.6.2 → 9.6.3

package/dist/cspell-rpc/client.d.ts

@@ -1,7 +1,7 @@
-import type { RPCClientConfiguration, RPCClientOptions, RPCProtocol } from '../rpc/index.js';
-import { RPCClient } from '../rpc/index.js';
+import type { RPCClientConfiguration, RPCClientOptions, RPCProtocol } from '@cspell/rpc';
+import { RPCClient } from '@cspell/rpc';
 import type { CSpellRPCApi } from './api.js';
-export type { MessagePortLike } from '../rpc/index.js';
+export type { MessagePortLike } from '@cspell/rpc';
 export type CSpellRPCClientOptions = RPCClientOptions;
 export type CSpellRPCClientConfig = RPCClientConfiguration;
 export declare class CSpellRPCClient extends RPCClient<CSpellRPCApi> {

package/dist/cspell-rpc/client.js

@@ -1,5 +1,5 @@
 import { randomUUID } from 'node:crypto';
-import { RPCClient } from '../rpc/index.js';
+import { RPCClient } from '@cspell/rpc';
 import { CSPELL_RPC_API_ENDPOINTS } from './api.js';
 export class CSpellRPCClient extends RPCClient {
     constructor(config) {

package/dist/cspell-rpc/server.d.ts

@@ -1,7 +1,7 @@
-import type { RPCServerConfiguration, RPCServerOptions } from '../rpc/index.js';
-import { RPCServer } from '../rpc/index.js';
+import type { RPCServerConfiguration, RPCServerOptions } from '@cspell/rpc';
+import { RPCServer } from '@cspell/rpc';
 import type { CSpellRPCApi } from './api.js';
-export type { MessagePortLike } from '../rpc/index.js';
+export type { MessagePortLike } from '@cspell/rpc';
 export type CSpellRPCServerOptions = RPCServerOptions;
 export type CSpellRPCServerConfig = RPCServerConfiguration;
 export declare class CSpellRPCServer extends RPCServer<CSpellRPCApi> {

package/dist/cspell-rpc/server.js

@@ -1,4 +1,4 @@
-import { RPCServer } from '../rpc/index.js';
+import { RPCServer } from '@cspell/rpc';
 import { spellCheckDocumentRPC } from './spellCheckFile.js';
 export class CSpellRPCServer extends RPCServer {
     constructor(config) {

package/dist/lib/Settings/sanitizeSettings.js

@@ -28,6 +28,7 @@ const handlers = {
     enableFiletypes: copy1,
     enabledFileTypes: copy1,
     enableGlobDot: copy1,
+    engines: copy1,
     failFast: copy1,
     features: skip,
     files: copyGlobsSettingsFields,
@@ -68,6 +69,7 @@ const handlers = {
     usePnP: skip,
     userWords: copy1,
     validateDirectives: copy1,
+    vfs: skip,
     words: copy1,
     // Experimental
     parser: skip,

package/dist/rpc.d.ts

@@ -1,2 +1,2 @@
-export * from './rpc/index.js';
+export * from '@cspell/rpc';
 //# sourceMappingURL=rpc.d.ts.map

package/dist/rpc.js

@@ -1,2 +1,2 @@
-export * from './rpc/index.js';
+export * from '@cspell/rpc';
 //# sourceMappingURL=rpc.js.map

package/package.json

@@ -4,7 +4,7 @@
     "access": "public",
     "provenance": true
   },
-  "version": "9.6.2",
+  "version": "9.6.3",
   "description": "A library of useful functions used across various cspell tools.",
   "type": "module",
   "sideEffects": false,
@@ -15,7 +15,7 @@
       "import": "./dist/index.js"
     },
     "./rpc": {
-      "import": "./dist/rpc/index.js"
+      "import": "./dist/rpc.js"
     },
     "./cspell-rpc": {
       "import": "./dist/cspell-rpc/index.js"
@@ -76,23 +76,24 @@
   },
   "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-lib#readme",
   "dependencies": {
-    "@cspell/cspell-bundled-dicts": "9.6.2",
-    "@cspell/cspell-performance-monitor": "9.6.2",
-    "@cspell/cspell-pipe": "9.6.2",
-    "@cspell/cspell-resolver": "9.6.2",
-    "@cspell/cspell-types": "9.6.2",
-    "@cspell/dynamic-import": "9.6.2",
-    "@cspell/filetypes": "9.6.2",
-    "@cspell/strong-weak-map": "9.6.2",
-    "@cspell/url": "9.6.2",
+    "@cspell/cspell-bundled-dicts": "9.6.3",
+    "@cspell/cspell-performance-monitor": "9.6.3",
+    "@cspell/cspell-pipe": "9.6.3",
+    "@cspell/cspell-resolver": "9.6.3",
+    "@cspell/cspell-types": "9.6.3",
+    "@cspell/dynamic-import": "9.6.3",
+    "@cspell/filetypes": "9.6.3",
+    "@cspell/rpc": "9.6.3",
+    "@cspell/strong-weak-map": "9.6.3",
+    "@cspell/url": "9.6.3",
     "clear-module": "^4.1.2",
-    "cspell-config-lib": "9.6.2",
-    "cspell-dictionary": "9.6.2",
-    "cspell-glob": "9.6.2",
-    "cspell-grammar": "9.6.2",
-    "cspell-io": "9.6.2",
-    "cspell-trie-lib": "9.6.2",
-    "env-paths": "^3.0.0",
+    "cspell-config-lib": "9.6.3",
+    "cspell-dictionary": "9.6.3",
+    "cspell-glob": "9.6.3",
+    "cspell-grammar": "9.6.3",
+    "cspell-io": "9.6.3",
+    "cspell-trie-lib": "9.6.3",
+    "env-paths": "^4.0.0",
     "gensequence": "^8.0.8",
     "import-fresh": "^3.3.1",
     "resolve-from": "^5.0.0",
@@ -104,11 +105,11 @@
     "node": ">=20"
   },
   "devDependencies": {
-    "@cspell/cspell-tools": "9.6.2",
+    "@cspell/cspell-tools": "9.6.3",
     "@cspell/dict-cpp": "^7.0.2",
     "@cspell/dict-csharp": "^4.0.8",
     "@cspell/dict-css": "^4.0.19",
-    "@cspell/dict-en_us": "^4.4.27",
+    "@cspell/dict-en_us": "^4.4.28",
     "@cspell/dict-fa-ir": "^4.0.5",
     "@cspell/dict-fr-fr": "^2.3.2",
     "@cspell/dict-html": "^4.0.14",
@@ -122,5 +123,5 @@
     "lorem-ipsum": "^2.0.8",
     "perf-insight": "^2.0.1"
   },
-  "gitHead": "646e18a04ff36d43f78a74e5055540e0f5297e91"
+  "gitHead": "500b996b6c0a6ff025c42ef98db44776f43a9e72"
 }

package/dist/rpc/Future.d.ts

@@ -1,18 +0,0 @@
-export declare class Future<T> {
-    #private;
-    constructor();
-    /**
-     * Indicates if the promise has been resolved or rejected.
-     *
-     * Use isRejected to determine if it was rejected.
-     */
-    get isResolved(): boolean;
-    /**
-     * Indicates if the promise has been rejected.
-     */
-    get isRejected(): boolean;
-    get promise(): Promise<T>;
-    resolve(value: T): void;
-    reject(reason?: unknown): void;
-}
-//# sourceMappingURL=Future.d.ts.map

package/dist/rpc/Future.js

@@ -1,49 +0,0 @@
-export class Future {
-    #isResolved = false;
-    #isRejected = false;
-    #promise;
-    #resolve;
-    #reject;
-    constructor() {
-        this.#reject = noop;
-        this.#resolve = noop;
-        this.#promise = new Promise((resolve, reject) => {
-            this.#resolve = resolve;
-            this.#reject = reject;
-        });
-    }
-    /**
-     * Indicates if the promise has been resolved or rejected.
-     *
-     * Use isRejected to determine if it was rejected.
-     */
-    get isResolved() {
-        return this.#isResolved;
-    }
-    /**
-     * Indicates if the promise has been rejected.
-     */
-    get isRejected() {
-        return this.#isRejected;
-    }
-    get promise() {
-        return this.#promise;
-    }
-    resolve(value) {
-        if (this.#isResolved)
-            return;
-        this.#isResolved = true;
-        this.#resolve(value);
-    }
-    reject(reason) {
-        if (this.#isResolved)
-            return;
-        this.#isResolved = true;
-        this.#isRejected = true;
-        this.#reject(reason);
-    }
-}
-function noop() {
-    // do nothing
-}
-//# sourceMappingURL=Future.js.map

package/dist/rpc/MessagePortEvents.d.ts

@@ -1,56 +0,0 @@
-import type { MessagePortLike } from './messagePort.js';
-import type { NotifyEvent } from './notify.js';
-/**
- * Wraps a {@link MessagePortLike} and exposes its key events through a
- * {@link NotifyEmitter}-based interface.
- *
- * This class listens to the underlying port's `message`,
- * `messageerror`, and `close` events and re-emits them as
- * {@link NotifyEvent} instances, making it easier to subscribe to and manage
- * notifications from a message port.
- */
-export declare class MessagePortNotifyEvents<T extends MessagePortLike = MessagePortLike> {
-    #private;
-    constructor(port: T);
-    [Symbol.dispose](): void;
-    /**
-     * Register a handler to be called when a message is received.
-     */
-    get onMessage(): NotifyEvent<unknown>;
-    /**
-     * Return a Promise that resolves on the next message.
-     * @param signal - A signal to abort the wait.
-     * @returns A Promise that resolves with the next message received.
-     */
-    readonly awaitNextMessage: (signal?: AbortSignal) => Promise<unknown>;
-    /**
-     * Return a Promise that resolves on the close event.
-     * @param signal - A signal to abort the wait.
-     * @returns A Promise that resolves when the port is closed.
-     */
-    readonly awaitClose: (signal?: AbortSignal) => Promise<Event>;
-    /**
-     * Post a message to the underlying port.
-     * @param message - The message to post.
-     */
-    readonly postMessage: T['postMessage'];
-    /**
-     * Start the underlying port.
-     */
-    start(): void;
-    /**
-     * Close the underlying port.
-     */
-    close(): void;
-    /**
-     * Register a handler to be called when the port is closed.
-     */
-    get onClose(): NotifyEvent<Event>;
-    /**
-     * Register a handler to be called when a message error is received.
-     */
-    get onMessageError(): NotifyEvent<Error>;
-    get isClosed(): boolean;
-    get port(): T;
-}
-//# sourceMappingURL=MessagePortEvents.d.ts.map

package/dist/rpc/MessagePortEvents.js

@@ -1,94 +0,0 @@
-import { NotifyEmitter } from './notify.js';
-/**
- * Wraps a {@link MessagePortLike} and exposes its key events through a
- * {@link NotifyEmitter}-based interface.
- *
- * This class listens to the underlying port's `message`,
- * `messageerror`, and `close` events and re-emits them as
- * {@link NotifyEvent} instances, making it easier to subscribe to and manage
- * notifications from a message port.
- */
-export class MessagePortNotifyEvents {
-    #notifyMessage = new NotifyEmitter();
-    #notifyClose = new NotifyEmitter();
-    #notifyMessageError = new NotifyEmitter();
-    #port;
-    #disposed = false;
-    #closed;
-    constructor(port) {
-        this.#port = port;
-        this.#port.addListener('message', this.#notifyMessage.notify);
-        this.#port.addListener('messageerror', this.#notifyMessageError.notify);
-        this.#port.addListener('close', this.#notifyClose.notify);
-        this.#notifyClose.once((event) => (this.#closed = event));
-    }
-    [Symbol.dispose]() {
-        if (this.#disposed)
-            return;
-        this.#disposed = true;
-        this.#port.removeListener('message', this.#notifyMessage.notify);
-        this.#port.removeListener('messageerror', this.#notifyMessageError.notify);
-        this.#port.removeListener('close', this.#notifyClose.notify);
-        this.#notifyMessage[Symbol.dispose]();
-        this.#notifyClose[Symbol.dispose]();
-        this.#notifyMessageError[Symbol.dispose]();
-    }
-    /**
-     * Register a handler to be called when a message is received.
-     */
-    get onMessage() {
-        return this.#notifyMessage.onEvent;
-    }
-    /**
-     * Return a Promise that resolves on the next message.
-     * @param signal - A signal to abort the wait.
-     * @returns A Promise that resolves with the next message received.
-     */
-    awaitNextMessage = (signal) => this.#notifyMessage.awaitNext(signal);
-    /**
-     * Return a Promise that resolves on the close event.
-     * @param signal - A signal to abort the wait.
-     * @returns A Promise that resolves when the port is closed.
-     */
-    awaitClose = (signal) => {
-        if (this.#closed)
-            return Promise.resolve(this.#closed);
-        return this.#notifyClose.awaitNext(signal);
-    };
-    /**
-     * Post a message to the underlying port.
-     * @param message - The message to post.
-     */
-    postMessage = (message) => this.#port.postMessage(message);
-    /**
-     * Start the underlying port.
-     */
-    start() {
-        this.#port.start?.();
-    }
-    /**
-     * Close the underlying port.
-     */
-    close() {
-        this.#port.close?.();
-    }
-    /**
-     * Register a handler to be called when the port is closed.
-     */
-    get onClose() {
-        return this.#notifyClose.onEvent;
-    }
-    /**
-     * Register a handler to be called when a message error is received.
-     */
-    get onMessageError() {
-        return this.#notifyMessageError.onEvent;
-    }
-    get isClosed() {
-        return this.#closed !== undefined;
-    }
-    get port() {
-        return this.#port;
-    }
-}
-//# sourceMappingURL=MessagePortEvents.js.map

package/dist/rpc/assert.d.ts

@@ -1,14 +0,0 @@
-/**
- * Note: This code is here to avoid a dependency on Node's 'assert' module.
- */
-/**
- * Asserts that a condition is true.
- * @param condition - The condition to assert.
- * @param msg - optional message for the assertion error.
- * @throws {AssertionError} If the condition is false.
- */
-export declare function assert(condition: unknown, msg?: string): asserts condition;
-export declare class AssertionError extends Error {
-    constructor(message?: string);
-}
-//# sourceMappingURL=assert.d.ts.map

package/dist/rpc/assert.js

@@ -1,21 +0,0 @@
-/**
- * Note: This code is here to avoid a dependency on Node's 'assert' module.
- */
-/**
- * Asserts that a condition is true.
- * @param condition - The condition to assert.
- * @param msg - optional message for the assertion error.
- * @throws {AssertionError} If the condition is false.
- */
-export function assert(condition, msg) {
-    if (!condition) {
-        throw new AssertionError(msg);
-    }
-}
-export class AssertionError extends Error {
-    constructor(message) {
-        super(message || 'Assertion failed');
-        this.name = 'AssertionError';
-    }
-}
-//# sourceMappingURL=assert.js.map

package/dist/rpc/client.d.ts

@@ -1,186 +0,0 @@
-import type { MessagePortLike } from './messagePort.js';
-import type { RCPBaseRequest, RequestID, RPCPendingClientRequest, RPCResponse } from './models.js';
-import type { RPCProtocol, RPCProtocolMethodNames } from './protocol.js';
-interface PendingRequest {
-    readonly id: RequestID;
-    readonly request: RCPBaseRequest;
-    readonly response: Promise<RPCResponse>;
-    readonly isResolved: boolean;
-    readonly isCanceled: boolean;
-    /** calling abort will cancel the request if it has not already been resolved. */
-    abort: AbortController['abort'];
-    handleResponse: (res: RPCResponse) => void;
-    /**
-     * Cancels the request by telling the server to cancel the request and waiting on the response.
-     */
-    cancel: () => Promise<boolean>;
-}
-export interface RPCClientOptions {
-    /**
-     * A function to generate random UUIDs.
-     * @default undefined
-     */
-    randomUUID?: () => string;
-    /**
-     * If true, the client will close the port when disposed.
-     * @default false
-     */
-    closePortOnDispose?: boolean;
-    /**
-     * Set the default timeout in milliseconds for requests.
-     */
-    timeoutMs?: number;
-}
-export interface RPCClientConfiguration extends RPCClientOptions {
-    /**
-     * The message port to use for communication.
-     */
-    port: MessagePortLike;
-}
-export interface RequestOptions {
-    /**
-     * An AbortSignal to abort the request.
-     */
-    signal?: AbortSignal | undefined;
-    /**
-     * Timeout in milliseconds to wait before aborting the request.
-     */
-    timeoutMs?: number | undefined;
-}
-/**
- * The RPC Client.
- */
-declare class RPCClientImpl<T, P extends RPCProtocol<T> = RPCProtocol<T>, MethodNames extends RPCProtocolMethodNames<P> = RPCProtocolMethodNames<P>> {
-    #private;
-    /**
-     * Create an RPC Client.
-     * @param config - The client configuration.
-     */
-    constructor(config: RPCClientConfiguration);
-    /**
-     * Make a request to the RPC server.
-     *
-     * It is unlikely you need to use this method directly. Consider using `call` or `getApi` instead.
-     *
-     * @param method - The method name.
-     * @param params - The method parameters.
-     * @param options - Request options including abort signal and timeout.
-     * @returns The pending client request.
-     */
-    request<M extends MethodNames>(method: M, params: Parameters<P[M]>, options?: RequestOptions): RPCPendingClientRequest<M, ReturnType<P[M]>>;
-    /**
-     * Check the health of the RPC server.
-     * @param options - used to set timeout and abort signal.
-     * @returns resolves to true if the server is OK, false on timeout.
-     */
-    isOK(options?: RequestOptions): Promise<boolean>;
-    /**
-     * The current known ready state of the RPC server.
-     * - `true` - The server is ready.
-     * - `false` - The server is not ready.
-     */
-    get isReady(): boolean;
-    /**
-     * Check if the RPC server is ready. If already ready, returns true immediately.
-     * If not ready, sends a 'ready' request to the server.
-     * @param options - used to set timeout and abort signal.
-     * @returns resolves to true when the server is ready, rejects if the request times out or fails.
-     */
-    ready(options?: RequestOptions): Promise<boolean>;
-    /**
-     * Call a method on the RPC server.
-     * @param method - The method name.
-     * @param params - The method parameters.
-     * @param options - Call options including abort signal.
-     * @returns A Promise with the method result.
-     */
-    call<M extends MethodNames>(method: M, params: Parameters<P[M]>, options?: RequestOptions): ReturnType<P[M]>;
-    /**
-     * Get the API for the given method names.
-     *
-     * This is useful passing the API to other parts of the code that do not need to know about the RPCClient.
-     *
-     * @param methods - The method names to include in the API.
-     * @returns A partial API with the requested methods.
-     */
-    getApi<M extends MethodNames>(methods: M[]): Pick<P, M>;
-    /**
-     * Get info about a pending request by its RequestID.
-     * @param id - The RequestID of the pending request.
-     * @returns The found pending request or undefined if not found.
-     */
-    getPendingRequestById(id: RequestID): PendingRequest | undefined;
-    /**
-     * Get info about a pending request by the promise returned using `call` or an api method.
-     * @param id - The RequestID of the pending request.
-     * @returns The found pending request or undefined if not found.
-     */
-    getPendingRequestByPromise(promise: Promise<unknown>): PendingRequest | undefined;
-    /**
-     * Get the number of pending requests.
-     */
-    get length(): number;
-    /**
-     * Abort a pending request by its promise.
-     *
-     * Note: the request promise will be rejected with an AbortRequestError.
-     * @param promise - The promise returned by the request.
-     * @param reason - The reason for aborting the request.
-     * @returns True if the request was found and aborted, false otherwise.
-     */
-    abortPromise(promise: Promise<unknown>, reason: unknown): boolean;
-    /**
-     * Abort a pending request by its RequestId.
-     *
-     * Note: the request promise will be rejected with an AbortRequestError.
-     * @param requestId - The RequestID of the request to abort.
-     * @param reason - The reason for aborting the request.
-     * @returns True if the request was found and aborted, false otherwise.
-     */
-    abortRequest(requestId: RequestID, reason?: unknown): boolean;
-    /**
-     * Abort all pending requests.
-     *
-     * Note: each request promise will be rejected with an AbortRequestError.
-     *
-     * @param reason - The reason for aborting the request.
-     */
-    abortAllRequests(reason?: unknown): void;
-    /**
-     * Cancel a pending request by its RequestID.
-     *
-     * Tries to cancel the request by sending a cancel request to the server and waiting for the response.
-     * @param id - The RequestID of the request to cancel.
-     * @returns resolves to true if the request was found and canceled, false otherwise.
-     */
-    cancelRequest(id: RequestID): Promise<boolean>;
-    /**
-     * Cancel a pending request by its Promise.
-     *
-     * Tries to cancel the request by sending a cancel request to the server and waiting for the response.
-     * @param id - The RequestID of the request to cancel.
-     * @returns resolves to true if the request was found and canceled, false otherwise.
-     */
-    cancelPromise(promise: Promise<unknown>): Promise<boolean>;
-    /**
-     * Set the default timeout for requests. Requests can override this value.
-     * @param timeoutMs - the timeout in milliseconds
-     */
-    setTimeout(timeoutMs: number | undefined): void;
-    /**
-     * Dispose of the RPC client, aborting all pending requests and closing the port if specified in options.
-     */
-    [Symbol.dispose](): void;
-}
-/**
- * The RPC Client.
- */
-export declare class RPCClient<T> extends RPCClientImpl<T> {
-    /**
-     * Create an RPC Client.
-     * @param config - The client configuration.
-     */
-    constructor(config: RPCClientConfiguration);
-}
-export {};
-//# sourceMappingURL=client.d.ts.map