Upgrade template

LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2017-2020, Project Jupyter Contributors
+Copyright (c) 2017-2023, Project Jupyter Contributors
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -1,43 +1,53 @@
-# JupyterLab debug-config-cookiecutter
+# JupyterLab Visual Studio Code configurator
 
-A [cookiecutter](https://github.com/audreyr/cookiecutter) template for creating the IDE config needed to debug the Python and Typescript code in Jupyter projects. Works with both JupyterLab core and any extension.
+A [copier](https://copier.readthedocs.io/en/stable/) template for creating
+the Visual Studio Code configuration needed to debug the Python and Typescript
+code in Jupyter extension projects.
 
-Currently only supports vscode. PRs for setting up other debug tools/techniques are welcome.
+It will add:
 
-## Setup vscode debugging for any JupyterLab Extension
+- Debug configuration to debug your code in Visual Studio Code
+- Development container (can be used to develop within a container)
 
-Install cookiecutter.
+## Setup Visual Studio Code for extensions
+
+> The best is to run this on project generated by the [extension template](https://github.com/jupyterlab/extension-template).
+
+1. Install copier.
 
 ```bash
-pip install cookiecutter
+pip install copier
 ```
 
-Navigate to the root of your Jupyter project, then run
+2. Navigate to the root of your Jupyter project, then run
 
 ```bash
-cookiecutter gh:jupyterlab/debug-config-cookiecutter
+copier -a .copier-answer.vscode.yml copy https://github.com/jupyterlab/vscode-config-template .
 ```
 
-A number of prompts will pop up. DO NOT CHANGE `vscode_config_path`. Answer the rest of the prompts as appropriate for your project
+3. Answer the options questions
 
-Install the debug dev dependencies
+4. Install the extension
 
-```bash
-jlpm install
+```shell
+pip install -e ".[test]"
+jupyter labextension develop . --overwrite
+# Server extension must be manually enabled in develop mode
+# jupyter server extension enable <python_name>
 ```
 
-Build the extension, this will generate the source maps for front-end debugging
+5. Optional, start watching your extension source changes
 
-```bash
-jlpm build
+```shell
+jlpm run watch
 ```
 
-Inside vscode, use the newly added "jlab debug" or "jlab debug (watch)" targets to start debugging.
+6. Inside Visual Studio Code Debug panel, use _Debug JupyterLab with Chrome_.
 
-## Troubleshooting
+## Update configuration
 
-- `Error: ".vscode" directory already exists`: you'll need to delete the existing `.vscode` dir at your project's root. You can force cookiecutter to overwrite the existing dir with:
+To update the configuration to a newer version of the template, execute:
 
-  ```bash
-  cookiecutter gh:jupyterlab/debug-config-cookiecutter -f
-  ```
+```shell
+copier -a .copier-answer.vscode.yml update
+```

copier.yml

@@ -0,0 +1,14 @@
+_min_copier_version: "7.1.0"
+_subdirectory: template
+_tasks:
+  # Create notebooks_dir
+  - ["{{ _copier_python }}", "-c", "from pathlib import Path; Path('{{ notebooks_dir }}').mkdir(parents=True, exist_ok=True)"]
+
+notebooks_dir:
+  type: str
+  help: Directory to start JupyterLab with in
+  default: "notebooks"
+virtual_env_root:
+  type: str
+  help: Python virtual env prefix (leave empty if you use Python extension)
+  default: ""

template/.devcontainer/Dockerfile

@@ -0,0 +1,17 @@
+FROM mcr.microsoft.com/devcontainers/miniconda:0-3
+
+# Copy environment.yml (if found) to a temp location so we update the environment.
+COPY environment.yml /tmp/conda-tmp/
+RUN /opt/conda/bin/conda config --add channels conda-forge \
+    && /opt/conda/bin/conda config --remove channels defaults \
+    && /opt/conda/bin/conda install -y mamba
+RUN umask 0002 && /opt/conda/bin/mamba env update -n base -f /tmp/conda-tmp/environment.yml
+
+# [Optional] Uncomment to install a different version of Python than the default
+# RUN mamba install -y python=3.6 \
+#     && pip install --no-cache-dir pipx \
+#     && pipx reinstall-all
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>

template/.devcontainer/devcontainer.json

@@ -0,0 +1,33 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/miniconda
+{
+    "name": "Miniconda (Python 3)",
+    "build": { 
+        "context": "..",
+        "dockerfile": "Dockerfile"
+    },
+
+    // Features to add to the dev container. More info: https://containers.dev/features.
+    // "features": {},
+
+    // Use 'forwardPorts' to make a list of ports inside the container available locally.
+    // "forwardPorts": [],
+
+    // Use 'postCreateCommand' to run commands after the container is created.
+    // "postCreateCommand": "python --version",
+
+    // Configure tool-specific properties.
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "dbaeumer.vscode-eslint",
+                "esbenp.prettier-vscode",
+                "meganrogge.template-string-converter",
+                "ms-python.python"
+            ]
+        }
+    }
+
+    // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+    // "remoteUser": "root"
+}

