with-editor 项目使用教程

with-editor 项目使用教程

with-editor Use the Emacsclient as the $EDITOR of child processes 项目地址: https://gitcode.com/gh_mirrors/wi/with-editor

1. 项目的目录结构及介绍

with-editor 是一个 Emacs Lisp 库，使得 Emacsclient 可以作为子进程的 $EDITOR 使用。以下是项目的目录结构及其简要介绍：

with-editor/
├── .github/         # GitHub 相关的配置文件
├── docs/            # 项目文档
├── lisp/            # Lisp 源代码文件
├── .gitignore       # Git 忽略文件
├── .mailmap         # Git 邮件地址映射文件
├── .travis.yml      # Travis CI 配置文件
├── CHANGELOG        # 更新日志
├── LICENSE          # 许可证文件
├── Makefile         # Makefile 文件
├── README.org       # 项目介绍文档
├── default.mk       # 默认 Makefile 文件

• .github/: 存放 GitHub 专用的配置文件。
• docs/: 包含项目的文档。
• lisp/: 存放 Emacs Lisp 源代码。
• .gitignore: 指定 Git 忽略的文件和目录。
• .mailmap: 用于规范 Git 提交中的作者和电子邮件地址。
• .travis.yml: 用于配置 Travis CI 自动化构建服务。
• CHANGELOG: 记录项目的版本更新和修改历史。
• LICENSE: 项目使用的许可证信息。
• Makefile: 编译和构建项目时使用的 Makefile 文件。
• README.org: 项目的主要介绍文档，使用 Org 模式编写。
• default.mk: 默认的 Makefile 文件。

2. 项目的启动文件介绍

with-editor 项目没有特定的启动文件，但是你需要在 Emacs 配置文件（通常是 ~/.emacs 或 ~/.emacs.d/init.el）中加载库，以便使用其功能。以下是一个简单的加载示例：

(package-initialize)                 ; 初始化包管理器
(add-to-list 'load-path "/path/to/with-editor/lisp") ; 添加库路径
(require 'with-editor)                ; 加载库

确保将 /path/to/with-editor/lisp 替换为实际的库路径。

3. 项目的配置文件介绍

with-editor 项目的主要配置是通过 Emacs 的模式钩（mode hooks）来完成的。以下是一些常用的配置示例：

• 将 with-editor 设置为默认的 $EDITOR：

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

• 为 shell-mode、eshell-mode、term-mode 和 vterm-mode 自动设置 $EDITOR：

(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)

你可以根据需要修改这些配置，以适应你的工作流程。

with-editor Use the Emacsclient as the $EDITOR of child processes 项目地址: https://gitcode.com/gh_mirrors/wi/with-editor