@jupyterlab/fileeditor 4.0.0-alpha.9 → 4.0.0-beta.0

package/lib/toc/python.js

@@ -0,0 +1,116 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+import { TableOfContentsModel } from '@jupyterlab/toc';
+import { EditorTableOfContentsFactory } from './factory';
+/**
+ * Regular expression to create the outline
+ */
+let KEYWORDS;
+try {
+    // https://github.com/tc39/proposal-regexp-match-indices was accepted
+    // in May 2021 (https://github.com/tc39/proposals/blob/main/finished-proposals.md)
+    // So we will fallback to the polyfill regexp-match-indices if not available
+    KEYWORDS = new RegExp('^\\s*(class |def |from |import )', 'd');
+}
+catch (_a) {
+    KEYWORDS = new RegExp('^\\s*(class |def |from |import )');
+}
+/**
+ * Table of content model for Python files.
+ */
+export class PythonTableOfContentsModel extends TableOfContentsModel {
+    /**
+     * Type of document supported by the model.
+     *
+     * #### Notes
+     * A `data-document-type` attribute with this value will be set
+     * on the tree view `.jp-TableOfContents-content[data-document-type="..."]`
+     */
+    get documentType() {
+        return 'python';
+    }
+    /**
+     * Produce the headings for a document.
+     *
+     * @returns The list of new headings or `null` if nothing needs to be updated.
+     */
+    async getHeadings() {
+        if (!this.isActive) {
+            return Promise.resolve(null);
+        }
+        // Split the text into lines:
+        const lines = this.widget.content.model.sharedModel
+            .getSource()
+            .split('\n');
+        // Iterate over the lines to get the heading level and text for each line:
+        let headings = new Array();
+        let processingImports = false;
+        let indent = 1;
+        let lineIdx = -1;
+        for (const line of lines) {
+            lineIdx++;
+            let hasKeyword;
+            if (KEYWORDS.flags.includes('d')) {
+                hasKeyword = KEYWORDS.exec(line);
+            }
+            else {
+                const { default: execWithIndices } = await import('regexp-match-indices');
+                hasKeyword = execWithIndices(KEYWORDS, line);
+            }
+            if (hasKeyword) {
+                // Index 0 contains the spaces, index 1 is the keyword group
+                const [start] = hasKeyword.indices[1];
+                if (indent === 1 && start > 0) {
+                    indent = start;
+                }
+                const isImport = ['from ', 'import '].includes(hasKeyword[1]);
+                if (isImport && processingImports) {
+                    continue;
+                }
+                processingImports = isImport;
+                const level = 1 + start / indent;
+                if (level > this.configuration.maximalDepth) {
+                    continue;
+                }
+                headings.push({
+                    text: line.slice(start),
+                    level,
+                    line: lineIdx
+                });
+            }
+        }
+        return Promise.resolve(headings);
+    }
+}
+/**
+ * Table of content model factory for Python files.
+ */
+export class PythonTableOfContentsFactory extends EditorTableOfContentsFactory {
+    /**
+     * Whether the factory can handle the widget or not.
+     *
+     * @param widget - widget
+     * @returns boolean indicating a ToC can be generated
+     */
+    isApplicable(widget) {
+        var _a, _b;
+        const isApplicable = super.isApplicable(widget);
+        if (isApplicable) {
+            let mime = (_b = (_a = widget.content) === null || _a === void 0 ? void 0 : _a.model) === null || _b === void 0 ? void 0 : _b.mimeType;
+            return (mime &&
+                (mime === 'application/x-python-code' || mime === 'text/x-python'));
+        }
+        return false;
+    }
+    /**
+     * Create a new table of contents model for the widget
+     *
+     * @param widget - widget
+     * @param configuration - Table of contents configuration
+     * @returns The table of contents model
+     */
+    _createNew(widget, configuration) {
+        return new PythonTableOfContentsModel(widget, configuration);
+    }
+}
+//# sourceMappingURL=python.js.map

