chore: update template to include settings

Author: AllanChain

.copier-answers.yml

@@ -1,14 +1,14 @@
 # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
-_commit: v4.2.4
+_commit: v4.2.5
 _src_path: https://github.com/jupyterlab/extension-template
 author_email: [email protected]
 author_name: Allan Chain
 has_binder: false
-has_settings: false
+has_settings: true
 kind: server
 labextension_name: jupyterlab-wakatime
 project_short_description: A JupyterLab WakaTime extension.
 python_name: jupyterlab_wakatime
-repository: https://github.com/AllanChain/jupyterlab-wakatime
+repository: https://github.com/wakatime/jupyterlab-wakatime
 test: false
 

.github/workflows/build.yml

@@ -6,6 +6,10 @@ on:
   pull_request:
     branches: '*'
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
 jobs:
   build:
     runs-on: ubuntu-latest

.github/workflows/check-release.yml

@@ -5,6 +5,10 @@ on:
   pull_request:
     branches: ["*"]
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
 jobs:
   check_release:
     runs-on: ubuntu-latest

package.json

@@ -18,7 +18,9 @@
     },
     "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}"
+        "style/**/*.{css,js,eot,gif,html,jpg,json,png,svg,woff2,ttf}",
+        "src/**/*.{ts,tsx}",
+        "schema/*.json"
     ],
     "main": "lib/index.js",
     "types": "lib/index.d.ts",
@@ -58,7 +60,8 @@
         "@jupyterlab/coreutils": "^6.0.0",
         "@jupyterlab/fileeditor": "^4.0.10",
         "@jupyterlab/notebook": "^4.0.10",
-        "@jupyterlab/services": "^7.0.0"
+        "@jupyterlab/services": "^7.0.0",
+        "@jupyterlab/settingregistry": "^4.0.0"
     },
     "devDependencies": {
         "@jupyterlab/builder": "^4.0.0",
@@ -105,7 +108,8 @@
             }
         },
         "extension": true,
-        "outputDir": "jupyterlab_wakatime/labextension"
+        "outputDir": "jupyterlab_wakatime/labextension",
+        "schemaDir": "schema"
     },
     "eslintIgnore": [
         "node_modules",

schema/plugin.json

@@ -0,0 +1,8 @@
+{
+  "jupyter.lab.shortcuts": [],
+  "title": "jupyterlab-wakatime",
+  "description": "jupyterlab-wakatime settings.",
+  "type": "object",
+  "properties": {},
+  "additionalProperties": false
+}

src/index.ts

@@ -1,6 +1,7 @@
 import { JupyterFrontEnd, JupyterFrontEndPlugin } from '@jupyterlab/application'
 import { INotebookTracker } from '@jupyterlab/notebook'
 import { IEditorTracker } from '@jupyterlab/fileeditor'
+import { ISettingRegistry } from '@jupyterlab/settingregistry'
 
 import { beatHeart } from './watch'
 
@@ -12,10 +13,12 @@ const plugin: JupyterFrontEndPlugin<void> = {
   description: 'A JupyterLab WakaTime extension.',
   autoStart: true,
   requires: [INotebookTracker, IEditorTracker],
+  optional: [ISettingRegistry],
   activate: (
     app: JupyterFrontEnd,
     notebooks: INotebookTracker,
-    editors: IEditorTracker
+    editors: IEditorTracker,
+    settingRegistry: ISettingRegistry | null
   ) => {
     console.log('JupyterLab extension jupyterlab-wakatime is activated!')
     notebooks.widgetAdded.connect((_, notebook) => {
@@ -50,6 +53,22 @@ const plugin: JupyterFrontEndPlugin<void> = {
         beatHeart(editor.context.path, 'switch')
       }
     })
+    if (settingRegistry) {
+      settingRegistry
+        .load(plugin.id)
+        .then(settings => {
+          console.log(
+            'jupyterlab-wakatime settings loaded:',
+            settings.composite
+          )
+        })
+        .catch(reason => {
+          console.error(
+            'Failed to load settings for jupyterlab-wakatime.',
+            reason
+          )
+        })
+    }
   }
 }
 

yarn.lock

@@ -868,6 +868,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@jupyterlab/nbformat@npm:^4.0.12":
+  version: 4.0.12
+  resolution: "@jupyterlab/nbformat@npm:4.0.12"
+  dependencies:
+    "@lumino/coreutils": ^2.1.2
+  checksum: e9bd3385e9b7020f27577dc790462cebab3fada9571b64e57c19d9246b944726a1b3d866fec79b4be67153e2b19a1caa08d15d066274b975bfd07cd8211de605
+  languageName: node
+  linkType: hard
+
 "@jupyterlab/notebook@npm:^4.0.10":
   version: 4.0.10
   resolution: "@jupyterlab/notebook@npm:4.0.10"
@@ -988,6 +997,25 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@jupyterlab/settingregistry@npm:^4.0.0":
+  version: 4.0.12
+  resolution: "@jupyterlab/settingregistry@npm:4.0.12"
+  dependencies:
+    "@jupyterlab/nbformat": ^4.0.12
+    "@jupyterlab/statedb": ^4.0.12
+    "@lumino/commands": ^2.1.3
+    "@lumino/coreutils": ^2.1.2
+    "@lumino/disposable": ^2.1.2
+    "@lumino/signaling": ^2.1.2
+    "@rjsf/utils": ^5.1.0
+    ajv: ^8.12.0
+    json5: ^2.2.3
+  peerDependencies:
+    react: ">=16"
+  checksum: 1d3b425effb33333b3c89b0f4bac08ffba5fd97602ce92fb3c3037c15573c853609ec04b0e7e2d4c74f67a75360063e1fd00ba19862abc992f867a3d31e8b440
+  languageName: node
+  linkType: hard
+
 "@jupyterlab/settingregistry@npm:^4.0.10":
   version: 4.0.10
   resolution: "@jupyterlab/settingregistry@npm:4.0.10"
@@ -1020,6 +1048,19 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@jupyterlab/statedb@npm:^4.0.12":
+  version: 4.0.12
+  resolution: "@jupyterlab/statedb@npm:4.0.12"
+  dependencies:
+    "@lumino/commands": ^2.1.3
+    "@lumino/coreutils": ^2.1.2
+    "@lumino/disposable": ^2.1.2
+    "@lumino/properties": ^2.0.1
+    "@lumino/signaling": ^2.1.2
+  checksum: a0bc781a2c16067890ad1a7f7a774ea9b47a9db052cde756416f953aef6cb9451e057a18230b0bb91dad0c3000dbeb6d349121561050e8dc4a91478aa0d40e61
+  languageName: node
+  linkType: hard
+
 "@jupyterlab/statusbar@npm:^4.0.10":
   version: 4.0.10
   resolution: "@jupyterlab/statusbar@npm:4.0.10"
@@ -3905,6 +3946,7 @@ __metadata:
     "@jupyterlab/fileeditor": ^4.0.10
     "@jupyterlab/notebook": ^4.0.10
     "@jupyterlab/services": ^7.0.0
+    "@jupyterlab/settingregistry": ^4.0.0
     "@types/json-schema": ^7.0.11
     "@types/react": ^18.0.26
     "@types/react-addons-linked-state-mixin": ^0.14.22