brighterscript 1.0.0-alpha.5 → 1.0.0-alpha.51

package/dist/lsp/ActionQueue.d.ts

@@ -0,0 +1,35 @@
+import type { CancellationToken } from 'vscode-languageserver-protocol';
+export declare class ActionQueue {
+    constructor(options?: ActionQueueOptions);
+    options: ActionQueueOptions;
+    private queue;
+    /**
+     * Run an action. This will run after all previous actions have completed
+     * @param action action to be run
+     */
+    run<T = any>(action: Action<T>, data?: T): Promise<void>;
+    private isRunning;
+    /**
+     * Process the next pending action. Safe to call even if another action is running, we will only run one action at a time
+     */
+    private process;
+    private stringifyJson;
+    get isIdle(): boolean;
+    /**
+     * Get a promise that resolves when the queue is empty
+     */
+    onIdle(): Promise<void>;
+    once(eventname: 'idle'): Promise<void>;
+    on(eventName: 'idle', handler: () => any): any;
+    private emit;
+    private emitter;
+    dispose(): void;
+}
+export declare type Action<T = any> = (data: T, cancellationToken?: CancellationToken) => any;
+export interface ActionQueueOptions {
+    /**
+     * Max milliseconds an individual action may run before it's cancelled. This is the amount of time the action actually runs,
+     * and does not count the time it waits in the queue
+     */
+    maxActionDuration: number;
+}

package/dist/lsp/ActionQueue.js

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActionQueue = void 0;
+const vscode_languageserver_protocol_1 = require("vscode-languageserver-protocol");
+const deferred_1 = require("../deferred");
+const safeJsonStringify = require("safe-json-stringify");
+const eventemitter3_1 = require("eventemitter3");
+const util_1 = require("../util");
+class ActionQueue {
+    constructor(options) {
+        var _a;
+        var _b;
+        this.queue = [];
+        this.isRunning = false;
+        this.emitter = new eventemitter3_1.EventEmitter();
+        this.options = options !== null && options !== void 0 ? options : {};
+        (_a = (_b = this.options).maxActionDuration) !== null && _a !== void 0 ? _a : (_b.maxActionDuration = 2147483647);
+    }
+    /**
+     * Run an action. This will run after all previous actions have completed
+     * @param action action to be run
+     */
+    run(action, data) {
+        const deferred = new deferred_1.Deferred();
+        this.queue.push({
+            action: action,
+            data: data,
+            deferred: deferred
+        });
+        void this.process();
+        return deferred.promise;
+    }
+    /**
+     * Process the next pending action. Safe to call even if another action is running, we will only run one action at a time
+     */
+    async process() {
+        if (this.isRunning) {
+            return;
+        }
+        if (this.queue.length === 0) {
+            this.emit('idle');
+            return;
+        }
+        this.isRunning = true;
+        //run the action and resolve the deferred if it succeeds
+        const queueItem = this.queue.shift();
+        const cancellationTokenSource = new vscode_languageserver_protocol_1.CancellationTokenSource();
+        //process the action next tick to allow the event loop to catch up
+        let actionPromise = Promise.resolve().then(() => {
+            return queueItem.action(queueItem.data, cancellationTokenSource.token);
+        }).then((result) => {
+            queueItem.deferred.resolve(result);
+        });
+        //register a timeout that will reject if the action takes too long
+        let timeoutId;
+        const timeoutPromise = new Promise((resolve, reject) => {
+            timeoutId = setTimeout(() => {
+                cancellationTokenSource.cancel();
+                reject(new Error(`Action took longer than ${this.options.maxActionDuration}ms to complete. Data: ${this.stringifyJson(queueItem.data)}`));
+            }, this.options.maxActionDuration);
+        });
+        //wait for the action to finish or the timeout to trigger
+        await Promise.race([timeoutPromise, actionPromise]).catch((error) => {
+            //if we have an error, reject the deferred
+            queueItem.deferred.tryReject(error);
+        });
+        clearTimeout(timeoutId);
+        //small delay to allow the event loop to catch up
+        await util_1.default.sleep(1);
+        this.isRunning = false;
+        //at this point, we've properly handled the action, so try and handle the next one
+        await this.process();
+    }
+    stringifyJson(data) {
+        return safeJsonStringify(data, (_, value) => {
+            return typeof value === 'bigint' ? value.toString() : value;
+        });
+    }
+    get isIdle() {
+        return this.queue.length === 0 && !this.isRunning;
+    }
+    /**
+     * Get a promise that resolves when the queue is empty
+     */
+    onIdle() {
+        if (!this.isIdle) {
+            return this.once('idle');
+        }
+        return Promise.resolve();
+    }
+    once(eventName) {
+        return new Promise((resolve) => {
+            const disconnect = this.on(eventName, (...args) => {
+                disconnect();
+                resolve(args);
+            });
+        });
+    }
+    on(eventName, handler) {
+        this.emitter.on(eventName, handler);
+        return () => {
+            this.emitter.removeListener(eventName, handler);
+        };
+    }
+    async emit(eventName, data) {
+        //emit these events on next tick, otherwise they will be processed immediately which could cause issues
+        await util_1.default.sleep(0);
+        this.emitter.emit(eventName, data);
+    }
+    dispose() {
+        this.emitter.removeAllListeners();
+    }
+}
+exports.ActionQueue = ActionQueue;
+//# sourceMappingURL=ActionQueue.js.map

