Update READMEs

Lint server-extension

Author: fcollonval

command-palette/README.md

@@ -42,13 +42,13 @@ const extension: JupyterFrontEndPlugin<void> = {
         console.log(
           `jlab-examples:command-palette has been called ${args['origin']}.`
         );
-      }
+      },
     });
 
     // Add the command to the command palette
     const category = 'Extension Examples';
     palette.addItem({ command, category, args: { origin: 'from palette' } });
-  }
+  },
 ```
 
 The `ICommandPalette`

commands/README.md

@@ -71,12 +71,12 @@ with the unique command id and optionally the arguments.
 ```ts
 // src/index.ts#L31-L36
 
-  commands.execute(command, { origin: 'init' }).catch(reason => {
+  commands.execute(command, { origin: 'init' }).catch((reason) => {
     console.error(
       `An error occurred during the execution of jlab-examples:command.\n${reason}`
     );
   });
-}
+},
 ```
 
 When running JupyterLab with this extension, the following message should

context-menu/README.md

@@ -52,7 +52,7 @@ app.docRegistry.addFileType({
   extensions: ['.example'],
   fileFormat: 'text',
   contentType: 'file',
-  mimeTypes: ['text/plain']
+  mimeTypes: ['text/plain'],
 });
 ```
 <!-- prettier-ignore-end -->
@@ -73,9 +73,9 @@ app.commands.addCommand('jlab-examples/context-menu:open', {
     showDialog({
       title: file.name,
       body: 'Path: ' + file.path,
-      buttons: [Dialog.okButton()]
-    }).catch(e => console.log(e));
-  }
+      buttons: [Dialog.okButton()],
+    }).catch((e) => console.log(e));
+  },
 });
 ```
 <!-- prettier-ignore-end -->
@@ -93,7 +93,7 @@ Finally, you can add the command to a context menu using the `addItem()` method
 app.contextMenu.addItem({
   command: 'jlab-examples/context-menu:open',
   selector: '.jp-DirListing-item[data-file-type="example"]',
-  rank: 0
+  rank: 0,
 });
 ```
 <!-- prettier-ignore-end -->

custom-log-console/README.md

@@ -74,7 +74,7 @@ To initialize a new `LogConsoleWidget` you have to create a `LogConsolePanel` to
 logConsolePanel = new LogConsolePanel(
   new LoggerRegistry({
     defaultRendermime: rendermime,
-    maxLength: 1000
+    maxLength: 1000,
   })
 );
 ```
@@ -97,7 +97,7 @@ Now you are ready to initialize a new `MainAreaWidget` passing the `logConsolePa
 // src/index.ts#L86-L88
 
 logConsoleWidget = new MainAreaWidget<LogConsolePanel>({
-  content: logConsolePanel
+  content: logConsolePanel,
 });
 ```
 <!-- prettier-ignore-end -->
@@ -133,7 +133,7 @@ commands.addCommand('jlab-examples/custom-log-console:open', {
     } else {
       createLogConsoleWidget();
     }
-  }
+  },
 });
 ```
 
@@ -147,7 +147,7 @@ Finally, you can send log messages calling `log` method present on the `logger`
 const msg: IHtmlLog = {
   type: 'html',
   level: 'debug',
-  data: '<div>Hello world HTML!!</div>'
+  data: '<div>Hello world HTML!!</div>',
 };
 
 logConsolePanel?.logger?.log(msg);
@@ -180,14 +180,14 @@ logConsolePanel?.logger?.log(msg);
 const data: nbformat.IOutput = {
   output_type: 'display_data',
   data: {
-    'text/plain': 'Hello world nbformat!!'
-  }
+    'text/plain': 'Hello world nbformat!!',
+  },
 };
 
 const msg: IOutputLog = {
   type: 'output',
   level: 'warning',
-  data
+  data,
 };
 
 logConsolePanel?.logger?.log(msg);

hello-world/README.md

@@ -100,6 +100,7 @@ The following sections will walk you through the extension code files.
 Start with the file `src/index.ts`. This typescript file contains the main
 logic of the extension. It begins with the following import section:
 
+<!-- prettier-ignore-start -->
 ```ts
 // src/index.ts#L1-L4
 
@@ -108,6 +109,7 @@ import {
   JupyterFrontEndPlugin,
 } from '@jupyterlab/application';
 ```
