Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/smashwilson/merge-conflicts

Resolve git merge conflicts in Atom
https://github.com/smashwilson/merge-conflicts

atom conflict-resolution merge-conflicts

Last synced: 16 days ago
JSON representation

Resolve git merge conflicts in Atom

Awesome Lists containing this project

README 

        
# Merge Conflicts



## Deprecation Notice



This package is **deprecated** and subsumed by the [Git and GitHub integration](https://github.atom.io/) that's bundled with Atom starting with [1.18.0-beta0](https://github.com/atom/atom/releases/tag/v1.18.0-beta0). I highly recommend using that instead!



[![Build Status](https://travis-ci.org/smashwilson/merge-conflicts.svg?branch=master)](https://travis-ci.org/smashwilson/merge-conflicts)



Resolve your git merge conflicts in Atom!



![conflict-resolution](https://raw.github.com/smashwilson/merge-conflicts/master/docs/conflict-resolution.gif)



This package detects the conflict markers left by `git merge` and overlays a set of controls for resolving each and navigating among them. Additionally, it displays your progress through a merge.



## Installation

```bash

apm install merge-conflicts

```



## Features



 * Conflict resolution controls are provided for each detected conflict.

 * Choose your version, their version, combinations thereof, or arbitrary changes edited in place as a resolution.

 * Navigate to the next and previous conflicts in each file.

 * Track your progress through a merge with per-file progress bars and a file list.

 * Save and stage your resolved version of each file as it's completed.



## Using



When `git merge` tells you that it couldn't resolve all of your conflicts automatically:



```

$ git merge branch

Auto-merging two

CONFLICT (content): Merge conflict in two

Auto-merging one

CONFLICT (content): Merge conflict in one

Automatic merge failed; fix conflicts and then commit the result.

```



Open Atom on your project and run the command `Merge Conflicts: Detect` (default hotkey: *alt-m d*). You'll see a panel at the bottom of the window describing your progress through the merge:



![merge progress](https://raw.github.com/smashwilson/merge-conflicts/master/docs/merge-progress.jpg)



Click each filename to visit it and step through the identified conflicts. For each conflict area, click "Use me" on either side of the change to accept that side as-is:



![conflict area](https://raw.github.com/smashwilson/merge-conflicts/master/docs/conflict-area.jpg)



Use the right-click menu to choose more advanced resolutions, like "ours then theirs", or edit any chunk by hand then click "use me" to accept your manual modifications. Once you've addressed all of the conflicts within a file, you'll be prompted to save and stage the changes you've made:



![save and stage?](https://raw.github.com/smashwilson/merge-conflicts/master/docs/were-done-here.jpg)



Finally, when *all* of the conflicts throughout the project have been dealt with, a message will appear to prompt you how to commit the resolution and continue on your way. :tada:



![onward!](https://raw.github.com/smashwilson/merge-conflicts/master/docs/merge-complete.jpg)



## Key bindings



To customize your key bindings, choose "Keymap..." from your Atom menu and add CSON to bind whatever keys you wish to `merge-conflicts` events. To get started, you can copy and paste this snippet and change the bindings to whatever you prefer:



```

'atom-text-editor.conflicted':

  'alt-m down': 'merge-conflicts:next-unresolved'

  'alt-m up': 'merge-conflicts:previous-unresolved'

  'alt-m enter': 'merge-conflicts:accept-current'

  'alt-m r': 'merge-conflicts:revert-current'

  'alt-m 1': 'merge-conflicts:accept-ours'

  'alt-m 2': 'merge-conflicts:accept-theirs'



'atom-workspace':

  'alt-m d': 'merge-conflicts:detect'

```



For more detail, the Atom docs include both [basic](http://flight-manual.atom.io/using-atom/sections/basic-customization/#_customizing_keybindings) and [advanced](http://flight-manual.atom.io/behind-atom/sections/keymaps-in-depth/) guidelines describing the syntax.



## Events



The merge-conflicts plugin emits a number of events that other packages can subscribe to, if they wish. If you want your plugin to consume one, use code like the following:



```coffeescript

{CompositeDisposable} = require 'atom'



pkg = atom.packages.getActivePackage('merge-conflicts')?.mainModule

subs = new CompositeDisposable



subs.add pkg.onDidResolveConflict (event) ->



# ...



subs.dispose()

```



 * `onDidResolveConflict`: broadcast whenever a conflict is resolved. `event.file`: the absolute path of the file in which the conflict was found; `event.total`: the total number of conflicts in that file; `event.resolved`: the number of conflicts that are resolved, including this one.

 * `onDidResolveFile`: broadcast whenever a file has been completed and staged for commit. `event.file`: the absolute path of the file that was staged.

 * `onDidQuitConflictResolution`: broadcast when you stop merging conflicts by clicking the quit button.

 * `onDidCompleteConflictResolution`: broadcast when all conflicts in all files have successfully been resolved.



## Contributions



Pull requests are welcome, big and small! Check out the [contributing guide](./CONTRIBUTING.md) for details.