@jupyterlab/fileeditor-extension 3.4.1 → 4.0.0-alpha.10

package/lib/commands.d.ts

@@ -1,12 +1,15 @@
-import { ICommandPalette, ISessionContextDialogs, WidgetTracker } from '@jupyterlab/apputils';
+import { JupyterFrontEnd } from '@jupyterlab/application';
+import { ICommandPalette, ISessionContextDialogs, MainAreaWidget, WidgetTracker } from '@jupyterlab/apputils';
+import { CodeViewerWidget, IEditorServices } from '@jupyterlab/codeeditor';
+import { ICompletionProviderManager } from '@jupyterlab/completer';
 import { IConsoleTracker } from '@jupyterlab/console';
 import { IDocumentWidget } from '@jupyterlab/docregistry';
 import { IFileBrowserFactory } from '@jupyterlab/filebrowser';
-import { FileEditor } from '@jupyterlab/fileeditor';
+import { FileEditor, IEditorTracker } from '@jupyterlab/fileeditor';
 import { ILauncher } from '@jupyterlab/launcher';
 import { IMainMenu } from '@jupyterlab/mainmenu';
 import { ISettingRegistry } from '@jupyterlab/settingregistry';
-import { TranslationBundle } from '@jupyterlab/translation';
+import { ITranslator, TranslationBundle } from '@jupyterlab/translation';
 import { CommandRegistry } from '@lumino/commands';
 import { ReadonlyJSONObject } from '@lumino/coreutils';
 /**
@@ -17,13 +20,17 @@ export declare namespace CommandIDs {
     const createNewMarkdown = "fileeditor:create-new-markdown-file";
     const changeFontSize = "fileeditor:change-font-size";
     const lineNumbers = "fileeditor:toggle-line-numbers";
+    const currentLineNumbers = "fileeditor:toggle-current-line-numbers";
     const lineWrap = "fileeditor:toggle-line-wrap";
+    const currentLineWrap = "fileeditor:toggle-current-line-wrap";
     const changeTabs = "fileeditor:change-tabs";
     const matchBrackets = "fileeditor:toggle-match-brackets";
+    const currentMatchBrackets = "fileeditor:toggle-current-match-brackets";
     const autoClosingBrackets = "fileeditor:toggle-autoclosing-brackets";
     const autoClosingBracketsUniversal = "fileeditor:toggle-autoclosing-brackets-universal";
     const createConsole = "fileeditor:create-console";
     const replaceSelection = "fileeditor:replace-selection";
+    const restartConsole = "fileeditor:restart-console";
     const runCode = "fileeditor:run-code";
     const runAllCode = "fileeditor:run-all";
     const markdownPreview = "fileeditor:markdown-preview";
@@ -33,6 +40,9 @@ export declare namespace CommandIDs {
     const copy = "fileeditor:copy";
     const paste = "fileeditor:paste";
     const selectAll = "fileeditor:select-all";
+    const invokeCompleter = "completer:invoke-file";
+    const selectCompleter = "completer:select-file";
+    const openCodeViewer = "code-viewer:open";
 }
 export interface IFileTypeData extends ReadonlyJSONObject {
     fileExt: string;
@@ -66,85 +76,8 @@ 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>>, browserFactory: IFileBrowserFactory): void;
-    /**
-     * Add a command to change font size for File Editor
-     */
-    function addChangeFontSizeCommand(commands: CommandRegistry, settingRegistry: ISettingRegistry, trans: TranslationBundle, id: string): void;
-    /**
-     * Add the Line Numbers command
-     */
-    function addLineNumbersCommand(commands: CommandRegistry, settingRegistry: ISettingRegistry, trans: TranslationBundle, id: string, isEnabled: () => boolean): void;
-    /**
-     * Add the Word Wrap command
-     */
-    function addWordWrapCommand(commands: CommandRegistry, settingRegistry: ISettingRegistry, trans: TranslationBundle, id: string, isEnabled: () => boolean): void;
-    /**
-     * Add command for changing tabs size or type in File Editor
-     */
-    function addChangeTabsCommand(commands: CommandRegistry, settingRegistry: ISettingRegistry, trans: TranslationBundle, id: string): void;
-    /**
-     * Add the Match Brackets command
-     */
-    function addMatchBracketsCommand(commands: CommandRegistry, settingRegistry: ISettingRegistry, trans: TranslationBundle, id: string, isEnabled: () => boolean): void;
-    /**
-     * Add the Auto Close Brackets for Text Editor command
-     */
-    function addAutoClosingBracketsCommand(commands: CommandRegistry, settingRegistry: ISettingRegistry, trans: TranslationBundle, id: string): void;
-    /**
-     * Add the replace selection for text editor command
-     */
-    function addReplaceSelectionCommand(commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, trans: TranslationBundle, isEnabled: () => boolean): void;
-    /**
-     * Add the Create Console for Editor command
-     */
-    function addCreateConsoleCommand(commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, trans: TranslationBundle, isEnabled: () => boolean): void;
-    /**
-     * Add the Run Code command
-     */
-    function addRunCodeCommand(commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, trans: TranslationBundle, isEnabled: () => boolean): void;
-    /**
-     * Add the Run All Code command
-     */
-    function addRunAllCodeCommand(commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, trans: TranslationBundle, isEnabled: () => boolean): void;
-    /**
-     * Add markdown preview command
-     */
-    function addMarkdownPreviewCommand(commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, trans: TranslationBundle): void;
-    /**
-     * Add undo command
-     */
-    function addUndoCommand(commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, trans: TranslationBundle, isEnabled: () => boolean): void;
-    /**
-     * Add redo command
-     */
-    function addRedoCommand(commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, trans: TranslationBundle, isEnabled: () => boolean): void;
-    /**
-     * Add cut command
-     */
-    function addCutCommand(commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, trans: TranslationBundle, isEnabled: () => boolean): void;
-    /**
-     * Add copy command
-     */
-    function addCopyCommand(commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, trans: TranslationBundle, isEnabled: () => boolean): void;
-    /**
-     * Add paste command
-     */
-    function addPasteCommand(commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, trans: TranslationBundle, isEnabled: () => boolean): void;
-    /**
-     * Add select all command
-     */
-    function addSelectAllCommand(commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, trans: TranslationBundle, isEnabled: () => boolean): void;
-    /**
-     * Add the New File command
-     *
-     * Defaults to Text/.txt if file type data is not specified
-     */
-    function addCreateNewCommand(commands: CommandRegistry, browserFactory: IFileBrowserFactory, trans: TranslationBundle): void;
-    /**
-     * Add the New Markdown File command
-     */
-    function addCreateNewMarkdownCommand(commands: CommandRegistry, browserFactory: IFileBrowserFactory, trans: TranslationBundle): void;
+    function addCommands(commands: CommandRegistry, settingRegistry: ISettingRegistry, trans: TranslationBundle, id: string, isEnabled: () => boolean, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, browserFactory: IFileBrowserFactory, consoleTracker: IConsoleTracker | null, sessionDialogs: ISessionContextDialogs | 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
      */
@@ -188,25 +121,14 @@ export declare namespace Commands {
     /**
      * Wrapper function for adding the default menu items for File Editor
      */
-    function addMenuItems(menu: IMainMenu, commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, trans: TranslationBundle, consoleTracker: IConsoleTracker | null, sessionDialogs: ISessionContextDialogs | null): void;
+    function addMenuItems(menu: IMainMenu, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, consoleTracker: IConsoleTracker | null, isEnabled: () => boolean): void;
     /**
      * Add Create New ___ File commands to the File menu for common file types associated with available kernels
      */
     function addKernelLanguageMenuItems(menu: IMainMenu, availableKernelFileTypes: Iterable<IFileTypeData>): void;
-    /**
-     * Add File Editor undo and redo widgets to the Edit menu
-     */
-    function addUndoRedoToEditMenu(menu: IMainMenu, tracker: WidgetTracker<IDocumentWidget<FileEditor>>): void;
-    /**
-     * Add a File Editor editor viewer to the View Menu
-     */
-    function addEditorViewerToViewMenu(menu: IMainMenu, tracker: WidgetTracker<IDocumentWidget<FileEditor>>): void;
-    /**
-     * Add a File Editor console creator to the File menu
-     */
-    function addConsoleCreatorToFileMenu(menu: IMainMenu, commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, trans: TranslationBundle): void;
     /**
      * Add a File Editor code runner to the Run menu
      */
-    function addCodeRunnersToRunMenu(menu: IMainMenu, commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, consoleTracker: IConsoleTracker, trans: TranslationBundle, sessionDialogs: ISessionContextDialogs | null): void;
+    function addCodeRunnersToRunMenu(menu: IMainMenu, consoleTracker: IConsoleTracker): void;
+    function addOpenCodeViewerCommand(app: JupyterFrontEnd, editorServices: IEditorServices, tracker: WidgetTracker<MainAreaWidget<CodeViewerWidget>>, trans: TranslationBundle): void;
 }