gennaker-tools 0.0.1 → 0.1.2

package/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Angus
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -1,45 +1,119 @@
 # gennaker-tools
 
-## ⚠️ IMPORTANT NOTICE ⚠️
+[![Github Actions Status](https://github.com/agoose77/gennaker-tools/workflows/Build/badge.svg)](https://github.com/agoose77/gennaker-tools/actions/workflows/build.yml)
 
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
+A series of JupyterLab and Jupyter Server extensions to power the gennaker project.
 
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
+## Features
 
-## Purpose
+### TOML ←→ JSON Settings Sync
 
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `gennaker-tools`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
+<img width="1130" height="900" alt="image" src="https://github.com/user-attachments/assets/c9babdd6-d247-45a1-a590-f17165f5b7fb" />
 
-## What is OIDC Trusted Publishing?
+_Synchronise between JSON and TOML representations of settings under the JupyterLab settings path._
 
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
+## Code Snippets
 
-## Setup Instructions
+<img width="1350" height="870" alt="image" src="https://github.com/user-attachments/assets/4e2673a9-3e27-4535-a3b0-b86e27f12f49" />
 
-To properly configure OIDC trusted publishing for this package:
+_Use CodeMirror snippets to autocomplete text and modular units of content._ See https://codemirror.net/docs/ref/#autocomplete.autocompletion for more information.
 
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
+## Reset Command
 
-## DO NOT USE THIS PACKAGE
+```
+gennaker-tools:reset-jupyterlab
+```
 
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
+<img width="887" height="423" alt="image" src="https://github.com/user-attachments/assets/2ef028a5-0eca-45ab-81e1-f22627c427c1" />
 
-## More Information
+_Reset the current session by reloading the page_.
 
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
+## Stateless Execution Command
 
----
+```
+gennaker-tools:restart-run-stateless
+```
 
-**Maintained for OIDC setup purposes only**
+<img width="627" height="318" alt="image" src="https://github.com/user-attachments/assets/079684f8-e7bc-484f-b466-533f2dc1665e" />
+
+_Perform some compute_
+
+<img width="618" height="140" alt="image" src="https://github.com/user-attachments/assets/0029730a-e9ea-4791-8f61-a4ed0da783f8" />
+
+_Modify the earlier state_
+
+<img width="626" height="362" alt="image" src="https://github.com/user-attachments/assets/18ad2055-105e-461e-af36-5be4b4c7c51e" />
+
+_Re-run up to a particular cell, and clear outputs_
+
+## Requirements
+
+- JupyterLab >= 4.0.0
+
+## Install
+
+To install the extension, execute:
+
+```bash
+pip install gennaker-tools
+```
+
+## Uninstall
+
+To remove the extension, execute:
+
+```bash
+pip uninstall gennaker-tools
+```
+
+## Contributing
+
+### Development install
+
+Note: You will need NodeJS to build the extension package.
+
+The `jlpm` command is JupyterLab's pinned version of
+[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
+`yarn` or `npm` in lieu of `jlpm` below.
+
+```bash
+# Clone the repo to your local environment
+# Change directory to the gennaker_tools directory
+# Install package in development mode
+pip install -e "."
+# Link your development version of the extension with JupyterLab
+jupyter labextension develop . --overwrite
+# Rebuild extension Typescript source after making changes
+jlpm build
+```
+
+You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
+
+```bash
+# Watch the source directory in one terminal, automatically rebuilding when needed
+jlpm watch
+# Run JupyterLab in another terminal
+jupyter lab
+```
+
+With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
+
+By default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
+
+```bash
+jupyter lab build --minimize=False
+```
+
+### Development uninstall
+
+```bash
+pip uninstall gennaker-tools
+```
+
+In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
+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 `gennaker-tools` within that folder.
+
+### Packaging the extension
+
+See [RELEASE](RELEASE.md)

package/lib/index.d.ts

@@ -0,0 +1,12 @@
+import { JupyterFrontEndPlugin } from '@jupyterlab/application';
+/**
+ * Initialization data for the gennaker-tools extension.
+ */
+export declare const statelessRunPlugin: JupyterFrontEndPlugin<void>;
+/**
+ * Initialization data for the gennaker-tools extension.
+ */
+export declare const reloadPlugin: JupyterFrontEndPlugin<void>;
+export declare const snippetsPlugin: JupyterFrontEndPlugin<void>;
+declare const _default: JupyterFrontEndPlugin<void>[];
+export default _default;

package/lib/index.js

@@ -0,0 +1,147 @@
+import { INotebookTracker } from '@jupyterlab/notebook';
+import { ICommandPalette } from '@jupyterlab/apputils';
+import { ITranslator, nullTranslator } from '@jupyterlab/translation';
+import { IEditorExtensionRegistry, EditorExtensionRegistry } from '@jupyterlab/codemirror';
+import { snippetCompletion, autocompletion, completeFromList } from '@codemirror/autocomplete';
+const RESTART_RUN_STATELESS = 'gennaker-tools:restart-run-stateless';
+const RESET_JUPYTERLAB = 'gennaker-tools:reset-jupyterlab';
+/**
+ * Initialization data for the gennaker-tools extension.
+ */
+export const statelessRunPlugin = {
+    id: 'gennaker-tools:stateless-run',
+    description: 'A JupyterLab extension.',
+    autoStart: true,
+    requires: [ICommandPalette, INotebookTracker],
+    optional: [ITranslator],
+    activate: (app, palette, tracker, translator) => {
+        const trans = (translator !== null && translator !== void 0 ? translator : nullTranslator).load('jupyterlab');
+        const { commands, shell } = app;
+        console.log('JupyterLab extension gennaker-tools is activated!');
+        // Add a command
+        const isEnabled = () => {
+            console.log('enabed', { tracker, shell });
+            return (tracker.currentWidget !== null &&
+                tracker.currentWidget === shell.currentWidget);
+        };
+        commands.addCommand(RESTART_RUN_STATELESS, {
+            label: 'Restart Kernel, Clear Outputs, and Run All Above Selected Cell',
+            caption: 'Clear all outputs, restart kernel, and run all cells above the selected cell',
+            isEnabled,
+            execute: async (args) => {
+                const orig = args['origin'];
+                console.log(`${RESTART_RUN_STATELESS} has been called from... ${orig}.`);
+                if (orig !== 'init') {
+                    // Clear all outputs
+                    await commands.execute('apputils:run-all-enabled', {
+                        commands: [
+                            'notebook:clear-all-cell-outputs',
+                            'notebook:restart-and-run-to-selected'
+                        ]
+                    });
+                }
+            }
+        });
+        // Add the command to the command palette
+        const category = trans.__('Notebook Operations');
+        palette.addItem({
+            command: RESTART_RUN_STATELESS,
+            category,
+            args: { origin: 'from palette' }
+        });
+    }
+};
+/**
+ * Initialization data for the gennaker-tools extension.
+ */
+export const reloadPlugin = {
+    id: 'gennaker-tools:reload',
+    description: 'A JupyterLab extension.',
+    autoStart: true,
+    requires: [ICommandPalette],
+    optional: [ITranslator],
+    activate: (app, palette, translator) => {
+        const { commands } = app;
+        const trans = (translator !== null && translator !== void 0 ? translator : nullTranslator).load('jupyterlab');
+        commands.addCommand(RESET_JUPYTERLAB, {
+            label: 'Reset JupyterLab',
+            caption: 'Reset JupyterLab',
+            isEnabled: () => true,
+            execute: (args) => {
+                const orig = args['origin'];
+                if (orig !== 'init') {
+                    window.location.reload();
+                }
+            }
+        });
+        // Add the command to the command palette
+        const category = trans.__('Reset');
+        palette.addItem({
+            command: RESET_JUPYTERLAB,
+            category,
+            args: { origin: 'from palette' }
+        });
+    }
+};
+const SNIPPET_EXTENSION_SCHEMA = {
+    properties: {
+        snippets: {
+            type: 'array',
+            title: 'Codemirror snippets',
+            description: 'Snippets of the form accepted by Codemirrors snippetCompletion',
+            items: {
+                type: 'object',
+                properties: {
+                    type: {
+                        type: 'string',
+                        enum: [
+                            'class',
+                            'constant',
+                            'enum',
+                            'function',
+                            'interface',
+                            'keyword',
+                            'method',
+                            'namespace',
+                            'property',
+                            'text',
+                            'type',
+                            'variable'
+                        ]
+                    },
+                    body: { type: 'string' },
+                    label: { type: 'string' }
+                },
+                required: ['type', 'body', 'label']
+            }
+        }
+    },
+    additionalProperties: false,
+    type: 'object'
+};
+const SNIPPETS_PLUGIN_ID = 'gennaker-tools:snippets';
+export const snippetsPlugin = {
+    id: SNIPPETS_PLUGIN_ID,
+    description: 'A JupyterLab extension.',
+    autoStart: true,
+    requires: [IEditorExtensionRegistry],
+    optional: [],
+    activate: (app, registry) => {
+        registry.addExtension(Object.freeze({
+            name: 'gennaker-tools:snippets',
+            factory: () => EditorExtensionRegistry.createConfigurableExtension((config) => {
+                return autocompletion({
+                    override: [
+                        completeFromList(config.snippets.map(snippet => {
+                            const { body, ...rest } = snippet;
+                            return snippetCompletion(body, rest);
+                        }))
+                    ]
+                });
+            }),
+            default: { snippets: [] },
+            schema: SNIPPET_EXTENSION_SCHEMA
+        }));
+    }
+};
+export default [statelessRunPlugin, reloadPlugin, snippetsPlugin];

package/package.json

@@ -1,10 +1,193 @@
 {
-  "name": "gennaker-tools",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for gennaker-tools",
-  "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
+    "name": "gennaker-tools",
+    "version": "0.1.2",
+    "description": "A JupyterLab extension to provide a restart-and-run-to-selected command variant that clears non-executed cell outputs.",
+    "keywords": [
+        "jupyter",
+        "jupyterlab",
+        "jupyterlab-extension"
+    ],
+    "homepage": "",
+    "bugs": {
+        "url": "https://github.com/agoose77/gennaker-tools/issues"
+    },
+    "license": "BSD-3-Clause",
+    "author": {
+        "name": "Angus",
+        "email": "angus@oieltd.com"
+    },
+    "files": [
+        "lib/**/*.{d.ts,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf}",
+        "style/**/*.{css,js,eot,gif,html,jpg,json,png,svg,woff2,ttf}",
+        "schema/*.json",
+        "src/**/*.{ts,tsx}"
+    ],
+    "main": "lib/index.js",
+    "types": "lib/index.d.ts",
+    "style": "style/index.css",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/agoose77/gennaker-tools.git"
+    },
+    "scripts": {
+        "build": "jlpm build:lib && jlpm build:labextension:dev",
+        "build:prod": "jlpm clean && jlpm build:lib:prod && jlpm build:labextension",
+        "build:labextension": "jupyter labextension build .",
+        "build:labextension:dev": "jupyter labextension build --development True .",
+        "build:lib": "tsc --sourceMap",
+        "build:lib:prod": "tsc",
+        "clean": "jlpm clean:lib",
+        "clean:lib": "rimraf lib tsconfig.tsbuildinfo",
+        "clean:lintcache": "rimraf .eslintcache .stylelintcache",
+        "clean:labextension": "rimraf gennaker_tools/labextension gennaker_tools/_version.py",
+        "clean:all": "jlpm clean:lib && jlpm clean:labextension && jlpm clean:lintcache",
+        "eslint": "jlpm eslint:check --fix",
+        "eslint:check": "eslint . --cache --ext .ts,.tsx",
+        "install:extension": "jlpm build",
+        "lint": "jlpm stylelint && jlpm prettier && jlpm eslint",
+        "lint:check": "jlpm stylelint:check && jlpm prettier:check && jlpm eslint:check",
+        "prettier": "jlpm prettier:base --write --list-different",
+        "prettier:base": "prettier \"**/*{.ts,.tsx,.js,.jsx,.css,.json,.md}\"",
+        "prettier:check": "jlpm prettier:base --check",
+        "stylelint": "jlpm stylelint:check --fix",
+        "stylelint:check": "stylelint --cache \"style/**/*.css\"",
+        "watch": "run-p watch:src watch:labextension",
+        "watch:src": "tsc -w --sourceMap",
+        "watch:labextension": "jupyter labextension watch ."
+    },
+    "dependencies": {
+        "@codemirror/autocomplete": "^6.0.1",
+        "@jupyterlab/application": "^4.4.0",
+        "@jupyterlab/codemirror": "^4.4.0",
+        "@jupyterlab/mainmenu": "^4.4.0",
+        "@jupyterlab/notebook": "^4.4.0"
+    },
+    "devDependencies": {
+        "@jupyterlab/builder": "^4.2.0",
+        "@types/json-schema": "^7.0.11",
+        "@types/react": "^18.0.26",
+        "@types/react-addons-linked-state-mixin": "^0.14.22",
+        "@typescript-eslint/eslint-plugin": "^6.1.0",
+        "@typescript-eslint/parser": "^6.1.0",
+        "css-loader": "^6.7.1",
+        "eslint": "^8.36.0",
+        "eslint-config-prettier": "^8.8.0",
+        "eslint-plugin-prettier": "^5.0.0",
+        "npm-run-all2": "^7.0.1",
+        "prettier": "^3.0.0",
+        "rimraf": "^5.0.1",
+        "source-map-loader": "^1.0.2",
+        "style-loader": "^3.3.1",
+        "stylelint": "^15.10.1",
+        "stylelint-config-recommended": "^13.0.0",
+        "stylelint-config-standard": "^34.0.0",
+        "stylelint-csstree-validator": "^3.0.0",
+        "stylelint-prettier": "^4.0.0",
+        "typescript": "~5.5.4",
+        "yjs": "^13.5.0"
+    },
+    "sideEffects": [
+        "style/*.css",
+        "style/index.js"
+    ],
+    "styleModule": "style/index.js",
+    "publishConfig": {
+        "access": "public"
+    },
+    "jupyterlab": {
+        "extension": true,
+        "outputDir": "gennaker_tools/labextension",
+        "schemaDir": "schema"
+    },
+    "eslintIgnore": [
+        "node_modules",
+        "dist",
+        "coverage",
+        "**/*.d.ts"
+    ],
+    "eslintConfig": {
+        "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"
+        }
+    },
+    "prettier": {
+        "singleQuote": true,
+        "trailingComma": "none",
+        "arrowParens": "avoid",
+        "endOfLine": "auto",
+        "overrides": [
+            {
+                "files": "package.json",
+                "options": {
+                    "tabWidth": 4
+                }
+            }
+        ]
+    },
+    "stylelint": {
+        "extends": [
+            "stylelint-config-recommended",
+            "stylelint-config-standard",
+            "stylelint-prettier/recommended"
+        ],
+        "plugins": [
+            "stylelint-csstree-validator"
+        ],
+        "rules": {
+            "csstree/validator": true,
+            "property-no-vendor-prefix": null,
+            "selector-class-pattern": "^([a-z][A-z\\d]*)(-[A-z\\d]+)*$",
+            "selector-no-vendor-prefix": null,
+            "value-no-vendor-prefix": null
+        }
+    }
 }

package/schema/stateless-run.json

@@ -0,0 +1,17 @@
+{
+  "title": "Gennaker Settings",
+  "description": "Gennaker tools settings.",
+  "jupyter.lab.menus": {
+    "main": [
+      {
+        "id": "jp-mainmenu-run",
+        "items": [
+          {
+            "command": "stateless:clear-restart-run-to-selected",
+            "rank": 80
+          }
+        ]
+      }
+    ]
+  }
+}

package/src/index.ts

@@ -0,0 +1,199 @@
+import {
+  JupyterFrontEnd,
+  JupyterFrontEndPlugin
+} from '@jupyterlab/application';
+import { INotebookTracker } from '@jupyterlab/notebook';
+import { ICommandPalette } from '@jupyterlab/apputils';
+import { ITranslator, nullTranslator } from '@jupyterlab/translation';
+import {
+  IEditorExtensionRegistry,
+  EditorExtensionRegistry
+} from '@jupyterlab/codemirror';
+import {
+  snippetCompletion,
+  autocompletion,
+  completeFromList
+} from '@codemirror/autocomplete';
+import type { Completion } from '@codemirror/autocomplete';
+
+const RESTART_RUN_STATELESS = 'gennaker-tools:restart-run-stateless';
+const RESET_JUPYTERLAB = 'gennaker-tools:reset-jupyterlab';
+
+/**
+ * Initialization data for the gennaker-tools extension.
+ */
+export const statelessRunPlugin: JupyterFrontEndPlugin<void> = {
+  id: 'gennaker-tools:stateless-run',
+  description: 'A JupyterLab extension.',
+  autoStart: true,
+  requires: [ICommandPalette, INotebookTracker],
+  optional: [ITranslator],
+  activate: (
+    app: JupyterFrontEnd,
+    palette: ICommandPalette,
+    tracker: INotebookTracker,
+    translator: ITranslator | null
+  ) => {
+    const trans = (translator ?? nullTranslator).load('jupyterlab');
+    const { commands, shell } = app;
+
+    console.log('JupyterLab extension gennaker-tools is activated!');
+    // Add a command
+
+    const isEnabled = () => {
+      console.log('enabed', { tracker, shell });
+      return (
+        tracker.currentWidget !== null &&
+        tracker.currentWidget === shell.currentWidget
+      );
+    };
+
+    commands.addCommand(RESTART_RUN_STATELESS, {
+      label: 'Restart Kernel, Clear Outputs, and Run All Above Selected Cell',
+      caption:
+        'Clear all outputs, restart kernel, and run all cells above the selected cell',
+      isEnabled,
+      execute: async (args: any) => {
+        const orig = args['origin'];
+        console.log(
+          `${RESTART_RUN_STATELESS} has been called from... ${orig}.`
+        );
+        if (orig !== 'init') {
+          // Clear all outputs
+          await commands.execute('apputils:run-all-enabled', {
+            commands: [
+              'notebook:clear-all-cell-outputs',
+              'notebook:restart-and-run-to-selected'
+            ]
+          });
+        }
+      }
+    });
+
+    // Add the command to the command palette
+    const category = trans.__('Notebook Operations');
+    palette.addItem({
+      command: RESTART_RUN_STATELESS,
+      category,
+      args: { origin: 'from palette' }
+    });
+  }
+};
+
+/**
+ * Initialization data for the gennaker-tools extension.
+ */
+export const reloadPlugin: JupyterFrontEndPlugin<void> = {
+  id: 'gennaker-tools:reload',
+  description: 'A JupyterLab extension.',
+  autoStart: true,
+  requires: [ICommandPalette],
+  optional: [ITranslator],
+  activate: (
+    app: JupyterFrontEnd,
+    palette: ICommandPalette,
+    translator: ITranslator | null
+  ) => {
+    const { commands } = app;
+    const trans = (translator ?? nullTranslator).load('jupyterlab');
+
+    commands.addCommand(RESET_JUPYTERLAB, {
+      label: 'Reset JupyterLab',
+      caption: 'Reset JupyterLab',
+      isEnabled: () => true,
+      execute: (args: any) => {
+        const orig = args['origin'];
+        if (orig !== 'init') {
+          window.location.reload();
+        }
+      }
+    });
+
+    // Add the command to the command palette
+    const category = trans.__('Reset');
+    palette.addItem({
+      command: RESET_JUPYTERLAB,
+      category,
+      args: { origin: 'from palette' }
+    });
+  }
+};
+
+type SnippetConfigurationItem = Completion & { body: string };
+type SnippetConfiguration = {
+  snippets: SnippetConfigurationItem[];
+};
+
+const SNIPPET_EXTENSION_SCHEMA = {
+  properties: {
+    snippets: {
+      type: 'array',
+      title: 'Codemirror snippets',
+      description:
+        'Snippets of the form accepted by Codemirrors snippetCompletion',
+      items: {
+        type: 'object',
+        properties: {
+          type: {
+            type: 'string',
+            enum: [
+              'class',
+              'constant',
+              'enum',
+              'function',
+              'interface',
+              'keyword',
+              'method',
+              'namespace',
+              'property',
+              'text',
+              'type',
+              'variable'
+            ]
+          },
+
+          body: { type: 'string' },
+          label: { type: 'string' }
+        },
+        required: ['type', 'body', 'label']
+      }
+    }
+  },
+  additionalProperties: false,
+  type: 'object'
+};
+
+const SNIPPETS_PLUGIN_ID = 'gennaker-tools:snippets';
+export const snippetsPlugin: JupyterFrontEndPlugin<void> = {
+  id: SNIPPETS_PLUGIN_ID,
+  description: 'A JupyterLab extension.',
+  autoStart: true,
+  requires: [IEditorExtensionRegistry],
+  optional: [],
+  activate: (app: JupyterFrontEnd, registry: IEditorExtensionRegistry) => {
+    registry.addExtension(
+      Object.freeze({
+        name: 'gennaker-tools:snippets',
+        factory: () =>
+          EditorExtensionRegistry.createConfigurableExtension(
+            (config: SnippetConfiguration) => {
+              return autocompletion({
+                override: [
+                  completeFromList(
+                    config.snippets.map(snippet => {
+                      const { body, ...rest } = snippet;
+                      return snippetCompletion(body, rest);
+                    })
+                  )
+                ]
+              });
+            }
+          ),
+        default: { snippets: [] },
+        schema: SNIPPET_EXTENSION_SCHEMA
+      })
+    );
+  }
+};
+
+export default [statelessRunPlugin, reloadPlugin, snippetsPlugin];

package/style/base.css

@@ -0,0 +1,5 @@
+/*
+    See the JupyterLab Developer Guide for useful CSS Patterns:
+
+    https://jupyterlab.readthedocs.io/en/stable/developer/css.html
+*/

package/style/index.css

@@ -0,0 +1 @@
+@import url('base.css');

package/style/index.js

@@ -0,0 +1 @@
+import './base.css';