package/dist/lsp/ActionQueue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActionQueue.js","sourceRoot":"","sources":["../../src/lsp/ActionQueue.ts"],"names":[],"mappings":";;;AACA,mFAAyE;AACzE,0CAAuC;AACvC,yDAAyD;AACzD,iDAA6C;AAC7C,kCAA2B;AAE3B,MAAa,WAAW;IAEpB,YACI,OAA4B;;;QAQxB,UAAK,GAcR,EAAE,CAAC;QAiBA,cAAS,GAAG,KAAK,CAAC;QAqGlB,YAAO,GAAG,IAAI,4BAAY,EAAE,CAAC;QA1IjC,IAAI,CAAC,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAS,CAAC;QACpC,YAAA,IAAI,CAAC,OAAO,EAAC,iBAAiB,uCAAjB,iBAAiB,GAAK,UAAa,EAAC;IACrD,CAAC;IAoBD;;;OAGG;IACI,GAAG,CAAU,MAAiB,EAAE,IAAQ;QAC3C,MAAM,QAAQ,GAAG,IAAI,mBAAQ,EAAE,CAAC;QAChC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;YACZ,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,QAAQ,EAAE,QAAQ;SACrB,CAAC,CAAC;QACH,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;QACpB,OAAO,QAAQ,CAAC,OAAO,CAAC;IAC5B,CAAC;IAID;;OAEG;IACK,KAAK,CAAC,OAAO;QACjB,IAAI,IAAI,CAAC,SAAS,EAAE;YAChB,OAAO;SACV;QACD,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;YACzB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAClB,OAAO;SACV;QACD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QAEtB,wDAAwD;QACxD,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACrC,MAAM,uBAAuB,GAAG,IAAI,wDAAuB,EAAE,CAAC;QAE9D,kEAAkE;QAClE,IAAI,aAAa,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;YAC5C,OAAO,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,uBAAuB,CAAC,KAAK,CAAC,CAAC;QAC3E,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YACf,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,kEAAkE;QAClE,IAAI,SAAyB,CAAC;QAC9B,MAAM,cAAc,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnD,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;gBACxB,uBAAuB,CAAC,MAAM,EAAE,CAAC;gBACjC,MAAM,CACF,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,OAAO,CAAC,iBAAiB,yBAAyB,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CACpI,CAAC;YACN,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,yDAAyD;QACzD,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YAChE,0CAA0C;YAC1C,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,YAAY,CAAC,SAAS,CAAC,CAAC;QAExB,iDAAiD;QACjD,MAAM,cAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAEpB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QAEvB,kFAAkF;QAClF,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;IACzB,CAAC;IAEO,aAAa,CAAC,IAAS;QAC3B,OAAO,iBAAiB,CACpB,IAAI,EACJ,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE;YACT,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QAChE,CAAC,CACJ,CAAC;IACN,CAAC;IAED,IAAW,MAAM;QACb,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC;IACtD,CAAC;IAED;;OAEG;IACI,MAAM;QACT,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACd,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SAC5B;QACD,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;IAGM,IAAI,CAAC,SAAiB;QACzB,OAAO,IAAI,OAAO,CAAM,CAAC,OAAO,EAAE,EAAE;YAChC,MAAM,UAAU,GAAG,IAAI,CAAC,EAAE,CAAC,SAA6C,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE;gBAClF,UAAU,EAAE,CAAC;gBACb,OAAO,CAAC,IAAI,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAGM,EAAE,CAAC,SAAiB,EAAE,OAA8B;QACvD,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,OAAc,CAAC,CAAC;QAC3C,OAAO,GAAG,EAAE;YACR,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,SAAS,EAAE,OAAc,CAAC,CAAC;QAC3D,CAAC,CAAC;IACN,CAAC;IAGO,KAAK,CAAC,IAAI,CAAC,SAAiB,EAAE,IAAU;QAC5C,uGAAuG;QACvG,MAAM,cAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACpB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;IAGM,OAAO;QACV,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC;IACtC,CAAC;CACJ;AApJD,kCAoJC"}