+<!-- prettier-ignore-end -->
 
 `JupyterFrontEnd` is the main Jupyterlab application class. It allows you to
 access and modify some of its main components. `JupyterFrontEndPlugin` is the class
@@ -116,10 +118,10 @@ called `@jupyterlab/application`. The dependency of your extension on this
 package is declared in the file `package.json`:
 
 ```json5
-// package.json#L46-L48
+// package.json#L50-L52
 
 "dependencies": {
-  "@jupyterlab/application": "^3.0.0"
+  "@jupyterlab/application": "^3.0.10"
 },
 ```
 
@@ -143,7 +145,7 @@ const plugin: JupyterFrontEndPlugin<void> = {
 ```ts
 // src/index.ts#L14-L17
 
-  }
+  },
 };
 
 export default plugin;
@@ -230,7 +232,7 @@ a bit. Simply replace the `activate` function with the following lines:
 
 activate: (app: JupyterFrontEnd) => {
   console.log('the JupyterLab main application:', app);
-}
+},
 ```
 <!-- prettier-ignore-end -->
 

kernel-messaging/README.md

@@ -51,12 +51,12 @@ this._sessionContext = new SessionContext({
 ```ts
 void this._sessionContext
   .initialize()
-  .then(async value => {
+  .then(async (value) => {
     if (value) {
       await sessionContextDialogs.selectKernel(this._sessionContext);
     }
   })
-  .catch(reason => {
+  .catch((reason) => {
     console.error(
       `Failed to initialize the session in ExamplePanel.\n${reason}`
     );

kernel-output/README.md

@@ -79,12 +79,12 @@ with this line:
 
 void this._sessionContext
   .initialize()
-  .then(async value => {
+  .then(async (value) => {
     if (value) {
       await sessionContextDialogs.selectKernel(this._sessionContext);
     }
   })
-  .catch(reason => {
+  .catch((reason) => {
     console.error(
       `Failed to initialize the session in ExamplePanel.\n${reason}`
     );
@@ -145,7 +145,7 @@ execute(code: string): void {
     .then((msg: KernelMessage.IExecuteReplyMsg) => {
       console.log(msg);
     })
-    .catch(reason => console.error(reason));
+    .catch((reason) => console.error(reason));
 }
 ```
 

log-messages/README.md

@@ -62,7 +62,7 @@ Finally, you can send log messages by calling the `log` method of the `logger` o
 const msg: ITextLog = {
   type: 'text',
   level: 'info',
-  data: 'Hello world text!!'
+  data: 'Hello world text!!',
 };
 
 logger?.log(msg);

main-menu/README.md

@@ -14,17 +14,20 @@ The `IMainMenu` interface can be requested as a new argument to the `activate`
 function, but first it has to be imported. And the class `Menu` to create new
 menu needs also to be imported but from the Lumino library:
 
+<!-- prettier-ignore-start -->
 ```ts
 // src/index.ts#L6-L8
 
 import { IMainMenu } from '@jupyterlab/mainmenu';
 
 import { Menu } from '@lumino/widgets';
 ```
+<!-- prettier-ignore-end -->
 
 You can add the `IMainMenu` in the `requires:` property such that it is injected into
 the `activate` function. The extension looks like:
 
+<!-- prettier-ignore-start -->
 ```ts
 // src/index.ts#L15-L57
 
@@ -72,6 +75,7 @@ const extension: JupyterFrontEndPlugin<void> = {
   },
 };
 ```
+<!-- prettier-ignore-end -->
 
 In this extension, you have the dependencies to _@jupyterlab/mainmenu_ and
 _@lumino/widgets_. Before it builds, this dependencies have to be added to the
@@ -85,11 +89,11 @@ After the execution of that command, `package.json` should list them in the
 `dependencies`:
 
 ```json5
-// package.json#L46-L50
+// package.json#L50-L54
 
 "dependencies": {
-  "@jupyterlab/application": "^3.0.0-rc.15",
-  "@jupyterlab/mainmenu": "^3.0.0-rc.15",
+  "@jupyterlab/application": "^3.0.10",
+  "@jupyterlab/mainmenu": "^3.0.8",
   "@lumino/widgets": "^1.16.1"
 },
 ```