package/lib/toc/python.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"python.js","sourceRoot":"","sources":["../../src/toc/python.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAK3D,OAAO,EAAmB,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAGxE,OAAO,EAAE,4BAA4B,EAAkB,MAAM,WAAW,CAAC;AAEzE;;GAEG;AACH,IAAI,QAAgB,CAAC;AACrB,IAAI;IACF,qEAAqE;IACrE,kFAAkF;IAClF,4EAA4E;IAC5E,QAAQ,GAAG,IAAI,MAAM,CAAC,kCAAkC,EAAE,GAAG,CAAC,CAAC;CAChE;AAAC,WAAM;IACN,QAAQ,GAAG,IAAI,MAAM,CAAC,kCAAkC,CAAC,CAAC;CAC3D;AAED;;GAEG;AACH,MAAM,OAAO,0BAA2B,SAAQ,oBAG/C;IACC;;;;;;OAMG;IACH,IAAI,YAAY;QACd,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,WAAW;QACzB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SAC9B;QAED,6BAA6B;QAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW;aAChD,SAAS,EAAE;aACX,KAAK,CAAC,IAAI,CAAkB,CAAC;QAEhC,0EAA0E;QAC1E,IAAI,QAAQ,GAAG,IAAI,KAAK,EAAkB,CAAC;QAC3C,IAAI,iBAAiB,GAAG,KAAK,CAAC;QAE9B,IAAI,MAAM,GAAG,CAAC,CAAC;QAEf,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC;QACjB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,OAAO,EAAE,CAAC;YACV,IAAI,UAAkC,CAAC;YACvC,IAAI,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;gBAChC,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAClC;iBAAM;gBACL,MAAM,EAAE,OAAO,EAAE,eAAe,EAAE,GAAG,MAAM,MAAM,CAC/C,sBAAsB,CACvB,CAAC;gBACF,UAAU,GAAG,eAAe,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;aAC9C;YACD,IAAI,UAAU,EAAE;gBACd,4DAA4D;gBAC5D,MAAM,CAAC,KAAK,CAAC,GAAI,UAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAI,MAAM,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE;oBAC7B,MAAM,GAAG,KAAK,CAAC;iBAChB;gBAED,MAAM,QAAQ,GAAG,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC9D,IAAI,QAAQ,IAAI,iBAAiB,EAAE;oBACjC,SAAS;iBACV;gBACD,iBAAiB,GAAG,QAAQ,CAAC;gBAE7B,MAAM,KAAK,GAAG,CAAC,GAAG,KAAK,GAAG,MAAM,CAAC;gBAEjC,IAAI,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE;oBAC3C,SAAS;iBACV;gBAED,QAAQ,CAAC,IAAI,CAAC;oBACZ,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;oBACvB,KAAK;oBACL,IAAI,EAAE,OAAO;iBACd,CAAC,CAAC;aACJ;SACF;QAED,OAAO,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,4BAA6B,SAAQ,4BAA4B;IAC5E;;;;;OAKG;IACH,YAAY,CAAC,MAAc;;QACzB,MAAM,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAEhD,IAAI,YAAY,EAAE;YAChB,IAAI,IAAI,GAAG,MAAA,MAAC,MAAc,CAAC,OAAO,0CAAE,KAAK,0CAAE,QAAQ,CAAC;YACpD,OAAO,CACL,IAAI;gBACJ,CAAC,IAAI,KAAK,2BAA2B,IAAI,IAAI,KAAK,eAAe,CAAC,CACnE,CAAC;SACH;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IACO,UAAU,CAClB,MAAmC,EACnC,aAAuC;QAEvC,OAAO,IAAI,0BAA0B,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC/D,CAAC;CACF"}

package/lib/widget.d.ts

@@ -81,6 +81,10 @@ export declare namespace FileEditor {
          */
         context: DocumentRegistry.CodeContext;
     }