package/dist/lsp/DocumentManager.d.ts

@@ -0,0 +1,63 @@
+import type { MaybePromise } from '../interfaces';
+/**
+ * Maintains a queued/buffered list of file operations. These operations don't actually do anything on their own.
+ * You need to call the .apply() function and provide an action to operate on them.
+ */
+export declare class DocumentManager {
+    private options;
+    constructor(options: {
+        delay: number;
+        flushHandler?: (event: FlushEvent) => any;
+    });
+    private queue;
+    private timeoutHandle;
+    private throttle;
+    /**
+     * Add/set the contents of a file
+     */
+    set(options: {
+        srcPath: string;
+        fileContents?: string;
+        allowStandaloneProject?: boolean;
+    }): void;
+    /**
+     * Delete a file or directory. If a directory is provided, all pending changes within that directory will be discarded
+     * and only the delete action will be queued
+     */
+    delete(srcPath: string): void;
+    private isFlushRunning;
+    private flush;
+    /**
+     * Is the manager settled (i.e. no pending files, all files have been fully flushed)
+     */
+    get isIdle(): boolean;
+    /**
+     * Returns a promise that resolves when there are no pending files and no active flushes are running. Will immediately resolve if there are no files,
+     * and will wait until files are flushed if there are files.
+     */
+    onIdle(): Promise<void>;
+    once(eventName: 'flush'): Promise<FlushEvent>;
+    on(eventName: 'flush', handler: (data: any) => MaybePromise<void>): any;
+    private emitSync;
+    private emitter;
+    dispose(): void;
+}
+export interface SetDocumentAction {
+    srcPath: string;
+    type: 'set';
+    allowStandaloneProject?: boolean;
+    fileContents: string;
+}
+export interface DeleteDocumentAction {
+    srcPath: string;
+    type: 'delete';
+    allowStandaloneProject?: boolean;
+}
+export declare type DocumentAction = SetDocumentAction | DeleteDocumentAction;
+export declare type DocumentActionWithStatus = DocumentAction & {
+    id: number;
+    status: 'accepted' | 'rejected';
+};
+export interface FlushEvent {
+    actions: DocumentAction[];
+}

