Skip to main content

Installation

MergeNB is currently only available as a VS Code extension. You can install it from a release or build it from source.

Compatibility note​

nbdime

MergeNB does not coexist with nbdime in the same merge flow. If both are active, you can end up with merge artifacts that MergeNB cannot reliably parse. Pick one notebook merge strategy per repo.

MergeNB will guard against nbdime configs and give you a way to disable nbdime.

From a release​

  1. Download the latest .vsix from the releases page
  2. Open VS Code.
  3. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P) and run Extensions: Install from VSIX...
  4. Select the downloaded file.
VS Code Marketplace

A VS Code Marketplace listing is in the works!

Quick Start​

Once installed, resolving conflicts with MergeNB is mostly plug and play:

  • Status bar: a badge appears when the workspace has unmerged notebooks
  • Command Palette: MergeNB: Find Notebooks with Merge Conflicts (merge-nb.findConflicts)

See Settings for configuration options.

From source​

Clone the repo and build the extension:

git clone https://github.com/Avni2000/MergeNB.git
cd MergeNB
npm install
npm run compile
npm run package

Development​

To load the extension in a development VS Code window:

  • Run:
npm run compile && code --extensionDevelopmentPath=. --new-window <folder to open extension in>
  • There's also a launch configuration in VS Code that does this for you, as well as hot-reloading on file changes, but it's never worked for me.
testing

See more in Testing, since I've already created a TUI testing framework for this purpose.