Add CI to check for changes to js build files

Author: marthacryan

.circleci/config.yml

@@ -14,22 +14,27 @@ executors:
       - image: cimg/python:<<parameters.python_version>>-browsers
 
 commands:
+  check-js-build:
+    description: Fail if JupyterLab extension build artifacts are out of date
+    steps:
+      - run:
+          name: Check JupyterLab build artifacts
+          command: |
+            echo "Checking for uncommitted changes in plotly/labextension/..."
+            git diff --exit-code plotly/labextension/ || (echo "Error: JupyterLab build artifacts out of date. Run 'npm run build' in js/ and commit the results." && exit 1)
+
   test_core:
     steps:
       - checkout
       - browser-tools/install-chrome
       - browser-tools/install-chromedriver
+      - check-js-build
       - run:
           name: Install dependencies
           command: |
             curl -LsSf https://astral.sh/uv/install.sh | sh
             uv venv
             source .venv/bin/activate
-            uv pip install jupyter
-            cd js
-            npm ci
-            npm run build
-            cd ..
             uv pip install .
             uv pip install -r ./test_requirements/requirements_core.txt
       - run:
@@ -55,17 +60,13 @@ commands:
       - checkout
       - browser-tools/install-chrome
       - browser-tools/install-chromedriver
+      - check-js-build
       - run:
           name: Install dependencies
           command: |
             curl -LsSf https://astral.sh/uv/install.sh | sh
             uv venv
             source .venv/bin/activate
-            uv pip install jupyter
-            cd js
-            npm ci
-            npm run build
-            cd ..
             uv pip install .
             uv pip install -r ./test_requirements/requirements_optional.txt
       
@@ -243,11 +244,6 @@ jobs:
             curl -LsSf https://astral.sh/uv/install.sh | sh
             uv venv
             source .venv/bin/activate
-            uv pip install jupyter
-            cd js
-            npm i
-            npm run build
-            cd ..
             uv pip install -e .
             uv pip install -r ./test_requirements/requirements_core.txt black inflect jupyterlab
       - run:
@@ -281,19 +277,6 @@ jobs:
 
     steps:
       - checkout
-
-      - run:
-          name: initial NPM Build
-          command: |
-            curl -LsSf https://astral.sh/uv/install.sh | sh
-            uv venv
-            source .venv/bin/activate
-            uv pip install jupyter
-            cd js
-            npm ci
-            npm run build
-            git status
-
       - run:
           name: PyPI Build
           command: |
@@ -324,6 +307,7 @@ jobs:
       - checkout
       - browser-tools/install-chrome
       - browser-tools/install-chromedriver
+      - check-js-build
 
       - run:
           name: Install dependencies
@@ -337,11 +321,6 @@ jobs:
             if [ "${CIRCLE_BRANCH}" != "doc-prod" ]; then
               uv pip uninstall plotly
               uv pip install -e .
-              uv pip install jupyter
-              cd js
-              npm ci
-              npm run build
-              cd ../..
             fi
 
       - run:

.gitignore

@@ -60,8 +60,6 @@ doc/.ipynb_checkpoints
 tags
 doc/check-or-enforce-order.py
 plotly/package_data/widgetbundle.js