package/dist/lsp/DocumentManager.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentManager = void 0;
+const EventEmitter = require("eventemitter3");
+const util_1 = require("../util");
+/**
+ * Maintains a queued/buffered list of file operations. These operations don't actually do anything on their own.
+ * You need to call the .apply() function and provide an action to operate on them.
+ */
+class DocumentManager {
+    constructor(options) {
+        this.options = options;
+        this.queue = new Map();
+        this.isFlushRunning = false;
+        this.emitter = new EventEmitter();
+    }
+    throttle() {
+        if (this.timeoutHandle) {
+            clearTimeout(this.timeoutHandle);
+        }
+        this.timeoutHandle = setTimeout(() => {
+            void this.flush();
+        }, this.options.delay);
+    }
+    /**
+     * Add/set the contents of a file
+     */
+    set(options) {
+        var _a;
+        const srcPath = util_1.default.standardizePath(options.srcPath);
+        if (this.queue.has(srcPath)) {
+            this.queue.delete(srcPath);
+        }
+        this.queue.set(srcPath, {
+            type: 'set',
+            srcPath: srcPath,
+            fileContents: options.fileContents,
+            allowStandaloneProject: (_a = options.allowStandaloneProject) !== null && _a !== void 0 ? _a : false
+        });
+        //schedule a future flush
+        this.throttle();
+    }
+    /**
+     * Delete a file or directory. If a directory is provided, all pending changes within that directory will be discarded
+     * and only the delete action will be queued
+     */
+    delete(srcPath) {
+        srcPath = util_1.default.standardizePath(srcPath);
+        //remove any pending action with this exact path
+        this.queue.delete(srcPath);
+        //we can't tell if this a directory, so just remove all pending changes for files that start with this path
+        for (const key of this.queue.keys()) {
+            if (key.startsWith(srcPath)) {
+                this.queue.delete(key);
+            }
+        }
+        //register this delete
+        this.queue.set(srcPath, { type: 'delete', srcPath: srcPath });
+        //schedule a future flush
+        this.throttle();
+    }
+    async flush() {
+        var _a, _b;
+        //if we're already running a flush, don't run another
+        if (this.isFlushRunning) {
+            return;
+        }
+        this.isFlushRunning = true;
+        while (this.queue.size > 0) {
+            try {
+                const event = {
+                    actions: [...this.queue.values()]
+                };
+                this.queue.clear();
+                await ((_b = (_a = this.options).flushHandler) === null || _b === void 0 ? void 0 : _b.call(_a, event));
+            }
+            catch (e) {
+                console.error(e);
+            }
+        }
+        this.emitSync('flush');
+        this.isFlushRunning = false;
+    }
+    /**
+     * Is the manager settled (i.e. no pending files, all files have been fully flushed)
+     */
+    get isIdle() {
+        return this.queue.size === 0 && this.isFlushRunning === false;
+    }
+    /**
+     * Returns a promise that resolves when there are no pending files and no active flushes are running. Will immediately resolve if there are no files,
+     * and will wait until files are flushed if there are files.
+     */
+    async onIdle() {
+        while (!this.isIdle) {
+            await this.once('flush');
+        }
+    }
+    once(eventName) {
+        return new Promise((resolve) => {
+            const off = this.on(eventName, (data) => {
+                off();
+                resolve(data);
+            });
+        });
+    }
+    on(eventName, handler) {
+        this.emitter.on(eventName, handler);
+        return () => {
+            this.emitter.removeListener(eventName, handler);
+        };
+    }
+    emitSync(eventName, data) {
+        this.emitter.emit(eventName, data);
+    }
+    dispose() {
+        this.queue = new Map();
+        this.emitter.removeAllListeners();
+    }
+}
+exports.DocumentManager = DocumentManager;
+//# sourceMappingURL=DocumentManager.js.map

