Port to JupyterLab 3

Author: Frédéric Collonval

.eslintignore

@@ -0,0 +1,5 @@
+node_modules
+dist
+coverage
+**/*.d.ts
+tests

.eslintrc.js

@@ -0,0 +1,39 @@
+module.exports = {
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended'
+  ],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    sourceType: 'module'
+  },
+  plugins: ['@typescript-eslint'],
+  rules: {
+    '@typescript-eslint/naming-convention': [
+      'error',
+      {
+        'selector': 'interface',
+        'format': ['PascalCase'],
+        'custom': {
+          'regex': '^I[A-Z]',
+          'match': true
+        }
+      }
+    ],
+    '@typescript-eslint/no-unused-vars': ['warn', { args: 'none' }],
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-namespace': 'off',
+    '@typescript-eslint/no-use-before-define': 'off',
+    '@typescript-eslint/quotes': [
+      'error',
+      'single',
+      { avoidEscape: true, allowTemplateLiterals: false }
+    ],
+    curly: ['error', 'all'],
+    eqeqeq: 'error',
+    'prefer-arrow-callback': 'error'
+  }
+};

.github/workflows/build.yml

@@ -11,22 +11,48 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
-      uses: actions/checkout@v1
+      uses: actions/checkout@v2
     - name: Install node
       uses: actions/setup-node@v1
       with:
-       node-version: '10.x'
+       node-version: '12.x'
     - name: Install Python
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v2
       with:
         python-version: '3.7'
         architecture: 'x64'
+    
+    
+    - name: Setup pip cache
+      uses: actions/cache@v2
+      with:
+        path: ~/.cache/pip
+        key: pip-3.7-${{ hashFiles('package.json') }}
+        restore-keys: |
+          pip-3.7-
+          pip-
+
+    - name: Get yarn cache directory path
+      id: yarn-cache-dir-path
+      run: echo "::set-output name=dir::$(yarn cache dir)"
+    - name: Setup yarn cache
+      uses: actions/cache@v2
+      id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
+      with:
+        path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+        key: yarn-${{ hashFiles('**/yarn.lock') }}
+        restore-keys: |
+          yarn-
+    
     - name: Install dependencies
-      run: python -m pip install jupyterlab
+      run: python -m pip install -U jupyterlab~=3.0 jupyter_packaging~=0.7.9
     - name: Build the extension
       run: |
-        pip install .
-        jupyter lab build
-        jupyter serverextension list
-        jupyter labextension list
+        jlpm
+        jlpm run eslint:check
+        python -m pip install .
+
+        jupyter server extension list 2>&1 | grep -ie "jupyterlab-snippets.*OK"
+
+        jupyter labextension list 2>&1 | grep -ie "jupyterlab-snippets.*OK"
         python -m jupyterlab.browser_check

.gitignore

@@ -1,8 +1,10 @@
 *.bundle.*
 lib/
 node_modules/
+*.egg-info/
 .ipynb_checkpoints
 *.tsbuildinfo
+jupyterlab_snippets/labextension
 
 # Created by https://www.gitignore.io/api/python
 # Edit at https://www.gitignore.io/?templates=python
@@ -32,7 +34,6 @@ var/
 wheels/
 pip-wheel-metadata/
 share/python-wheels/
-*.egg-info/
 .installed.cfg
 *.egg
 MANIFEST
@@ -107,5 +108,8 @@ dmypy.json
 
 # End of https://www.gitignore.io/api/python
 
+# OSX files
+.DS_Store
+
 yarn.lock
 .vscode

.prettierignore

@@ -0,0 +1,5 @@
+node_modules
+**/node_modules
+**/lib
+**/package.json
+jupyterlab-snippets

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "singleQuote": true,
+  "trailingComma": "none",
+  "arrowParens": "avoid"
+}

MANIFEST.in

@@ -1,12 +1,14 @@
 include LICENSE
 include README.md
-
-include setupbase.py
+include pyproject.toml
 include jupyter-config/jupyterlab-snippets.json
 
 include package.json
+include install.json
 include ts*.json