-plotly/labextension/*
-js/lib
 
 tests/percy/*.html
 tests/percy/pandas2/*.html

js/lib/mimeExtension.js

@@ -0,0 +1,38 @@
+{
+  "name": "jupyterlab-plotly",
+  "main": "lib/mimeExtension.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/plotly/plotly.py"
+  },
+  "description": "The plotly Jupyter extension",
+  "author": "The plotly.py team",
+  "license": "MIT",
+  "scripts": {
+    "build:widget": "esbuild --bundle --alias:plotly.js=plotly.js/dist/plotly --format=esm --minify --outfile=../plotly/package_data/widgetbundle.js src/widget.ts",
+    "build:mimerenderer": "esbuild --bundle --alias:plotly.js=plotly.js/dist/plotly --format=esm --minify --outfile=lib/mimeExtension.js src/mimeExtension.ts",
+    "build:labextension": "jupyter labextension build .",
+    "build": "npm run build:widget && npm run build:mimerenderer && npm run build:labextension",
+    "watch": "npm run build -- --watch --sourcemap=inline",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "lodash-es": "^4.17.21",
+    "plotly.js": "3.0.1",
+    "@lumino/widgets": "~2.4.0"
+  },
+  "devDependencies": {
+    "@jupyterlab/builder": "^4.3.6 || ^3.6.8",
+    "@types/plotly.js": "^2.33.4",
+    "esbuild": "^0.23.1",
+    "typescript": "^5.6.2"
+  },
+  "jupyterlab": {
+    "mimeExtension": true,
+    "outputDir": "../plotly/labextension",
+    "_build": {
+      "load": "static/remoteEntry.6da8cafc79c9700a7f84.js",
+      "mimeExtension": "./mimeExtension"
+    }
+  }
+}

plotly/labextension/package.json

@@ -0,0 +1,79 @@
+/*! Bundled license information:
+
+plotly.js/dist/plotly.js:
+  (*!
+   * The buffer module from node.js, for the browser.
+   *
+   * @author   Feross Aboukhadijeh <https://feross.org>
+   * @license  MIT
+   *)
+  (*! ieee754. BSD-3-Clause License. Feross Aboukhadijeh <https://feross.org/opensource> *)
+  (*!
+   * Determine if an object is a Buffer
+   *
+   * @author   Feross Aboukhadijeh <https://feross.org>
+   * @license  MIT
+   *)
+  (*!
+   * pad-left <https://github.com/jonschlinkert/pad-left>
+   *
+   * Copyright (c) 2014-2015, Jon Schlinkert.
+   * Licensed under the MIT license.
+   *)
+  (*!
+   * repeat-string <https://github.com/jonschlinkert/repeat-string>
+   *
+   * Copyright (c) 2014-2015, Jon Schlinkert.
+   * Licensed under the MIT License.
+   *)
+  (*! Bundled license information:
+  
+  native-promise-only/lib/npo.src.js:
+    (*! Native Promise Only
+        v0.8.1 (c) Kyle Simpson
+        MIT License: http://getify.mit-license.org
+    *)
+  
+  polybooljs/index.js:
+    (*
+     * @copyright 2016 Sean Connelly (@voidqk), http://syntheti.cc
+     * @license MIT
+     * @preserve Project Home: https://github.com/voidqk/polybooljs
+     *)
+  
+  ieee754/index.js:
+    (*! ieee754. BSD-3-Clause License. Feross Aboukhadijeh <https://feross.org/opensource> *)
+  
+  buffer/index.js:
+    (*!
+     * The buffer module from node.js, for the browser.
+     *
+     * @author   Feross Aboukhadijeh <https://feross.org>
+     * @license  MIT
+     *)
+  
+  safe-buffer/index.js:
+    (*! safe-buffer. MIT License. Feross Aboukhadijeh <https://feross.org/opensource> *)
+  
+  assert/build/internal/util/comparisons.js:
+    (*!
+     * The buffer module from node.js, for the browser.
+     *
+     * @author   Feross Aboukhadijeh <[email protected]> <http://feross.org>
+     * @license  MIT
+     *)
+  
+  object-assign/index.js:
+    (*
+    object-assign
+    (c) Sindre Sorhus
+    @license MIT
+    *)
+  
+  maplibre-gl/dist/maplibre-gl.js:
+    (**
+     * MapLibre GL JS
+     * @license 3-Clause BSD. Full text of license: https://github.com/maplibre/maplibre-gl-js/blob/v4.7.1/LICENSE.txt
+     *)
+  *)
+*/

plotly/labextension/static/340.183c15a978a3bd06e343.js

@@ -0,0 +1,4 @@
+/* This is a generated file of CSS imports */
+/* It was generated by @jupyterlab/builder in Build.ensureAssets() */
+
+

plotly/labextension/static/340.183c15a978a3bd06e343.js.LICENSE.txt

@@ -0,0 +1,10 @@
+{
+  "packages": [
+    {
+      "name": "process",
+      "versionInfo": "0.11.10",
+      "licenseId": "MIT",
+      "extractedText": "(The MIT License)\n\nCopyright (c) 2013 Roman Shtylman <[email protected]>\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n'Software'), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n"
+    }
+  ]
+}