+    /**
+     * File editor default configuration.
+     */
+    const defaultEditorConfig: Record<string, any>;
 }
 /**
  * A widget factory for editors.

package/lib/widget.js

@@ -28,7 +28,10 @@ export class FileEditor extends Widget {
         this._mimeTypeService = options.mimeTypeService;
         const editorWidget = (this._editorWidget = new CodeEditorWrapper({
             factory: options.factory,
-            model: context.model
+            model: context.model,
+            editorOptions: {
+                config: FileEditor.defaultEditorConfig
+            }
         }));
         this._editorWidget.addClass('jp-FileEditorCodeWrapper');
         this._editorWidget.node.dataset[CODE_RUNNER] = 'true';
@@ -39,8 +42,8 @@ export class FileEditor extends Widget {
             this._onContextReady();
         });
         // Listen for changes to the path.
-        context.pathChanged.connect(this._onPathChanged, this);
         this._onPathChanged();
+        context.pathChanged.connect(this._onPathChanged, this);
         const layout = (this.layout = new StackedLayout());
         layout.addWidget(editorWidget);
     }
@@ -54,7 +57,7 @@ export class FileEditor extends Widget {
      * A promise that resolves when the file editor is ready.
      */
     get ready() {
-        return this.ready;
+        return this._ready.promise;
     }
     /**
      * Handle the DOM events for the widget.
@@ -125,9 +128,22 @@ export class FileEditor extends Widget {
     _onPathChanged() {
         const editor = this.editor;
         const localPath = this._context.localPath;
-        editor.model.mimeType = this._mimeTypeService.getMimeTypeByFilePath(localPath);
+        editor.model.mimeType =
+            this._mimeTypeService.getMimeTypeByFilePath(localPath);
     }
 }
+/**
+ * The namespace for editor widget statics.
+ */
+(function (FileEditor) {
+    /**
+     * File editor default configuration.
+     */
+    FileEditor.defaultEditorConfig = {
+        lineNumbers: true,
+        scrollPastEnd: true
+    };
+})(FileEditor || (FileEditor = {}));
 /**
  * A widget factory for editors.
  */