-include jupyterlab-snippets/labextension/*.tgz
+include yarn.lock
+
+graft jupyterlab_snippets/labextension
 
 # Javascript files
 graft src

binder/environment.yml

@@ -1,7 +1,19 @@
-name: jupyterlan-snippets
+# a mybinder.org-ready environment for demoing jupyterlab-snippets
+# this environment may also be used locally on Linux/MacOS/Windows, e.g.
+#
+#   conda env update --file binder/environment.yml
+#   conda activate jupyterlab-snippets-demo
+#
+name: jupyterlab-snippets-demo
+
 channels:
   - conda-forge
+
 dependencies:
-  - jupyterlab-snippets=0.3.2
-  - jupyterlab >=2
-  - nodejs
+  # runtime dependencies
+  - python >=3.8,<3.9.0a0
+  - jupyterlab >=3,<4.0.0a0
+  # labextension build dependencies
+  - nodejs >=14,<15
+  - pip
+  - wheel

binder/postBuild

@@ -1,6 +1,9 @@
-#!/bin/bash
+#!/usr/bin/env sh
+""" perform a development install of jupyterlab-snippets
 
-# install snippets
+    On Binder, this will run _after_ the environment has been fully created from
+    the environment.yml in this directory.
+"""
 
 cd jupyter-boilerplate-converter
 git clone git://github.com/moble/jupyter_boilerplate
@@ -23,7 +26,23 @@ cd ../binder
 
 ln -s $SNIPPET_DIR snippets_symlink
 
-# prepare Jupyter Lab
+cd ..
 
-jupyter lab build
+# verify the environment is self-consistent before even starting
+python -m pip check
 
+# install the labextension
+python -m pip install -e .
+
+# verify the environment the extension didn't break anything
+python -m pip check
+
+# list the extensions
+jupyter server extension list
+
+# initially list installed extensions to determine if there are any surprises
+jupyter labextension list
+
+
+echo "JupyterLab with jupyterlab-snippets is ready to run with:"
+echo "    jupyter lab"

install.json

@@ -0,0 +1,5 @@
+{
+  "packageManager": "python",
+  "packageName": "jupyterlab-snippets",
+  "uninstallInstructions": "Use your Python package manager (pip, conda, etc.) to uninstall the package jupyterlab-snippets"
+}

jupyter-config/jupyterlab-snippets.json renamed to jupyter-config/jupyter_notebook_config.d/jupyterlab_snippets.json

@@ -1,7 +1,7 @@
 {
   "NotebookApp": {
     "nbserver_extensions": {
-      "jupyterlab-snippets": true
+      "jupyterlab_snippets": true
     }
   }
-}
+}

jupyter-config/jupyter_server_config.d/jupyterlab_snippets.json

@@ -0,0 +1,7 @@
+{
+  "ServerApp": {
+    "jpserver_extensions": {
+      "jupyterlab_snippets": true
+    }
+  }
+}

jupyterlab-snippets/__init__.py

@@ -0,0 +1,35 @@
+import json
+from pathlib import Path
+
+from ._version import __version__
+from .handlers import setup_handlers
+from .loader import SnippetsLoader
+
+HERE = Path(__file__).parent.resolve()
+
+with (HERE / "labextension" / "package.json").open() as fid:
+    data = json.load(fid)
+
+
+def _jupyter_labextension_paths():
+    return [{"src": "labextension", "dest": data["name"]}]
+
+
+def _jupyter_server_extension_points():
+    return [{"module": "jupyterlab_snippets"}]
+
+
+def _load_jupyter_server_extension(server_app):
+    """Registers the API handler to receive HTTP requests from the frontend extension.
+
+    Parameters
+    ----------
+    server_app: jupyterlab.labapp.LabApp
+        JupyterLab application instance
+    """
+    loader = SnippetsLoader()
+    setup_handlers(server_app.web_app, loader)
+
+
+# For backward compatibility with the classical notebook
+load_jupyter_server_extension = _load_jupyter_server_extension

jupyterlab-snippets/_version.py

@@ -0,0 +1,19 @@
+import json
+from pathlib import Path
+
+__all__ = ["__version__"]
+
+def _fetchVersion():
+    HERE = Path(__file__).parent.resolve()
+
+    for settings in HERE.rglob("package.json"): 
+        try:
+            with settings.open() as f:
+                return json.load(f)["version"]
+        except FileNotFoundError:
+            pass
+
+    raise FileNotFoundError(f"Could not find package.json under dir {HERE!s}")
+
+__version__ = _fetchVersion()
+