Rename 'server' kind to 'frontend-and-server' (#109)

* Rename 'server' kind to 'frontend-and-server'

* Remove final newline

Author: petebachant

.github/workflows/main.yml

@@ -230,7 +230,7 @@ jobs:
           YARN_ENABLE_IMMUTABLE_INSTALLS: false
         run: |
           mkdir myextension
-          python -m copier copy -l -d kind=server -d author_name="My Name" -d repository="https://github.com/test/lab-extension" --vcs-ref HEAD --UNSAFE . myextension
+          python -m copier copy -l -d kind=frontend-and-server -d author_name="My Name" -d repository="https://github.com/test/lab-extension" --vcs-ref HEAD --UNSAFE . myextension
           cd myextension
           cat pyproject.toml
           pip install .
@@ -258,7 +258,7 @@ jobs:
           YARN_ENABLE_IMMUTABLE_INSTALLS: false
         run: |
           mkdir myextension
-          python -m copier copy -l -d kind=server -d author_name="My Name" -d repository="https://github.com/test/lab-extension" --vcs-ref HEAD --UNSAFE . myextension
+          python -m copier copy -l -d kind=frontend-and-server -d author_name="My Name" -d repository="https://github.com/test/lab-extension" --vcs-ref HEAD --UNSAFE . myextension
           cd myextension
           python -m pip install -e .[test]
           python -m pip install "jupyterlab>=4.0.0,<5" setuptools
@@ -298,7 +298,7 @@ jobs:
           YARN_ENABLE_IMMUTABLE_INSTALLS: false
         run: |
           mkdir myextension
-          python -m copier copy -l -d kind=server -d author_name="My Name" -d repository="https://github.com/test/lab-extension" --vcs-ref HEAD --UNSAFE . myextension
+          python -m copier copy -l -d kind=frontend-and-server -d author_name="My Name" -d repository="https://github.com/test/lab-extension" --vcs-ref HEAD --UNSAFE . myextension
           cd myextension
           python -m pip install "jupyterlab>=4.0.0,<5"
           jupyter lab clean --all
@@ -464,7 +464,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        kind: ["frontend", "server", "theme"]
+        kind: ["frontend", "frontend-and-server", "theme"]
 
     steps:
       - name: Checkout

README.md

@@ -6,7 +6,7 @@ A [copier](https://copier.readthedocs.io) template for creating
 a JupyterLab extension. Four kinds of extension are supported:
 - _frontend_: Pure frontend extension written in TypeScript.
 - _mimerenderer_: MIME renderer extension.
-- _server_: Extension with frontend (in TypeScript) and backend (in Python) parts.
+- _frontend-and-server_: Extension with frontend (in TypeScript) and backend (in Python) parts.
 - _theme_: Theme for JupyterLab (using CSS variables).
 
 ## Use the template to create extension
@@ -38,7 +38,7 @@ cd myextension
 copier copy --trust https://github.com/jupyterlab/extension-template .
 ```
 
-> If you are using Visual Studio Code, you may be interested in the 
+> If you are using Visual Studio Code, you may be interested in the
 > [configuration template](https://github.com/jupyterlab/vscode-config-template) for JupyterLab extension.
 
 ---
@@ -49,7 +49,7 @@ If you'd like to generate an extension for a older release, use the `--vcs-ref`
 copier copy --vcs-ref v4.0.0 --trust https://github.com/jupyterlab/extension-template .
 ```
 
-> If you are looking for a template compatible with JupyterLab version prior to 4.0.0, look at 
+> If you are looking for a template compatible with JupyterLab version prior to 4.0.0, look at
 > the [cookiecutter template](https://github.com/jupyterlab/extension-cookiecutter-ts) or the
 > [mimerenderer template](https://github.com/jupyterlab/mimerender-cookiecutter-ts).
 

copier.yml

@@ -1,7 +1,7 @@
 _min_copier_version: "7.1.0"
 _subdirectory: template
 _jinja_extensions:
-    - jinja2_time.TimeExtension
+  - jinja2_time.TimeExtension
 
 kind:
   type: str
@@ -10,7 +10,7 @@ kind:
   choices:
     - frontend
     - mimerenderer
-    - server
+    - frontend-and-server
     - theme
 
 author_name:

template/.github/workflows/build.yml.jinja

@@ -39,7 +39,7 @@ jobs:
       run: |
         set -eux
         python -m pip install .[test]
-{% if kind.lower() == 'server' %}{% if test %}
+{% if kind.lower() == 'frontend-and-server' %}{% if test %}
         pytest -vv -r ap --cov {{ python_name }}{% endif %}
         jupyter server extension list
         jupyter server extension list 2>&1 | grep -ie "{{ python_name }}.*OK"
@@ -85,7 +85,7 @@ jobs:
 
         pip install "jupyterlab>=4.0.0,<5" {{ python_name }}*.whl
 
-{% if kind.lower() == 'server' %}
+{% if kind.lower() == 'frontend-and-server' %}
         jupyter server extension list
         jupyter server extension list 2>&1 | grep -ie "{{ python_name }}.*OK"
 {% endif %}

template/README.md.jinja

@@ -6,7 +6,7 @@
 
 {% endif %}
 {{ project_short_description }}
-{% if kind.lower() == 'server' %}
+{% if kind.lower() == 'frontend-and-server' %}
 This extension is composed of a Python package named `{{ python_name }}`
 for the server extension and a NPM package named `{{ labextension_name }}`
 for the frontend extension.
@@ -30,7 +30,7 @@ To remove the extension, execute:
 ```bash
 pip uninstall {{ python_name }}
 ```
-{% if kind.lower() == 'server' %}
+{% if kind.lower() == 'frontend-and-server' %}
 ## Troubleshoot
 
 If you are seeing the frontend extension, but it is not working, check
@@ -61,9 +61,9 @@ The `jlpm` command is JupyterLab's pinned version of
 # Clone the repo to your local environment
 # Change directory to the {{ python_name }} directory
 # Install package in development mode
-pip install -e ".{% if test and kind.lower() == 'server' %}[test]{% endif %}"
+pip install -e ".{% if test and kind.lower() == 'frontend-and-server' %}[test]{% endif %}"
 # Link your development version of the extension with JupyterLab
-jupyter labextension develop . --overwrite{% if kind.lower() == 'server' %}
+jupyter labextension develop . --overwrite{% if kind.lower() == 'frontend-and-server' %}
 # Server extension must be manually installed in develop mode
 jupyter server extension enable {{ python_name }}{% endif %}
 # Rebuild extension Typescript source after making changes
@@ -89,7 +89,7 @@ jupyter lab build --minimize=False
 
 ### Development uninstall
 
-```bash{% if kind.lower() == 'server' %}
+```bash{% if kind.lower() == 'frontend-and-server' %}
 # Server extension must be manually disabled in develop mode
 jupyter server extension disable {{ python_name }}{% endif %}
 pip uninstall {{ python_name }}
@@ -99,7 +99,7 @@ In development mode, you will also need to remove the symlink created by `jupyte
 command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
 folder is located. Then you can remove the symlink named `{{ labextension_name }}` within that folder.
 {% if test %}
-### Testing the extension{% if kind.lower() == 'server' %}
+### Testing the extension{% if kind.lower() == 'frontend-and-server' %}
 
 #### Server tests
 

template/package.json.jinja

@@ -58,7 +58,7 @@
     },
     "dependencies": {
         {% if kind.lower() != 'mimerenderer' %}"@jupyterlab/application": "^4.0.0"{% if kind.lower() == 'theme' %},
-        "@jupyterlab/apputils": "^4.0.0"{% endif %}{% if kind.lower() == 'server' %},
+        "@jupyterlab/apputils": "^4.0.0"{% endif %}{% if kind.lower() == 'frontend-and-server' %},
         "@jupyterlab/coreutils": "^6.0.0",
         "@jupyterlab/services": "^7.0.0"{% endif %}{% if has_settings %},
         "@jupyterlab/settingregistry": "^4.0.0"{% endif %}{% else %}"@jupyterlab/rendermime-interfaces": "^3.8.0",
@@ -77,7 +77,7 @@
         "eslint": "^8.36.0",
         "eslint-config-prettier": "^8.8.0",
         "eslint-plugin-prettier": "^5.0.0",{% if test %}
-        "jest": "^29.2.0",{% endif %}{% if kind.lower() == 'server' %}
+        "jest": "^29.2.0",{% endif %}{% if kind.lower() == 'frontend-and-server' %}
         "mkdirp": "^1.0.3",{% endif %}
         "npm-run-all2": "^7.0.1",
         "prettier": "^3.0.0",
@@ -101,7 +101,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "jupyterlab": { {%- if kind.lower() == 'server' %}
+    "jupyterlab": { {%- if kind.lower() == 'frontend-and-server' %}
         "discovery": {
             "server": {
                 "managers": [

template/pyproject.toml.jinja

@@ -24,11 +24,11 @@ classifiers = [
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
 ]
-dependencies = [{% if kind.lower() == "server" %}
+dependencies = [{% if kind.lower() == "frontend-and-server" %}
     "jupyter_server>=2.4.0,<3"{% endif %}
 ]
 dynamic = ["version", "description", "authors", "urls", "keywords"]
-{% if test and kind.lower() == 'server' %}
+{% if test and kind.lower() == 'frontend-and-server' %}
 [project.optional-dependencies]
 test = [
     "coverage",
@@ -50,7 +50,7 @@ exclude = [".github", "binder"]
 
 [tool.hatch.build.targets.wheel.shared-data]
 "{{ python_name }}/labextension" = "share/jupyter/labextensions/{{ labextension_name }}"
-"install.json" = "share/jupyter/labextensions/{{ labextension_name }}/install.json"{% if kind.lower() == "server" %}
+"install.json" = "share/jupyter/labextensions/{{ labextension_name }}/install.json"{% if kind.lower() == "frontend-and-server" %}
 "jupyter-config/server-config" = "etc/jupyter/jupyter_server_config.d"{% endif %}
 
 [tool.hatch.build.hooks.version]

template/src/index.ts.jinja

@@ -5,7 +5,7 @@
 
 import { IThemeManager } from '@jupyterlab/apputils';{% endif %}{% if has_settings %}
 
-import { ISettingRegistry } from '@jupyterlab/settingregistry';{% endif %}{% if kind.lower() == 'server' %}
+import { ISettingRegistry } from '@jupyterlab/settingregistry';{% endif %}{% if kind.lower() == 'frontend-and-server' %}
 
 import { requestAPI } from './handler';{% endif %}
 
@@ -38,7 +38,7 @@ const plugin: JupyterFrontEndPlugin<void> = {
         .catch(reason => {
           console.error('Failed to load settings for {{ labextension_name }}.', reason);
         });
-    }{% endif %}{% if kind.lower() == 'server' %}
+    }{% endif %}{% if kind.lower() == 'frontend-and-server' %}
 
     requestAPI<any>('get-example')
       .then(data => {

template/src/{% if kind == 'server' %}handler.ts{% endif %}.jinja renamed to template/src/{% if kind == 'frontend-and-server' %}handler.ts{% endif %}.jinja

@@ -31,7 +31,7 @@ _(sys.executable, "-m", "pip", "check")
 
 # install the labextension
 _(sys.executable, "-m", "pip", "install", "-e", ".")
-_(sys.executable, "-m", "jupyter", "labextension", "develop", "--overwrite", "."){% if kind.lower() == 'server' %}
+_(sys.executable, "-m", "jupyter", "labextension", "develop", "--overwrite", "."){% if kind.lower() == 'frontend-and-server' %}
 _(
     sys.executable,
     "-m",