Added Lumino Plugin Description (#7008) (#7127)

* Added Lumino Plugin Description * Added Lumino Plugin Description * Added Lumino Plugin Description * Added Lumino Plugin Description * Added Lumino Description * Added Lumino Description * Added Lumino Description * Added Lumino Description * Added Lumino Description * Fixed test checks * Fixed test checks * Fixed test checks * Fixed test checks --------- Co-authored-by: Aditya Mahimkar <mahimkaradi@gmail.com> Co-authored-by: Jeremy Tuloup <jeremy.tuloup@gmail.com>
jupyter · Oct 27, 2023 · 1ff6293 · 1ff6293
1 parent e73d410
commit 1ff6293
Show file tree

Hide file tree

Showing 9 changed files with 55 additions and 1 deletion.
diff --git a/packages/application-extension/src/index.ts b/packages/application-extension/src/index.ts
@@ -129,6 +129,8 @@ namespace CommandIDs {
  */
 const dirty: JupyterFrontEndPlugin<void> = {
   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 +159,7 @@ const dirty: JupyterFrontEndPlugin<void> = {
  */
 const logo: JupyterFrontEndPlugin<void> = {
   id: '@jupyter-notebook/application-extension:logo',
+  description: 'The logo plugin.',
   autoStart: true,
   activate: (app: JupyterFrontEnd) => {
     const baseUrl = PageConfig.getBaseUrl();
@@ -185,6 +188,7 @@ const logo: JupyterFrontEndPlugin<void> = {
  */
 const opener: JupyterFrontEndPlugin<void> = {
   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 +257,7 @@ const opener: JupyterFrontEndPlugin<void> = {
  */
 const menus: JupyterFrontEndPlugin<void> = {
   id: '@jupyter-notebook/application-extension:menus',
+  description: 'A plugin to customize menus.',
   requires: [IMainMenu],
   autoStart: true,
   activate: (app: JupyterFrontEnd, menu: IMainMenu) => {
@@ -283,6 +288,7 @@ const menus: JupyterFrontEndPlugin<void> = {
  */
 const menuSpacer: JupyterFrontEndPlugin<void> = {
   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 +303,7 @@ const menuSpacer: JupyterFrontEndPlugin<void> = {
  */
 const pages: JupyterFrontEndPlugin<void> = {
   id: '@jupyter-notebook/application-extension:pages',
+  description: 'Add commands to open the tree and running pages.',
   autoStart: true,
   requires: [ITranslator],
   optional: [ICommandPalette],
@@ -339,6 +346,7 @@ const pages: JupyterFrontEndPlugin<void> = {
  */
 const pathOpener: JupyterFrontEndPlugin<INotebookPathOpener> = {
   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 +359,7 @@ const pathOpener: JupyterFrontEndPlugin<INotebookPathOpener> = {
  */
 const paths: JupyterFrontEndPlugin<JupyterFrontEnd.IPaths> = {
   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 +375,9 @@ const paths: JupyterFrontEndPlugin<JupyterFrontEnd.IPaths> = {
  */
 const rendermime: JupyterFrontEndPlugin<IRenderMimeRegistry> = {
   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 +448,7 @@ const rendermime: JupyterFrontEndPlugin<IRenderMimeRegistry> = {
  */
 const shell: JupyterFrontEndPlugin<INotebookShell> = {
   id: '@jupyter-notebook/application-extension:shell',
+  description: 'The default Jupyter Notebook application shell.',
   autoStart: true,
   provides: INotebookShell,
   optional: [ISettingRegistry],
@@ -505,6 +515,7 @@ const splash: JupyterFrontEndPlugin<ISplashScreen> = {
  */
 const status: JupyterFrontEndPlugin<ILabStatus> = {
   id: '@jupyter-notebook/application-extension:status',
+  description: 'The default JupyterLab application status provider.',
   autoStart: true,
   provides: ILabStatus,
   activate: (app: JupyterFrontEnd) => {
@@ -520,6 +531,8 @@ const status: JupyterFrontEndPlugin<ILabStatus> = {
  */
 const tabTitle: JupyterFrontEndPlugin<void> = {
   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 +569,7 @@ const tabTitle: JupyterFrontEndPlugin<void> = {
  */
 const title: JupyterFrontEndPlugin<void> = {
   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 +668,7 @@ const title: JupyterFrontEndPlugin<void> = {
  */
 const topVisibility: JupyterFrontEndPlugin<void> = {
   id: '@jupyter-notebook/application-extension:top',
+  description: 'Plugin to toggle the top header visibility.',
   requires: [INotebookShell, ITranslator],
   optional: [ISettingRegistry, ICommandPalette],
   activate: (
@@ -735,6 +750,7 @@ const topVisibility: JupyterFrontEndPlugin<void> = {
  */
 const sidePanelVisibility: JupyterFrontEndPlugin<void> = {
   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 +966,7 @@ const sidePanelVisibility: JupyterFrontEndPlugin<void> = {
  */
 const tree: JupyterFrontEndPlugin<JupyterFrontEnd.ITreeResolver> = {
   id: '@jupyter-notebook/application-extension:tree-resolver',
+  description: 'The default tree route resolver plugin.',
   autoStart: true,
   requires: [IRouter],
   provides: JupyterFrontEnd.ITreeResolver,
@@ -1007,8 +1024,12 @@ const tree: JupyterFrontEndPlugin<JupyterFrontEnd.ITreeResolver> = {
   },
 };
 
+/**
+ * Plugin to update tree path.
+ */
 const treePathUpdater: JupyterFrontEndPlugin<ITreePathUpdater> = {
   id: '@jupyter-notebook/application-extension:tree-updater',
+  description: 'Plugin to update tree path.',
   requires: [IRouter],
   provides: ITreePathUpdater,
   activate: (app: JupyterFrontEnd, router: IRouter) => {
@@ -1029,8 +1050,12 @@ const treePathUpdater: JupyterFrontEndPlugin<ITreePathUpdater> = {
   autoStart: true,
 };
 
+/**
+ * Translator plugin
+ */
 const translator: JupyterFrontEndPlugin<void> = {
   id: '@jupyter-notebook/application-extension:translator',
+  description: 'Translator plugin',
   requires: [INotebookShell, ITranslator],
   autoStart: true,
   activate: (
@@ -1047,6 +1072,7 @@ const translator: JupyterFrontEndPlugin<void> = {
  */
 const zen: JupyterFrontEndPlugin<void> = {
   id: '@jupyter-notebook/application-extension:zen',
+  description: 'Zen mode plugin.',
   autoStart: true,
   requires: [ITranslator],
   optional: [ICommandPalette, INotebookShell],

diff --git a/packages/console-extension/src/index.ts b/packages/console-extension/src/index.ts
@@ -25,6 +25,7 @@ const opener: JupyterFrontEndPlugin<void> = {
   id: '@jupyter-notebook/console-extension:opener',
   requires: [IRouter],
   autoStart: true,
+  description: 'A plugin to open consoles in a new tab',
   activate: (app: JupyterFrontEnd, router: IRouter) => {
     const { commands } = app;
     const consolePattern = new RegExp('/consoles/(.*)');
@@ -59,6 +60,7 @@ const redirect: JupyterFrontEndPlugin<void> = {
   requires: [IConsoleTracker],
   optional: [INotebookPathOpener],
   autoStart: true,
+  description: 'Open consoles in a new tab',
   activate: (
     app: JupyterFrontEnd,
     tracker: IConsoleTracker,

diff --git a/packages/docmanager-extension/src/index.ts b/packages/docmanager-extension/src/index.ts
@@ -29,6 +29,7 @@ const opener: JupyterFrontEndPlugin<IDocumentWidgetOpener> = {
   autoStart: true,
   optional: [INotebookPathOpener, INotebookShell],
   provides: IDocumentWidgetOpener,
+  description: 'Open documents in a new browser tab',
   activate: (
     app: JupyterFrontEnd,
     notebookPathOpener: INotebookPathOpener,

diff --git a/packages/documentsearch-extension/src/index.ts b/packages/documentsearch-extension/src/index.ts
@@ -18,6 +18,7 @@ const notebookShellWidgetListener: JupyterFrontEndPlugin<void> = {
   id: '@jupyter-notebook/documentsearch-extension:notebookShellWidgetListener',
   requires: [INotebookShell, ISearchProviderRegistry],
   autoStart: true,
+  description: 'A plugin to add document search functionalities',
   activate: (
     app: JupyterFrontEnd,
     notebookShell: INotebookShell,

diff --git a/packages/help-extension/src/index.tsx b/packages/help-extension/src/index.tsx
@@ -49,6 +49,7 @@ namespace CommandIDs {
 const open: JupyterFrontEndPlugin<void> = {
   id: '@jupyter-notebook/help-extension:open',
   autoStart: true,
+  description: 'A plugin to open the about section with resources',
   activate: (app: JupyterFrontEnd): void => {
     const { commands } = app;
 
@@ -70,6 +71,8 @@ const about: JupyterFrontEndPlugin<void> = {
   autoStart: true,
   requires: [ITranslator],
   optional: [IMainMenu, ICommandPalette],
+  description:
+    'Plugin to add a command to show an About Jupyter Notebook and Markdown Reference',
   activate: (
     app: JupyterFrontEnd,
     translator: ITranslator,

diff --git a/packages/lab-extension/src/index.ts b/packages/lab-extension/src/index.ts
@@ -67,6 +67,7 @@ interface ISwitcherChoice {
  */
 const interfaceSwitcher: JupyterFrontEndPlugin<void> = {
   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<void> = {
  */
 const launchNotebookTree: JupyterFrontEndPlugin<void> = {
   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
@@ -68,6 +68,7 @@ const SCROLLED_OUTPUTS_CLASS = 'jp-mod-outputsScrolled';
  */
 const checkpoints: JupyterFrontEndPlugin<void> = {
   id: '@jupyter-notebook/notebook-extension:checkpoints',
+  description: 'A plugin for the checkpoint indicator.',
   autoStart: true,
   requires: [IDocumentManager, ITranslator],
   optional: [INotebookShell, IToolbarWidgetRegistry],
@@ -133,6 +134,8 @@ const checkpoints: JupyterFrontEndPlugin<void> = {
  */
 const closeTab: JupyterFrontEndPlugin<void> = {
   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 +170,7 @@ const closeTab: JupyterFrontEndPlugin<void> = {
  */
 const kernelLogo: JupyterFrontEndPlugin<void> = {
   id: '@jupyter-notebook/notebook-extension:kernel-logo',
+  description: 'The kernel logo plugin.',
   autoStart: true,
   requires: [INotebookShell],
   optional: [IToolbarWidgetRegistry],
@@ -230,6 +234,7 @@ const kernelLogo: JupyterFrontEndPlugin<void> = {
  */
 const kernelStatus: JupyterFrontEndPlugin<void> = {
   id: '@jupyter-notebook/notebook-extension:kernel-status',
+  description: 'A plugin to display the kernel status.',
   autoStart: true,
   requires: [INotebookShell, ITranslator],
   activate: (
@@ -294,6 +299,7 @@ const kernelStatus: JupyterFrontEndPlugin<void> = {
  */
 const scrollOutput: JupyterFrontEndPlugin<void> = {
   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 +385,7 @@ const scrollOutput: JupyterFrontEndPlugin<void> = {
  */
 const notebookToolsWidget: JupyterFrontEndPlugin<void> = {
   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 +414,7 @@ const notebookToolsWidget: JupyterFrontEndPlugin<void> = {
  */
 const tabIcon: JupyterFrontEndPlugin<void> = {
   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 +464,7 @@ const tabIcon: JupyterFrontEndPlugin<void> = {
  */
 const trusted: JupyterFrontEndPlugin<void> = {
   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
@@ -23,6 +23,7 @@ import { find } from '@lumino/algorithm';
  */
 const opener: JupyterFrontEndPlugin<void> = {
   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<void> = {
  */
 const redirect: JupyterFrontEndPlugin<void> = {
   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
@@ -76,6 +76,8 @@ namespace CommandIDs {
  */
 const createNew: JupyterFrontEndPlugin<void> = {
   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 +130,8 @@ const createNew: JupyterFrontEndPlugin<void> = {
  */
 const fileActions: JupyterFrontEndPlugin<void> = {
   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 +181,8 @@ const fileActions: JupyterFrontEndPlugin<void> = {
  */
 const loadPlugins: JupyterFrontEndPlugin<void> = {
   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 +239,7 @@ const loadPlugins: JupyterFrontEndPlugin<void> = {
  */
 const openFileBrowser: JupyterFrontEndPlugin<void> = {
   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 +261,7 @@ const openFileBrowser: JupyterFrontEndPlugin<void> = {
  */
 const notebookTreeWidget: JupyterFrontEndPlugin<INotebookTree> = {
   id: '@jupyter-notebook/tree-extension:widget',
+  description: 'A plugin to add the file browser widget to an INotebookShell.',
   requires: [
     IDefaultFileBrowser,
     ITranslator,