瀏覽代碼

Clean up and standardize plugin exports.

Afshin Darian 8 年之前
父節點
當前提交
abd8a17221

+ 28 - 28
examples/lab/index.js

@@ -13,34 +13,34 @@ require('jupyterlab/lib/default-theme/index.css');
 var lab = new JupyterLab();
 
 lab.registerPlugins([
-  require('jupyterlab/lib/about/plugin').aboutExtension,
-  require('jupyterlab/lib/application/plugin').mainExtension,
-  require('jupyterlab/lib/clipboard/plugin').clipboardProvider,
-  require('jupyterlab/lib/commandlinker/plugin').commandLinkerProvider,
-  require('jupyterlab/lib/commandpalette/plugin').commandPaletteProvider,
-  require('jupyterlab/lib/console/plugin').consoleTrackerProvider,
-  require('jupyterlab/lib/console/codemirror/plugin').rendererProvider,
-  require('jupyterlab/lib/docregistry/plugin').docRegistryProvider,
-  require('jupyterlab/lib/docmanager/plugin').docManagerProvider,
-  require('jupyterlab/lib/editorwidget/plugin').editorHandlerProvider,
-  require('jupyterlab/lib/faq/plugin').faqExtension,
-  require('jupyterlab/lib/filebrowser/plugin').fileBrowserProvider,
-  require('jupyterlab/lib/help/plugin').helpHandlerExtension,
-  require('jupyterlab/lib/imagewidget/plugin').imageHandlerExtension,
-  require('jupyterlab/lib/inspector/plugin').inspectorProvider,
-  require('jupyterlab/lib/landing/plugin').landingExtension,
-  require('jupyterlab/lib/launcher/plugin').launcherProvider,
-  require('jupyterlab/lib/layoutrestorer/plugin').layoutRestorerProvider,
-  require('jupyterlab/lib/mainmenu/plugin').mainMenuProvider,
-  require('jupyterlab/lib/markdownwidget/plugin').markdownHandlerExtension,
-  require('jupyterlab/lib/notebook/plugin').notebookTrackerProvider,
-  require('jupyterlab/lib/notebook/codemirror/plugin').rendererProvider,
-  require('jupyterlab/lib/rendermime/plugin').renderMimeProvider,
-  require('jupyterlab/lib/running/plugin').runningSessionsExtension,
-  require('jupyterlab/lib/services/plugin').servicesProvider,
-  require('jupyterlab/lib/shortcuts/plugin').shortcutsExtension,
-  require('jupyterlab/lib/statedb/plugin').stateProvider,
-  require('jupyterlab/lib/terminal/plugin').terminalExtension
+  require('jupyterlab/lib/about/plugin').plugin,
+  require('jupyterlab/lib/application/plugin').plugin,
+  require('jupyterlab/lib/clipboard/plugin').plugin,
+  require('jupyterlab/lib/commandlinker/plugin').plugin,
+  require('jupyterlab/lib/commandpalette/plugin').plugin,
+  require('jupyterlab/lib/console/plugin').plugin,
+  require('jupyterlab/lib/console/codemirror/plugin').plugin,
+  require('jupyterlab/lib/docregistry/plugin').plugin,
+  require('jupyterlab/lib/docmanager/plugin').plugin,
+  require('jupyterlab/lib/editorwidget/plugin').plugin,
+  require('jupyterlab/lib/faq/plugin').plugin,
+  require('jupyterlab/lib/filebrowser/plugin').plugin,
+  require('jupyterlab/lib/help/plugin').plugin,
+  require('jupyterlab/lib/imagewidget/plugin').plugin,
+  require('jupyterlab/lib/inspector/plugin').plugin,
+  require('jupyterlab/lib/landing/plugin').plugin,
+  require('jupyterlab/lib/launcher/plugin').plugin,
+  require('jupyterlab/lib/layoutrestorer/plugin').plugin,
+  require('jupyterlab/lib/mainmenu/plugin').plugin,
+  require('jupyterlab/lib/markdownwidget/plugin').plugin,
+  require('jupyterlab/lib/notebook/plugin').plugin,
+  require('jupyterlab/lib/notebook/codemirror/plugin').plugin,
+  require('jupyterlab/lib/rendermime/plugin').plugin,
+  require('jupyterlab/lib/running/plugin').plugin,
+  require('jupyterlab/lib/services/plugin').plugin,
+  require('jupyterlab/lib/shortcuts/plugin').plugin,
+  require('jupyterlab/lib/statedb/plugin').plugin,
+  require('jupyterlab/lib/terminal/plugin').plugin
 ]);
 
 window.onload = function() { lab.start(); }

