elken / embark-vc

Blazing fast embark actions for various version control packages 🚀

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

embark-vc 🚀

https://melpa.org/packages/embark-vc-badge.svg

Some glue between embark and a number of version control packages. As it’s (currently) quite simple, there’s not much to document. As that changes, so will this.

Currently provides targets and actions for:

  • Magit (forge)
  • smerge-mode
  • code-review

All of which are considered dependencies, but as the package grows they will become optional (if I did that now, it wouldn’t do anything!)

Terminology

In the context of Magit, Issues and Pull Requests are both marked as “topics”, and are referred to as such in the codebase to denote actions that apply to both. For example, setting the title of an Issue or a Pull Request is fundamentally the same operation, however Issues can’t be merged.

So the “topic” actions are defined as actions that would apply to both Issues and Pull Requests, with both also having their own set of actions to act on.

Install

Standard

Clone the repo, add to your load-path

MELPA

Install using your favourite package manager

Doom Emacs

Append the following to the corresponding file:

packages.el

(package! embark-vc)

config.el

(use-package! embark-vc
  :after embark)

Keymaps

Currently all it really does is create some targets and add some wrapped verisons of existing functions.

topic

Keymap applies to both Pull Requests and Issues, so won’t be duplicated there

keyaction
yforge-copy-url-at-point-as-kill
sembark-vc-edit-topic-state
tembark-vc-edit-topic-title
lembark-vc-edit-topic-labels

pull-request

Only list actions that are relevant to just Pull Requests

keyaction
cembark-vc-checkout-branch
bforge-browse-pullreq
rembark-vc-start-review
nforge-merge

issue

Only list actions that are relevant to just Issues

keyaction

commit

Only list actions that are relevant to Commits

keyaction
bforge-browse-commit

conflict

Only list actions that are relevant to Merge Conflicts

keyaction
tsmerge-keep-upper
bsmerge-keep-lower
asmerge-keep-all
dsmerge-ediff

About

Blazing fast embark actions for various version control packages 🚀

License:GNU General Public License v3.0


Languages

Language:Emacs Lisp 100.0%