Skip to content

Latest commit

 

History

History
67 lines (49 loc) · 2.08 KB

readme.md

File metadata and controls

67 lines (49 loc) · 2.08 KB

Sqitch for Emacs

This package provides two modes for interacting with sqitch projects.

Installation

Ensure the files are on your load path, and require the modes:

(add-to-list 'load-path "/path/to/sqitch-for-emacs")
(require 'sqitch-plan-mode)
(require 'sqitch-mode)

Alternatively, if you favor el-get, you can use this recipe:

(:name sqitch
       :description "Emacs modes for interacting with Sqitch projects"
       :type github
       :pkgname "christophermaier/sqitch-for-emacs")

The Modes

sqitch-mode

This is a minor mode for Sqitch deploy, verify, and revert scripts. It allows you to easily jump between the different scripts for a given changeset, as well as jump to the appropriate sqitch.plan file.

Keybinding Description
C-c d Jump to corresponding "deploy" script
C-c v Jump to corresponding "verify" script
C-c r Jump to corresponding "revert" script
C-c p Jump to sqitch.plan file

As a convenience, additional C-c C- bindings are also provided. That is, C-c d and C-c C-d are both bound to sqitch-find-deploy-script, and so on.

sqitch-plan-mode

This is a major mode for sqitch.plan files. With point on a changeset label (either at the beginning of a line or in a dependency list), it allows you to jump directly to the deploy, verify, and revert scripts for that changeset.

Keybinding Description
C-c d Jump to "deploy" script for changeset at point
C-c v Jump to "verify" script for changeset at point
C-c r Jump to "revert" script for changeset at point

As with sqitch-mode, additional C-c C- bindings are also provided. That is, C-c d and C-c C-d are both bound to sqitch-plan-find-deploy-script, and so on.

TODO

  • Make changeset detection more robust; currently does not recognize tagged changesets as such.