Emacs Projectile 使用教程

Projectile 是 Emacs 中最强大的项目管理库之一,专门用于简化项目内的导航和操作。

1. 安装与配置

(use-package projectile
  :ensure t
  :diminish projectile-mode
  :config
  (projectile-mode +1)
  ;; 绑定喜欢的快捷键前缀
  (setq projectile-keymap-prefix (kbd "C-c p")))

1. 核心快捷键

项目切换与发现

项目操作

项目信息

1. 使用说明

3.1 项目识别

Projectile 自动识别以下类型的项目:

• Git 仓库
• Mercurial 仓库
• Subversion 仓库
• Emacs 项目 (.projectile 文件)
• 特定语言项目 (如 npm package.json, Python setup.py 等)

3.2 项目切换 (C-c p p)

1. 按 C-c p p 打开项目列表
2. 使用 C-s 搜索过滤项目
3. 回车切换到选中项目
4. C-d 删除选中的项目(从缓存)

3.3 文件搜索

• C-c p f: 递归搜索项目文件 (可使用 * 和 ? 通配符)
• C-c p F: 在所有已知项目中搜索文件
• C-c p 4 f: 在其他窗口中打开文件

3.4 内容搜索

• C-c p s g: 使用 grep 搜索
• C-c p a: 使用 ag/ripgrep 搜索 (更快)
• C-c p r: 多文件替换

1. 小技巧

4.1 智能搜索

• 使用 C-c p s g 后,可使用正则表达式
• 在搜索时输入 -i 忽略大小写

4.2 缓存优化

;; 启用持久缓存(跨会话)
(setq projectile-enable-caching 'persistent)

;; 设置缓存过期时间(秒)
(setq projectile-files-cache-expire-time 3600)

4.3 自定义项目类型

(setq projectile-project-root-files-top-down-recurring
      (append '("compile_flags" "tox.ini" "setup.py")
              projectile-project-root-files-top-down-recurring))

4.4 忽略文件/目录

在项目根目录创建 .projectile 文件:

test/
node_modules/
*.tmp

4.5 常用配置

;; 使用 ivy 提升体验
(setq projectile-completion-system 'ivy)

;; 启用项目自动发现
(setq projectile-auto-discover t)

;; 设置索引方法(alien 更快)
(setq projectile-indexing-method 'alien)

4.6 结合其他包使用

• ivy: C-c p f 会自动使用 ivy 补全
• helm: 同样支持 helm 接口
• magit: 项目内快捷调用 magit

4.7 快速操作

• C-c p TAB: 切换到上一个项目缓冲区
• M-o: 在 projectile-commander 中选择常用操作

1. 常用命令列表

M-x projectile-switch-project      ; 切换项目
M-x projectile-find-file           ; 查找文件
M-x projectile-grep                 ; grep 搜索
M-x projectile-ag                   ; ag 搜索
M-x projectile-replace             ; 替换
M-x projectile-invalidate-cache   ; 清除缓存
M-x projectile-regenerate-tags     ; 生成 tags

1. 调试技巧

如果遇到问题:

1. M-x projectile-mode 确认模式已启用
2. M-x projectile-version 查看版本
3. M-x projectile-debug 查看调试信息
4. M-x projectile-invalidate-cache 清除缓存