diff --git a/packages/application-extension/src/index.ts b/packages/application-extension/src/index.ts index f9291c012f..072497e4fa 100644 --- a/packages/application-extension/src/index.ts +++ b/packages/application-extension/src/index.ts @@ -129,6 +129,7 @@ namespace CommandIDs { */ const dirty: JupyterFrontEndPlugin = { id: '@jupyter-notebook/application-extension:dirty', + description: 'Check if the application is dirty before closing the browser tab.', autoStart: true, requires: [ILabStatus, ITranslator], activate: ( @@ -157,6 +158,7 @@ const dirty: JupyterFrontEndPlugin = { */ const logo: JupyterFrontEndPlugin = { id: '@jupyter-notebook/application-extension:logo', + description: 'The logo plugin.', autoStart: true, activate: (app: JupyterFrontEnd) => { const baseUrl = PageConfig.getBaseUrl(); @@ -185,6 +187,7 @@ const logo: JupyterFrontEndPlugin = { */ const opener: JupyterFrontEndPlugin = { id: '@jupyter-notebook/application-extension:opener', + description: 'A plugin to open documents in the main area.', autoStart: true, requires: [IRouter, IDocumentManager], optional: [ISettingRegistry], @@ -253,6 +256,7 @@ const opener: JupyterFrontEndPlugin = { */ const menus: JupyterFrontEndPlugin = { id: '@jupyter-notebook/application-extension:menus', + description: 'A plugin to customize menus.', requires: [IMainMenu], autoStart: true, activate: (app: JupyterFrontEnd, menu: IMainMenu) => { @@ -283,6 +287,7 @@ const menus: JupyterFrontEndPlugin = { */ const menuSpacer: JupyterFrontEndPlugin = { id: '@jupyter-notebook/application-extension:menu-spacer', + description: 'A plugin to provide a spacer at rank 900 in the menu area.', autoStart: true, activate: (app: JupyterFrontEnd) => { const menu = new Widget(); @@ -297,6 +302,7 @@ const menuSpacer: JupyterFrontEndPlugin = { */ const pages: JupyterFrontEndPlugin = { id: '@jupyter-notebook/application-extension:pages', + description: 'Add commands to open the tree and running pages.', autoStart: true, requires: [ITranslator], optional: [ICommandPalette], @@ -339,6 +345,7 @@ const pages: JupyterFrontEndPlugin = { */ const pathOpener: JupyterFrontEndPlugin = { id: '@jupyter-notebook/application-extension:path-opener', + description: 'A plugin to open paths in new browser tabs.', autoStart: true, provides: INotebookPathOpener, activate: (app: JupyterFrontEnd): INotebookPathOpener => { @@ -351,6 +358,7 @@ const pathOpener: JupyterFrontEndPlugin = { */ const paths: JupyterFrontEndPlugin = { id: '@jupyter-notebook/application-extension:paths', + description: 'The default paths for a Jupyter Notebook app.', autoStart: true, provides: JupyterFrontEnd.IPaths, activate: (app: JupyterFrontEnd): JupyterFrontEnd.IPaths => { @@ -366,9 +374,9 @@ const paths: JupyterFrontEndPlugin = { */ const rendermime: JupyterFrontEndPlugin = { id: '@jupyter-notebook/application-extension:rendermime', + description: 'A plugin providing a rendermime registry.', autoStart: true, provides: IRenderMimeRegistry, - description: 'Provides the render mime registry.', optional: [ IDocumentManager, ILatexTypesetter, @@ -439,6 +447,7 @@ const rendermime: JupyterFrontEndPlugin = { */ const shell: JupyterFrontEndPlugin = { id: '@jupyter-notebook/application-extension:shell', + description: 'The default Jupyter Notebook application shell.', autoStart: true, provides: INotebookShell, optional: [ISettingRegistry], @@ -505,6 +514,7 @@ const splash: JupyterFrontEndPlugin = { */ const status: JupyterFrontEndPlugin = { id: '@jupyter-notebook/application-extension:status', + description: 'The default JupyterLab application status provider.', autoStart: true, provides: ILabStatus, activate: (app: JupyterFrontEnd) => { @@ -520,6 +530,7 @@ const status: JupyterFrontEndPlugin = { */ const tabTitle: JupyterFrontEndPlugin = { id: '@jupyter-notebook/application-extension:tab-title', + description: 'A plugin to display the document title in the browser tab title.', autoStart: true, requires: [INotebookShell], activate: (app: JupyterFrontEnd, shell: INotebookShell) => { @@ -556,6 +567,7 @@ const tabTitle: JupyterFrontEndPlugin = { */ const title: JupyterFrontEndPlugin = { id: '@jupyter-notebook/application-extension:title', + description: 'A plugin to display and rename the title of a file.', autoStart: true, requires: [INotebookShell, ITranslator], optional: [IDocumentManager, IRouter, IToolbarWidgetRegistry], @@ -654,6 +666,7 @@ const title: JupyterFrontEndPlugin = { */ const topVisibility: JupyterFrontEndPlugin = { id: '@jupyter-notebook/application-extension:top', + description: 'Plugin to toggle the top header visibility.', requires: [INotebookShell, ITranslator], optional: [ISettingRegistry, ICommandPalette], activate: ( @@ -735,6 +748,7 @@ const topVisibility: JupyterFrontEndPlugin = { */ const sidePanelVisibility: JupyterFrontEndPlugin = { id: '@jupyter-notebook/application-extension:sidepanel', + description: 'Plugin to toggle the visibility of left or right side panel.', requires: [INotebookShell, ITranslator], optional: [IMainMenu, ICommandPalette], autoStart: true, @@ -950,6 +964,7 @@ const sidePanelVisibility: JupyterFrontEndPlugin = { */ const tree: JupyterFrontEndPlugin = { id: '@jupyter-notebook/application-extension:tree-resolver', + description: 'The default tree route resolver plugin.', autoStart: true, requires: [IRouter], provides: JupyterFrontEnd.ITreeResolver, @@ -1007,8 +1022,12 @@ const tree: JupyterFrontEndPlugin = { }, }; +/** + * Plugin to update tree path. + */ const treePathUpdater: JupyterFrontEndPlugin = { id: '@jupyter-notebook/application-extension:tree-updater', + description: 'Plugin to update tree path.', requires: [IRouter], provides: ITreePathUpdater, activate: (app: JupyterFrontEnd, router: IRouter) => { @@ -1029,8 +1048,12 @@ const treePathUpdater: JupyterFrontEndPlugin = { autoStart: true, }; +/** + * Translator plugin + */ const translator: JupyterFrontEndPlugin = { id: '@jupyter-notebook/application-extension:translator', + description: 'Translator plugin', requires: [INotebookShell, ITranslator], autoStart: true, activate: ( @@ -1047,6 +1070,7 @@ const translator: JupyterFrontEndPlugin = { */ const zen: JupyterFrontEndPlugin = { id: '@jupyter-notebook/application-extension:zen', + description: 'Zen mode plugin.', autoStart: true, requires: [ITranslator], optional: [ICommandPalette, INotebookShell], diff --git a/packages/lab-extension/src/index.ts b/packages/lab-extension/src/index.ts index bd309e5c24..3a5d0d49b5 100644 --- a/packages/lab-extension/src/index.ts +++ b/packages/lab-extension/src/index.ts @@ -67,6 +67,7 @@ interface ISwitcherChoice { */ const interfaceSwitcher: JupyterFrontEndPlugin = { id: '@jupyter-notebook/lab-extension:interface-switcher', + description: 'A plugin to add custom toolbar items to the notebook page.', autoStart: true, requires: [ITranslator, INotebookTracker], optional: [ @@ -218,6 +219,7 @@ const interfaceSwitcher: JupyterFrontEndPlugin = { */ const launchNotebookTree: JupyterFrontEndPlugin = { id: '@jupyter-notebook/lab-extension:launch-tree', + description: 'A plugin to add a command to open the Jupyter Notebook Tree.', autoStart: true, requires: [ITranslator], optional: [ICommandPalette], diff --git a/packages/notebook-extension/src/index.ts b/packages/notebook-extension/src/index.ts index 90c86dcd77..dff81abecd 100644 --- a/packages/notebook-extension/src/index.ts +++ b/packages/notebook-extension/src/index.ts @@ -68,6 +68,7 @@ const SCROLLED_OUTPUTS_CLASS = 'jp-mod-outputsScrolled'; */ const checkpoints: JupyterFrontEndPlugin = { id: '@jupyter-notebook/notebook-extension:checkpoints', + description: 'A plugin for the checkpoint indicator.', autoStart: true, requires: [IDocumentManager, ITranslator], optional: [INotebookShell, IToolbarWidgetRegistry], @@ -133,6 +134,7 @@ const checkpoints: JupyterFrontEndPlugin = { */ const closeTab: JupyterFrontEndPlugin = { id: '@jupyter-notebook/notebook-extension:close-tab', + description: 'Add a command to close the browser tab when clicking on "Close and Shut Down".', autoStart: true, requires: [IMainMenu], optional: [ITranslator], @@ -167,6 +169,7 @@ const closeTab: JupyterFrontEndPlugin = { */ const kernelLogo: JupyterFrontEndPlugin = { id: '@jupyter-notebook/notebook-extension:kernel-logo', + description: 'The kernel logo plugin.', autoStart: true, requires: [INotebookShell], optional: [IToolbarWidgetRegistry], @@ -230,6 +233,7 @@ const kernelLogo: JupyterFrontEndPlugin = { */ const kernelStatus: JupyterFrontEndPlugin = { id: '@jupyter-notebook/notebook-extension:kernel-status', + description: 'A plugin to display the kernel status.', autoStart: true, requires: [INotebookShell, ITranslator], activate: ( @@ -294,6 +298,7 @@ const kernelStatus: JupyterFrontEndPlugin = { */ const scrollOutput: JupyterFrontEndPlugin = { id: '@jupyter-notebook/notebook-extension:scroll-output', + description: 'A plugin to enable scrolling for outputs by default.', autoStart: true, requires: [INotebookTracker], optional: [ISettingRegistry], @@ -379,6 +384,7 @@ const scrollOutput: JupyterFrontEndPlugin = { */ const notebookToolsWidget: JupyterFrontEndPlugin = { id: '@jupyter-notebook/notebook-extension:notebook-tools', + description: 'A plugin to add the NotebookTools to the side panel.', autoStart: true, requires: [INotebookShell], optional: [INotebookTools], @@ -407,6 +413,7 @@ const notebookToolsWidget: JupyterFrontEndPlugin = { */ const tabIcon: JupyterFrontEndPlugin = { id: '@jupyter-notebook/notebook-extension:tab-icon', + description: 'A plugin to update the tab icon based on the kernel status.', autoStart: true, requires: [INotebookTracker], activate: (app: JupyterFrontEnd, tracker: INotebookTracker) => { @@ -456,6 +463,7 @@ const tabIcon: JupyterFrontEndPlugin = { */ const trusted: JupyterFrontEndPlugin = { id: '@jupyter-notebook/notebook-extension:trusted', + description: 'A plugin that adds a Trusted indicator to the menu area.', autoStart: true, requires: [INotebookShell, ITranslator], activate: ( diff --git a/packages/terminal-extension/src/index.ts b/packages/terminal-extension/src/index.ts index 917b871999..3de0250808 100644 --- a/packages/terminal-extension/src/index.ts +++ b/packages/terminal-extension/src/index.ts @@ -23,6 +23,7 @@ import { find } from '@lumino/algorithm'; */ const opener: JupyterFrontEndPlugin = { id: '@jupyter-notebook/terminal-extension:opener', + description: 'A plugin to open terminals in a new tab.', requires: [IRouter, ITerminalTracker], autoStart: true, activate: ( @@ -62,6 +63,7 @@ const opener: JupyterFrontEndPlugin = { */ const redirect: JupyterFrontEndPlugin = { id: '@jupyter-notebook/terminal-extension:redirect', + description: 'Open terminals in a new tab.', requires: [ITerminalTracker], optional: [INotebookPathOpener], autoStart: true, diff --git a/packages/tree-extension/src/index.ts b/packages/tree-extension/src/index.ts index dab2ed564e..5614d80bff 100644 --- a/packages/tree-extension/src/index.ts +++ b/packages/tree-extension/src/index.ts @@ -76,6 +76,7 @@ namespace CommandIDs { */ const createNew: JupyterFrontEndPlugin = { id: '@jupyter-notebook/tree-extension:new', + description: 'Plugin to add extra commands to the file browser to create new notebooks, files, consoles and terminals.', requires: [ITranslator], optional: [IToolbarWidgetRegistry], autoStart: true, @@ -128,6 +129,7 @@ const createNew: JupyterFrontEndPlugin = { */ const fileActions: JupyterFrontEndPlugin = { id: '@jupyter-notebook/tree-extension:file-actions', + description: 'A plugin to add file browser actions to the file browser toolbar.', autoStart: true, requires: [IDefaultFileBrowser, IToolbarWidgetRegistry, ITranslator], activate: ( @@ -177,6 +179,7 @@ const fileActions: JupyterFrontEndPlugin = { */ const loadPlugins: JupyterFrontEndPlugin = { id: '@jupyter-notebook/tree-extension:load-plugins', + description: 'Plugin to load the default plugins that are loaded on all the Notebook pages (tree, edit, view, etc.) so they are visible in the settings editor.', autoStart: true, requires: [ISettingRegistry], activate(app: JupyterFrontEnd, settingRegistry: ISettingRegistry) { @@ -233,6 +236,7 @@ const loadPlugins: JupyterFrontEndPlugin = { */ const openFileBrowser: JupyterFrontEndPlugin = { id: '@jupyter-notebook/tree-extension:open-file-browser', + description: 'A plugin to add file browser commands for the tree view.', requires: [INotebookTree, IDefaultFileBrowser], autoStart: true, activate: ( @@ -254,6 +258,7 @@ const openFileBrowser: JupyterFrontEndPlugin = { */ const notebookTreeWidget: JupyterFrontEndPlugin = { id: '@jupyter-notebook/tree-extension:widget', + description: 'A plugin to add the file browser widget to an INotebookShell.', requires: [ IDefaultFileBrowser, ITranslator,