Merge pull request #516 from vidartf/th-config

Add extensions configurator
jupyter · Mar 9, 2020 · a9435d5 · a9435d5
2 parents a506b66 + d4f8247
commit a9435d5
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 11 deletions.
diff --git a/nbdime/notebook_ext/index.js b/nbdime/notebook_ext/index.js
@@ -7,6 +7,12 @@ define([
 ], function(Jupyter, $, utils) {
     "use strict";
 
+    // params are updated on config load
+    var params = {
+        add_checkpoints_toolbar_button: true,
+        add_git_toolbar_button: true,
+    };
+
     // Custom util functions:
     var reStripLeading = /^\/+/
     var stripLeft = function (string) {
@@ -120,28 +126,40 @@ define([
                 help: 'Display nbdiff from git HEAD to currently saved version',
                 handler : nbGitDiffView
             }, 'diff-notebook-git', prefix);
+        }
 
-            // Add both buttons, with label on git button
-            var btn_group = Jupyter.toolbar.add_buttons_group([
-                checkpointAction,
-            {
-                action: gitAction,
-                label: 'nbdiff',
-            }]);
+        if (isGit && params.add_git_toolbar_button) {
+            if (params.add_checkpoints_toolbar_button) {
+                // Add both buttons, with label on git button
+                var btn_group = Jupyter.toolbar.add_buttons_group([
+                    checkpointAction,
+                {
+                    action: gitAction,
+                    label: 'nbdiff',
+                }]);
+            } else {
+                // Add only git button, with label on it
+                var btn_group = Jupyter.toolbar.add_buttons_group([{
+                    action: gitAction,
+                    label: 'nbdiff',
+                }]);
+           };
 
             // Tooltip for git button:
-            btn_group.children(':last-child').attr('title', Jupyter.actions.get(gitAction).help);
-        } else {
+            if (typeof btn_group !== 'undefined') {
+                btn_group.children(':last-child').attr('title', Jupyter.actions.get(gitAction).help);
+            }
+        } else if (params.add_checkpoints_toolbar_button) {
             // Add only checkpoint button, with label on it
             var btn_group = Jupyter.toolbar.add_buttons_group([{
                 action: checkpointAction,
                 label: 'nbdiff',
             }]);
+        }
 
-            if (serverMissing) {
+        if (serverMissing) {
                 setActionEnabledState(checkpointAction, false);
                 console.error(serverMissingMsg);
-            }
         }
 
         // Tooltip for checkpoint button:
@@ -159,6 +177,9 @@ define([
             // Assume that we don't have git
             register(false, error);
         });
+
+        // Update params:
+        $.extend(true, params, Jupyter.notebook.config.data.nbdime);
     };
 
     return {

diff --git a/nbdime/notebook_ext/nbdime.yaml b/nbdime/notebook_ext/nbdime.yaml
@@ -0,0 +1,16 @@
+Type: Jupyter Notebook Extension
+Name: nbdime
+Description: Tools for diffing and merging of Jupyter notebooks.
+Main: index.js
+Compatibility: Jupyter 4.x, 5.x
+Parameters:
+
+- name: nbdime.add_checkpoints_toolbar_button
+  description: Add a toolbar button to diff against checkpointed notebook
+  input_type: checkbox
+  default: true
+
+- name: nbdime.add_git_toolbar_button
+  description: Add a toolbar button to diff against most recently git committed notebook
+  input_type: checkbox
+  default: true