package/dist/lsp/DocumentManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocumentManager.js","sourceRoot":"","sources":["../../src/lsp/DocumentManager.ts"],"names":[],"mappings":";;;AAAA,8CAA8C;AAE9C,kCAA2B;AAE3B;;;GAGG;AACH,MAAa,eAAe;IAExB,YACY,OAGP;QAHO,YAAO,GAAP,OAAO,CAGd;QAGG,UAAK,GAAG,IAAI,GAAG,EAA0B,CAAC;QAmD1C,mBAAc,GAAG,KAAK,CAAC;QAgEvB,YAAO,GAAG,IAAI,YAAY,EAAE,CAAC;IArHrC,CAAC;IAKO,QAAQ;QACZ,IAAI,IAAI,CAAC,aAAa,EAAE;YACpB,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;SACpC;QACD,IAAI,CAAC,aAAa,GAAG,UAAU,CAAC,GAAG,EAAE;YACjC,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;QACtB,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,OAAqF;;QAC5F,MAAM,OAAO,GAAG,cAAI,CAAC,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACtD,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;YACzB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;SAC9B;QACD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE;YACpB,IAAI,EAAE,KAAK;YACX,OAAO,EAAE,OAAO;YAChB,YAAY,EAAE,OAAO,CAAC,YAAY;YAClC,sBAAsB,EAAE,MAAA,OAAO,CAAC,sBAAsB,mCAAI,KAAK;SAClE,CAAC,CAAC;QACH,yBAAyB;QACzB,IAAI,CAAC,QAAQ,EAAE,CAAC;IACpB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,OAAe;QACzB,OAAO,GAAG,cAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QACxC,gDAAgD;QAChD,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC3B,2GAA2G;QAC3G,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE;YACjC,IAAI,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;gBACzB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;aAC1B;SACJ;QACD,sBAAsB;QACtB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;QAE9D,yBAAyB;QACzB,IAAI,CAAC,QAAQ,EAAE,CAAC;IACpB,CAAC;IAIO,KAAK,CAAC,KAAK;;QACf,qDAAqD;QACrD,IAAI,IAAI,CAAC,cAAc,EAAE;YACrB,OAAO;SACV;QAED,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,EAAE;YACxB,IAAI;gBACA,MAAM,KAAK,GAAe;oBACtB,OAAO,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;iBACpC,CAAC;gBACF,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;gBACnB,MAAM,CAAA,MAAA,MAAA,IAAI,CAAC,OAAO,EAAC,YAAY,mDAAG,KAAK,CAAC,CAAA,CAAC;aAC5C;YAAC,OAAO,CAAC,EAAE;gBACR,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;aACpB;SACJ;QACD,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QACvB,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,IAAW,MAAM;QACb,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC;IAClE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM;QACf,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE;YACjB,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC5B;IACL,CAAC;IAGM,IAAI,CAAC,SAAiB;QACzB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC,SAAgB,EAAE,CAAC,IAAI,EAAE,EAAE;gBAC3C,GAAG,EAAE,CAAC;gBACN,OAAO,CAAC,IAAI,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAGM,EAAE,CAAC,SAAiB,EAAE,OAA+C;QACxE,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,OAAc,CAAC,CAAC;QAC3C,OAAO,GAAG,EAAE;YACR,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,SAAS,EAAE,OAAc,CAAC,CAAC;QAC3D,CAAC,CAAC;IACN,CAAC;IAGO,QAAQ,CAAC,SAAiB,EAAE,IAAK;QACrC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;IAIM,OAAO;QACV,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,EAAE,CAAC;QACvB,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC;IACtC,CAAC;CACJ;AAlID,0CAkIC"}

package/dist/lsp/LspProject.d.ts

