@jupyterlab/lsp 4.0.0-alpha.11 → 4.0.0-alpha.12

package/lib/manager.js

@@ -1,61 +1,102 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
 import { PageConfig, URLExt } from '@jupyterlab/coreutils';
 import { ServerConnection } from '@jupyterlab/services';
 import { Signal } from '@lumino/signaling';
 import { ILanguageServerManager } from './tokens';
+import { PromiseDelegate } from '@lumino/coreutils';
 export class LanguageServerManager {
     constructor(options) {
-        this._sessionsChanged = new Signal(this);
+        /**
+         * map of language server sessions.
+         */
         this._sessions = new Map();
+        /**
+         * Map of language server specs.
+         */
         this._specs = new Map();
+        /**
+         * Set of emitted warning message, message in this set will not be warned again.
+         */
         this._warningsEmitted = new Set();
+        /**
+         * A promise resolved when this server manager is ready.
+         */
+        this._ready = new PromiseDelegate();
+        /**
+         * Signal emitted when a  language server session is changed
+         */
+        this._sessionsChanged = new Signal(this);
+        this._isDisposed = false;
         this._settings = options.settings || ServerConnection.makeSettings();
         this._baseUrl = options.baseUrl || PageConfig.getBaseUrl();
         this._retries = options.retries || 2;
         this._retriesInterval = options.retriesInterval || 10000;
         this._statusCode = -1;
         this._configuration = {};
-        this.fetchSessions().catch(e => console.error(e));
+        this.fetchSessions().catch(e => console.log(e));
+    }
+    /**
+     * Check if the manager is disposed.
+     */
+    get isDisposed() {
+        return this._isDisposed;
     }
+    /**
+     * Get the language server specs.
+     */
     get specs() {
         return this._specs;
     }
+    /**
+     * Get the status end point.
+     */
     get statusUrl() {
         return URLExt.join(this._baseUrl, ILanguageServerManager.URL_NS, 'status');
     }
+    /**
+     * Signal emitted when a  language server session is changed
+     */
     get sessionsChanged() {
         return this._sessionsChanged;
     }
+    /**
+     * Get the map of language server sessions.
+     */
     get sessions() {
         return this._sessions;
     }
-    setConfiguration(configuration) {
-        this._configuration = configuration;
+    /**
+     * A promise resolved when this server manager is ready.
+     */
+    get ready() {
+        return this._ready.promise;
     }
-    warnOnce(arg) {
-        if (!this._warningsEmitted.has(arg)) {
-            this._warningsEmitted.add(arg);
-            console.warn(arg);
-        }
+    /**
+     * Get the status code of server's responses.
+     */
+    get statusCode() {
+        return this._statusCode;
     }
-    _comparePriorities(a, b) {
-        var _a, _b, _c, _d;
-        const DEFAULT_PRIORITY = 50;
-        const aPriority = (_b = (_a = this._configuration[a]) === null || _a === void 0 ? void 0 : _a.priority) !== null && _b !== void 0 ? _b : DEFAULT_PRIORITY;
-        const bPriority = (_d = (_c = this._configuration[b]) === null || _c === void 0 ? void 0 : _c.priority) !== null && _d !== void 0 ? _d : DEFAULT_PRIORITY;
-        if (aPriority == bPriority) {
-            this.warnOnce(`Two matching servers: ${a} and ${b} have the same priority; choose which one to use by changing the priority in Advanced Settings Editor`);
-            return a.localeCompare(b);
+    /**
+     * Dispose the manager.
+     */
+    dispose() {
+        if (this._isDisposed) {
+            return;
         }
-        // higher priority = higher in the list (descending order)
-        return bPriority - aPriority;
+        this._isDisposed = true;
+        Signal.clearData(this);
     }
-    isMatchingSpec(options, spec) {
-        // most things speak language
-        // if language is not known, it is guessed based on MIME type earlier
-        // so some language should be available by now (which can be not so obvious, e.g. "plain" for txt documents)
-        const lowerCaseLanguage = options.language.toLocaleLowerCase();
-        return spec.languages.some((language) => language.toLocaleLowerCase() == lowerCaseLanguage);
+    /**
+     * Update the language server configuration.
+     */
+    setConfiguration(configuration) {
+        this._configuration = configuration;
     }
+    /**
+     * Get matching language server for input language option.
+     */
     getMatchingServers(options) {
         if (!options.language) {
             console.error('Cannot match server by language: language not available; ensure that kernel and specs provide language and MIME type');
@@ -67,8 +108,11 @@ export class LanguageServerManager {
                 matchingSessionsKeys.push(key);
             }
         }
-        return matchingSessionsKeys.sort(this._comparePriorities.bind(this));
+        return matchingSessionsKeys.sort(this.compareRanks.bind(this));
     }
+    /**
+     * Get matching language server spec for input language option.
+     */
     getMatchingSpecs(options) {
         const result = new Map();
         for (const [key, specification] of this._specs.entries()) {
@@ -78,18 +122,25 @@ export class LanguageServerManager {
         }
         return result;
     }
-    get statusCode() {
-        return this._statusCode;
-    }
+    /**
+     * Fetch the server session list from the status endpoint. The server
+     * manager is ready once this method finishes.
+     */
     async fetchSessions() {
         let response = await ServerConnection.makeRequest(this.statusUrl, { method: 'GET' }, this._settings);
         this._statusCode = response.status;
         if (!response.ok) {
-            console.error('Could not fetch sessions', response);
+            // if(response.status === 404){
+            //   this._retries = -1
+            // }
             if (this._retries > 0) {
                 this._retries -= 1;
                 setTimeout(this.fetchSessions.bind(this), this._retriesInterval);
             }
+            else {
+                this._ready.resolve(undefined);
+                console.log('Missing jupyter_lsp server extension, skipping.');
+            }
             return;
         }
         let sessions;
@@ -97,7 +148,7 @@ export class LanguageServerManager {
             const data = await response.json();
             sessions = data.sessions;
             try {
-                this._version = data.version;
+                this.version = data.version;
                 this._specs = new Map(Object.entries(data.specs));
             }
             catch (err) {
@@ -106,6 +157,7 @@ export class LanguageServerManager {
         }
         catch (err) {
             console.warn(err);
+            this._ready.resolve(undefined);
             return;
         }
         for (let key of Object.keys(sessions)) {
@@ -125,6 +177,41 @@ export class LanguageServerManager {
             }
         }
         this._sessionsChanged.emit(void 0);
+        this._ready.resolve(undefined);
+    }
+    /**
+     * Check if input language option maths the language server spec.
+     */
+    isMatchingSpec(options, spec) {
+        // most things speak language
+        // if language is not known, it is guessed based on MIME type earlier
+        // so some language should be available by now (which can be not so obvious, e.g. "plain" for txt documents)
+        const lowerCaseLanguage = options.language.toLocaleLowerCase();
+        return spec.languages.some((language) => language.toLocaleLowerCase() == lowerCaseLanguage);
+    }
+    /**
+     * Helper function to warn a message only once.
+     */
+    warnOnce(arg) {
+        if (!this._warningsEmitted.has(arg)) {
+            this._warningsEmitted.add(arg);
+            console.warn(arg);
+        }
+    }
+    /**
+     * Compare the rank of two servers with the same language.
+     */
+    compareRanks(a, b) {
+        var _a, _b, _c, _d;
+        const DEFAULT_RANK = 50;
+        const aRank = (_b = (_a = this._configuration[a]) === null || _a === void 0 ? void 0 : _a.rank) !== null && _b !== void 0 ? _b : DEFAULT_RANK;
+        const bRank = (_d = (_c = this._configuration[b]) === null || _c === void 0 ? void 0 : _c.rank) !== null && _d !== void 0 ? _d : DEFAULT_RANK;
+        if (aRank == bRank) {
+            this.warnOnce(`Two matching servers: ${a} and ${b} have the same rank; choose which one to use by changing the rank in Advanced Settings Editor`);
+            return a.localeCompare(b);
+        }
+        // higher rank = higher in the list (descending order)
+        return bRank - aRank;
     }
 }
 //# sourceMappingURL=manager.js.map

package/lib/manager.js.map

@@ -1 +1 @@
-{"version":3,"file":"manager.js","sourceRoot":"","sources":["../src/manager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAW,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,EACL,sBAAsB,EAKvB,MAAM,UAAU,CAAC;AAGlB,MAAM,OAAO,qBAAqB;IAgBhC,YAAY,OAAwC;QAf1C,qBAAgB,GAAyC,IAAI,MAAM,CAG3E,IAAI,CAAC,CAAC;QACE,cAAS,GAAgB,IAAI,GAAG,EAAE,CAAC;QACnC,WAAM,GAAc,IAAI,GAAG,EAAE,CAAC;QAQhC,qBAAgB,GAAG,IAAI,GAAG,EAAU,CAAC;QAG3C,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,QAAQ,IAAI,gBAAgB,CAAC,YAAY,EAAE,CAAC;QACrE,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,IAAI,UAAU,CAAC,UAAU,EAAE,CAAC;QAC3D,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,IAAI,CAAC,CAAC;QACrC,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,eAAe,IAAI,KAAK,CAAC;QACzD,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC;QACtB,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;QACzB,IAAI,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACpD,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,SAAS;QACX,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,sBAAsB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC7E,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,gBAAgB,CAAC,aAA4C;QAC3D,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;IACtC,CAAC;IAES,QAAQ,CAAC,GAAW;QAC5B,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YACnC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC/B,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACnB;IACH,CAAC;IAES,kBAAkB,CAC1B,CAAoB,EACpB,CAAoB;;QAEpB,MAAM,gBAAgB,GAAG,EAAE,CAAC;QAC5B,MAAM,SAAS,GAAG,MAAA,MAAA,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,0CAAE,QAAQ,mCAAI,gBAAgB,CAAC;QACvE,MAAM,SAAS,GAAG,MAAA,MAAA,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,0CAAE,QAAQ,mCAAI,gBAAgB,CAAC;QACvE,IAAI,SAAS,IAAI,SAAS,EAAE;YAC1B,IAAI,CAAC,QAAQ,CACX,yBAAyB,CAAC,QAAQ,CAAC,uGAAuG,CAC3I,CAAC;YACF,OAAO,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;SAC3B;QACD,0DAA0D;QAC1D,OAAO,SAAS,GAAG,SAAS,CAAC;IAC/B,CAAC;IAES,cAAc,CACtB,OAAmD,EACnD,IAA0B;QAE1B,6BAA6B;QAC7B,qEAAqE;QACrE,4GAA4G;QAC5G,MAAM,iBAAiB,GAAG,OAAO,CAAC,QAAS,CAAC,iBAAiB,EAAE,CAAC;QAChE,OAAO,IAAI,CAAC,SAAU,CAAC,IAAI,CACzB,CAAC,QAAgB,EAAE,EAAE,CAAC,QAAQ,CAAC,iBAAiB,EAAE,IAAI,iBAAiB,CACxE,CAAC;IACJ,CAAC;IAED,kBAAkB,CAChB,OAAmD;QAEnD,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;YACrB,OAAO,CAAC,KAAK,CACX,sHAAsH,CACvH,CAAC;YACF,OAAO,EAAE,CAAC;SACX;QAED,MAAM,oBAAoB,GAAwB,EAAE,CAAC;QAErD,KAAK,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,EAAE;YACrD,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE;gBAC9C,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aAChC;SACF;QAED,OAAO,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACvE,CAAC;IAED,gBAAgB,CACd,OAAmD;QAEnD,MAAM,MAAM,GAAc,IAAI,GAAG,EAAE,CAAC;QAEpC,KAAK,MAAM,CAAC,GAAG,EAAE,aAAa,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE;YACxD,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,aAAa,CAAC,EAAE;gBAC/C,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;aAChC;SACF;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,aAAa;QACjB,IAAI,QAAQ,GAAG,MAAM,gBAAgB,CAAC,WAAW,CAC/C,IAAI,CAAC,SAAS,EACd,EAAE,MAAM,EAAE,KAAK,EAAE,EACjB,IAAI,CAAC,SAAS,CACf,CAAC;QAEF,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAC;QAEnC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;YAChB,OAAO,CAAC,KAAK,CAAC,0BAA0B,EAAE,QAAQ,CAAC,CAAC;YACpD,IAAI,IAAI,CAAC,QAAQ,GAAG,CAAC,EAAE;gBACrB,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC;gBACnB,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;aAClE;YACD,OAAO;SACR;QAED,IAAI,QAAgC,CAAC;QAErC,IAAI;YACF,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;YACzB,IAAI;gBACF,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC;gBAC7B,IAAI,CAAC,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAc,CAAC;aAChE;YAAC,OAAO,GAAG,EAAE;gBACZ,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACnB;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAClB,OAAO;SACR;QAED,KAAK,IAAI,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YACrC,IAAI,EAAE,GAAsB,GAAwB,CAAC;YACrD,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;gBAC1B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAE,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;aACvD;iBAAM;gBACL,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;aACvC;SACF;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;QAEtC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;YAC5B,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;gBACrB,IAAI,KAAK,GAAG,MAA2B,CAAC;gBACxC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;aAC9B;SACF;QAED,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACrC,CAAC;CACF"}
+{"version":3,"file":"manager.js","sourceRoot":"","sources":["../src/manager.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAE3D,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAW,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,EACL,sBAAsB,EAKvB,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,MAAM,OAAO,qBAAqB;IAChC,YAAY,OAAwC;QAsOpD;;WAEG;QACK,cAAS,GAAgB,IAAI,GAAG,EAAE,CAAC;QAE3C;;WAEG;QACK,WAAM,GAAc,IAAI,GAAG,EAAE,CAAC;QAgCtC;;WAEG;QACK,qBAAgB,GAAG,IAAI,GAAG,EAAU,CAAC;QAE7C;;WAEG;QACK,WAAM,GAAG,IAAI,eAAe,EAAQ,CAAC;QAE7C;;WAEG;QACK,qBAAgB,GAAyC,IAAI,MAAM,CACzE,IAAI,CACL,CAAC;QAEM,gBAAW,GAAG,KAAK,CAAC;QA9R1B,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,QAAQ,IAAI,gBAAgB,CAAC,YAAY,EAAE,CAAC;QACrE,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,IAAI,UAAU,CAAC,UAAU,EAAE,CAAC;QAC3D,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,IAAI,CAAC,CAAC;QACrC,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,eAAe,IAAI,KAAK,CAAC;QACzD,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC;QACtB,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;QAEzB,IAAI,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,IAAI,SAAS;QACX,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,sBAAsB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,OAAO;QACL,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAO;SACR;QACD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QAExB,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IACD;;OAEG;IACH,gBAAgB,CAAC,aAA4C;QAC3D,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;IACtC,CAAC;IAED;;OAEG;IACH,kBAAkB,CAChB,OAAmD;QAEnD,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;YACrB,OAAO,CAAC,KAAK,CACX,sHAAsH,CACvH,CAAC;YACF,OAAO,EAAE,CAAC;SACX;QAED,MAAM,oBAAoB,GAAwB,EAAE,CAAC;QAErD,KAAK,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,EAAE;YACrD,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE;gBAC9C,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aAChC;SACF;QAED,OAAO,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjE,CAAC;IAED;;OAEG;IACH,gBAAgB,CACd,OAAmD;QAEnD,MAAM,MAAM,GAAc,IAAI,GAAG,EAAE,CAAC;QAEpC,KAAK,MAAM,CAAC,GAAG,EAAE,aAAa,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE;YACxD,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,aAAa,CAAC,EAAE;gBAC/C,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;aAChC;SACF;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,aAAa;QACjB,IAAI,QAAQ,GAAG,MAAM,gBAAgB,CAAC,WAAW,CAC/C,IAAI,CAAC,SAAS,EACd,EAAE,MAAM,EAAE,KAAK,EAAE,EACjB,IAAI,CAAC,SAAS,CACf,CAAC;QAEF,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAC;QACnC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;YAChB,+BAA+B;YAC/B,uBAAuB;YACvB,IAAI;YACJ,IAAI,IAAI,CAAC,QAAQ,GAAG,CAAC,EAAE;gBACrB,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC;gBACnB,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;aAClE;iBAAM;gBACL,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;gBAC/B,OAAO,CAAC,GAAG,CAAC,iDAAiD,CAAC,CAAC;aAChE;YACD,OAAO;SACR;QAED,IAAI,QAAgC,CAAC;QAErC,IAAI;YACF,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;YACzB,IAAI;gBACF,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;gBAC5B,IAAI,CAAC,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAc,CAAC;aAChE;YAAC,OAAO,GAAG,EAAE;gBACZ,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACnB;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAClB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC/B,OAAO;SACR;QAED,KAAK,IAAI,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YACrC,IAAI,EAAE,GAAsB,GAAwB,CAAC;YACrD,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;gBAC1B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAE,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;aACvD;iBAAM;gBACL,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;aACvC;SACF;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;QAEtC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;YAC5B,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;gBACrB,IAAI,KAAK,GAAG,MAA2B,CAAC;gBACxC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;aAC9B;SACF;QACD,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QACnC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAOD;;OAEG;IACO,cAAc,CACtB,OAAmD,EACnD,IAA0B;QAE1B,6BAA6B;QAC7B,qEAAqE;QACrE,4GAA4G;QAC5G,MAAM,iBAAiB,GAAG,OAAO,CAAC,QAAS,CAAC,iBAAiB,EAAE,CAAC;QAChE,OAAO,IAAI,CAAC,SAAU,CAAC,IAAI,CACzB,CAAC,QAAgB,EAAE,EAAE,CAAC,QAAQ,CAAC,iBAAiB,EAAE,IAAI,iBAAiB,CACxE,CAAC;IACJ,CAAC;IAED;;OAEG;IACO,QAAQ,CAAC,GAAW;QAC5B,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YACnC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC/B,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACnB;IACH,CAAC;IAED;;OAEG;IACO,YAAY,CAAC,CAAoB,EAAE,CAAoB;;QAC/D,MAAM,YAAY,GAAG,EAAE,CAAC;QACxB,MAAM,KAAK,GAAG,MAAA,MAAA,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,0CAAE,IAAI,mCAAI,YAAY,CAAC;QAC3D,MAAM,KAAK,GAAG,MAAA,MAAA,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,0CAAE,IAAI,mCAAI,YAAY,CAAC;QAC3D,IAAI,KAAK,IAAI,KAAK,EAAE;YAClB,IAAI,CAAC,QAAQ,CACX,yBAAyB,CAAC,QAAQ,CAAC,+FAA+F,CACnI,CAAC;YACF,OAAO,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;SAC3B;QACD,sDAAsD;QACtD,OAAO,KAAK,GAAG,KAAK,CAAC;IACvB,CAAC;CA4DF"}

package/lib/plugin.d.ts

@@ -4,37 +4,42 @@
  * and run jlpm build:schema to regenerate this file.
  */
 /**
- * When multiple servers match specific document/language, the server with the highest priority will be used
+ * When multiple servers match specific document/language, the server with the highest rank will be used
  */
-export declare type PriorityOfTheServer = number;
+export declare type RankOfTheServer = number;
 /**
- * Whether to ask server to send logs with execution trace (for debugging). To see these messages, set loggingLevel to debug or log. Accepted values are: "off", "messages", "verbose". Servers are allowed to ignore this request.
+ * Whether to ask server to send logs with execution trace (for debugging). Accepted values are: "off", "messages", "verbose". Servers are allowed to ignore this request.
  */
 export declare type AskServersToSendTraceNotifications = 'off' | 'messages' | 'verbose';
+/**
+ * Enable or disable the logging feature of the language servers.
+ */
+export declare type LogCommunication = boolean;
 /**
  * Language Server Protocol settings.
  */
-export interface LanguageServer {
-    language_servers?: LanguageServer1;
+export interface LanguageServers {
+    languageServers?: LanguageServer;
     setTrace?: AskServersToSendTraceNotifications;
+    logAllCommunication?: LogCommunication;
     [k: string]: any;
 }
 /**
  * Language-server specific configuration, keyed by implementation
  */
-export interface LanguageServer1 {
-    [k: string]: LanguageServer2;
+export interface LanguageServer {
+    [k: string]: LanguageServer1;
 }
 /**
- * This interface was referenced by `LanguageServer1`'s JSON-Schema definition
+ * This interface was referenced by `LanguageServer`'s JSON-Schema definition
  * via the `patternProperty` ".*".
  *
- * This interface was referenced by `LanguageServer`'s JSON-Schema
- * via the `definition` "language-server".
+ * This interface was referenced by `LanguageServers`'s JSON-Schema
+ * via the `definition` "languageServer".
  */
-export interface LanguageServer2 {
-    serverSettings?: LanguageServerConfigurations;
-    priority?: PriorityOfTheServer;
+export interface LanguageServer1 {
+    configuration?: LanguageServerConfigurations;
+    rank?: RankOfTheServer;
     [k: string]: any;
 }
 /**

package/lib/plugin.js

@@ -1,3 +1,4 @@
-/* eslint-disable */
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
 export {};
 //# sourceMappingURL=plugin.js.map

package/lib/plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,oBAAoB"}
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D"}

package/lib/positioning.d.ts

@@ -1,12 +1,24 @@
 import { CodeEditor } from '@jupyterlab/codeeditor';
-import type * as CodeMirror from 'codemirror';
 import type * as lsp from 'vscode-languageserver-protocol';
 /**
- * is_* attributes are there only to enforce strict interface type checking
+ * CM5 position interface.
+ *
+ * TODO: Migrate to offset-only mode once `CodeEditor.IPosition`
+ * is migrated.
  */
-export interface IPosition extends CodeMirror.Position {
+export interface IPosition {
+    /**
+     * Line number
+     */
+    line: number;
+    /**
+     * Position of character in line
+     */
+    ch: number;
 }
-export declare function isEqual(self: IPosition, other: IPosition): boolean;
+/**
+ * is_* attributes are there only to enforce strict interface type checking
+ */
 export interface ISourcePosition extends IPosition {
     isSource: true;
 }
@@ -19,10 +31,35 @@ export interface IVirtualPosition extends IPosition {
 export interface IRootPosition extends ISourcePosition {
     isRoot: true;
 }
+/**
+ * Compare two `IPosition` variable.
+ *
+ */
+export declare function isEqual(self: IPosition, other: IPosition): boolean;
+/**
+ * Given a list of line and an offset from the start, compute the corresponding
+ * position in form of line and column number
+ *
+ * @param offset - number of spaces counted from the start of first line
+ * @param  lines - list of lines to compute the position
+ * @return  - the position of cursor
+ */
 export declare function positionAtOffset(offset: number, lines: string[]): CodeEditor.IPosition;
+/**
+ * Given a list of line and position in form of line and column number,
+ * compute the offset from the start of first line.
+ * @param position - postion of cursor
+ * @param  lines - list of lines to compute the position
+ * @param linesIncludeBreaks - should count the line break as space?
+ * return - offset number
+ */
 export declare function offsetAtPosition(position: CodeEditor.IPosition, lines: string[], linesIncludeBreaks?: boolean): number;
-export declare class PositionError extends Error {
-}
 export declare namespace ProtocolCoordinates {
+    /**
+     * Check if the position is in the input range
+     *
+     * @param position - position in form of line and character number.
+     * @param  range - range in from of start and end position.
+     */
     function isWithinRange(position: lsp.Position, range: lsp.Range): boolean;
 }

package/lib/positioning.js

@@ -1,6 +1,20 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+/**
+ * Compare two `IPosition` variable.
+ *
+ */
 export function isEqual(self, other) {
     return other && self.line === other.line && self.ch === other.ch;
 }
+/**
+ * Given a list of line and an offset from the start, compute the corresponding
+ * position in form of line and column number
+ *
+ * @param offset - number of spaces counted from the start of first line
+ * @param  lines - list of lines to compute the position
+ * @return  - the position of cursor
+ */
 export function positionAtOffset(offset, lines) {
     let line = 0;
     let column = 0;
@@ -17,6 +31,14 @@ export function positionAtOffset(offset, lines) {
     }
     return { line, column };
 }
+/**
+ * Given a list of line and position in form of line and column number,
+ * compute the offset from the start of first line.
+ * @param position - postion of cursor
+ * @param  lines - list of lines to compute the position
+ * @param linesIncludeBreaks - should count the line break as space?
+ * return - offset number
+ */
 export function offsetAtPosition(position, lines, linesIncludeBreaks = false) {
     let breakIncrement = linesIncludeBreaks ? 0 : 1;
     let offset = 0;
@@ -32,10 +54,14 @@ export function offsetAtPosition(position, lines, linesIncludeBreaks = false) {
     }
     return offset;
 }
-export class PositionError extends Error {
-}
 export var ProtocolCoordinates;
 (function (ProtocolCoordinates) {
+    /**
+     * Check if the position is in the input range
+     *
+     * @param position - position in form of line and character number.
+     * @param  range - range in from of start and end position.
+     */
     function isWithinRange(position, range) {
         const { line, character } = position;
         return (line >= range.start.line &&

package/lib/positioning.js.map

@@ -1 +1 @@
-{"version":3,"file":"positioning.js","sourceRoot":"","sources":["../src/positioning.ts"],"names":[],"mappings":"AASA,MAAM,UAAU,OAAO,CAAC,IAAe,EAAE,KAAgB;IACvD,OAAO,KAAK,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,KAAK,KAAK,CAAC,EAAE,CAAC;AACnE,CAAC;AAkBD,MAAM,UAAU,gBAAgB,CAC9B,MAAc,EACd,KAAe;IAEf,IAAI,IAAI,GAAG,CAAC,CAAC;IACb,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,IAAI,QAAQ,IAAI,KAAK,EAAE;QAC1B,oEAAoE;QACpE,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,EAAE;YACjC,MAAM,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;YAC9B,IAAI,IAAI,CAAC,CAAC;SACX;aAAM;YACL,MAAM,GAAG,MAAM,CAAC;YAChB,MAAM;SACP;KACF;IACD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,QAA8B,EAC9B,KAAe,EACf,kBAAkB,GAAG,KAAK;IAE1B,IAAI,cAAc,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAChD,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACrC,IAAI,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACxB,IAAI,QAAQ,CAAC,IAAI,GAAG,CAAC,EAAE;YACrB,MAAM,IAAI,QAAQ,CAAC,MAAM,GAAG,cAAc,CAAC;SAC5C;aAAM;YACL,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC;YAC1B,MAAM;SACP;KACF;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,OAAO,aAAc,SAAQ,KAAK;CAEvC;AAED,MAAM,KAAW,mBAAmB,CAcnC;AAdD,WAAiB,mBAAmB;IAClC,SAAgB,aAAa,CAC3B,QAAsB,EACtB,KAAgB;QAEhB,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,QAAQ,CAAC;QACrC,OAAO,CACL,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI;YACxB,IAAI,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI;YACtB,0FAA0F;YAC1F,CAAC,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,IAAI,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC;YAC/D,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,IAAI,SAAS,IAAI,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAC7D,CAAC;IACJ,CAAC;IAZe,iCAAa,gBAY5B,CAAA;AACH,CAAC,EAdgB,mBAAmB,KAAnB,mBAAmB,QAcnC"}
+{"version":3,"file":"positioning.js","sourceRoot":"","sources":["../src/positioning.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AA0C3D;;;GAGG;AACH,MAAM,UAAU,OAAO,CAAC,IAAe,EAAE,KAAgB;IACvD,OAAO,KAAK,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,KAAK,KAAK,CAAC,EAAE,CAAC;AACnE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAC9B,MAAc,EACd,KAAe;IAEf,IAAI,IAAI,GAAG,CAAC,CAAC;IACb,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,IAAI,QAAQ,IAAI,KAAK,EAAE;QAC1B,oEAAoE;QACpE,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,EAAE;YACjC,MAAM,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;YAC9B,IAAI,IAAI,CAAC,CAAC;SACX;aAAM;YACL,MAAM,GAAG,MAAM,CAAC;YAChB,MAAM;SACP;KACF;IACD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AAC1B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAC9B,QAA8B,EAC9B,KAAe,EACf,kBAAkB,GAAG,KAAK;IAE1B,IAAI,cAAc,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAChD,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACrC,IAAI,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACxB,IAAI,QAAQ,CAAC,IAAI,GAAG,CAAC,EAAE;YACrB,MAAM,IAAI,QAAQ,CAAC,MAAM,GAAG,cAAc,CAAC;SAC5C;aAAM;YACL,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC;YAC1B,MAAM;SACP;KACF;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,KAAW,mBAAmB,CAoBnC;AApBD,WAAiB,mBAAmB;IAClC;;;;;OAKG;IACH,SAAgB,aAAa,CAC3B,QAAsB,EACtB,KAAgB;QAEhB,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,QAAQ,CAAC;QACrC,OAAO,CACL,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI;YACxB,IAAI,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI;YACtB,0FAA0F;YAC1F,CAAC,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,IAAI,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC;YAC/D,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,IAAI,SAAS,IAAI,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAC7D,CAAC;IACJ,CAAC;IAZe,iCAAa,gBAY5B,CAAA;AACH,CAAC,EApBgB,mBAAmB,KAAnB,mBAAmB,QAoBnC"}

package/lib/schema.js

@@ -1,3 +1,4 @@
-/* eslint-disable */
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
 export {};
 //# sourceMappingURL=schema.js.map

package/lib/schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,oBAAoB"}
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D"}