Repository: magit/with-editor
Branch: main
Commit: 14ea1d98337a
Files: 20
Total size: 104.8 KB
Directory structure:
gitextract_kaalnlk_/
├── .dir-locals.el
├── .elpaignore
├── .github/
│ ├── ISSUE_TEMPLATE/
│ │ ├── bug_report.md
│ │ └── config.yml
│ └── workflows/
│ ├── compile.yml
│ ├── manual.yml
│ └── stats.yml
├── .gitignore
├── .mailmap
├── CHANGELOG
├── LICENSE
├── Makefile
├── README.org
├── default.mk
├── docs/
│ ├── .orgconfig
│ ├── Makefile
│ ├── htmlxref.cnf
│ └── with-editor.org
└── lisp/
├── Makefile
└── with-editor.el
================================================
FILE CONTENTS
================================================
================================================
FILE: .dir-locals.el
================================================
((nil
(indent-tabs-mode . nil))
(makefile-mode
(indent-tabs-mode . t))
(git-commit-mode
(git-commit-major-mode . git-commit-elisp-text-mode))
("CHANGELOG"
(nil (fill-column . 70)
(mode . display-fill-column-indicator))))
================================================
FILE: .elpaignore
================================================
.dir-locals.el
.elpaignore
.github
.gitignore
.mailmap
LICENSE
Makefile
default.mk
docs/.orgconfig
docs/Makefile
docs/htmlxref.cnf
docs/with-editor.texi
lisp/Makefile
================================================
FILE: .github/ISSUE_TEMPLATE/bug_report.md
================================================
---
title:
name: 🪳 Bug report
about: Report a defect. Do not use this for support requests and feature suggestions.
---
Please use your own words.
If you really must use a LLM, at least disclose that upfront.
Please explain
(0) without using these lines as headings,
(1) what behavior you expected
(2) what behavior you observed
(3) and how we can reproduce the issue.
You don't have to quote the above lines to do that.
Please include a backtrace in your report. In most cases doing:
M-x toggle-debug-on-error RET
and then going through the steps again should result in a backtrace.
---- now delete this line and everything above ----
================================================
FILE: .github/ISSUE_TEMPLATE/config.yml
================================================
blank_issues_enabled: false
contact_links:
- name: "💡 Suggest a feature"
url: https://github.com/magit/with-editor/discussions
about: Start a discussion suggest an improvement or a new feature.
- name: "🆘 Ask the community for support"
url: https://www.reddit.com/r/emacs
about: Please also consider supporting others.
- name: "🆘 Ask the maintainers for support"
url: https://github.com/magit/with-editor/discussions
about: Please keep in mind that our bandwidth is limited.
- name: "😢 \"I am unable to commit with Magit\""
url: https://docs.magit.vc/with-editor/Debugging.html
about: Others might have had the same question before.
- name: "ℹ️ With-Editor Manual"
url: https://docs.magit.vc/with-editor/#Top
about: The fine manual may also be of use.
================================================
FILE: .github/workflows/compile.yml
================================================
name: Compile
on: [push, pull_request]
jobs:
compile:
name: Compile
uses: | # zizmor: ignore[unpinned-uses] same maintainer as this repo
emacscollective/workflows/.github/workflows/compile.yml@main
permissions: {}
================================================
FILE: .github/workflows/manual.yml
================================================
name: Manual
on:
push:
branches: main
tags: "v[0-9]+.[0-9]+.[0-9]+"
jobs:
manual:
name: Manual
uses: | # zizmor: ignore[unpinned-uses] same maintainer as this repo
emacscollective/workflows/.github/workflows/manual.yml@main
permissions: {}
secrets:
rclone_config: ${{ secrets.RCLONE_CONFIG }}
================================================
FILE: .github/workflows/stats.yml
================================================
name: Statistics
on:
push:
branches: main
schedule:
- cron: '3 13 * * 1'
jobs:
stats:
name: Statistics
uses: | # zizmor: ignore[unpinned-uses] same maintainer as this repo
emacscollective/workflows/.github/workflows/stats.yml@main
permissions: {}
secrets:
rclone_config: ${{ secrets.RCLONE_CONFIG }}
================================================
FILE: .gitignore
================================================
/config.mk
/docs/*.html
/docs/*.info
/docs/*.pdf
/docs/*.texi
/docs/.revdesc
/docs/dir
/docs/stats/
/lisp/*-autoloads.el
/lisp/*.elc
/docs/with-editor/
================================================
FILE: .mailmap
================================================
Justin Burkett <justin@burkett.cc>
================================================
FILE: CHANGELOG
================================================
# -*- mode: org -*-
* v3.5.0 2026-05-01
- Append newline to emacsclient commands as required by Emacs 31.1.
#137
* v3.4.9 2026-03-01
- Thoughts and whitespace.
* v3.4.8 2026-01-01
- Various build improvements.
* v3.4.7 2025-11-01
- Thoughts and whitespace.
* v3.4.6 2025-09-01
- Thoughts and whitespace.
* v3.4.5 2025-08-01
- No longer add "clear" to the shell's history when using vterm. #135
* v3.4.4 2025-06-01
- Added kludge for Nix on macOS. #134
* v3.4.3 2024-12-01
- Added new variable ~with-editor-emacsclient-program-suffixes~. #132
* v3.4.2 2024-09-01
- Fixed ~shell-command-with-editor-mode~ for remote processes. #129
- ~with-editor-export-editor~ now waits longer for the terminal to get
ready. #130
- Updated tooling.
================================================
FILE: LICENSE
================================================
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.
================================================
FILE: Makefile
================================================
-include config.mk
include default.mk
.PHONY: lisp docs
all: lisp docs
help:
$(info make all -- Generate lisp and manual)
$(info make lisp -- Generate byte-code and autoloads)
$(info make redo -- Re-generate byte-code and autoloads)
$(info make docs -- Generate all manual formats)
$(info make redo-docs -- Re-generate all manual formats)
$(info make texi -- Generate texi manual)
$(info make info -- Generate info manual)
$(info make html -- Generate html manual file)
$(info make html-dir -- Generate html manual directory)
$(info make pdf -- Generate pdf manual)
$(info make publish -- Publish snapshot manuals)
$(info make release -- Publish release manuals)
$(info make stats -- Generate statistics)
$(info make stats-upload -- Publish statistics)
$(info make clean -- Remove most generated files)
@printf "\n"
lisp:
@$(MAKE) -C lisp lisp
redo:
@$(MAKE) -C lisp clean lisp
docs:
@$(MAKE) -C docs docs
redo-docs:
@$(MAKE) -C docs redo-docs
texi:
@$(MAKE) -C docs texi
info:
@$(MAKE) -C docs info
html:
@$(MAKE) -C docs html
html-dir:
@$(MAKE) -C docs html-dir
pdf:
@$(MAKE) -C docs pdf
publish:
@$(MAKE) -C docs publish
release:
@$(MAKE) -C docs release
stats:
@$(MAKE) -C docs stats
stats-upload:
@$(MAKE) -C docs stats-upload
clean:
@$(MAKE) -C lisp clean
@$(MAKE) -C docs clean
================================================
FILE: README.org
================================================
* 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:
#+begin_src emacs-lisp
(keymap-global-set "<remap> <async-shell-command>"
#'with-editor-async-shell-command)
(keymap-global-set "<remap> <shell-command>"
#'with-editor-shell-command)
#+end_src
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:
#+begin_src emacs-lisp
(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)
#+end_src
Some variants of this function exist, these two forms are
equivalent:
#+begin_src emacs-lisp
(add-hook 'shell-mode-hook
(apply-partially 'with-editor-export-editor "GIT_EDITOR"))
(add-hook 'shell-mode-hook 'with-editor-export-git-editor)
#+end_src
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.
#+html: <br><br>
#+html: <a href="https://github.com/magit/with-editor/actions/workflows/compile.yml"><img alt="Compile" src="https://github.com/magit/with-editor/actions/workflows/compile.yml/badge.svg"/></a>
#+html: <a href="https://github.com/magit/with-editor/actions/workflows/manual.yml"><img alt="Manual" src="https://github.com/magit/with-editor/actions/workflows/manual.yml/badge.svg"/></a>
#+html: <a href="https://elpa.nongnu.org/nongnu/with-editor.html"><img alt="NonGNU ELPA" src="https://emacsair.me/assets/badges/nongnu-elpa.svg"/></a>
#+html: <a href="https://stable.melpa.org/#/with-editor"><img alt="MELPA Stable" src="https://stable.melpa.org/packages/with-editor-badge.svg"/></a>
#+html: <a href="https://melpa.org/#/with-editor"><img alt="MELPA" src="https://melpa.org/packages/with-editor-badge.svg"/></a>
================================================
FILE: default.mk
================================================
TOP := $(dir $(lastword $(MAKEFILE_LIST)))
DOMAIN ?= magit.vc
PKG = with-editor
ELS = $(PKG).el
ELCS = $(ELS:.el=.elc)
DEPS = compat
DEPS += vterm
LOAD_PATH ?= $(addprefix -L ../../,$(DEPS))
LOAD_PATH += -L .
ORG_LOAD_PATH ?= -L ../../org/lisp
VERSION ?= $(shell test -e $(TOP).git && git describe --tags --abbrev=0 | cut -c2-)
REVDESC := $(shell test -e $(TOP).git && git describe --tags)
EMACS ?= emacs
EMACS_ARGS ?= --eval "(setq with-editor-emacsclient-executable nil)"
EMACS_Q_ARG ?= -Q
EMACS_BATCH ?= $(EMACS) $(EMACS_Q_ARG) --batch $(EMACS_ARGS) $(LOAD_PATH)
EMACS_ORG ?= $(EMACS) $(EMACS_Q_ARG) --batch $(EMACS_ARGS) $(ORG_LOAD_PATH)
INSTALL_INFO ?= $(shell command -v ginstall-info || printf install-info)
MAKEINFO ?= makeinfo
MANUAL_HTML_ARGS ?= --css-ref https://magit.vc/assets/page.css
GITSTATS ?= gitstats
GITSTATS_DIR ?= $(TOP)docs/stats
GITSTATS_ARGS ?= -c style=https://magit.vc/assets/stats.css -c max_authors=999
RCLONE ?= rclone
RCLONE_ARGS ?= -v
================================================
FILE: docs/.orgconfig
================================================
# -*- mode:org -*-
# Copyright (C) 2021-2026 Jonas Bernoulli
# SPDX-License-Identifier: GPL-3.0-or-later
# URL: https://github.com/emacscollective/org-macros
# Visit that to see these macros in a human-readable format.
#+language: en
#+options: H:4 num:3 toc:2 compact-itemx:t
#+property: header-args :eval never
#+macro: year (eval (format-time-string "%Y"))
#+macro: version (eval (if-let ((tag (ignore-errors (car (process-lines "git" "describe" "--exact-match"))))) (concat "version " (substring tag 1)) (or (ignore-errors (car (process-lines "git" "describe"))) (concat "version " (or $1 "<unknown>")))))
#+macro: kbd (eval (format "@@texinfo:@kbd{@@%s@@texinfo:}@@" (let (case-fold-search) (replace-regexp-in-string (regexp-opt '("BS" "TAB" "RET" "ESC" "SPC" "DEL" "LFD" "DELETE" "SHIFT" "Ctrl" "Meta" "Alt" "Cmd" "Super" "UP" "LEFT" "RIGHT" "DOWN") 'words) "@@texinfo:@key{@@\\&@@texinfo:}@@" $1 t))))
#+macro: kbdvar (eval (format "@@texinfo:@kbd{@@%s@@texinfo:}@@" (let (case-fold-search) (replace-regexp-in-string "<\\([a-zA-Z-]+\\)>" "@@texinfo:@var{@@\\1@@texinfo:}@@" (replace-regexp-in-string (regexp-opt '("BS" "TAB" "RET" "ESC" "SPC" "DEL" "LFD" "DELETE" "SHIFT" "Ctrl" "Meta" "Alt" "Cmd" "Super" "UP" "LEFT" "RIGHT" "DOWN") 'words) "@@texinfo:@key{@@\\&@@texinfo:}@@" $1 t) t))))
#+macro: codevar (eval (format "@@texinfo:@code{@@%s@@texinfo:}@@" (let (case-fold-search) (replace-regexp-in-string "\\([A-Z][A-Z-]+\\)" "@@texinfo:@var{@@\\&@@texinfo:}@@" $1 t))))
#+macro: var @@texinfo:@var{@@$1@@texinfo:}@@
#+macro: dfn @@texinfo:@dfn{@@$1@@texinfo:}@@
================================================
FILE: docs/Makefile
================================================
-include ../config.mk
include ../default.mk
.PHONY: stats
docs: texi info html html-dir pdf
texi: $(PKG).texi
info: $(PKG).info dir
html: $(PKG).html
html-dir: $(PKG)/index.html
pdf: $(PKG).pdf
ORG_EVAL += --eval "(setq indent-tabs-mode nil)"
ORG_EVAL += --eval "(setq org-src-preserve-indentation nil)"
ORG_EVAL += --eval "\
(defun org-texinfo--sanitize-content (text)\
(replace-regexp-in-string \"[@@{}]\" \"@@\\&\" text))"
ORG_EVAL += --funcall org-texinfo-export-to-texinfo
redo-docs:
@touch $(PKG).org
@make docs
.revdesc: ;
_ := $(shell test "$(REVDESC)" = "$$(cat .revdesc 2> /dev/null)" ||\
echo "$(REVDESC)" > .revdesc)
%.texi: %.org .orgconfig .revdesc
@printf "Generating $@\n"
@$(EMACS_ORG) $< $(ORG_EVAL)
%.info: %.texi
@printf "Generating $@\n"
@$(MAKEINFO) --no-split $< -o $@
dir: $(PKG).info
@printf "Generating $@\n"
@printf "%s" $^ | xargs -n 1 $(INSTALL_INFO) --dir=$@
HTML_FIXUP_CSS = '/<link rel="stylesheet" type="text\/css" href="https:\/\/$(DOMAIN)\/assets\/page.css">/a\
<link rel="icon" href="https://$(DOMAIN)/assets/magit_alt1.ico">\
\n<link class="s-css-s--style" rel="stylesheet" title="Default" href="https://$(DOMAIN)/assets/themes/default.css">\
\n<link class="s-css-s--style" rel="stylesheet alternate" title="Default high contrast" href="https://$(DOMAIN)/assets/themes/default-high-contrast.css">\
\n<link class="s-css-s--style" rel="stylesheet alternate" title="Solarized dark xterm" href="https://$(DOMAIN)/assets/themes/solarized-dark-xterm.css">\
\n<link class="s-css-s--style" rel="stylesheet alternate" title="Black on white" href="https://$(DOMAIN)/assets/themes/black-on-white.css">\
\n<script src="https://$(DOMAIN)/assets/js/simple-css-switch.js"></script>'
HTML_FIXUP_ONLOAD = 's/<body lang="en">/<body lang="en" onload="simpleCssSwitch()">/'
HTML_FIXUP_MENU = '/<\/body>/i<div id="s-css-s--menu"><\/div>'
%.html: %.texi
@printf "Generating $@\n"
@$(MAKEINFO) --html --no-split $(MANUAL_HTML_ARGS) $<
@sed -i -e $(HTML_FIXUP_CSS) -e $(HTML_FIXUP_ONLOAD) -e $(HTML_FIXUP_MENU) $@
%/index.html: %.texi
@printf "Generating $(PKG)/*.html\n"
@rm -rf $(PKG)
@$(MAKEINFO) --html -o $(PKG)/ $(MANUAL_HTML_ARGS) $<
@for f in $$(find $(PKG) -name '*.html') ; do \
sed -i -e $(HTML_FIXUP_CSS) -e $(HTML_FIXUP_ONLOAD) -e $(HTML_FIXUP_MENU) $$f ; \
done
%.pdf: %.texi
@printf "Generating $@\n"
@texi2pdf --clean $< > /dev/null
DOCS_DOMAIN = docs.$(DOMAIN)
STAT_DOMAIN = stats.$(DOMAIN)
SNAP_TARGET = $(subst .,_,$(DOCS_DOMAIN)):devel/$(PKG)/
DOCS_TARGET = $(subst .,_,$(DOCS_DOMAIN)):$(PKG)/
STAT_TARGET = $(subst .,_,$(STAT_DOMAIN)):$(PKG)/
publish: redo-docs
@printf "Publishing snapshot manual...\n"
@cp $(PKG).pdf $(PKG)/$(PKG).pdf
@$(RCLONE) sync $(RCLONE_ARGS) $(PKG) $(SNAP_TARGET)
release: redo-docs
@printf "Publishing release manual...\n"
@cp $(PKG).pdf $(PKG)/$(PKG).pdf
@$(RCLONE) sync $(RCLONE_ARGS) $(PKG) $(DOCS_TARGET)
stats:
@printf "Generating statistics...\n"
@$(GITSTATS) $(GITSTATS_ARGS) $(TOP) $(GITSTATS_DIR)
stats-upload:
@printf "Uploading statistics...\n"
@$(RCLONE) sync $(RCLONE_ARGS) stats $(STAT_TARGET)
CLEAN = .revdesc $(PKG).info dir $(PKG) $(PKG).html $(PKG).pdf $(STAT_TARGET)
clean:
@printf " Cleaning docs/*...\n"
@rm -rf $(CLEAN)
================================================
FILE: docs/htmlxref.cnf
================================================
# https://www.gnu.org/software/texinfo/manual/texinfo/html_node/HTML-Xref-Configuration.html
EMACS = https://www.gnu.org/software/emacs/manual
auth mono ${EMACS}/html_mono/auth.html
auth node ${EMACS}/html_node/auth/
ediff mono ${EMACS}/html_mono/ediff.html
ediff node ${EMACS}/html_node/ediff/
elisp mono ${EMACS}/html_mono/elisp.html
elisp node ${EMACS}/html_node/elisp/
emacs mono ${EMACS}/html_mono/emacs.html
emacs node ${EMACS}/html_node/emacs/
MAGIT = https://docs.magit.vc
forge mono ${MAGIT}/forge.html
forge node ${MAGIT}/forge/
ghub mono ${MAGIT}/ghub.html
ghub node ${MAGIT}/ghub/
magit mono ${MAGIT}/magit.html
magit node ${MAGIT}/magit/
transient mono ${MAGIT}/transient.html
transient node ${MAGIT}/transient/
with-editor mono ${MAGIT}/with-editor.html
with-editor node ${MAGIT}/with-editor/
MIRROR = https://emacsmirror.net/manual
borg mono ${MAGIT}/borg.html
borg node ${MAGIT}/borg/
epkg mono ${MAGIT}/epkg.html
epkg node ${MAGIT}/epkg/
================================================
FILE: docs/with-editor.org
================================================
#+title: With-Editor User Manual
:PREAMBLE:
#+author: Jonas Bernoulli
#+email: emacs.with-editor@jonas.bernoulli.dev
#+date: 2015-{{{year}}}
#+texinfo_dir_category: Emacs
#+texinfo_dir_title: With-Editor: (with-editor).
#+texinfo_dir_desc: Using the Emacsclient as $EDITOR
#+subtitle: for version 3.5.0
#+setupfile: .orgconfig
The library ~with-editor~ makes it easy to use the Emacsclient as the
~$EDITOR~ of child processes, making sure they know how to call home.
For remote processes a substitute is provided, which communicates with
Emacs on standard output instead of using a socket as the Emacsclient
does.
This library was written because Magit has to be able to do the above
to allow the user to edit commit messages gracefully and to edit
rebase sequences, which wouldn't be possible at all otherwise.
Because other packages can benefit from such functionality, this
library is made available as a separate package. It also defines some
additional functionality which makes it useful even for end-users, who
don't use Magit or another package which uses it internally.
#+texinfo: @noindent
This manual is for With-Editor version 3.5.0.
#+texinfo: @insertcopying
:END:
* Using the With-Editor package
The ~With-Editor~ package is used internally by Magit when editing
commit messages and rebase sequences. It also provides some commands
and features which are useful by themselves, even if you don't use
Magit.
For information about using this library in your own package, see
[[*Using With-Editor as a library]].
** Configuring With-Editor
With-Editor tries very hard to locate a suitable ~emacsclient~
executable, so ideally you should never have to customize the option
~with-editor-emacsclient-executable~. When it fails to do so, then the
most likely reason is that someone found yet another way to package
Emacs (most likely on macOS) without putting the executable on ~$PATH~,
and we have to add another kludge to find it anyway.
- User Option: with-editor-emacsclient-executable ::
The ~emacsclient~ executable used as the editor by child processes of
this Emacs instance. By using this executable, child processes can
call home to their parent process.
This option is automatically set at startup by looking in ~exec-path~,
and other places where the executable could be installed, to find
the ~emacsclient~ executable most suitable for the current Emacs
instance.
You should *not* customize this option permanently. If you have to do
it, then you should consider that a temporary kludge and inform the
Magit maintainer as described in [[*Debugging][Debugging]].
If With-Editor fails to find a suitable ~emacsclient~ on your system,
then this should be fixed for all users at once, by teaching
~with-editor-locate-emacsclient~ how to do so on your system and
systems like yours. Doing it this way has the advantage, that you
won't have do it again every time you update Emacs, and that other
users who have installed Emacs the same way as you have, won't have
to go through the same trouble.
Note that there also is a nuclear option; setting this variable to
~nil~ causes the "sleeping editor" described below to be used even for
local child processes. Obviously we don't recommend that you use
this except in "emergencies", i.e., before we had a change to add a
kludge appropriate for your setup.
- Function: with-editor-locate-emacsclient ::
The function used to set the initial value of the option
~with-editor-emacsclient-executable~. There's a lot of voodoo here.
The ~emacsclient~ cannot be used when using Tramp to run a process on a
remote machine. (Theoretically it could, but that would be hard to
setup, very fragile, and rather insecure).
With-Editor provides an alternative "editor" which can be used by
remote processes in much the same way as local processes use an
~emacsclient~ executable. This alternative is known as the "sleeping
editor" because it is implemented as a shell script which sleeps until
it receives a signal.
- User Option: with-editor-sleeping-editor ::
The sleeping editor is a shell script used as the editor of child
processes when the ~emacsclient~ executable cannot be used.
This fallback is used for asynchronous processes started inside the
macro ~with-editor~, when the process runs on a remote machine or for
local processes when ~with-editor-emacsclient-executable~ is ~nil~.
Where the latter uses a socket to communicate with Emacs' server,
this substitute prints edit requests to its standard output on
which a process filter listens for such requests. As such it is
not a complete substitute for a proper ~emacsclient~, it can only
be used as ~$EDITOR~ of child process of the current Emacs instance.
Some shells do not execute traps immediately when waiting for a
child process, but by default we do use such a blocking child
process.
If you use such a shell (e.g., ~csh~ on FreeBSD, but not Debian), then
you have to edit this option. You can either replace ~sh~ with ~bash~
(and install that), or you can use the older, less performant
implementation:
#+BEGIN_SRC emacs-lisp
"sh -c '\
echo \"WITH-EDITOR: $$ OPEN $0 $1 IN $(pwd)\"; \
trap \"exit 0\" USR1; \
trap \"exit 1\" USR2; \
while true; do sleep 1; done'"
#+END_SRC
Note that the unit separator character ( ) right after the file
name ($0) is required.
Also note that using this alternative implementation leads to a
delay of up to a second. The delay can be shortened by replacing
~sleep 1~ with ~sleep 0.01~, or if your implementation does not support
floats, then by using ~nanosleep~ instead.
** Using With-Editor commands
This section describes how to use the ~with-editor~ library /outside/ of
Magit. You don't need to know any of this just to create commits
using Magit.
The commands ~with-editor-async-shell-command~ and
~with-editor-shell-command~ are intended as drop in 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~.
- Command: with-editor-async-shell-command ::
This command is like ~async-shell-command~, but it runs the shell
command with the current Emacs instance exported as ~$EDITOR~.
- Command: with-editor-shell-command ::
This command is like ~shell-command~, but if the shell command ends
with ~&~ and is therefore run asynchronously, then the current Emacs
instance is exported as ~$EDITOR~.
To always use these variants add this to your init file:
#+begin_src emacs-lisp
(keymap-global-set "<remap> <async-shell-command>"
#'with-editor-async-shell-command)
(keymap-global-set "<remap> <shell-command>"
#'with-editor-shell-command)
#+end_src
Alternatively use the global ~shell-command-with-editor-mode~.
- Variable: shell-command-with-editor-mode ::
When this mode is active, then ~$EDITOR~ is exported whenever
ultimately ~shell-command~ is called to asynchronously run some shell
command. This affects most variants of that command, whether they
are defined in Emacs or in some third-party package.
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:
#+begin_src emacs-lisp
(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)
#+end_src
Some variants of this function exist; these two forms are equivalent:
#+begin_src emacs-lisp
(add-hook 'shell-mode-hook
(apply-partially 'with-editor-export-editor "GIT_EDITOR"))
(add-hook 'shell-mode-hook 'with-editor-export-git-editor)
#+end_src
- Command: with-editor-export-editor ::
When invoked in a ~shell-mode~, ~eshell-mode~, ~term-mode~ or ~vterm-mode~
buffer, this command teaches shell commands to use the current Emacs
instance as the editor, by exporting ~$EDITOR~.
- Command: with-editor-export-git-editor ::
This command is like ~with-editor-export-editor~ but exports
~$GIT_EDITOR~.
- Command: with-editor-export-hg-editor ::
This command is like ~with-editor-export-editor~ but exports
~$HG_EDITOR~.
* Using With-Editor as a library
This section describes how to use the ~with-editor~ library /outside/ of
Magit to teach another package how to have its child processes call
home, just like Magit does. You don't need to know any of this just
to create commits using Magit. You can also ignore this if you use
~with-editor~ outside of Magit, but only as an end-user.
For information about interactive use and options that affect both
interactive and non-interactive use, see [[*Using the With-Editor
package]].
- Macro: with-editor &rest body ::
This macro arranges for the ~emacsclient~ or the sleeping editor to be
used as the editor of child processes, effectively teaching them to
call home to the current Emacs instance when they require that the
user edits a file.
This is done by establishing a local binding for ~process-environment~
and changing the value of the ~EDITOR~ environment variable in that
scope. This affects all (asynchronous) processes started by forms
(dynamically) inside BODY.
If BODY begins with a literal string, then that variable is set
instead of ~EDITOR~.
- Macro: with-editor* envvar &rest body ::
This macro is like ~with-editor~, except that the ENVVAR argument is
required and that it is evaluated at run-time.
- Function: with-editor-set-process-filter process filter ::
This function is like ~set-process-filter~ but ensures that adding the
new FILTER does not remove the ~with-editor-process-filter~. This is
done by wrapping the two filter functions using a lambda, which
becomes the actual filter. It calls FILTER first, which may or
may not insert the text into the PROCESS's buffer. Then it calls
~with-editor-process-filter~, passing ~t~ as NO-STANDARD-FILTER.
* Debugging
With-Editor tries very hard to locate a suitable ~emacsclient~
executable, and then sets option ~with-editor-emacsclient-executable~
accordingly. In very rare cases this fails. When it does fail, then
the most likely reason is that someone found yet another way to
package Emacs (most likely on macOS) without putting the executable on
~$PATH~, and we have to add another kludge to find it anyway.
If you are having problems using ~with-editor~, e.g., you cannot commit
in Magit, then please open a new issue at
https://github.com/magit/with-editor/issues and provide information
about your Emacs installation. Most importantly how did you install
Emacs and what is the output of ~M-x with-editor-debug RET~.
* Function and Command Index
:PROPERTIES:
:APPENDIX: t
:INDEX: fn
:END:
* Variable Index
:PROPERTIES:
:APPENDIX: t
:INDEX: vr
:END:
* Copying
:PROPERTIES:
:COPYING: t
:END:
#+begin_quote
Copyright (C) 2015-{{{year}}} Jonas Bernoulli <emacs.with-editor@jonas.bernoulli.dev>
You can redistribute this document and/or modify it under the terms
of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any
later version.
This document is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
#+end_quote
# LocalWords: LocalWords
# LocalWords: Magit Emacs emacsclient FreeBSD macOS texinfo
# LocalWords: async eval hg init performant rebase startup
# IMPORTANT: Also update ORG_ARGS and ORG_EVAL in the Makefile.
# Local Variables:
# eval: (require 'magit-utils nil t)
# indent-tabs-mode: nil
# org-src-preserve-indentation: nil
# End:
================================================
FILE: lisp/Makefile
================================================
-include ../config.mk
include ../default.mk
lisp: $(ELCS) autoloads check-declare
autoloads: $(PKG)-autoloads.el
%.elc: %.el
@printf "Compiling $<\n"
@$(EMACS_BATCH) --funcall batch-byte-compile $<
check-declare:
@printf " Checking function declarations\n"
@$(EMACS_BATCH) --eval "(check-declare-directory default-directory)"
CLEAN = $(ELCS) $(PKG)-autoloads.el
clean:
@printf " Cleaning lisp/*...\n"
@rm -rf $(CLEAN)
$(PKG)-autoloads.el: $(ELS)
@printf " Creating $@\n"
@$(EMACS_BATCH) --load autoload --eval "\
(let* ((file (expand-file-name \"$@\"))\
(generated-autoload-file file)\
(coding-system-for-write 'utf-8-emacs-unix)\
(backup-inhibited t)\
(version-control 'never)\
(inhibit-message t))\
(write-region (autoload-rubric file \"package\" t) nil file)\
(update-directory-autoloads default-directory))" \
2>&1 | sed "/^Package autoload is deprecated$$/d"
================================================
FILE: lisp/with-editor.el
================================================
;;; with-editor.el --- Use the Emacsclient as $EDITOR -*- lexical-binding:t -*-
;; Copyright (C) 2014-2026 The Magit Project Contributors
;; Author: Jonas Bernoulli <emacs.with-editor@jonas.bernoulli.dev>
;; Homepage: https://github.com/magit/with-editor
;; Keywords: processes terminals
;; Package-Version: 3.5.0
;; Package-Requires: ((emacs "26.1") (compat "30.1"))
;; SPDX-License-Identifier: GPL-3.0-or-later
;; This file is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published
;; by the Free Software Foundation, either version 3 of the License,
;; or (at your option) any later version.
;;
;; This file is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;;
;; You should have received a copy of the GNU General Public License
;; along with this file. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; 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.
;;; Code:
(require 'cl-lib)
(require 'compat)
(require 'server)
(require 'shell)
(eval-when-compile (require 'subr-x))
(declare-function dired-get-filename "dired"
(&optional localp no-error-if-not-filep))
(declare-function term-emulate-terminal "term" (proc str))
(defvar eshell-preoutput-filter-functions)
(defvar git-commit-post-finish-hook)
(defvar vterm--process)
(defvar warning-minimum-level)
(defvar warning-minimum-log-level)
;;; Options
(defgroup with-editor nil
"Use the Emacsclient as $EDITOR."
:group 'external
:group 'server)
(defun with-editor-locate-emacsclient ()
"Search for a suitable Emacsclient executable."
(or (with-editor-locate-emacsclient-1
(with-editor-emacsclient-path)
(length (split-string emacs-version "\\.")))
(prog1 nil (display-warning 'with-editor "\
Cannot determine a suitable Emacsclient
Determining an Emacsclient executable suitable for the
current Emacs instance failed. For more information
please see https://github.com/magit/magit/wiki/Emacsclient."))))
(defvar with-editor-emacsclient-program-suffixes
(list "-snapshot" ".emacs-snapshot")
"Suffixes to append to append when looking for a Emacsclient executables.")
(defun with-editor-locate-emacsclient-1 (path depth)
(let* ((version-lst (cl-subseq (split-string emacs-version "\\.") 0 depth))
(version-reg (concat "^" (string-join version-lst "\\."))))
(or (locate-file
(cond ((equal (downcase invocation-name) "remacs")
"remacsclient")
((bound-and-true-p emacsclient-program-name))
("emacsclient"))
path
(mapcan (lambda (v) (cl-mapcar (lambda (e) (concat v e)) exec-suffixes))
(nconc (and (boundp 'debian-emacs-flavor)
(list (format ".%s" debian-emacs-flavor)))
(cl-mapcon (lambda (v)
(setq v (string-join (reverse v) "."))
(list v
(concat "-" v)
(concat ".emacs" v)))
(reverse version-lst))
(cons "" with-editor-emacsclient-program-suffixes)))
(lambda (exec)
(ignore-errors
(string-match-p version-reg
(with-editor-emacsclient-version exec)))))
(and (> depth 1)
(with-editor-locate-emacsclient-1 path (1- depth))))))
(defun with-editor-emacsclient-version (exec)
(let ((default-directory (file-name-directory exec)))
(ignore-errors
(cadr (split-string (car (process-lines exec "--version")))))))
(defun with-editor-emacsclient-path ()
(let ((path exec-path))
(when invocation-directory
(push (directory-file-name invocation-directory) path)
(let* ((linkname (expand-file-name invocation-name invocation-directory))
(truename (file-chase-links linkname)))
(unless (equal truename linkname)
(push (directory-file-name (file-name-directory truename)) path)))
(when (eq system-type 'darwin)
(let ((dir (expand-file-name "bin" invocation-directory)))
(when (file-directory-p dir)
(push dir path)))
(cond
((string-search "Cellar" invocation-directory)
(let ((dir (expand-file-name "../../../bin" invocation-directory)))
(when (file-directory-p dir)
(push dir path))))
((string-search "Emacs.app" invocation-directory)
(let ((dir (expand-file-name "../../../../bin" invocation-directory)))
(when (file-directory-p dir)
(push dir path)))))))
(cl-remove-duplicates path :test #'equal)))
(defcustom with-editor-emacsclient-executable (with-editor-locate-emacsclient)
"The Emacsclient executable used by the `with-editor' macro."
:group 'with-editor
:type '(choice (string :tag "Executable")
(const :tag "Don't use Emacsclient" nil)))
(defcustom with-editor-sleeping-editor "\
sh -c '\
printf \"\\nWITH-EDITOR: $$ OPEN $0\\037$1\\037 IN $(pwd)\\n\"; \
sleep 604800 & sleep=$!; \
trap \"kill $sleep; exit 0\" USR1; \
trap \"kill $sleep; exit 1\" USR2; \
wait $sleep'"
"The sleeping editor, used when the Emacsclient cannot be used.
This fallback is used for asynchronous processes started inside
the macro `with-editor', when the process runs on a remote machine
or for local processes when `with-editor-emacsclient-executable'
is nil (i.e., when no suitable Emacsclient was found, or the user
decided not to use it).
Where the latter uses a socket to communicate with Emacs' server,
this substitute prints edit requests to its standard output on
which a process filter listens for such requests. As such it is
not a complete substitute for a proper Emacsclient, it can only
be used as $EDITOR of child process of the current Emacs instance.
Some shells do not execute traps immediately when waiting for a
child process, but by default we do use such a blocking child
process.
If you use such a shell (e.g., `csh' on FreeBSD, but not Debian),
then you have to edit this option. You can either replace \"sh\"
with \"bash\" (and install that), or you can use the older, less
performant implementation:
\"sh -c '\\
echo -e \\\"\\nWITH-EDITOR: $$ OPEN $0 $1 IN $(pwd)\\n\\\"; \\
trap \\\"exit 0\\\" USR1; \\
trap \\\"exit 1\" USR2; \\
while true; do sleep 1; done'\"
Note that the two unit separator characters ( ) right after $0
and $1 are required. Normally $0 is the file name and $1 is
missing or else gets ignored. But if $0 has the form \"+N[:N]\",
then it is treated as a position in the file and $1 is expected
to be the file.
Also note that using this alternative implementation leads to a
delay of up to a second. The delay can be shortened by replacing
\"sleep 1\" with \"sleep 0.01\", or if your implementation does
not support floats, then by using \"nanosleep\" instead."
:package-version '(with-editor . "2.8.0")
:group 'with-editor
:type 'string)
(defcustom with-editor-finish-query-functions nil
"List of functions called to query before finishing session.
The buffer in question is current while the functions are called.
If any of them returns nil, then the session is not finished and
the buffer is not killed. The user should then fix the issue and
try again. The functions are called with one argument. If it is
non-nil then that indicates that the user used a prefix argument
to force finishing the session despite issues. Functions should
usually honor that and return non-nil."
:group 'with-editor
:type 'hook)
(put 'with-editor-finish-query-functions 'permanent-local t)
(defcustom with-editor-cancel-query-functions nil
"List of functions called to query before canceling session.
The buffer in question is current while the functions are called.
If any of them returns nil, then the session is not canceled and
the buffer is not killed. The user should then fix the issue and
try again. The functions are called with one argument. If it is
non-nil then that indicates that the user used a prefix argument
to force canceling the session despite issues. Functions should
usually honor that and return non-nil."
:group 'with-editor
:type 'hook)
(put 'with-editor-cancel-query-functions 'permanent-local t)
(defcustom with-editor-mode-lighter " WE"
"The mode-line lighter of the With-Editor mode."
:group 'with-editor
:type '(choice (const :tag "No lighter" "") string))
(defvar with-editor-server-window-alist nil
"Alist of filename patterns vs corresponding `server-window'.
Each element looks like (REGEXP . FUNCTION). Files matching
REGEXP are selected using FUNCTION instead of the default in
`server-window'.
Note that when a package adds an entry here then it probably
has a reason to disrespect `server-window' and it likely is
not a good idea to change such entries.")
(defvar with-editor-file-name-history-exclude nil
"List of regexps for filenames `server-visit' should not remember.
When a filename matches any of the regexps, then `server-visit'
does not add it to the variable `file-name-history', which is
used when reading a filename in the minibuffer.")
(defcustom with-editor-shell-command-use-emacsclient t
"Whether to use the emacsclient when running shell commands.
This affects `with-editor-async-shell-command' and, if the input
ends with \"&\" `with-editor-shell-command' .
If `shell-command-with-editor-mode' is enabled, then it also
affects `shell-command-async' and, if the input ends with \"&\"
`shell-command'.
This is a temporary kludge that lets you choose between two
possible defects, the ones described in the issues #23 and #40.
When t, then use the emacsclient. This has the disadvantage that
`with-editor-mode' won't be enabled because we don't know whether
this package was involved at all in the call to the emacsclient,
and when it is not, then we really should. The problem is that
the emacsclient doesn't pass along any environment variables to
the server. This will hopefully be fixed in Emacs eventually.
When nil, then use the sleeping editor. Because in this case we
know that this package is involved, we can enable the mode. But
this makes it necessary that you invoke $EDITOR in shell scripts
like so:
eval \"$EDITOR\" file
And some tools that do not handle $EDITOR properly also break."
:package-version '(with-editor . "2.7.1")
:group 'with-editor
:type 'boolean)
;;; Mode Commands
(defvar with-editor-pre-finish-hook nil)
(defvar with-editor-pre-cancel-hook nil)
(defvar with-editor-post-finish-hook nil)
(defvar with-editor-post-finish-hook-1 nil)
(defvar with-editor-post-cancel-hook nil)
(defvar with-editor-post-cancel-hook-1 nil)
(defvar with-editor-cancel-alist nil)
(put 'with-editor-pre-finish-hook 'permanent-local t)
(put 'with-editor-pre-cancel-hook 'permanent-local t)
(put 'with-editor-post-finish-hook 'permanent-local t)
(put 'with-editor-post-cancel-hook 'permanent-local t)
(defvar-local with-editor-show-usage t)
(defvar-local with-editor-cancel-message nil)
(defvar-local with-editor-previous-winconf nil)
(put 'with-editor-cancel-message 'permanent-local t)
(put 'with-editor-previous-winconf 'permanent-local t)
(defvar-local with-editor--pid nil "For internal use.")
(put 'with-editor--pid 'permanent-local t)
(defun with-editor-finish (force)
"Finish the current edit session."
(interactive "P")
(when (run-hook-with-args-until-failure
'with-editor-finish-query-functions force)
(let ((post-finish-hook with-editor-post-finish-hook)
(post-commit-hook (bound-and-true-p git-commit-post-finish-hook))
(dir default-directory))
(run-hooks 'with-editor-pre-finish-hook)
(with-editor-return nil)
(accept-process-output nil 0.1)
(with-temp-buffer
(setq default-directory dir)
(setq-local with-editor-post-finish-hook post-finish-hook)
(when post-commit-hook
(setq-local git-commit-post-finish-hook post-commit-hook))
(run-hooks 'with-editor-post-finish-hook)))))
(defun with-editor-cancel (force)
"Cancel the current edit session."
(interactive "P")
(when (run-hook-with-args-until-failure
'with-editor-cancel-query-functions force)
(let ((message with-editor-cancel-message))
(when (functionp message)
(setq message (funcall message)))
(let ((post-cancel-hook with-editor-post-cancel-hook)
(with-editor-cancel-alist nil)
(dir default-directory))
(run-hooks 'with-editor-pre-cancel-hook)
(with-editor-return t)
(accept-process-output nil 0.1)
(with-temp-buffer
(setq default-directory dir)
(setq-local with-editor-post-cancel-hook post-cancel-hook)
(run-hooks 'with-editor-post-cancel-hook)))
(message (or message "Canceled by user")))))
(defun with-editor-return (cancel)
(let ((winconf with-editor-previous-winconf)
(clients server-buffer-clients)
(dir default-directory)
(pid with-editor--pid))
(remove-hook 'kill-buffer-query-functions
#'with-editor-kill-buffer-noop t)
(cond (cancel
(save-buffer)
(if clients
(let ((buf (current-buffer)))
(dolist (client clients)
(message "client %S" client)
(ignore-errors
(server-send-string client "-error Canceled by user\n"))
(delete-process client))
(when (buffer-live-p buf)
(kill-buffer buf)))
;; Fallback for when emacs was used as $EDITOR
;; instead of emacsclient or the sleeping editor.
;; See https://github.com/magit/magit/issues/2258.
(ignore-errors (delete-file buffer-file-name))
(kill-buffer)))
(t
(save-buffer)
(if clients
;; Don't use `server-edit' because we do not want to
;; show another buffer belonging to another client.
;; See https://github.com/magit/magit/issues/2197.
(server-done)
(kill-buffer))))
(when pid
(let ((default-directory dir))
(process-file "kill" nil nil nil
"-s" (if cancel "USR2" "USR1") pid)))
(when (and winconf (eq (window-configuration-frame winconf)
(selected-frame)))
(set-window-configuration winconf))))
;;; Mode
(defvar-keymap with-editor-mode-map
"C-c C-c" #'with-editor-finish
"<remap> <server-edit>" #'with-editor-finish
"<remap> <evil-save-and-close>" #'with-editor-finish
"<remap> <evil-save-modified-and-close>" #'with-editor-finish
"C-c C-k" #'with-editor-cancel
"<remap> <kill-buffer>" #'with-editor-cancel
"<remap> <ido-kill-buffer>" #'with-editor-cancel
"<remap> <iswitchb-kill-buffer>" #'with-editor-cancel
"<remap> <evil-quit>" #'with-editor-cancel)
(define-minor-mode with-editor-mode
"Edit a file as the $EDITOR of an external process."
:lighter with-editor-mode-lighter
;; Protect the user from enabling or disabling the mode interactively.
;; Manually enabling the mode is dangerous because canceling the buffer
;; deletes the visited file. The mode must not be disabled manually,
;; either `with-editor-finish' or `with-editor-cancel' must be used.
:interactive nil ; >= 28.1
(when (called-interactively-p 'any) ; < 28.1
(setq with-editor-mode (not with-editor-mode))
(user-error "With-Editor mode is not intended for interactive use"))
;; The buffer must also not be killed using regular kill commands.
(add-hook 'kill-buffer-query-functions
#'with-editor-kill-buffer-noop nil t)
;; `server-execute' displays a message which is not
;; correct when using this mode.
(when with-editor-show-usage
(with-editor-usage-message)))
(put 'with-editor-mode 'permanent-local t)
(defun with-editor-kill-buffer-noop ()
;; We started doing this in response to #64, but it is not safe
;; to do so, because the client has already been killed, causing
;; `with-editor-return' (called by `with-editor-cancel') to delete
;; the file, see #66. The reason we delete the file in the first
;; place are https://github.com/magit/magit/issues/2258 and
;; https://github.com/magit/magit/issues/2248.
;; (if (memq this-command '(save-buffers-kill-terminal
;; save-buffers-kill-emacs))
;; (let ((with-editor-cancel-query-functions nil))
;; (with-editor-cancel nil)
;; t)
;; ...)
;; So go back to always doing this instead:
(user-error (substitute-command-keys (format "\
Don't kill this buffer %S. Instead cancel using \\[with-editor-cancel]"
(current-buffer)))))
(defvar-local with-editor-usage-message "\
Type \\[with-editor-finish] to finish, \
or \\[with-editor-cancel] to cancel")
(defun with-editor-usage-message ()
;; Run after `server-execute', which is run using
;; a timer which starts immediately.
(let ((buffer (current-buffer)))
(run-with-timer
0.05 nil
(lambda ()
(with-current-buffer buffer
(message (substitute-command-keys with-editor-usage-message)))))))
;;; Wrappers
(defvar with-editor--envvar nil "For internal use.")
(defmacro with-editor (&rest body)
"Use the Emacsclient as $EDITOR while evaluating BODY.
Modify the `process-environment' for processes started in BODY,
instructing them to use the Emacsclient as $EDITOR. If optional
ENVVAR is a literal string then bind that environment variable
instead.
\n(fn [ENVVAR] BODY...)"
(declare (indent defun) (debug (body)))
`(let ((with-editor--envvar ,(if (stringp (car body))
(pop body)
'(or with-editor--envvar "EDITOR")))
(process-environment process-environment))
(with-editor--setup)
,@body))
(defmacro with-editor* (envvar &rest body)
"Use the Emacsclient as the editor while evaluating BODY.
Modify the `process-environment' for processes started in BODY,
instructing them to use the Emacsclient as editor. ENVVAR is the
environment variable that is exported to do so, it is evaluated
at run-time.
\n(fn ENVVAR BODY...)"
(declare (indent defun) (debug (sexp body)))
`(let ((with-editor--envvar ,envvar)
(process-environment process-environment))
(with-editor--setup)
,@body))
(defun with-editor--setup ()
(if (or (not with-editor-emacsclient-executable)
(file-remote-p default-directory))
(push (concat with-editor--envvar "=" with-editor-sleeping-editor)
process-environment)
;; Make sure server-use-tcp's value is valid.
(unless (featurep 'make-network-process '(:family local))
(setq server-use-tcp t))
;; Make sure the server is running.
(unless (process-live-p server-process)
(when (server-running-p server-name)
(setq server-name (format "server%s" (emacs-pid)))
(when (server-running-p server-name)
(server-force-delete server-name)))
(server-start))
;; Tell $EDITOR to use the Emacsclient.
(push (concat with-editor--envvar "="
;; Quoting is the right thing to do. Applications that
;; fail because of that, are the ones that need fixing,
;; e.g., by using 'eval "$EDITOR" file'. See #121.
(shell-quote-argument
;; If users set the executable manually, they might
;; begin the path with "~", which would get quoted.
(if (string-prefix-p "~" with-editor-emacsclient-executable)
(concat (expand-file-name "~")
(substring with-editor-emacsclient-executable 1))
with-editor-emacsclient-executable))
;; Tell the process where the server file is.
(and (not server-use-tcp)
(concat " --socket-name="
(shell-quote-argument
(expand-file-name server-name
server-socket-dir)))))
process-environment)
(when server-use-tcp
(push (concat "EMACS_SERVER_FILE="
(expand-file-name server-name server-auth-dir))
process-environment))
;; As last resort fallback to the sleeping editor.
(push (concat "ALTERNATE_EDITOR=" with-editor-sleeping-editor)
process-environment)))
(defun with-editor-server-window ()
(or (and buffer-file-name
(cdr (cl-find-if (lambda (cons)
(string-match-p (car cons) buffer-file-name))
with-editor-server-window-alist)))
server-window))
(define-advice server-switch-buffer
(:around (fn &optional next-buffer &rest args)
with-editor-server-window-alist)
"Honor `with-editor-server-window-alist' (which see)."
(let ((server-window (with-current-buffer
(or next-buffer (current-buffer))
(when with-editor-mode
(setq with-editor-previous-winconf
(current-window-configuration)))
(with-editor-server-window))))
(apply fn next-buffer args)))
(define-advice start-file-process
(:around (fn name buffer program &rest program-args)
with-editor-process-filter)
"When called inside a `with-editor' form and the Emacsclient
cannot be used, then give the process the filter function
`with-editor-process-filter'. To avoid overriding the filter
being added here you should use `with-editor-set-process-filter'
instead of `set-process-filter' inside `with-editor' forms.
When the `default-directory' is located on a remote machine,
then also manipulate PROGRAM and PROGRAM-ARGS in order to set
the appropriate editor environment variable."
(if (not with-editor--envvar)
(apply fn name buffer program program-args)
(when (file-remote-p default-directory)
(unless (equal program "env")
(push program program-args)
(setq program "env"))
(push (concat with-editor--envvar "=" with-editor-sleeping-editor)
program-args))
(let ((process (apply fn name buffer program program-args)))
(set-process-filter process #'with-editor-process-filter)
(process-put process 'default-dir default-directory)
process)))
(advice-add #'make-process :around
#'make-process@with-editor-process-filter)
(cl-defun make-process@with-editor-process-filter
(fn &rest keys &key name buffer command coding noquery stop
connection-type filter sentinel stderr file-handler
&allow-other-keys)
"When called inside a `with-editor' form and the Emacsclient
cannot be used, then give the process the filter function
`with-editor-process-filter'. To avoid overriding the filter
being added here you should use `with-editor-set-process-filter'
instead of `set-process-filter' inside `with-editor' forms.
When the `default-directory' is located on a remote machine and
FILE-HANDLER is non-nil, then also manipulate COMMAND in order
to set the appropriate editor environment variable."
(if (or (not file-handler) (not with-editor--envvar))
(apply fn keys)
(when (file-remote-p default-directory)
(unless (equal (car command) "env")
(push "env" command))
(push (concat with-editor--envvar "=" with-editor-sleeping-editor)
(cdr command)))
(let* ((filter (if filter
(lambda (process output)
(funcall filter process output)
(with-editor-process-filter process output t))
#'with-editor-process-filter))
(process (funcall fn
:name name
:buffer buffer
:command command
:coding coding
:noquery noquery
:stop stop
:connection-type connection-type
:filter filter
:sentinel sentinel
:stderr stderr
:file-handler file-handler)))
(process-put process 'default-dir default-directory)
process)))
(defun with-editor-set-process-filter (process filter)
"Like `set-process-filter' but keep `with-editor-process-filter'.
Give PROCESS the new FILTER but keep `with-editor-process-filter'
if that was added earlier by the advised `start-file-process'.
Do so by wrapping the two filter functions using a lambda, which
becomes the actual filter. It calls FILTER first, which may or
may not insert the text into the PROCESS's buffer. Then it calls
`with-editor-process-filter', passing t as NO-STANDARD-FILTER."
(set-process-filter
process
(if (eq (process-filter process) 'with-editor-process-filter)
`(lambda (proc str)
(,filter proc str)
(with-editor-process-filter proc str t))
filter)))
(defvar with-editor-filter-visit-hook nil)
(defconst with-editor-sleeping-editor-regexp "^\
WITH-EDITOR: \\([0-9]+\\) \
OPEN \\([^ ]+?\\)\
\\(?: \\([^ ]*\\)\\)?\
\\(?: IN \\([^\r]+?\\)\\)?\r?$")
(defvar with-editor--max-incomplete-length 1000)
(defun with-editor-sleeping-editor-filter (process string)
(when-let ((incomplete (and process (process-get process 'incomplete))))
(setq string (concat incomplete string)))
(save-match-data
(cond
((and process (not (string-suffix-p "\n" string)))
(let ((length (length string)))
(when (> length with-editor--max-incomplete-length)
(setq string
(substring string
(- length with-editor--max-incomplete-length)))))
(process-put process 'incomplete string)
nil)
((string-match with-editor-sleeping-editor-regexp string)
(when process
(process-put process 'incomplete nil))
(let ((pid (match-string 1 string))
(arg0 (match-string 2 string))
(arg1 (match-string 3 string))
(dir (match-string 4 string))
file line column)
(cond ((string-match "\\`\\+\\([0-9]+\\)\\(?::\\([0-9]+\\)\\)?\\'" arg0)
(setq file arg1)
(setq line (string-to-number (match-string 1 arg0)))
(setq column (match-string 2 arg0))
(setq column (and column (string-to-number column))))
((setq file arg0)))
(unless (file-name-absolute-p file)
(setq file (expand-file-name file dir)))
(when default-directory
(setq file (concat (file-remote-p default-directory) file)))
(with-current-buffer (find-file-noselect file)
(with-editor-mode 1)
(setq with-editor--pid pid)
(setq with-editor-previous-winconf
(current-window-configuration))
(when line
(let ((pos (save-excursion
(save-restriction
(goto-char (point-min))
(forward-line (1- line))
(when column
(move-to-column column))
(point)))))
(when (and (buffer-narrowed-p)
widen-automatically
(not (<= (point-min) pos (point-max))))
(widen))
(goto-char pos)))
(run-hooks 'with-editor-filter-visit-hook)
(funcall (or (with-editor-server-window) #'switch-to-buffer)
(current-buffer))
(kill-local-variable 'server-window)))
nil)
(t string))))
(defun with-editor-process-filter
(process string &optional no-default-filter)
"Listen for edit requests by child processes."
(let ((default-directory (process-get process 'default-dir)))
(with-editor-sleeping-editor-filter process string))
(unless no-default-filter
(internal-default-process-filter process string)))
(define-advice server-visit-files
(:after (files _proc &optional _nowait)
with-editor-file-name-history-exclude)
"Prevent certain files from being added to `file-name-history'.
Files matching a regexp in `with-editor-file-name-history-exclude'
are prevented from being added to that list."
(pcase-dolist (`(,file . ,_) files)
(when (cl-find-if (lambda (regexp)
(string-match-p regexp file))
with-editor-file-name-history-exclude)
(setq file-name-history
(delete (abbreviate-file-name file) file-name-history)))))
;;; Augmentations
;;;###autoload
(cl-defun with-editor-export-editor (&optional (envvar "EDITOR"))
"Teach subsequent commands to use current Emacs instance as editor.
Set and export the environment variable ENVVAR, by default
\"EDITOR\". The value is automatically generated to teach
commands to use the current Emacs instance as \"the editor\".
This works in `shell-mode', `term-mode', `eshell-mode' and
`vterm'."
(interactive (list (with-editor-read-envvar)))
(cond
((derived-mode-p 'comint-mode 'term-mode)
(when-let ((process (get-buffer-process (current-buffer))))
(goto-char (process-mark process))
(process-send-string
process (format " export %s=%s\n" envvar
(shell-quote-argument with-editor-sleeping-editor)))
(while (accept-process-output process 1 nil t))
(if (derived-mode-p 'term-mode)
(with-editor-set-process-filter process #'with-editor-emulate-terminal)
(add-hook 'comint-output-filter-functions #'with-editor-output-filter
nil t))))
((derived-mode-p 'eshell-mode)
(add-to-list 'eshell-preoutput-filter-functions
#'with-editor-output-filter)
(setenv envvar with-editor-sleeping-editor))
((and (derived-mode-p 'vterm-mode)
(fboundp 'vterm-send-return)
(fboundp 'vterm-send-string))
(if with-editor-emacsclient-executable
(let ((with-editor--envvar envvar)
(process-environment process-environment))
(with-editor--setup)
(while (accept-process-output vterm--process 1 nil t))
(when-let ((v (getenv envvar)))
(vterm-send-string (format " export %s=%S" envvar v))
(vterm-send-return))
(when-let ((v (getenv "EMACS_SERVER_FILE")))
(vterm-send-string (format " export EMACS_SERVER_FILE=%S" v))
(vterm-send-return))
(vterm-send-string " clear")
(vterm-send-return))
(error "Cannot use sleeping editor in this buffer")))
(t
(error "Cannot export environment variables in this buffer")))
(message "Successfully exported %s" envvar))
;;;###autoload
(defun with-editor-export-git-editor ()
"Like `with-editor-export-editor' but always set `$GIT_EDITOR'."
(interactive)
(with-editor-export-editor "GIT_EDITOR"))
;;;###autoload
(defun with-editor-export-hg-editor ()
"Like `with-editor-export-editor' but always set `$HG_EDITOR'."
(interactive)
(with-editor-export-editor "HG_EDITOR"))
(defun with-editor-output-filter (string)
"Handle edit requests on behalf of `comint-mode' and `eshell-mode'."
(with-editor-sleeping-editor-filter nil string))
(defun with-editor-emulate-terminal (process string)
"Like `term-emulate-terminal' but also handle edit requests."
(let ((with-editor-sleeping-editor-regexp
(substring with-editor-sleeping-editor-regexp 1)))
(with-editor-sleeping-editor-filter process string))
(term-emulate-terminal process string))
(defvar with-editor-envvars '("EDITOR" "GIT_EDITOR" "HG_EDITOR"))
(cl-defun with-editor-read-envvar
(&optional (prompt "Set environment variable")
(default "EDITOR"))
(let ((reply (completing-read (if default
(format "%s (%s): " prompt default)
(concat prompt ": "))
with-editor-envvars nil nil nil nil default)))
(if (string= reply "") (user-error "Nothing selected") reply)))
;;;###autoload
(define-minor-mode shell-command-with-editor-mode
"Teach `shell-command' to use current Emacs instance as editor.
Teach `shell-command', and all commands that ultimately call that
command, to use the current Emacs instance as editor by executing
\"EDITOR=CLIENT COMMAND&\" instead of just \"COMMAND&\".
CLIENT is automatically generated; EDITOR=CLIENT instructs
COMMAND to use to the current Emacs instance as \"the editor\",
assuming no other variable overrides the effect of \"$EDITOR\".
CLIENT may be the path to an appropriate emacsclient executable
with arguments, or a script which also works over Tramp.
Alternatively you can use the `with-editor-async-shell-command',
which also allows the use of another variable instead of
\"EDITOR\"."
:global t)
;;;###autoload
(defun with-editor-async-shell-command
(command &optional output-buffer error-buffer envvar)
"Like `async-shell-command' but with `$EDITOR' set.
Execute string \"ENVVAR=CLIENT COMMAND\" in an inferior shell;
display output, if any. With a prefix argument prompt for an
environment variable, otherwise the default \"EDITOR\" variable
is used. With a negative prefix argument additionally insert
the COMMAND's output at point.
CLIENT is automatically generated; ENVVAR=CLIENT instructs
COMMAND to use to the current Emacs instance as \"the editor\",
assuming it respects ENVVAR as an \"EDITOR\"-like variable.
CLIENT may be the path to an appropriate emacsclient executable
with arguments, or a script which also works over Tramp.
Also see `async-shell-command' and `shell-command'."
(interactive (with-editor-shell-command-read-args "Async shell command: " t))
(let ((with-editor--envvar envvar))
(with-editor
(async-shell-command command output-buffer error-buffer))))
;;;###autoload
(defun with-editor-shell-command
(command &optional output-buffer error-buffer envvar)
"Like `shell-command' or `with-editor-async-shell-command'.
If COMMAND ends with \"&\" behave like the latter,
else like the former."
(interactive (with-editor-shell-command-read-args "Shell command: "))
(if (string-match "&[ \t]*\\'" command)
(with-editor-async-shell-command
command output-buffer error-buffer envvar)
(shell-command command output-buffer error-buffer)))
(defun with-editor-shell-command-read-args (prompt &optional async)
(let ((command (read-shell-command
prompt nil nil
(let ((filename (or buffer-file-name
(and (eq major-mode 'dired-mode)
(dired-get-filename nil t)))))
(and filename (file-relative-name filename))))))
(list command
(if (or async (setq async (string-match-p "&[ \t]*\\'" command)))
(< (prefix-numeric-value current-prefix-arg) 0)
current-prefix-arg)
shell-command-default-error-buffer
(and async current-prefix-arg (with-editor-read-envvar)))))
(define-advice shell-command
(:around (fn command &optional output-buffer error-buffer)
shell-command-with-editor-mode)
"Set editor envvar, if `shell-command-with-editor-mode' is enabled.
Also take care of that for `with-editor-[async-]shell-command'."
;; `shell-mode' and its hook are intended for buffers in which an
;; interactive shell is running, but `shell-command' also turns on
;; that mode, even though it only runs the shell to run a single
;; command. The `with-editor-export-editor' hook function is only
;; intended to be used in buffers in which an interactive shell is
;; running, so it has to be removed here.
(let ((shell-mode-hook (remove 'with-editor-export-editor shell-mode-hook)))
(cond
;; If `with-editor-async-shell-command' was used, then `with-editor'
;; was used, and `with-editor--envvar'. `with-editor-shell-command'
;; only goes down that path if the command ends with "&". We might
;; still have to use `with-editor' here, for `async-shell-command'
;; or `shell-command', if the mode is enabled.
((and (string-suffix-p "&" command)
(or with-editor--envvar
shell-command-with-editor-mode))
(if with-editor--envvar
(funcall fn command output-buffer error-buffer)
(with-editor (funcall fn command output-buffer error-buffer)))
;; The comint filter was overridden with our filter. Use both.
(and-let* ((process (get-buffer-process
(or output-buffer
(get-buffer "*Async Shell Command*")))))
(prog1 process
(set-process-filter process
(lambda (proc str)
(comint-output-filter proc str)
(with-editor-process-filter proc str t))))))
((funcall fn command output-buffer error-buffer)))))
;;; _
(defun with-editor-debug ()
"Debug configuration issues.
See info node `(with-editor)Debugging' for instructions."
(interactive)
(require 'warnings)
(with-current-buffer (get-buffer-create "*with-editor-debug*")
(pop-to-buffer (current-buffer))
(erase-buffer)
(ignore-errors (with-editor))
(insert
(format "with-editor: %s\n" (locate-library "with-editor.el"))
(format "emacs: %s (%s)\n"
(expand-file-name invocation-name invocation-directory)
emacs-version)
"system:\n"
(format " system-type: %s\n" system-type)
(format " system-configuration: %s\n" system-configuration)
(format " system-configuration-options: %s\n" system-configuration-options)
"server:\n"
(format " server-running-p: %s\n" (server-running-p))
(format " server-process: %S\n" server-process)
(format " server-use-tcp: %s\n" server-use-tcp)
(format " server-name: %s\n" server-name)
(format " server-socket-dir: %s\n" server-socket-dir))
(if (and server-socket-dir (file-accessible-directory-p server-socket-dir))
(dolist (file (directory-files server-socket-dir nil "^[^.]"))
(insert (format " %s\n" file)))
(insert (format " %s: not an accessible directory\n"
(if server-use-tcp "WARNING" "ERROR"))))
(insert (format " server-auth-dir: %s\n" server-auth-dir))
(if (file-accessible-directory-p server-auth-dir)
(dolist (file (directory-files server-auth-dir nil "^[^.]"))
(insert (format " %s\n" file)))
(insert (format " %s: not an accessible directory\n"
(if server-use-tcp "ERROR" "WARNING"))))
(let ((val with-editor-emacsclient-executable)
(def (default-value 'with-editor-emacsclient-executable))
(fun (let ((warning-minimum-level :error)
(warning-minimum-log-level :error))
(with-editor-locate-emacsclient))))
(insert "with-editor-emacsclient-executable:\n"
(format " value: %s (%s)\n" val
(and val (with-editor-emacsclient-version val)))
(format " default: %s (%s)\n" def
(and def (with-editor-emacsclient-version def)))
(format " funcall: %s (%s)\n" fun
(and fun (with-editor-emacsclient-version fun)))))
(insert "path:\n"
(format " $PATH: %s\n" (split-string (getenv "PATH") ":"))
(format " exec-path: %s\n" exec-path))
(insert (format " with-editor-emacsclient-path:\n"))
(dolist (dir (with-editor-emacsclient-path))
(insert (format " %s (%s)\n" dir (car (file-attributes dir))))
(when (file-directory-p dir)
;; Don't match emacsclientw.exe, it makes popup windows.
(dolist (exec (directory-files dir t "emacsclient\\(?:[^w]\\|\\'\\)"))
(insert (format " %s (%s)\n" exec
(with-editor-emacsclient-version exec))))))))
(defconst with-editor-font-lock-keywords
'(("(\\(with-\\(?:git-\\)?editor\\)\\_>" (1 'font-lock-keyword-face))))
(font-lock-add-keywords 'emacs-lisp-mode with-editor-font-lock-keywords)
(provide 'with-editor)
;; Local Variables:
;; byte-compile-warnings: (not docstrings-control-chars)
;; indent-tabs-mode: nil
;; lisp-indent-local-overrides: ((cond . 0) (interactive . 0))
;; End:
;;; with-editor.el ends here
gitextract_kaalnlk_/
├── .dir-locals.el
├── .elpaignore
├── .github/
│ ├── ISSUE_TEMPLATE/
│ │ ├── bug_report.md
│ │ └── config.yml
│ └── workflows/
│ ├── compile.yml
│ ├── manual.yml
│ └── stats.yml
├── .gitignore
├── .mailmap
├── CHANGELOG
├── LICENSE
├── Makefile
├── README.org
├── default.mk
├── docs/
│ ├── .orgconfig
│ ├── Makefile
│ ├── htmlxref.cnf
│ └── with-editor.org
└── lisp/
├── Makefile
└── with-editor.el
Condensed preview — 20 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (112K chars).
[
{
"path": ".dir-locals.el",
"chars": 239,
"preview": "((nil\n (indent-tabs-mode . nil))\n (makefile-mode\n (indent-tabs-mode . t))\n (git-commit-mode\n (git-commit-major-mode ."
},
{
"path": ".elpaignore",
"chars": 167,
"preview": ".dir-locals.el\n.elpaignore\n.github\n.gitignore\n.mailmap\nLICENSE\nMakefile\ndefault.mk\ndocs/.orgconfig\ndocs/Makefile\ndocs/ht"
},
{
"path": ".github/ISSUE_TEMPLATE/bug_report.md",
"chars": 665,
"preview": "---\ntitle: \nname: 🪳 Bug report\nabout: Report a defect. Do not use this for support requests and feature suggestions.\n---"
},
{
"path": ".github/ISSUE_TEMPLATE/config.yml",
"chars": 802,
"preview": "blank_issues_enabled: false\ncontact_links:\n - name: \"💡 Suggest a feature\"\n url: https://github.com/magit/with-editor"
},
{
"path": ".github/workflows/compile.yml",
"chars": 234,
"preview": "name: Compile\non: [push, pull_request]\njobs:\n compile:\n name: Compile\n uses: | # zizmor: ignore[unpinned-uses] sa"
},
{
"path": ".github/workflows/manual.yml",
"chars": 333,
"preview": "name: Manual\non:\n push:\n branches: main\n tags: \"v[0-9]+.[0-9]+.[0-9]+\"\njobs:\n manual:\n name: Manual\n uses:"
},
{
"path": ".github/workflows/stats.yml",
"chars": 342,
"preview": "name: Statistics\non:\n push:\n branches: main\n schedule:\n - cron: '3 13 * * 1'\njobs:\n stats:\n name: Statistics"
},
{
"path": ".gitignore",
"chars": 153,
"preview": "/config.mk\n/docs/*.html\n/docs/*.info\n/docs/*.pdf\n/docs/*.texi\n/docs/.revdesc\n/docs/dir\n/docs/stats/\n/lisp/*-autoloads.el"
},
{
"path": ".mailmap",
"chars": 35,
"preview": "Justin Burkett <justin@burkett.cc>\n"
},
{
"path": "CHANGELOG",
"chars": 786,
"preview": "# -*- mode: org -*-\n* v3.5.0 2026-05-01\n\n- Append newline to emacsclient commands as required by Emacs 31.1.\n #137\n\n"
},
{
"path": "LICENSE",
"chars": 35149,
"preview": " GNU GENERAL PUBLIC LICENSE\n Version 3, 29 June 2007\n\n Copyright (C) 2007 Free "
},
{
"path": "Makefile",
"chars": 1421,
"preview": "-include config.mk\ninclude default.mk\n\n.PHONY: lisp docs\n\nall: lisp docs\n\nhelp:\n\t$(info make all -- Generate li"
},
{
"path": "README.org",
"chars": 3226,
"preview": "* With-Editor\n\nThis library makes it possible to reliably use the Emacsclient as\nthe ~$EDITOR~ of child processes. It m"
},
{
"path": "default.mk",
"chars": 1021,
"preview": "TOP := $(dir $(lastword $(MAKEFILE_LIST)))\n\nDOMAIN ?= magit.vc\n\nPKG = with-editor\n\nELS = $(PKG).el\nELCS = $(ELS:.el=."
},
{
"path": "docs/.orgconfig",
"chars": 1575,
"preview": "# -*- mode:org -*-\n# Copyright (C) 2021-2026 Jonas Bernoulli\n# SPDX-License-Identifier: GPL-3.0-or-later\n# URL: https://"
},
{
"path": "docs/Makefile",
"chars": 3321,
"preview": "-include ../config.mk\ninclude ../default.mk\n\n.PHONY: stats\n\ndocs: texi info html html-dir pdf\n\ntexi: $(PKG).texi\ninf"
},
{
"path": "docs/htmlxref.cnf",
"chars": 989,
"preview": "# https://www.gnu.org/software/texinfo/manual/texinfo/html_node/HTML-Xref-Configuration.html\n\nEMACS = https://www.gnu.or"
},
{
"path": "docs/with-editor.org",
"chars": 12296,
"preview": "#+title: With-Editor User Manual\n:PREAMBLE:\n#+author: Jonas Bernoulli\n#+email: emacs.with-editor@jonas.bernoulli.dev\n#+d"
},
{
"path": "lisp/Makefile",
"chars": 919,
"preview": "-include ../config.mk\ninclude ../default.mk\n\nlisp: $(ELCS) autoloads check-declare\n\nautoloads: $(PKG)-autoloads.el\n\n%.el"
},
{
"path": "lisp/with-editor.el",
"chars": 43682,
"preview": ";;; with-editor.el --- Use the Emacsclient as $EDITOR -*- lexical-binding:t -*-\n\n;; Copyright (C) 2014-2026 The Magit P"
}
]
About this extraction
This page contains the full source code of the magit/with-editor GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 20 files (104.8 KB), approximately 26.0k tokens. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.