+ 29 - 29
jupyterlab/extensions.js

@@ -2,33 +2,33 @@
 // Distributed under the terms of the Modified BSD License.
 
 module.exports = [
-  require('../lib/about/plugin').aboutExtension,
-  require('../lib/application/plugin').mainExtension,
-  require('../lib/clipboard/plugin').clipboardProvider,
-  require('../lib/commandlinker/plugin').commandLinkerProvider,
-  require('../lib/commandpalette/plugin').commandPaletteProvider,
-  require('../lib/console/plugin').consoleTrackerProvider,
-  require('../lib/console/codemirror/plugin').rendererProvider,
-  require('../lib/csvwidget/plugin').csvHandlerExtension,
-  require('../lib/docmanager/plugin').docManagerProvider,
-  require('../lib/docregistry/plugin').docRegistryProvider,
-  require('../lib/editorwidget/plugin').editorHandlerProvider,
-  require('../lib/faq/plugin').faqExtension,
-  require('../lib/filebrowser/plugin').fileBrowserProvider,
-  require('../lib/help/plugin').helpHandlerExtension,
-  require('../lib/imagewidget/plugin').imageHandlerExtension,
-  require('../lib/inspector/plugin').inspectorProvider,
-  require('../lib/landing/plugin').landingExtension,
-  require('../lib/launcher/plugin').launcherProvider,
-  require('../lib/layoutrestorer/plugin').layoutRestorerProvider,
-  require('../lib/mainmenu/plugin').mainMenuProvider,
-  require('../lib/markdownwidget/plugin').markdownHandlerExtension,
-  require('../lib/notebook/plugin').notebookTrackerProvider,
-  require('../lib/notebook/codemirror/plugin').rendererProvider,
-  require('../lib/rendermime/plugin').renderMimeProvider,
-  require('../lib/running/plugin').runningSessionsExtension,
-  require('../lib/services/plugin').servicesProvider,
-  require('../lib/shortcuts/plugin').shortcutsExtension,
-  require('../lib/statedb/plugin').stateProvider,
-  require('../lib/terminal/plugin').terminalExtension
+  require('../lib/about/plugin').plugin,
+  require('../lib/application/plugin').plugin,
+  require('../lib/clipboard/plugin').plugin,
+  require('../lib/commandlinker/plugin').plugin,
+  require('../lib/commandpalette/plugin').plugin,
+  require('../lib/console/plugin').plugin,
+  require('../lib/console/codemirror/plugin').plugin,
+  require('../lib/csvwidget/plugin').plugin,
+  require('../lib/docmanager/plugin').plugin,
+  require('../lib/docregistry/plugin').plugin,
+  require('../lib/editorwidget/plugin').plugin,
+  require('../lib/faq/plugin').plugin,
+  require('../lib/filebrowser/plugin').plugin,
+  require('../lib/help/plugin').plugin,
+  require('../lib/imagewidget/plugin').plugin,
+  require('../lib/inspector/plugin').plugin,
+  require('../lib/landing/plugin').plugin,
+  require('../lib/launcher/plugin').plugin,
+  require('../lib/layoutrestorer/plugin').plugin,
+  require('../lib/mainmenu/plugin').plugin,
+  require('../lib/markdownwidget/plugin').plugin,
+  require('../lib/notebook/plugin').plugin,
+  require('../lib/notebook/codemirror/plugin').plugin,
+  require('../lib/rendermime/plugin').plugin,
+  require('../lib/running/plugin').plugin,
+  require('../lib/services/plugin').plugin,
+  require('../lib/shortcuts/plugin').plugin,
+  require('../lib/statedb/plugin').plugin,
+  require('../lib/terminal/plugin').plugin
 ];

