Git Product home page Git Product logo

embark-vc's Introduction

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

embark-vc's People

Contributors

elken avatar iyefrat avatar syohex avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

embark-vc's Issues

Some suggestions

Hi!

I have some minor suggestions for embark-vc:

s dependency

A related suggestion: is the s dependency used only for s-replace? If so, I wonder if it could be replaced (no pun intended) with string-replace. Note that this function was introduced by Emacs 28, though. If you want to enable older versions to still use embark-vc, I think requiring compat-28 would help: https://git.sr.ht/~pkal/compat/tree/master/item/compat-28.el

Of course, that would simply swap dependencies. But using compat and a core function is nicer than requiring s.el, IMO.

the embark-vc name

As you might know, vc has a very specific meaning in Emacs: the version control built-in package.
Given that, given embark-vc name, I would expect this package to deal with the Emacs vc stuff, but that's not the case (embark already does that).
So I suggest renaming the package, as it's misleading.

Note also that Emacs packages should start with a unique prefix to avoid collisions.
This package adopts embark-vc, which is arguably not enough for avoiding conflicts with embark, which could have a function starting with embark-vc.

B binding

embark-vc uses B for forge-browse-pullreq, but B is mapped as default to embark-become.
While I think I will never use embark-become in an embark-vc context, I think having the same binding is strange, since I'm used to B as become and embark offers its own actions as upper case letters.

Thanks!

Do not declare code-review as a dependency while keeping its functionality

Hi. embark-vc declares code-review as a dependency. I don't use that package.

Is there any way of installing embark-vc without getting code-review?

Additionally, I wonder if it's possible to resolve code-review dynamically and only offer its related functions when it's present, thus not needing to declare it as a dependency at all.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.