Lint example

Author: fcollonval

server-extension/README.md

@@ -664,6 +664,7 @@ JupyterLab is looking for frontend extensions when the Python package is install
 The last piece of configuration needed is the enabling of the server extension. This is
 done by copying the following JSON file:
 
+<!-- prettier-ignore-start -->
 ```json5
 // jupyter-config/server-config/jlab_ext_example.json
 
@@ -676,6 +677,7 @@ done by copying the following JSON file:
 }
 
 ```
+<!-- prettier-ignore-end -->
 
 in the appropriate jupyter folder (`etc/jupyter/jupyter_server_config.d`):
 

toolbar-button/.eslintrc.js

@@ -5,18 +5,18 @@ module.exports = {
     'plugin:@typescript-eslint/recommended',
     'plugin:jsdoc/recommended',
     'plugin:prettier/recommended',
-    'plugin:react/recommended'
+    'plugin:react/recommended',
   ],
   parser: '@typescript-eslint/parser',
   parserOptions: {
     project: 'tsconfig.json',
-    sourceType: 'module'
+    sourceType: 'module',
   },
   plugins: ['@typescript-eslint', 'jsdoc'],
   rules: {
     '@typescript-eslint/interface-name-prefix': [
       'error',
-      { prefixWithI: 'always' }
+      { prefixWithI: 'always' },
     ],
     '@typescript-eslint/no-unused-vars': ['warn', { args: 'none' }],
     '@typescript-eslint/no-explicit-any': 'off',
@@ -26,22 +26,22 @@ module.exports = {
     '@typescript-eslint/quotes': [
       'error',
       'single',
-      { avoidEscape: true, allowTemplateLiterals: false }
+      { avoidEscape: true, allowTemplateLiterals: false },
     ],
     curly: ['error', 'all'],
     eqeqeq: 'error',
     'jsdoc/require-param-type': 'off',
     'jsdoc/require-property-type': 'off',
     'jsdoc/require-returns-type': 'off',
     'jsdoc/no-types': 'warn',
-    'prefer-arrow-callback': 'error'
+    'prefer-arrow-callback': 'error',
   },
   settings: {
     jsdoc: {
-      mode: 'typescript'
+      mode: 'typescript',
     },
     react: {
-      version: 'detect'
-    }
-  }
+      version: 'detect',
+    },
+  },
 };

toolbar-button/README.md

@@ -15,7 +15,7 @@ import { IDisposable, DisposableDelegate } from '@lumino/disposable';
 
 import {
   JupyterFrontEnd,
-  JupyterFrontEndPlugin
+  JupyterFrontEndPlugin,
 } from '@jupyterlab/application';
 
 import { ToolbarButton } from '@jupyterlab/apputils';
@@ -25,7 +25,7 @@ import { DocumentRegistry } from '@jupyterlab/docregistry';
 import {
   NotebookActions,
   NotebookPanel,
-  INotebookModel
+  INotebookModel,
 } from '@jupyterlab/notebook';
 ```
 
@@ -37,7 +37,7 @@ Firstly you have to register the plugin information. For that you have to pass a
 const plugin: JupyterFrontEndPlugin<void> = {
   activate,
   id: 'toolbar-button',
-  autoStart: true
+  autoStart: true,
 };
 ```
 
@@ -48,7 +48,8 @@ document widget; in this case a notebook panel.
 // src/index.ts#L30-L54
 
 export class ButtonExtension
-  implements DocumentRegistry.IWidgetExtension<NotebookPanel, INotebookModel> {
+  implements DocumentRegistry.IWidgetExtension<NotebookPanel, INotebookModel>
+{
   /**
    * Create a new extension for the notebook panel widget.
    */
@@ -63,25 +64,24 @@ export class ButtonExtension
       className: 'clear-output-button',
       label: 'Clear All Outputs',
       onClick: clearOutput,
-      tooltip: 'Clear All Outputs'
+      tooltip: 'Clear All Outputs',
     });
 
     panel.toolbar.insertItem(10, 'clearOutputs', button);
     return new DisposableDelegate(() => {
       button.dispose();
     });
   }
-}
 ```
 
 Finally you need to tell the document registry about your widget extension:
 
 ```ts
 // src/index.ts#L59-L61
 
+ */
 function activate(app: JupyterFrontEnd) {
   app.docRegistry.addWidgetExtension('Notebook', new ButtonExtension());
-}
 ```
 
 ## Where to Go Next

toolbar-button/src/index.ts

@@ -2,7 +2,7 @@ import { IDisposable, DisposableDelegate } from '@lumino/disposable';
 
 import {
   JupyterFrontEnd,
-  JupyterFrontEndPlugin
+  JupyterFrontEndPlugin,
 } from '@jupyterlab/application';
 
 import { ToolbarButton } from '@jupyterlab/apputils';
@@ -12,7 +12,7 @@ import { DocumentRegistry } from '@jupyterlab/docregistry';
 import {
   NotebookActions,
   NotebookPanel,
-  INotebookModel
+  INotebookModel,
 } from '@jupyterlab/notebook';
 
 /**
@@ -21,14 +21,15 @@ import {
 const plugin: JupyterFrontEndPlugin<void> = {
   activate,
   id: 'toolbar-button',
-  autoStart: true
+  autoStart: true,
 };
 
 /**
  * A notebook widget extension that adds a button to the toolbar.
  */
 export class ButtonExtension
-  implements DocumentRegistry.IWidgetExtension<NotebookPanel, INotebookModel> {
+  implements DocumentRegistry.IWidgetExtension<NotebookPanel, INotebookModel>
+{
   /**
    * Create a new extension for the notebook panel widget.
    */
@@ -43,7 +44,7 @@ export class ButtonExtension
       className: 'clear-output-button',
       label: 'Clear All Outputs',
       onClick: clearOutput,
-      tooltip: 'Clear All Outputs'
+      tooltip: 'Clear All Outputs',
     });
 
     panel.toolbar.insertItem(10, 'clearOutputs', button);