+ 1 - 1
src/about/plugin.ts

@@ -29,7 +29,7 @@ import {
  * The about page extension.
  */
 export
-const aboutExtension: JupyterLabPlugin<void> = {
+const plugin: JupyterLabPlugin<void> = {
   id: 'jupyter.extensions.about',
   activate: activateAbout,
   autoStart: true,

+ 3 - 5
src/application/plugin.ts

@@ -14,16 +14,14 @@ import {
  * The main extension.
  */
 export
-const mainExtension: JupyterLabPlugin<void> = {
+const plugin: JupyterLabPlugin<void> = {
   id: 'jupyter.extensions.main',
   requires: [ICommandPalette],
   activate: (app: JupyterLab, palette: ICommandPalette) => {
-    let commandId = 'main-jupyterlab:closeAll';
+    let commandId = 'main-jupyterlab:close-all';
     app.commands.addCommand(commandId, {
       label: 'Close All Widgets',
-      execute: () => {
-        app.shell.closeAll();
-      }
+      execute: () => { app.shell.closeAll(); }
     });
 
     palette.addItem({ command: commandId, category: 'Main Area' });

+ 1 - 1
src/clipboard/plugin.ts

@@ -18,7 +18,7 @@ import {
  * The clipboard provider.
  */
 export
-const clipboardProvider: JupyterLabPlugin<IClipboard> = {
+const plugin: JupyterLabPlugin<IClipboard> = {
   id: 'jupyter.services.clipboard',
   provides: IClipboard,
   activate: (): IClipboard => new MimeData()

+ 1 - 1
src/commandlinker/plugin.ts

@@ -16,7 +16,7 @@ import {
  * The default commmand linker provider.
  */
 export
-const commandLinkerProvider: JupyterLabPlugin<ICommandLinker> = {
+const plugin: JupyterLabPlugin<ICommandLinker> = {
   id: 'jupyter.services.command-linker',
   provides: ICommandLinker,
   activate: (app: JupyterLab) => new CommandLinker({ commands: app.commands }),

+ 1 - 1
src/commandpalette/plugin.ts

@@ -69,7 +69,7 @@ class Palette implements ICommandPalette {
  * The default commmand palette extension.
  */
 export
-const commandPaletteProvider: JupyterLabPlugin<ICommandPalette> = {
+const plugin: JupyterLabPlugin<ICommandPalette> = {
   id: 'jupyter.services.commandpalette',
   provides: ICommandPalette,
   activate: activateCommandPalette,

+ 1 - 1
src/console/codemirror/plugin.ts

@@ -18,7 +18,7 @@ import {
  * The provider for a console's code mirror renderer.
  */
 export
-const rendererProvider: JupyterLabPlugin<ConsoleContent.IRenderer> = {
+const plugin: JupyterLabPlugin<ConsoleContent.IRenderer> = {
   id: 'jupyter.services.console.codemirror.renderer',
   provides: ConsoleContent.IRenderer,
   activate: () => CodeMirrorConsoleRenderer.defaultRenderer

+ 1 - 1
src/console/plugin.ts

@@ -70,7 +70,7 @@ import {
  * The console widget tracker provider.
  */
 export
-const consoleTrackerProvider: JupyterLabPlugin<IConsoleTracker> = {
+const plugin: JupyterLabPlugin<IConsoleTracker> = {
   id: 'jupyter.services.console-tracker',
   provides: IConsoleTracker,
   requires: [

+ 1 - 1
src/csvwidget/plugin.ts

@@ -36,7 +36,7 @@ const FACTORY = 'Table';
  * The table file handler extension.
  */
 export
-const csvHandlerExtension: JupyterLabPlugin<void> = {
+const plugin: JupyterLabPlugin<void> = {
   id: 'jupyter.extensions.csv-handler',
   requires: [IDocumentRegistry, IStateDB, ILayoutRestorer],
   activate: activateCSVWidget,

+ 3 - 14
src/docmanager/plugin.ts

@@ -13,10 +13,6 @@ import {
   IDocumentRegistry
 } from '../docregistry';
 
-import {
-  Widget
-} from 'phosphor/lib/ui/widget';
-
 import {
   JupyterLab
 } from '../application';
@@ -28,12 +24,12 @@ import {
 /**
  * The default document manager provider.
  */
-export const docManagerProvider: JupyterLabPlugin<IDocumentManager> = {
+export
+const plugin: JupyterLabPlugin<IDocumentManager> = {
   id: 'jupyter.services.document-manager',
   provides: IDocumentManager,
   requires: [IServiceManager, IDocumentRegistry],
   activate: (app: JupyterLab, manager: IServiceManager, registry: IDocumentRegistry): IDocumentManager => {
-    
     let id = 1;
     let opener: DocumentManager.IWidgetOpener = {
       open: widget => {
@@ -46,13 +42,6 @@ export const docManagerProvider: JupyterLabPlugin<IDocumentManager> = {
         app.shell.activateMain(widget.id);
       }
     };
-
-    let documentManager = new DocumentManager( {
-      registry,
-      manager,
-      opener
-    });
-    
-    return documentManager;
+    return new DocumentManager({ registry, manager, opener });
   }
 };

+ 2 - 5
src/docregistry/plugin.ts

@@ -14,7 +14,7 @@ import {
  * The default document registry provider.
  */
 export
-const docRegistryProvider: JupyterLabPlugin<IDocumentRegistry> = {
+const plugin: JupyterLabPlugin<IDocumentRegistry> = {
   id: 'jupyter.services.document-registry',
   provides: IDocumentRegistry,
   activate: (): IDocumentRegistry => {
@@ -27,10 +27,7 @@ const docRegistryProvider: JupyterLabPlugin<IDocumentRegistry> = {
       contentType: 'file',
       fileFormat: 'text'
     });
-    registry.addCreator({
-      name: 'Text File',
-      fileType: 'Text',
-    });
+    registry.addCreator({ name: 'Text File', fileType: 'Text', });
     return registry;
   }
 };

+ 1 - 1
src/editorwidget/plugin.ts

@@ -85,7 +85,7 @@ const cmdIds = {
  * The editor handler extension.
  */
 export
-const editorHandlerProvider: JupyterLabPlugin<IEditorTracker> = {
+const plugin: JupyterLabPlugin<IEditorTracker> = {
   id: 'jupyter.services.editor-handler',
   requires: [
     IDocumentRegistry, IMainMenu, ICommandPalette, IStateDB, ILayoutRestorer

+ 1 - 1
src/faq/plugin.ts

@@ -34,7 +34,7 @@ import {
  * The FAQ page extension.
  */
 export
-const faqExtension: JupyterLabPlugin<void> = {
+const plugin: JupyterLabPlugin<void> = {
   id: 'jupyter.extensions.faq',
   requires: [ICommandPalette, ICommandLinker, IStateDB, ILayoutRestorer],
   activate: activateFAQ,

+ 1 - 1
src/filebrowser/plugin.ts

@@ -50,7 +50,7 @@ import {
  * The default file browser provider.
  */
 export
-const fileBrowserProvider: JupyterLabPlugin<IPathTracker> = {
+const plugin: JupyterLabPlugin<IPathTracker> = {
   id: 'jupyter.services.file-browser',
   provides: IPathTracker,
   requires: [

+ 1 - 1
src/help/plugin.ts

@@ -99,7 +99,7 @@ const COMMANDS = [
  * The help handler extension.
  */
 export
-const helpHandlerExtension: JupyterLabPlugin<void> = {
+const plugin: JupyterLabPlugin<void> = {
   id: 'jupyter.extensions.help-handler',
   requires: [IMainMenu, ICommandPalette],
   activate: activateHelpHandler,

+ 1 - 1
src/imagewidget/plugin.ts

@@ -45,7 +45,7 @@ const FACTORY = 'Image';
  * The image file handler extension.
  */
 export
-const imageHandlerExtension: JupyterLabPlugin<void> = {
+const plugin: JupyterLabPlugin<void> = {
   id: 'jupyter.extensions.image-handler',
   requires: [IDocumentRegistry, ICommandPalette, IStateDB, ILayoutRestorer],
   activate: activateImageWidget,

+ 1 - 1
src/inspector/plugin.ts

@@ -31,7 +31,7 @@ import {
  * A service providing an inspector panel.
  */
 export
-const inspectorProvider: JupyterLabPlugin<IInspector> = {
+const plugin: JupyterLabPlugin<IInspector> = {
   id: 'jupyter.services.inspector',
   requires: [ICommandPalette, IStateDB, ILayoutRestorer],
   provides: IInspector,

+ 1 - 1
src/landing/plugin.ts

@@ -38,7 +38,7 @@ import {
  * The landing page extension.
  */
 export
-const landingExtension: JupyterLabPlugin<void> = {
+const plugin: JupyterLabPlugin<void> = {
   id: 'jupyter.extensions.landing',
   requires: [
     IPathTracker, ICommandPalette, IServiceManager, IStateDB, ILayoutRestorer

+ 1 - 1
src/launcher/plugin.ts

@@ -30,7 +30,7 @@ import {
  * A service providing an interface to the the launcher.
  */
 export
-const launcherProvider: JupyterLabPlugin<ILauncher> = {
+const plugin: JupyterLabPlugin<ILauncher> = {
   id: 'jupyter.services.launcher',
   requires: [IServiceManager, IPathTracker, ICommandPalette, ICommandLinker],
   provides: ILauncher,

+ 1 - 1
src/layoutrestorer/plugin.ts

@@ -20,7 +20,7 @@ import {
  * The default layout restorer provider.
  */
 export
-const layoutRestorerProvider: JupyterLabPlugin<ILayoutRestorer> = {
+const plugin: JupyterLabPlugin<ILayoutRestorer> = {
   id: 'jupyter.services.layout-restorer',
   requires: [IStateDB],
   activate: (app: JupyterLab, state: IStateDB) => {

+ 1 - 1
src/mainmenu/plugin.ts

@@ -29,7 +29,7 @@ const JUPYTER_ICON_CLASS = 'jp-JupyterIcon';
  * A service providing an interface to the main menu.
  */
 export
-const mainMenuProvider: JupyterLabPlugin<IMainMenu> = {
+const plugin: JupyterLabPlugin<IMainMenu> = {
   id: 'jupyter.services.main-menu',
   provides: IMainMenu,
   activate: activateMainMenu

+ 1 - 1
src/markdownwidget/plugin.ts

@@ -50,7 +50,7 @@ const FACTORY = 'Rendered Markdown';
  * The markdown handler extension.
  */
 export
-const markdownHandlerExtension: JupyterLabPlugin<void> = {
+const plugin: JupyterLabPlugin<void> = {
   id: 'jupyter.extensions.rendered-markdown',
   requires: [IDocumentRegistry, IRenderMime, IStateDB, ILayoutRestorer],
   activate: (app: JupyterLab, registry: IDocumentRegistry, rendermime: IRenderMime, state: IStateDB, layout: ILayoutRestorer) => {

+ 1 - 1
src/notebook/codemirror/plugin.ts

@@ -17,7 +17,7 @@ import {
  * The provider for a notebook's code mirror renderer.
  */
 export
-const rendererProvider: JupyterLabPlugin<NotebookPanel.IRenderer> = {
+const plugin: JupyterLabPlugin<NotebookPanel.IRenderer> = {
   id: 'jupyter.services.notebook.codemirror.renderer',
   provides: NotebookPanel.IRenderer,
   activate: () => CodeMirrorNotebookPanelRenderer.defaultRenderer

+ 1 - 1
src/notebook/plugin.ts

@@ -119,7 +119,7 @@ const FACTORY = 'Notebook';
  * The notebook widget tracker provider.
  */
 export
-const notebookTrackerProvider: JupyterLabPlugin<INotebookTracker> = {
+const plugin: JupyterLabPlugin<INotebookTracker> = {
   id: 'jupyter.services.notebook-tracker',
   provides: INotebookTracker,
   requires: [

+ 1 - 1
src/rendermime/plugin.ts

@@ -23,7 +23,7 @@ import {
  * The default rendermime provider.
  */
 export
-const renderMimeProvider: JupyterLabPlugin<IRenderMime> = {
+const plugin: JupyterLabPlugin<IRenderMime> = {
   id: 'jupyter.services.rendermime',
   provides: IRenderMime,
   activate: (): IRenderMime => {

+ 1 - 1
src/running/plugin.ts

@@ -18,7 +18,7 @@ import {
  * The default running sessions extension.
  */
 export
-const runningSessionsExtension: JupyterLabPlugin<void> = {
+const plugin: JupyterLabPlugin<void> = {
   id: 'jupyter.extensions.running-sessions',
   requires: [IServiceManager],
   activate: activateRunningSessions,

+ 2 - 4
src/services/plugin.ts

@@ -18,10 +18,8 @@ import {
  * The default services provider.
  */
 export
-const servicesProvider: JupyterLabPlugin<IServiceManager> = {
+const plugin: JupyterLabPlugin<IServiceManager> = {
   id: 'jupyter.services.services',
   provides: IServiceManager,
-  activate: (): IServiceManager => {
-    return new ServiceManager();
-  }
+  activate: (): IServiceManager => new ServiceManager()
 };

+ 2 - 2
src/shortcuts/plugin.ts

@@ -297,10 +297,10 @@ const SHORTCUTS = [
  * The default shortcuts extension.
  */
 export
-const shortcutsExtension: JupyterLabPlugin<void> = {
+const plugin: JupyterLabPlugin<void> = {
   id: 'jupyter.extensions.shortcuts',
   activate: (app: JupyterLab): void => {
-    SHORTCUTS.forEach(shortcut => app.keymap.addBinding(shortcut));
+    SHORTCUTS.forEach(shortcut => { app.keymap.addBinding(shortcut); });
   },
   autoStart: true
 };

+ 1 - 1
src/statedb/plugin.ts

@@ -26,7 +26,7 @@ import {
  * The default state database for storing application state.
  */
 export
-const stateProvider: JupyterLabPlugin<IStateDB> = {
+const plugin: JupyterLabPlugin<IStateDB> = {
   id: 'jupyter.services.statedb',
   activate: activateState,
   autoStart: true,

+ 1 - 1
src/terminal/plugin.ts

@@ -57,7 +57,7 @@ const TERMINAL_ICON_CLASS = 'jp-ImageTerminal';
  * The default terminal extension.
  */
 export
-const terminalExtension: JupyterLabPlugin<void> = {
+const plugin: JupyterLabPlugin<void> = {
   id: 'jupyter.extensions.terminal',
   requires: [
     IServiceManager, IMainMenu, ICommandPalette, IStateDB, ILayoutRestorer