Merge pull request #69 from ianhi/get-working-tests

jlab2 support + fix tests

Author: martinRenou

.travis.yml

@@ -14,7 +14,7 @@ cache:
     - $HOME/.npm
 before_install:
   - pip install -U pip setuptools
-  - nvm install 8
+  - nvm install 12
   - pip install cookiecutter
 install:
   - pushd $(mktemp -d)

README.md

@@ -54,6 +54,7 @@ When developing your extensions, you need to manually enable your extensions wit
 notebook / lab frontend. For lab, this is done by the command:
 
 ```
+jupyter labextension install @jupyter-widgets/jupyterlab-manager --no-build
 jupyter labextension install .
 ```
 

{{cookiecutter.github_project_name}}/.travis.yml

@@ -27,7 +27,7 @@ cache:
     - $HOME/.npm
 before_install:
   - pip install -U pip setuptools
-  - nvm install 8
+  - nvm install 12
   - |
     if [[ $GROUP == python ]]; then
       pip install codecov

{{cookiecutter.github_project_name}}/css/widget.css

@@ -1,3 +1,4 @@
 .custom-widget {
-  background-color: blue;
+  background-color: lightseagreen;
+  padding: 0px 2px;
 }

{{cookiecutter.github_project_name}}/docs/source/conf.py

@@ -29,7 +29,7 @@
     'sphinx.ext.napoleon',
     'sphinx.ext.todo',
     'nbsphinx',
-    'jupyter_sphinx.embed_widgets',
+    'jupyter_sphinx.execute',
     'nbsphinx_link',
 ]
 
@@ -197,12 +197,13 @@
 #
 nbsphinx_allow_errors = True # exception ipstruct.py ipython_genutils
 
+from sphinx.util import logging
+logger = logging.getLogger(__name__)
 
 def setup(app):
-    app.setup_extension('jupyter_sphinx.embed_widgets')
     def add_scripts(app):
         for fname in ['helper.js', 'embed-bundle.js']:
             if not os.path.exists(os.path.join(here, '_static', fname)):
-                app.warn('missing javascript file: %s' % fname)
-            app.add_javascript(fname)
-    app.connect('builder-inited', add_scripts)
+                logger.warning('missing javascript file: %s' % fname)
+            app.add_js_file(fname)
+    app.connect('builder-inited', add_scripts)

{{cookiecutter.github_project_name}}/examples/introduction.ipynb

@@ -22,7 +22,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "w = {{ cookiecutter.python_package_name }}.ExampleWidget()"
+    "w = {{ cookiecutter.python_package_name }}.ExampleWidget()\n",
+    "w"
    ]
   },
   {

{{cookiecutter.github_project_name}}/package.json

@@ -49,7 +49,7 @@
     "watch:nbextension": "webpack --watch"
   },
   "dependencies": {
-    "@jupyter-widgets/base": "^1.1.10 || ^2"
+    "@jupyter-widgets/base": "^1.1.10 || ^2 || ^3"
   },
   "devDependencies": {
     "@phosphor/application": "^1.6.0",
@@ -58,24 +58,26 @@
     "@types/mocha": "^5.2.5",
     "@types/node": "^10.11.6",
     "@types/webpack-env": "^1.13.6",
+    "acorn": "^7.2.0",
     "css-loader": "^3.2.0",
     "expect.js": "^0.3.1",
     "fs-extra": "^7.0.0",
-    "karma": "^3.0.0",
+    "karma": "^3.1.0",
     "karma-chrome-launcher": "^2.2.0",
     "karma-firefox-launcher": "^1.1.0",
     "karma-ie-launcher": "^1.0.0",
     "karma-mocha": "^1.3.0",
     "karma-mocha-reporter": "^2.2.5",
-    "karma-typescript": "^3.0.13",
+    "karma-typescript": "^5.0.3",
+    "karma-typescript-es6-transform": "^5.0.3",
     "mkdirp": "^0.5.1",
     "mocha": "^5.2.0",
     "npm-run-all": "^4.1.3",
     "rimraf": "^2.6.2",
     "source-map-loader": "^0.2.4",
     "style-loader": "^1.0.0",
     "ts-loader": "^5.2.1",
-    "typescript": "~3.1.2",
+    "typescript": "~3.8",
     "webpack": "^4.20.2",
     "webpack-cli": "^3.1.2"
   },

{{cookiecutter.github_project_name}}/src/plugin.ts

@@ -29,7 +29,9 @@ const examplePlugin: IPlugin<Application<Widget>, void> = {
   requires: [IJupyterWidgetRegistry],
   activate: activateWidgetExtension,
   autoStart: true
-};
+} as unknown as IPlugin<Application<Widget>, void>;
+// the "as unknown as ..." typecast above is solely to support JupyterLab 1
+// and 2 in the same codebase and should be removed when we migrate to Lumino.
 
 export default examplePlugin;
 

{{cookiecutter.github_project_name}}/tests/karma.conf.js

@@ -35,6 +35,11 @@ module.exports = function (config) {
           "directory": "coverage",
           "filename": "coverage.lcov"
         }
+      },
+      bundlerOptions: {
+        transforms: [
+            require("karma-typescript-es6-transform")()
+        ]
       }
     }
   });

{{cookiecutter.github_project_name}}/tests/src/utils.spec.ts

@@ -21,7 +21,7 @@ class MockComm {
     on_msg(fn: Function | null) {
         this._on_msg = fn;
     }
-    _process_msg(msg: services.KernelMessage.ICommMsg) {
+    _process_msg(msg: services.KernelMessage.ICommMsgMsg) {
         if (this._on_msg) {
             return this._on_msg(msg);
         } else {