@jupyterlab/fileeditor-extension 4.0.0-alpha.19 → 4.0.0-alpha.20

package/lib/commands.d.ts

@@ -1,10 +1,11 @@
 import { JupyterFrontEnd } from '@jupyterlab/application';
 import { ICommandPalette, ISessionContextDialogs, MainAreaWidget, WidgetTracker } from '@jupyterlab/apputils';
 import { CodeViewerWidget, IEditorServices } from '@jupyterlab/codeeditor';
+import { IEditorExtensionRegistry, IEditorLanguageRegistry, IEditorThemeRegistry } from '@jupyterlab/codemirror';
 import { ICompletionProviderManager } from '@jupyterlab/completer';
 import { IConsoleTracker } from '@jupyterlab/console';
 import { IDocumentWidget } from '@jupyterlab/docregistry';
-import { IDefaultFileBrowser, IFileBrowserFactory } from '@jupyterlab/filebrowser';
+import { IDefaultFileBrowser } from '@jupyterlab/filebrowser';
 import { FileEditor, IEditorTracker } from '@jupyterlab/fileeditor';
 import { ILauncher } from '@jupyterlab/launcher';
 import { IMainMenu } from '@jupyterlab/mainmenu';
@@ -43,6 +44,10 @@ export declare namespace CommandIDs {
     const invokeCompleter = "completer:invoke-file";
     const selectCompleter = "completer:select-file";
     const openCodeViewer = "code-viewer:open";
+    const changeTheme = "fileeditor:change-theme";
+    const changeLanguage = "fileeditor:change-language";
+    const find = "fileeditor:find";
+    const goToLine = "fileeditor:go-to-line";
 }
 export interface IFileTypeData extends ReadonlyJSONObject {
     fileExt: string;
@@ -76,7 +81,7 @@ export declare namespace Commands {
     /**
      * Wrapper function for adding the default File Editor commands
      */
-    function addCommands(commands: CommandRegistry, settingRegistry: ISettingRegistry, trans: TranslationBundle, id: string, isEnabled: () => boolean, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, defaultBrowser: IDefaultFileBrowser, browserFactory: IFileBrowserFactory, consoleTracker: IConsoleTracker | null, sessionDialogs: ISessionContextDialogs | null): void;
+    function addCommands(commands: CommandRegistry, settingRegistry: ISettingRegistry, trans: TranslationBundle, id: string, isEnabled: () => boolean, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, defaultBrowser: IDefaultFileBrowser, extensions: IEditorExtensionRegistry, languages: IEditorLanguageRegistry, themes: IEditorThemeRegistry, consoleTracker: IConsoleTracker | null, sessionDialogs: ISessionContextDialogs | null, mainMenu: IMainMenu | null): void;
     function addCompleterCommands(commands: CommandRegistry, editorTracker: IEditorTracker, manager: ICompletionProviderManager, translator: ITranslator | null): void;
     /**
      * Wrapper function for adding the default launcher items for File Editor

package/lib/commands.js

@@ -1,12 +1,13 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
+import { selectAll } from '@codemirror/commands';
+import { findNext, gotoLine } from '@codemirror/search';
 import { Clipboard, MainAreaWidget, sessionContextDialogs } from '@jupyterlab/apputils';
-import { CodeEditor, CodeViewerWidget } from '@jupyterlab/codeeditor';
+import { CodeViewerWidget } from '@jupyterlab/codeeditor';
 import { MarkdownCodeBlocks, PathExt } from '@jupyterlab/coreutils';
 import { nullTranslator } from '@jupyterlab/translation';
 import { consoleIcon, copyIcon, cutIcon, LabIcon, markdownIcon, pasteIcon, redoIcon, textEditorIcon, undoIcon } from '@jupyterlab/ui-components';
 import { find } from '@lumino/algorithm';
-import { selectAll } from '@codemirror/commands';
 const autoClosingBracketsNotebook = 'notebook:toggle-autoclosing-brackets';
 const autoClosingBracketsConsole = 'console:toggle-autoclosing-brackets';
 /**
@@ -41,57 +42,37 @@ export var CommandIDs;
     CommandIDs.invokeCompleter = 'completer:invoke-file';
     CommandIDs.selectCompleter = 'completer:select-file';
     CommandIDs.openCodeViewer = 'code-viewer:open';
+    CommandIDs.changeTheme = 'fileeditor:change-theme';
+    CommandIDs.changeLanguage = 'fileeditor:change-language';
+    CommandIDs.find = 'fileeditor:find';
+    CommandIDs.goToLine = 'fileeditor:go-to-line';
 })(CommandIDs || (CommandIDs = {}));
 /**
  * The name of the factory that creates editor widgets.
  */
 export const FACTORY = 'Editor';
-const userSettings = [
-    'autoClosingBrackets',
-    'codeFolding',
-    'cursorBlinkRate',
-    'fontFamily',
-    'fontSize',
-    'insertSpaces',
-    'lineHeight',
-    'lineNumbers',
-    'lineWrap',
-    'matchBrackets',
-    'readOnly',
-    'rulers',
-    'showTrailingSpace',
-    'tabSize',
-    'wordWrapColumn'
-];
-function filterUserSettings(config) {
-    const filteredConfig = { ...config };
-    // Delete parts of the config that are not user settings (like handlePaste).
-    for (let k of Object.keys(config)) {
-        if (!userSettings.includes(k)) {
-            delete config[k];
-        }
-    }
-    return filteredConfig;
-}
-let config = filterUserSettings(CodeEditor.defaultConfig);
 /**
  * A utility class for adding commands and menu items,
  * for use by the File Editor extension or other Editor extensions.
  */
 export var Commands;
 (function (Commands) {
+    let config = {};
+    let scrollPastEnd = true;
     /**
      * Accessor function that returns the createConsole function for use by Create Console commands
      */
-    function getCreateConsoleFunction(commands) {
+    function getCreateConsoleFunction(commands, languages) {
         return async function createConsole(widget, args) {
-            var _a;
+            var _a, _b, _c;
             const options = args || {};
             const console = await commands.execute('console:create', {
                 activate: options['activate'],
                 name: (_a = widget.context.contentsModel) === null || _a === void 0 ? void 0 : _a.name,
                 path: widget.context.path,
-                preferredLanguage: widget.context.model.defaultKernelLanguage,
+                // Default value is an empty string -> using OR operator
+                preferredLanguage: widget.context.model.defaultKernelLanguage ||
+                    ((_c = (_b = languages.findByFileName(widget.context.path)) === null || _b === void 0 ? void 0 : _b.name) !== null && _c !== void 0 ? _c : ''),
                 ref: widget.id,
                 insertMode: 'split-bottom'
             });
@@ -106,12 +87,20 @@ export var Commands;
      * Update the setting values.
      */
     function updateSettings(settings, commands) {
-        config = filterUserSettings({
-            ...CodeEditor.defaultConfig,
-            ...settings.get('editorConfig').composite
-        });
+        var _a;
+        config =
+            (_a = settings.get('editorConfig').composite) !== null && _a !== void 0 ? _a : {};
+        scrollPastEnd = settings.get('scrollPasteEnd').composite;
         // Trigger a refresh of the rendered commands
-        commands.notifyCommandChanged();
+        commands.notifyCommandChanged(CommandIDs.lineNumbers);
+        commands.notifyCommandChanged(CommandIDs.currentLineNumbers);
+        commands.notifyCommandChanged(CommandIDs.lineWrap);
+        commands.notifyCommandChanged(CommandIDs.currentLineWrap);
+        commands.notifyCommandChanged(CommandIDs.changeTabs);
+        commands.notifyCommandChanged(CommandIDs.matchBrackets);
+        commands.notifyCommandChanged(CommandIDs.currentMatchBrackets);
+        commands.notifyCommandChanged(CommandIDs.autoClosingBrackets);
+        commands.notifyCommandChanged(CommandIDs.changeLanguage);
     }
     Commands.updateSettings = updateSettings;
     /**
@@ -129,18 +118,19 @@ export var Commands;
      */
     function updateWidget(widget) {
         const editor = widget.editor;
-        editor.setOptions({ ...config });
+        editor.setOptions({ ...config, scrollPastEnd });
     }
     Commands.updateWidget = updateWidget;
     /**
      * Wrapper function for adding the default File Editor commands
      */
-    function addCommands(commands, settingRegistry, trans, id, isEnabled, tracker, defaultBrowser, browserFactory, consoleTracker, sessionDialogs) {
+    function addCommands(commands, settingRegistry, trans, id, isEnabled, tracker, defaultBrowser, extensions, languages, themes, consoleTracker, sessionDialogs, mainMenu) {
         /**
          * Add a command to change font size for File Editor
          */
         commands.addCommand(CommandIDs.changeFontSize, {
             execute: args => {
+                var _a;
                 const delta = Number(args['delta']);
                 if (Number.isNaN(delta)) {
                     console.error(`${CommandIDs.changeFontSize}: delta arg must be a number`);
@@ -148,7 +138,8 @@ export var Commands;
                 }
                 const style = window.getComputedStyle(document.documentElement);
                 const cssSize = parseInt(style.getPropertyValue('--jp-code-font-size'), 10);
-                const currentSize = config.fontSize || cssSize;
+                const currentSize = ((_a = config['customStyles']['fontSize']) !== null && _a !== void 0 ? _a : extensions.baseConfiguration['customStyles']['fontSize']) ||
+                    cssSize;
                 config.fontSize = currentSize + delta;
                 return settingRegistry
                     .set(id, 'editorConfig', config)
@@ -157,8 +148,11 @@ export var Commands;
                 });
             },
             label: args => {
-                var _a;
-                if (((_a = args.delta) !== null && _a !== void 0 ? _a : 0) > 0) {
+                const delta = Number(args['delta']);
+                if (Number.isNaN(delta)) {
+                    console.error(`${CommandIDs.changeFontSize}: delta arg must be a number`);
+                }
+                if (delta > 0) {
                     return args.isMenu
                         ? trans.__('Increase Text Editor Font Size')
                         : trans.__('Increase Font Size');
@@ -174,20 +168,23 @@ export var Commands;
          * Add the Line Numbers command
          */
         commands.addCommand(CommandIDs.lineNumbers, {
-            execute: () => {
-                config.lineNumbers = !config.lineNumbers;
-                return settingRegistry
-                    .set(id, 'editorConfig', config)
-                    .catch((reason) => {
+            execute: async () => {
+                var _a;
+                config.lineNumbers = !((_a = config.lineNumbers) !== null && _a !== void 0 ? _a : extensions.baseConfiguration.lineNumbers);
+                try {
+                    return await settingRegistry.set(id, 'editorConfig', config);
+                }
+                catch (reason) {
                     console.error(`Failed to set ${id}: ${reason.message}`);
-                });
+                }
             },
             isEnabled,
-            isToggled: () => config.lineNumbers,
-            label: trans.__('Line Numbers')
+            isToggled: () => { var _a; return (_a = config.lineNumbers) !== null && _a !== void 0 ? _a : extensions.baseConfiguration.lineNumbers; },
+            label: trans.__('Show Line Numbers')
         });
         commands.addCommand(CommandIDs.currentLineNumbers, {
             label: trans.__('Show Line Numbers'),
+            caption: trans.__('Show the line numbers for the current file.'),
             execute: () => {
                 const widget = tracker.currentWidget;
                 if (!widget) {
@@ -200,44 +197,48 @@ export var Commands;
             isToggled: () => {
                 var _a;
                 const widget = tracker.currentWidget;
-                return (_a = widget === null || widget === void 0 ? void 0 : widget.content.editor.getOption('lineNumbers')) !== null && _a !== void 0 ? _a : false;
+                return ((_a = widget === null || widget === void 0 ? void 0 : widget.content.editor.getOption('lineNumbers')) !== null && _a !== void 0 ? _a : false);
             }
         });
         /**
          * Add the Word Wrap command
          */
         commands.addCommand(CommandIDs.lineWrap, {
-            execute: args => {
-                config.lineWrap = args['mode'] || 'off';
-                return settingRegistry
-                    .set(id, 'editorConfig', config)
-                    .catch((reason) => {
+            execute: async (args) => {
+                var _a;
+                config.lineWrap = (_a = args['mode']) !== null && _a !== void 0 ? _a : false;
+                try {
+                    return await settingRegistry.set(id, 'editorConfig', config);
+                }
+                catch (reason) {
                     console.error(`Failed to set ${id}: ${reason.message}`);
-                });
+                }
             },
             isEnabled,
             isToggled: args => {
-                const lineWrap = args['mode'] || 'off';
-                return config.lineWrap === lineWrap;
+                var _a, _b;
+                const lineWrap = (_a = args['mode']) !== null && _a !== void 0 ? _a : false;
+                return (lineWrap ===
+                    ((_b = config.lineWrap) !== null && _b !== void 0 ? _b : extensions.baseConfiguration.lineWrap));
             },
             label: trans.__('Word Wrap')
         });
         commands.addCommand(CommandIDs.currentLineWrap, {
             label: trans.__('Wrap Words'),
+            caption: trans.__('Wrap words for the current file.'),
             execute: () => {
                 const widget = tracker.currentWidget;
                 if (!widget) {
                     return;
                 }
                 const oldValue = widget.content.editor.getOption('lineWrap');
-                const newValue = oldValue === 'off' ? 'on' : 'off';
-                widget.content.editor.setOption('lineWrap', newValue);
+                widget.content.editor.setOption('lineWrap', !oldValue);
             },
             isEnabled,
             isToggled: () => {
                 var _a;
                 const widget = tracker.currentWidget;
-                return (_a = (widget === null || widget === void 0 ? void 0 : widget.content.editor.getOption('lineWrap')) !== 'off') !== null && _a !== void 0 ? _a : false;
+                return ((_a = widget === null || widget === void 0 ? void 0 : widget.content.editor.getOption('lineWrap')) !== null && _a !== void 0 ? _a : false);
             }
         });
         /**
@@ -246,46 +247,55 @@ export var Commands;
         commands.addCommand(CommandIDs.changeTabs, {
             label: args => {
                 var _a;
-                if (args.insertSpaces) {
-                    return trans.__('Spaces: %1', (_a = args.size) !== null && _a !== void 0 ? _a : 0);
+                if (args.size) {
+                    return trans.__('Spaces: %1', (_a = args.size) !== null && _a !== void 0 ? _a : '');
                 }
                 else {
                     return trans.__('Indent with Tab');
                 }
             },
-            execute: args => {
-                config.tabSize = args['size'] || 4;
-                config.insertSpaces = !!args['insertSpaces'];
-                return settingRegistry
-                    .set(id, 'editorConfig', config)
-                    .catch((reason) => {
+            execute: async (args) => {
+                var _a;
+                config.indentUnit =
+                    args['size'] !== undefined
+                        ? ((_a = args['size']) !== null && _a !== void 0 ? _a : '4').toString()
+                        : 'Tab';
+                try {
+                    return await settingRegistry.set(id, 'editorConfig', config);
+                }
+                catch (reason) {
                     console.error(`Failed to set ${id}: ${reason.message}`);
-                });
+                }
             },
             isToggled: args => {
-                const insertSpaces = !!args['insertSpaces'];
-                const size = args['size'] || 4;
-                return config.insertSpaces === insertSpaces && config.tabSize === size;
+                var _a;
+                const currentIndentUnit = (_a = config.indentUnit) !== null && _a !== void 0 ? _a : extensions.baseConfiguration.indentUnit;
+                return args['size']
+                    ? args['size'] === currentIndentUnit
+                    : 'Tab' == currentIndentUnit;
             }
         });
         /**
          * Add the Match Brackets command
          */
         commands.addCommand(CommandIDs.matchBrackets, {
-            execute: () => {
-                config.matchBrackets = !config.matchBrackets;
-                return settingRegistry
-                    .set(id, 'editorConfig', config)
-                    .catch((reason) => {
+            execute: async () => {
+                var _a;
+                config.matchBrackets = !((_a = config.matchBrackets) !== null && _a !== void 0 ? _a : extensions.baseConfiguration.matchBrackets);
+                try {
+                    return await settingRegistry.set(id, 'editorConfig', config);
+                }
+                catch (reason) {
                     console.error(`Failed to set ${id}: ${reason.message}`);
-                });
+                }
             },
             label: trans.__('Match Brackets'),
             isEnabled,
-            isToggled: () => config.matchBrackets
+            isToggled: () => { var _a; return (_a = config.matchBrackets) !== null && _a !== void 0 ? _a : extensions.baseConfiguration.matchBrackets; }
         });
         commands.addCommand(CommandIDs.currentMatchBrackets, {
             label: trans.__('Match Brackets'),
+            caption: trans.__('Change match brackets for the current file.'),
             execute: () => {
                 const widget = tracker.currentWidget;
                 if (!widget) {
@@ -298,24 +308,28 @@ export var Commands;
             isToggled: () => {
                 var _a;
                 const widget = tracker.currentWidget;
-                return (_a = widget === null || widget === void 0 ? void 0 : widget.content.editor.getOption('matchBrackets')) !== null && _a !== void 0 ? _a : false;
+                return ((_a = widget === null || widget === void 0 ? void 0 : widget.content.editor.getOption('matchBrackets')) !== null && _a !== void 0 ? _a : false);
             }
         });
         /**
          * Add the Auto Close Brackets for Text Editor command
          */
         commands.addCommand(CommandIDs.autoClosingBrackets, {
-            execute: args => {
-                var _a;
-                config.autoClosingBrackets = !!((_a = args['force']) !== null && _a !== void 0 ? _a : !config.autoClosingBrackets);
-                return settingRegistry
-                    .set(id, 'editorConfig', config)
-                    .catch((reason) => {
+            execute: async (args) => {
+                var _a, _b;
+                config.autoClosingBrackets = !!((_a = args['force']) !== null && _a !== void 0 ? _a : !((_b = config.autoClosingBrackets) !== null && _b !== void 0 ? _b : extensions.baseConfiguration.autoClosingBrackets));
+                try {
+                    return await settingRegistry.set(id, 'editorConfig', config);
+                }
+                catch (reason) {
                     console.error(`Failed to set ${id}: ${reason.message}`);
-                });
+                }
             },
             label: trans.__('Auto Close Brackets in Text Editor'),
-            isToggled: () => config.autoClosingBrackets
+            isToggled: () => {
+                var _a;
+                return (_a = config.autoClosingBrackets) !== null && _a !== void 0 ? _a : extensions.baseConfiguration.autoClosingBrackets;
+            }
         });
         commands.addCommand(CommandIDs.autoClosingBracketsUniversal, {
             execute: () => {
@@ -344,6 +358,87 @@ export var Commands;
                 commands.isToggled(autoClosingBracketsNotebook) ||
                 commands.isToggled(autoClosingBracketsConsole)
         });
+        /**
+         * Create a menu for the editor.
+         */
+        commands.addCommand(CommandIDs.changeTheme, {
+            label: args => {
+                var _a, _b, _c, _d;
+                return (_d = (_c = (_b = ((_a = args.displayName) !== null && _a !== void 0 ? _a : args.theme)) !== null && _b !== void 0 ? _b : config.theme) !== null && _c !== void 0 ? _c : extensions.baseConfiguration.theme) !== null && _d !== void 0 ? _d : trans.__('Editor Theme');
+            },
+            execute: async (args) => {
+                var _a;
+                config.theme = (_a = args['theme']) !== null && _a !== void 0 ? _a : config.theme;
+                try {
+                    return await settingRegistry.set(id, 'editorConfig', config);
+                }
+                catch (reason) {
+                    console.error(`Failed to set theme - ${reason.message}`);
+                }
+            },
+            isToggled: args => { var _a; return args['theme'] === ((_a = config.theme) !== null && _a !== void 0 ? _a : extensions.baseConfiguration.theme); }
+        });
+        commands.addCommand(CommandIDs.find, {
+            label: trans.__('Find…'),
+            execute: () => {
+                const widget = tracker.currentWidget;
+                if (!widget) {
+                    return;
+                }
+                const editor = widget.content.editor;
+                editor.execCommand(findNext);
+            },
+            isEnabled
+        });
+        commands.addCommand(CommandIDs.goToLine, {
+            label: trans.__('Go to Line…'),
+            execute: args => {
+                const widget = tracker.currentWidget;
+                if (!widget) {
+                    return;
+                }
+                const editor = widget.content.editor;
+                const line = args['line'];
+                const column = args['column'];
+                if (line !== undefined || column !== undefined) {
+                    editor.setCursorPosition({
+                        line: (line !== null && line !== void 0 ? line : 1) - 1,
+                        column: (column !== null && column !== void 0 ? column : 1) - 1
+                    });
+                }
+                else {
+                    editor.execCommand(gotoLine);
+                }
+            },
+            isEnabled
+        });
+        commands.addCommand(CommandIDs.changeLanguage, {
+            label: args => {
+                var _a, _b;
+                return (_b = ((_a = args['displayName']) !== null && _a !== void 0 ? _a : args['name'])) !== null && _b !== void 0 ? _b : trans.__('Change editor language.');
+            },
+            execute: args => {
+                const name = args['name'];
+                const widget = tracker.currentWidget;
+                if (name && widget) {
+                    const spec = languages.findByName(name);
+                    if (spec) {
+                        widget.content.model.mimeType = spec.mime;
+                    }
+                }
+            },
+            isEnabled,
+            isToggled: args => {
+                const widget = tracker.currentWidget;
+                if (!widget) {
+                    return false;
+                }
+                const mime = widget.content.model.mimeType;
+                const spec = languages.findByMIME(mime);
+                const name = spec && spec.name;
+                return args['name'] === name;
+            }
+        });
         /**
          * Add the replace selection for text editor command
          */
@@ -369,7 +464,7 @@ export var Commands;
                 if (!widget) {
                     return;
                 }
-                return getCreateConsoleFunction(commands)(widget, args);
+                return getCreateConsoleFunction(commands, languages)(widget, args);
             },
             isEnabled,
             icon: consoleIcon,
@@ -834,14 +929,12 @@ export var Commands;
     function addChangeTabsCommandsToPalette(palette, trans) {
         const paletteCategory = trans.__('Text Editor');
         const args = {
-            insertSpaces: false,
             size: 4
         };
         const command = CommandIDs.changeTabs;
         palette.addItem({ command, args, category: paletteCategory });
         for (const size of [1, 2, 4, 8]) {
             const args = {
-                insertSpaces: true,
                 size
             };
             palette.addItem({ command, args, category: paletteCategory });