{{cookiecutter.vscode_config_path}}/debug.env → template/.vscode/debug.env.jinja

@@ -1,6 +1,6 @@
-{% if cookiecutter.virtual_env_root -%}
+{% if virtual_env_root -%}
 # set VIRTUAL_ENV to the root of your venv
-VIRTUAL_ENV="{{ cookiecutter.virtual_env_root }}"
+VIRTUAL_ENV="{{ virtual_env_root }}"
 
 # jupyter env vars
 JUPYTER_CONFIG_DIR="${VIRTUAL_ENV}/etc/jupyter"

template/.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "esbenp.prettier-vscode",
+    "meganrogge.template-string-converter",
+    "ms-python.python"
+  ]
+}

template/.vscode/launch.json.jinja

@@ -0,0 +1,47 @@
+{
+    // To debug jupyterlab running in a venv or conda env:
+    //   - set up Python env in your workspace as per https://code.visualstudio.com/docs/python/environments
+    //   - add an "envFile" prop to each backend config pointing to .vscode/debug.env
+    //   - configure the .vscode/debug.env file as needed
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "JupyterLab backend",
+            "type": "python",
+            "request": "launch",
+            "args": [
+                "--notebook-dir={{ notebooks_dir }}",
+                "--no-browser",
+                "--ServerApp.token=''",
+                "--port=9999"
+            ],
+            "justMyCode": false,
+            "module": "jupyterlab.labapp",
+            "presentation": {
+                "hidden": true
+            }{% if virtual_env_root -%},
+            "envFile": "${workspaceFolder}/.vscode/debug.env"{%- endif %}
+        },
+        {
+            "name": "JupyterLab in Chrome",
+            "type": "chrome",
+            "request": "launch",
+            "timeout": 180000,
+            "url": "http://localhost:9999/lab",
+            // set webroot to the parent dir of your project's top level package.json
+            "webRoot": "${workspaceFolder}",
+            "presentation": {
+                "hidden": true
+            }
+        }
+    ],
+    "compounds": [
+        {
+            "name": "Debug JupyterLab with Chrome",
+            "configurations": [
+                "JupyterLab backend",
+                "JupyterLab in Chrome"
+            ]
+        }
+    ]
+}

template/.vscode/settings.json.jinja

@@ -0,0 +1,5 @@
+{
+    {% if virtual_env_root -%}
+    "python.defaultInterpreterPath": "{{ virtual_env_root }}/bin/python"
+    {%- endif %}
+}

template/environment.yml

@@ -0,0 +1,12 @@
+# Extension development environment
+channels:
+  - conda-forge
+  - conda-forge/label/jupyterlab_beta
+
+dependencies:
+  # runtime dependencies
+  - python >=3.10,<3.11.0a0
+  - jupyterlab >=4.0.0b0,<5
+  # labextension build dependencies
+  - nodejs >=18,<19
+  - pip

template/{{_copier_conf.answers_file}}.jinja

@@ -0,0 +1,2 @@
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+{{_copier_answers|to_nice_yaml}}