NonGNU-devel ELPA - with-editor

with-editor

Description
Use the Emacsclient as $EDITOR
Latest
with-editor-3.3.2.0.20240206.230153.tar (.sig), 2024-Mar-31, 120 KiB
Maintainer
Jonas Bernoulli <jonas@bernoul.li>
Atom feed
with-editor.xml
Website
https://github.com/magit/with-editor
Browse ELPA's repository
CGit or Gitweb
Badge
Manual
with-editor

To install this package from Emacs, use package-install or list-packages.

Full description

1. With-Editor

This library makes it possible to reliably use the Emacsclient as the $EDITOR of child processes. It makes sure that they know how to call home. For remote processes a substitute is provided, which communicates with Emacs on standard output/input instead of using a socket as the Emacsclient does.

It provides the commands with-editor-async-shell-command and with-editor-shell-command, which are intended as replacements for async-shell-command and shell-command. They automatically export $EDITOR making sure the executed command uses the current Emacs instance as "the editor". With a prefix argument these commands prompt for an alternative environment variable such as $GIT_EDITOR. To always use these variants add this to your init file:

(keymap-global-set "<remap> <async-shell-command>"
		   #'with-editor-async-shell-command)
(keymap-global-set "<remap> <shell-command>"
		   #'with-editor-shell-command)

Alternatively use the global shell-command-with-editor-mode, which always sets $EDITOR for all Emacs commands which ultimately use shell-command to asynchronously run some shell command.

The command with-editor-export-editor exports $EDITOR or another such environment variable in shell-mode, eshell-mode, term-mode and vterm-mode buffers. Use this Emacs command before executing a shell command which needs the editor set, or always arrange for the current Emacs instance to be used as editor by adding it to the appropriate mode hooks:

(add-hook 'shell-mode-hook  'with-editor-export-editor)
(add-hook 'eshell-mode-hook 'with-editor-export-editor)
(add-hook 'term-exec-hook   'with-editor-export-editor)
(add-hook 'vterm-mode-hook  'with-editor-export-editor)

Some variants of this function exist, these two forms are equivalent:

(add-hook 'shell-mode-hook
	  (apply-partially 'with-editor-export-editor "GIT_EDITOR"))
(add-hook 'shell-mode-hook 'with-editor-export-git-editor)

This library can also be used by other packages which need to use the current Emacs instance as editor. In fact this library was written for Magit and its git-commit-mode and git-rebase-mode. Consult git-rebase.el and the related code in magit-sequence.el for a simple example.



Compile Manual NonGNU ELPA MELPA Stable MELPA

Old versions

with-editor-3.3.2.0.20240101.222643.tar.lz2024-Jan-0220.6 KiB
with-editor-3.3.2.0.20231217.202539.tar.lz2023-Dec-1720.6 KiB
with-editor-3.3.2.0.20231209.175525.tar.lz2023-Dec-0920.6 KiB
with-editor-3.3.2.0.20230917.95846.tar.lz2023-Sep-1720.6 KiB
with-editor-3.3.1.0.20230827.104051.tar.lz2023-Aug-2720.7 KiB
with-editor-3.3.0.0.20230711.121725.tar.lz2023-Jul-1120.7 KiB
with-editor-3.2.0.50snapshot0.20230412.105315.tar.lz2023-Apr-1220.7 KiB
with-editor-3.2.0snapshot0.20221119.143940.tar.lz2022-Nov-1920.2 KiB
with-editor-3.1.1.0.20220126.133910.tar.lz2022-Jan-2619.3 KiB
with-editor-3.0.5.0.20220101.131650.tar.lz2022-Jan-0129.6 KiB