@@ -0,0 +1,287 @@
+import type { Diagnostic, Position, Range, Location, DocumentSymbol, WorkspaceSymbol, CodeAction, CompletionList, SelectionRange, TextEdit } from 'vscode-languageserver-protocol';
+import type { Hover, MaybePromise, SemanticToken } from '../interfaces';
+import type { DocumentAction, DocumentActionWithStatus } from './DocumentManager';
+import type { FileTranspileResult, SignatureInfoObj } from '../Program';
+import type { Logger, LogLevel } from '../logging';
+/**
+ * Defines the contract between the ProjectManager and the main or worker thread Project classes
+ */
+export interface LspProject {
+    /**
+     * Is this a standalone project?
+     */
+    isStandaloneProject: boolean;
+    /**
+     * A logger instance used for logging in this project
+     */
+    logger: Logger;
+    /**
+     * The config used to activate this project
+     */
+    activateOptions: ProjectConfig;
+    /**
+     * A unique key to represent this project. The format of this key may change, but it will always be unique to this project and can be used for comparison purposes.
+     *
+     * For directory-only projects, this is the path to the dir. For bsconfig.json projects, this is the path to the config file (typically bsconfig.json).
+     */
+    projectKey: string;
+    /**
+     * The directory for the root of this project (typically where the bsconfig.json or manifest is located)
+     */
+    projectDir: string;
+    /**
+     * A unique number for this project, generated during this current language server session. Mostly used so we can identify which project is doing logging
+     */
+    projectNumber: number;
+    /**
+     * The root directory of the project.
+     * Only available after `.activate()` has completed
+     */
+    rootDir: string;
+    /**
+     * The file patterns from bsconfig.json that were used to find all files for this project
+     */
+    filePatterns: string[];
+    /**
+     * Path to a bsconfig.json file that will be used for this project.
+     * Only available after `.activate()` has completed
+     */
+    bsconfigPath?: string;
+    /**
+     * The contents of the bsconfig.json file. This is used to detect when the bsconfig file has not actually been changed (even if the fs says it did).
+     *
+     * Only available after `.activate()` has completed.
+     * @deprecated do not depend on this property. This will certainly be removed in a future release
+     */
+    bsconfigFileContents?: string;
+    /**
+     * The contents of the manifest file. This is used to detect when the manifest file has not actually been changed (even if the fs says it did).
+     *
+     * Only available after `.activate()` has completed.
+     * @deprecated do not depend on this property. This will certainly be removed in a future release
+     */
+    manifestFileContents?: string;
+    /**
+     * The absolute source path to the manifest file (the file that maps to dest 'manifest').
+     * May differ from rootDir/manifest if the project uses a custom {src; dest} mapping.
+     *
+     * Only available after `.activate()` has completed.
+     */
+    manifestSrcPath?: string;
+    /**
+     * Initialize and start running the project. This will scan for all files, and build a full project in memory, then validate the project
+     * @param options
+     */
+    activate(options: ProjectConfig): MaybePromise<ActivateResponse>;
+    /**
+     * Get a promise that resolves when the project finishes activating
+     */
+    whenActivated(): Promise<void>;
+    /**
+     * Validate the project. This will trigger a full validation on any scopes that were changed since the last validation,
+     * and will also eventually emit a new 'diagnostics' event that includes all diagnostics for the project
+     */
+    validate(): Promise<void>;
+    /**
+     * Cancel any active validation that's running
+     */
+    cancelValidate(): MaybePromise<void>;
+    /**
+     * Get the list of all diagnostics from this project
+     */
+    getDiagnostics(): MaybePromise<LspDiagnostic[]>;
+    /**
+     * Get the full list of semantic tokens for the given file path
+     * @param srcPath absolute path to the source file
+     */
+    getSemanticTokens(options: {
+        srcPath: string;
+    }): MaybePromise<SemanticToken[]>;
+    /**
+     * Transpile the specified file
+     * @param srcPath
+     */
+    transpileFile(options: {
+        srcPath: string;
+    }): MaybePromise<FileTranspileResult>;
+    /**
+     * Get the hover information for the specified position in the specified file
+     */
+    getHover(options: {
+        srcPath: string;
+        position: Position;
+    }): MaybePromise<Hover[]>;
+    /**
+     * Get the locations where the symbol at the specified position is defined
+     * @param options the file path and position to get the definition for
+     */
+    getDefinition(options: {
+        srcPath: string;
+        position: Position;
+    }): MaybePromise<Location[]>;
+    /**
+     * Get the locations where the symbol at the specified position is defined
+     * @param options the file path and position to get the definition for
+     */
+    getSignatureHelp(options: {
+        srcPath: string;
+        position: Position;
+    }): MaybePromise<SignatureInfoObj[]>;
+    /**
+     * Get the list of symbols for the specified file
+     */
+    getDocumentSymbol(options: {
+        srcPath: string;
+    }): MaybePromise<DocumentSymbol[]>;
+    /**
+     * Get the list of symbols for the entire workspace
+     */
+    getWorkspaceSymbol(): Promise<WorkspaceSymbol[]>;
+    /**
+     * Get the list of references for the specified file and position
+     */
+    getReferences(options: {
+        srcPath: string;
+        position: Position;
+    }): MaybePromise<Location[]>;
+    /**
+     * Compute the text edits required to keep `import` statements and `<script uri>` tags pointing
+     * at a source file when that source file is being renamed. Each project answers independently;
+     * the ProjectManager is responsible for reconciling agreement across projects.
+     */
+    getFileRenameEdits(options: {
+        oldSrcPath: string;
+        newSrcPath: string;
+    }): MaybePromise<FileRenameTextEdit[]>;
+    /**
+     * Get all of the code actions for the specified file and range
+     */
+    getCodeActions(options: {
+        srcPath: string;
+        range: Range;
+    }): Promise<CodeAction[]>;
+    /**
+     * Get all "fix all" source actions for the specified file
+     */
+    getSourceFixAllCodeActions(options: {
+        srcPath: string;
+    }): Promise<CodeAction[]>;
+    /**
+     * Get the selection ranges for the given positions in the specified file
+     */
+    getSelectionRanges(options: {
+        srcPath: string;
+        positions: Position[];
+    }): MaybePromise<SelectionRange[]>;
+    /**
+     * Get the completions for the specified file and position
+     */
+    getCompletions(options: {
+        srcPath: string;
+        position: Position;
+    }): Promise<CompletionList>;
+    /**
+     * Apply a series of file changes to the program.
+     * This will cancel any active validation.
+     * @param documentActions
+     * @returns a boolean indicating whether this project accepted any of the file changes. If false, then this project didn't recognize any of the files and thus did nothing
+     */
+    applyFileChanges(documentActions: DocumentAction[]): Promise<DocumentActionWithStatus[]>;
+    /**
+     * An event that is emitted anytime the diagnostics for the project have changed (typically after a validate cycle has finished)
+     * @param eventName
+     * @param handler
+     */
+    on(eventName: 'diagnostics', handler: (data: {
+        diagnostics: LspDiagnostic[];
+    }) => void): any;
+    on(eventName: 'all', handler: (eventName: string, data: Record<string, any>) => void): any;
+    /**
+     * List of items to dispose when this project is disposed
+     */
+    disposables: Array<{
+        dispose(): void;
+    }>;
+    /**
+     * Release all resources so this file can be safely garbage collected
+     */
+    dispose(): void;
+}
+export interface ProjectConfig {
+    /**
+     * A unique key to represent this project. The format of this key may change, but it will always be unique to this project and can be used for comparison purposes.
+     *
+     * For directory-only projects, this is the path to the dir. For bsconfig.json projects, this is the path to the config file (typically bsconfig.json).
+     */
+    projectKey: string;
+    /**
+     * The directory for the root of this project (typically where the bsconfig.json or manifest is located)
+     */
+    projectDir: string;
+    /**
+     * Path to the workspace in which all project files reside or are referenced by
+     */
+    workspaceFolder: string;
+    /**
+     * A list of glob patterns used to _exclude_ files from various bsconfig searches
+     */
+    excludePatterns?: string[];
+    /**
+     * An optional project number to assign to the project within the context of a language server. reloaded projects should keep the same number if possible
+     */
+    projectNumber?: number;
+    /**
+     * Path to a bsconfig that should be used instead of the auto-discovery algorithm. If this is present, no bsconfig discovery should be used. and an error should be emitted if this file is missing
+     */
+    bsconfigPath: string | undefined;
+    /**
+     * Should this project run in its own dedicated worker thread
+     * TODO - is there a better name for this?
+     */
+    enableThreading?: boolean;
+    /**
+     * If present, this will override any files array found in bsconfig or the default.
+     *
+     * The list of file globs used to find all files for the project
+     * If using the {src;dest;} format, you can specify a different destination directory
+     * for the matched files in src.
+     *
+     */
+    files?: Array<string | {
+        src: string | string[];
+        dest?: string;
+    }>;
+}
+export interface LspDiagnostic extends Diagnostic {
+    uri: string;
+}
+/**
+ * A LSP TextEdit augmented with the URI of the document the edit applies to. Used for cross-file
+ * edits where each entry stands alone (e.g. file-rename edits collected across projects).
+ */
+export interface FileRenameTextEdit extends TextEdit {
+    uri: string;
+}
+export interface ActivateResponse {
+    /**
+     * The root directory of the project
+     */
+    rootDir: string;
+    /**
+     * The path to the config file (i.e. `bsconfig.json`) that was used to load this project
+     */
+    bsconfigPath: string;
+    /**
+     * The file patterns from bsconfig.json that were used to find all files for this project
+     */
+    filePatterns: string[];
+    /**
+     * The logLevel used for this project's logger
+     */
+    logLevel: LogLevel;
+    /**
+     * The absolute source path to the manifest file (the file that maps to dest 'manifest').
+     * May differ from rootDir/manifest if the project uses a custom {src; dest} mapping.
+     */
+    manifestSrcPath: string;
+}

package/dist/lsp/LspProject.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=LspProject.js.map

package/dist/lsp/LspProject.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LspProject.js","sourceRoot":"","sources":["../../src/lsp/LspProject.ts"],"names":[],"mappings":""}