Merge pull request #219 from osscar-org/disable-cell-edits

Disable editing keyboard shortcuts when activating the hide-code button

Author: ceriottm

.github/workflows/build.yml

@@ -12,7 +12,7 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v6
 
     - name: Base Setup
       uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
@@ -49,7 +49,7 @@ jobs:
         pip uninstall -y "jupyterlab_hide_code" jupyterlab
 
     - name: Upload extension packages
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v7
       with:
         name: extension-artifacts
         path: dist/jupyterlab_hide_code*
@@ -61,11 +61,11 @@ jobs:
 
     steps:
     - name: Install Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v6
       with:
         python-version: '3.9'
         architecture: 'x64'
-    - uses: actions/download-artifact@v3
+    - uses: actions/download-artifact@v8
       with:
         name: extension-artifacts
     - name: Install and Test
@@ -92,13 +92,13 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v6
 
     - name: Base Setup
       uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
 
     - name: Download extension package
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v8
       with:
         name: extension-artifacts
 
@@ -114,7 +114,7 @@ jobs:
       run: jlpm install
 
     - name: Set up browser cache
-      uses: actions/cache@v3
+      uses: actions/cache@v5
       with:
         path: |
           ${{ github.workspace }}/pw-browsers
@@ -131,7 +131,7 @@ jobs:
 
     - name: Upload Playwright Test report
       if: always()
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v7
       with:
         name: jupyterlab_hide_code-playwright-tests
         path: |
@@ -143,6 +143,6 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 15
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v6
       - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
       - uses: jupyterlab/maintainer-tools/.github/actions/check-links@v1

.github/workflows/check-release.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v6
       - name: Base Setup
         uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
       - name: Install Dependencies
@@ -23,7 +23,7 @@ jobs:
           token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Upload Distributions
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v7
         with:
           name: jupyterlab_hide_code-releaser-dist-${{ github.run_number }}
           path: .jupyter_releaser_checkout/dist

.github/workflows/update-integration-tests.yml

@@ -15,7 +15,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v6
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 

src/index.ts

@@ -40,6 +40,48 @@ export class ButtonExtension
     panel: NotebookPanel,
     context: DocumentRegistry.IContext<INotebookModel>
   ): IDisposable {
+    let hidden = false;
+
+    // Block keyboard shortcuts that change cell type in command mode
+    const blockCellTypeShortcuts = (event: KeyboardEvent) => {
+      if (!hidden) {
+        return;
+      }
+      // Cell type: m, y, r, 1-6
+      // Add/remove/reorder: a, b, d (dd), x, v, z, Shift+M
+      const blockedKeys = [
+        'm',
+        'y',
+        'r',
+        '1',
+        '2',
+        '3',
+        '4',
+        '5',
+        '6',
+        'a',
+        'b',
+        'd',
+        'x',
+        'v',
+        'z'
+      ];
+      const isBlocked =
+        (blockedKeys.includes(event.key) &&
+          !event.ctrlKey &&
+          !event.altKey &&
+          !event.metaKey) ||
+        (event.key === 'M' &&
+          event.shiftKey &&
+          !event.ctrlKey &&
+          !event.altKey &&
+          !event.metaKey);
+      if (isBlocked) {
+        event.stopPropagation();
+        event.preventDefault();
+      }
+    };
+
     const hideInputCode = () => {
       NotebookActions.runAll(panel.content, context.sessionContext);
 
@@ -48,7 +90,18 @@ export class ButtonExtension
           const layout = cell.layout as PanelLayout;
           layout.widgets[1].hide();
         }
+        if (cell.editor) {
+          cell.editor.setOption('readOnly', true);
+        }
       });
+
+      hidden = true;
+      panel.content.node.addEventListener(
+        'keydown',
+        blockCellTypeShortcuts,
+        true
+      );
+
       buttonHideInput.hide();
       buttonShowInput.show();
     };
@@ -58,8 +111,18 @@ export class ButtonExtension
           const layout = cell.layout as PanelLayout;
           layout.widgets[1].show();
         }
+        if (cell.editor) {
+          cell.editor.setOption('readOnly', false);
+        }
       });
 
+      hidden = false;
+      panel.content.node.removeEventListener(
+        'keydown',
+        blockCellTypeShortcuts,
+        true
+      );
+
       buttonHideInput.show();
       buttonShowInput.hide();
     };

tsconfig.json

@@ -15,6 +15,7 @@
     "resolveJsonModule": true,
     "outDir": "lib",
     "rootDir": "src",
+    "skipLibCheck": true,
     "strict": true,
     "strictNullChecks": true,
     "target": "ES2018",