@@ -145,6 +161,7 @@ export class FileEditorFactory extends ABCWidgetFactory {
     createNewWidget(context) {
         const func = this._services.factoryService.newDocumentEditor;
         const factory = options => {
+            // Use same id as document factory
             return func(options);
         };
         const content = new FileEditor({

package/lib/widget.js.map

@@ -1 +1 @@
-{"version":3,"file":"widget.js","sourceRoot":"","sources":["../src/widget.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAE3D,OAAO,EAEL,iBAAiB,EAGlB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,gBAAgB,EAEhB,cAAc,EAEf,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,GAAG,cAAc,CAAC;AAEnC;;GAEG;AACH,MAAM,MAAM,GAAG,UAAU,CAAC;AAE1B;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,MAAM;IACpC;;OAEG;IACH,YAAY,OAA4B;QACtC,KAAK,EAAE,CAAC;QAkIF,WAAM,GAAG,IAAI,eAAe,EAAQ,CAAC;QAjI3C,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;QAE/B,MAAM,OAAO,GAAG,CAAC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;QAClD,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC;QAEhD,MAAM,YAAY,GAAG,CAAC,IAAI,CAAC,aAAa,GAAG,IAAI,iBAAiB,CAAC;YAC/D,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,KAAK,EAAE,OAAO,CAAC,KAAK;SACrB,CAAC,CAAC,CAAC;QACJ,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,0BAA0B,CAAC,CAAC;QACxD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC;QACtD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;QAEjD,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC;QAClC,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC;QAEhC,KAAK,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE;YAC3B,IAAI,CAAC,eAAe,EAAE,CAAC;QACzB,CAAC,CAAC,CAAC;QAEH,kCAAkC;QAClC,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;QACvD,IAAI,CAAC,cAAc,EAAE,CAAC;QAEtB,MAAM,MAAM,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,aAAa,EAAE,CAAC,CAAC;QACnD,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;;;;;;OASG;IACH,WAAW,CAAC,KAAY;QACtB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YACf,OAAO;SACR;QACD,QAAQ,KAAK,CAAC,IAAI,EAAE;YAClB,KAAK,WAAW;gBACd,IAAI,CAAC,YAAY,EAAE,CAAC;gBACpB,MAAM;YACR;gBACE,MAAM;SACT;IACH,CAAC;IAED;;OAEG;IACO,aAAa,CAAC,GAAY;QAClC,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED;;OAEG;IACO,cAAc,CAAC,GAAY;QACnC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,mBAAmB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACO,iBAAiB,CAAC,GAAY;QACtC,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED;;OAEG;IACK,YAAY;QAClB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE;YAC3B,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;SACrB;IACH,CAAC;IAED;;OAEG;IACK,eAAe;QACrB,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,OAAO;SACR;QAED,0EAA0E;QAC1E,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;QAC3B,6BAA6B;QAC7B,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACK,cAAc;QACpB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;QAE1C,MAAM,CAAC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,qBAAqB,CACjE,SAAS,CACV,CAAC;IACJ,CAAC;CAQF;AA2BD;;GAEG;AACH,MAAM,OAAO,iBAAkB,SAAQ,gBAGtC;IACC;;OAEG;IACH,YAAY,OAAmC;QAC7C,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAC9B,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,cAAc,CAAC;IAC1C,CAAC;IAED;;OAEG;IACO,eAAe,CACvB,OAAqC;QAErC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,iBAAiB,CAAC;QAC7D,MAAM,OAAO,GAAuB,OAAO,CAAC,EAAE;YAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC,CAAC;QACF,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC;YAC7B,OAAO;YACP,OAAO;YACP,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,eAAe;SAChD,CAAC,CAAC;QAEH,OAAO,CAAC,KAAK,CAAC,IAAI,GAAG,cAAc,CAAC;QACpC,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;QACxD,OAAO,MAAM,CAAC;IAChB,CAAC;CAGF"}
+{"version":3,"file":"widget.js","sourceRoot":"","sources":["../src/widget.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAE3D,OAAO,EAEL,iBAAiB,EAGlB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,gBAAgB,EAEhB,cAAc,EAEf,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,GAAG,cAAc,CAAC;AAEnC;;GAEG;AACH,MAAM,MAAM,GAAG,UAAU,CAAC;AAE1B;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,MAAM;IACpC;;OAEG;IACH,YAAY,OAA4B;QACtC,KAAK,EAAE,CAAC;QAoIF,WAAM,GAAG,IAAI,eAAe,EAAQ,CAAC;QAnI3C,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;QAE/B,MAAM,OAAO,GAAG,CAAC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;QAClD,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC;QAEhD,MAAM,YAAY,GAAG,CAAC,IAAI,CAAC,aAAa,GAAG,IAAI,iBAAiB,CAAC;YAC/D,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,aAAa,EAAE;gBACb,MAAM,EAAE,UAAU,CAAC,mBAAmB;aACvC;SACF,CAAC,CAAC,CAAC;QACJ,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,0BAA0B,CAAC,CAAC;QACxD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC;QACtD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;QAEjD,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC;QAClC,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC;QAEhC,KAAK,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE;YAC3B,IAAI,CAAC,eAAe,EAAE,CAAC;QACzB,CAAC,CAAC,CAAC;QAEH,kCAAkC;QAClC,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;QAEvD,MAAM,MAAM,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,aAAa,EAAE,CAAC,CAAC;QACnD,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;IAC7B,CAAC;IAED;;;;;;;;;OASG;IACH,WAAW,CAAC,KAAY;QACtB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YACf,OAAO;SACR;QACD,QAAQ,KAAK,CAAC,IAAI,EAAE;YAClB,KAAK,WAAW;gBACd,IAAI,CAAC,YAAY,EAAE,CAAC;gBACpB,MAAM;YACR;gBACE,MAAM;SACT;IACH,CAAC;IAED;;OAEG;IACO,aAAa,CAAC,GAAY;QAClC,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED;;OAEG;IACO,cAAc,CAAC,GAAY;QACnC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,mBAAmB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACO,iBAAiB,CAAC,GAAY;QACtC,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED;;OAEG;IACK,YAAY;QAClB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE;YAC3B,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;SACrB;IACH,CAAC;IAED;;OAEG;IACK,eAAe;QACrB,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,OAAO;SACR;QAED,0EAA0E;QAC1E,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;QAC3B,6BAA6B;QAC7B,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACK,cAAc;QACpB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;QAE1C,MAAM,CAAC,KAAK,CAAC,QAAQ;YACnB,IAAI,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAC;IAC3D,CAAC;CAQF;AAED;;GAEG;AACH,WAAiB,UAAU;IAqBzB;;OAEG;IACU,8BAAmB,GAAwB;QACtD,WAAW,EAAE,IAAI;QACjB,aAAa,EAAE,IAAI;KACpB,CAAC;AACJ,CAAC,EA5BgB,UAAU,KAAV,UAAU,QA4B1B;AAED;;GAEG;AACH,MAAM,OAAO,iBAAkB,SAAQ,gBAGtC;IACC;;OAEG;IACH,YAAY,OAAmC;QAC7C,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAC9B,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,cAAc,CAAC;IAC1C,CAAC;IAED;;OAEG;IACO,eAAe,CACvB,OAAqC;QAErC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,iBAAiB,CAAC;QAC7D,MAAM,OAAO,GAAuB,OAAO,CAAC,EAAE;YAC5C,kCAAkC;YAClC,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC,CAAC;QACF,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC;YAC7B,OAAO;YACP,OAAO;YACP,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,eAAe;SAChD,CAAC,CAAC;QAEH,OAAO,CAAC,KAAK,CAAC,IAAI,GAAG,cAAc,CAAC;QACpC,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;QACxD,OAAO,MAAM,CAAC;IAChB,CAAC;CAGF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyterlab/fileeditor",
-  "version": "4.0.0-alpha.9",
+  "version": "4.0.0-beta.0",
   "description": "JupyterLab - Editor Widget",
   "homepage": "https://github.com/jupyterlab/jupyterlab",
   "bugs": {
@@ -23,11 +23,10 @@
     "lib": "lib/"
   },
   "files": [
-    "lib/*.d.ts",
-    "lib/*.js.map",
-    "lib/*.js",
+    "lib/**/*.{d.ts,js,js.map}",
     "style/*.css",
-    "style/index.js"
+    "style/index.js",
+    "src/**/*.{ts,tsx}"
   ],
   "scripts": {
     "build": "tsc -b",
@@ -41,25 +40,31 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyterlab/apputils": "^4.0.0-alpha.9",
-    "@jupyterlab/codeeditor": "^4.0.0-alpha.9",
-    "@jupyterlab/docregistry": "^4.0.0-alpha.9",
-    "@jupyterlab/statusbar": "^4.0.0-alpha.9",
-    "@jupyterlab/translation": "^4.0.0-alpha.9",
-    "@jupyterlab/ui-components": "^4.0.0-alpha.24",
-    "@lumino/coreutils": "^1.12.0",
-    "@lumino/messaging": "^1.10.1",
-    "@lumino/widgets": "^1.31.1",
-    "react": "^17.0.1"
+    "@jupyterlab/apputils": "^4.0.0-beta.0",
+    "@jupyterlab/codeeditor": "^4.0.0-beta.0",
+    "@jupyterlab/codemirror": "^4.0.0-beta.0",
+    "@jupyterlab/coreutils": "^6.0.0-beta.0",
+    "@jupyterlab/docregistry": "^4.0.0-beta.0",
+    "@jupyterlab/documentsearch": "^4.0.0-beta.0",
+    "@jupyterlab/lsp": "^4.0.0-beta.0",
+    "@jupyterlab/statusbar": "^4.0.0-beta.0",
+    "@jupyterlab/toc": "^6.0.0-beta.0",
+    "@jupyterlab/translation": "^4.0.0-beta.0",
+    "@jupyterlab/ui-components": "^4.0.0-beta.0",
+    "@lumino/commands": "^2.0.0",
+    "@lumino/coreutils": "^2.0.0",
+    "@lumino/messaging": "^2.0.0",
+    "@lumino/widgets": "^2.0.0",
+    "react": "^18.2.0",
+    "regexp-match-indices": "^1.0.2"
   },
   "devDependencies": {
-    "@jupyterlab/testutils": "^4.0.0-alpha.9",
-    "@types/jest": "^26.0.10",
-    "jest": "^26.4.2",
+    "@jupyterlab/testing": "^4.0.0-beta.0",
+    "@types/jest": "^29.2.0",
+    "jest": "^29.2.0",
     "rimraf": "~3.0.0",
-    "ts-jest": "^26.3.0",
-    "typedoc": "~0.22.10",
-    "typescript": "~4.6.3"
+    "typedoc": "~0.23.25",
+    "typescript": "~5.0.2"
   },
   "publishConfig": {
     "access": "public"

package/src/fileeditorlspadapter.ts

@@ -0,0 +1,225 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+
+import { CodeMirrorEditor } from '@jupyterlab/codemirror';
+import { DocumentRegistry, IDocumentWidget } from '@jupyterlab/docregistry';
+import {
+  Document,
+  IAdapterOptions,
+  IVirtualPosition,
+  VirtualDocument,
+  WidgetLSPAdapter
+} from '@jupyterlab/lsp';
+import { PromiseDelegate } from '@lumino/coreutils';
+
+import { FileEditor } from './widget';
+
+export interface IFileEditorAdapterOptions extends IAdapterOptions {
+  /**
+   * The document registry instance.
+   */
+  docRegistry: DocumentRegistry;
+}
+
+export class FileEditorAdapter extends WidgetLSPAdapter<
+  IDocumentWidget<FileEditor>
+> {
+  constructor(
+    editorWidget: IDocumentWidget<FileEditor>,
+    options: IFileEditorAdapterOptions
+  ) {
+    const { docRegistry, ...others } = options;
+    super(editorWidget, others);
+    this.editor = editorWidget.content;
+    this._docRegistry = docRegistry;
+
+    // Ensure editor uniqueness
+    this._virtualEditor = Object.freeze({
+      getEditor: () => this.editor.editor,
+      ready: () => Promise.resolve(this.editor.editor),
+      reveal: () => Promise.resolve(this.editor.editor)
+    });
+
+    Promise.all([this.editor.context.ready, this.connectionManager.ready])
+      .then(async () => {
+        await this.initOnceReady();
+        this._readyDelegate.resolve();
+      })
+      .catch(console.error);
+  }
+
+  /**
+   * The wrapped `FileEditor` widget.
+   */
+  readonly editor: FileEditor;
+
+  /**
+   * Promise that resolves once the adapter is initialized
+   */
+  get ready(): Promise<void> {
+    return this._readyDelegate.promise;
+  }
+
+  /**
+   * Get current path of the document.
+   */
+  get documentPath(): string {
+    return this.widget.context.path;
+  }
+
+  /**
+   * Get the mime type of the document.
+   */
+  get mimeType(): string {
+    const mimeTypeFromModel = this.editor.model.mimeType;
+    const codeMirrorMimeType: string = Array.isArray(mimeTypeFromModel)
+      ? mimeTypeFromModel[0] ?? 'text/plain'
+      : mimeTypeFromModel;
+    const contentsModel = this.editor.context.contentsModel;
+
+    // when MIME type is not known it defaults to 'text/plain',
+    // so if it is different we can accept it as it is
+    if (codeMirrorMimeType != 'text/plain') {
+      return codeMirrorMimeType;
+    } else if (contentsModel) {
+      // a script that does not have a MIME type known by the editor
+      // (no syntax highlight mode), can still be known by the document
+      // registry (and this is arguably easier to extend).
+      let fileType = this._docRegistry.getFileTypeForModel(contentsModel);
+      return fileType.mimeTypes[0];
+    } else {
+      // "text/plain" this is
+      return codeMirrorMimeType;
+    }
+  }
+
+  /**
+   * Get the file extension of the document.
+   */
+  get languageFileExtension(): string {
+    let parts = this.documentPath.split('.');
+    return parts[parts.length - 1];
+  }
+
+  /**
+   * Get the CM editor
+   */
+  get ceEditor(): CodeMirrorEditor {
+    return this.editor.editor as CodeMirrorEditor;
+  }
+
+  /**
+   * Get the activated CM editor.
+   */
+  get activeEditor(): Document.IEditor {
+    return this._virtualEditor;
+  }
+
+  /**
+   * Get the inner HTMLElement of the document widget.
+   */
+  get wrapperElement(): HTMLElement {
+    return this.widget.node;
+  }
+
+  /**
+   * Get current path of the document.
+   */
+  get path(): string {
+    return this.widget.context.path;
+  }
+
+  /**
+   *  Get the list of CM editors in the document, there is only one editor
+   * in the case of file editor.
+   */
+  get editors(): Document.ICodeBlockOptions[] {
+    return [
+      {
+        ceEditor: this._virtualEditor,
+        type: 'code',
+        value: this.editor?.model.sharedModel.getSource() ?? ''
+      }
+    ];
+  }
+
+  /**
+   * Dispose the widget.
+   */
+  dispose(): void {
+    if (this.isDisposed) {
+      return;
+    }
+    this.editor.model.mimeTypeChanged.disconnect(this.reloadConnection);
+    super.dispose();
+  }
+
+  /**
+   * Generate the virtual document associated with the document.
+   */
+  createVirtualDocument(): VirtualDocument {
+    return new VirtualDocument({
+      language: this.language,
+      foreignCodeExtractors: this.options.foreignCodeExtractorsManager,
+      path: this.documentPath,
+      fileExtension: this.languageFileExtension,
+      // notebooks are continuous, each cell is dependent on the previous one
+      standalone: true,
+      // notebooks are not supported by LSP servers
+      hasLspSupportedFile: true
+    });
+  }
+
+  /**
+   * Get the index of editor from the cursor position in the virtual
+   * document. Since there is only one editor, this method always return
+   * 0
+   *
+   * @param position - the position of cursor in the virtual document.
+   * @return  {number} - index of the virtual editor
+   */
+  getEditorIndexAt(position: IVirtualPosition): number {
+    return 0;
+  }
+
+  /**
+   * Get the index of input editor
+   *
+   * @param ceEditor - instance of the code editor
+   */
+  getEditorIndex(ceEditor: Document.IEditor): number {
+    return 0;
+  }
+
+  /**
+   * Get the wrapper of input editor.
+   *
+   * @param ceEditor
+   * @return  {HTMLElement}
+   */
+  getEditorWrapper(ceEditor: Document.IEditor): HTMLElement {
+    return this.wrapperElement;
+  }
+
+  /**
+   * Initialization function called once the editor and the LSP connection
+   * manager is ready. This function will create the virtual document and
+   * connect various signals.
+   */
+  protected async initOnceReady(): Promise<void> {
+    this.initVirtual();
+
+    // connect the document, but do not open it as the adapter will handle this
+    // after registering all features
+    await this.connectDocument(this.virtualDocument!, false);
+
+    this.editor.model.mimeTypeChanged.connect(this.reloadConnection, this);
+  }
+
+  /**
+   * The document registry instance.
+   */
+  private readonly _docRegistry: DocumentRegistry;
+  private readonly _virtualEditor: Document.IEditor;
+  private _readyDelegate = new PromiseDelegate<void>();
+}

package/src/index.ts

@@ -0,0 +1,14 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+/**
+ * @packageDocumentation
+ * @module fileeditor
+ */
+
+export * from './fileeditorlspadapter';
+export * from './searchprovider';
+export * from './syntaxstatus';
+export * from './tabspacestatus';
+export * from './toc';
+export * from './tokens';
+export * from './widget';

package/src/searchprovider.ts

@@ -0,0 +1,115 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+
+import { MainAreaWidget } from '@jupyterlab/apputils';
+import { CodeMirrorEditor, EditorSearchProvider } from '@jupyterlab/codemirror';
+import { CodeEditor } from '@jupyterlab/codeeditor';
+import {
+  IFilters,
+  IReplaceOptionsSupport,
+  ISearchProvider
+} from '@jupyterlab/documentsearch';
+import { ITranslator } from '@jupyterlab/translation';
+import { Widget } from '@lumino/widgets';
+import { FileEditor } from './widget';
+
+/**
+ * Helper type
+ */
+export type FileEditorPanel = MainAreaWidget<FileEditor>;
+
+/**
+ * File editor search provider
+ */
+export class FileEditorSearchProvider
+  extends EditorSearchProvider<CodeEditor.IModel>
+  implements ISearchProvider
+{
+  /**
+   * Constructor
+   * @param widget File editor panel
+   */
+  constructor(protected widget: FileEditorPanel) {
+    super();
+  }
+
+  get isReadOnly(): boolean {
+    return this.editor.getOption('readOnly') as boolean;
+  }
+
+  /**
+   * Support for options adjusting replacement behavior.
+   */
+  get replaceOptionsSupport(): IReplaceOptionsSupport {
+    return {
+      preserveCase: true
+    };
+  }
+
+  /**
+   * Text editor
+   */
+  get editor() {
+    return this.widget.content.editor as CodeMirrorEditor;
+  }
+
+  /**
+   * Editor content model
+   */
+  get model(): CodeEditor.IModel {
+    return this.widget.content.model;
+  }
+
+  async startQuery(
+    query: RegExp,
+    filters: IFilters | undefined
+  ): Promise<void> {
+    await super.startQuery(query, filters);
+    await this.highlightNext(false, true);
+  }
+
+  /**
+   * Instantiate a search provider for the widget.
+   *
+   * #### Notes
+   * The widget provided is always checked using `isApplicable` before calling
+   * this factory.
+   *
+   * @param widget The widget to search on
+   * @param translator [optional] The translator object
+   *
+   * @returns The search provider on the widget
+   */
+  static createNew(
+    widget: FileEditorPanel,
+    translator?: ITranslator
+  ): ISearchProvider {
+    return new FileEditorSearchProvider(widget);
+  }
+
+  /**
+   * Report whether or not this provider has the ability to search on the given object
+   */
+  static isApplicable(domain: Widget): domain is FileEditorPanel {
+    return (
+      domain instanceof MainAreaWidget &&
+      domain.content instanceof FileEditor &&
+      domain.content.editor instanceof CodeMirrorEditor
+    );
+  }
+
+  /**
+   * Get an initial query value if applicable so that it can be entered
+   * into the search box as an initial query
+   *
+   * @returns Initial value used to populate the search box.
+   */
+  getInitialQuery(): string {
+    const cm = this.editor as CodeMirrorEditor;
+    const selection = cm.state.sliceDoc(
+      cm.state.selection.main.from,
+      cm.state.selection.main.to
+    );
+    return selection;
+  }
+}