Emacs Refactor (EMR) 项目教程

Emacs Refactor (EMR) 项目教程

emacs-refactorlanguage-specific refactoring in Emacs项目地址:https://gitcode.com/gh_mirrors/em/emacs-refactor

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

Emacs Refactor (EMR) 项目的目录结构如下：

emacs-refactor/
├── assets/
├── test/
│   └── ert-runner/
├── .gitignore
├── CHANGELOG.md
├── CONTRIBUTING.md
├── COPYING
├── Cask
├── README.md
├── emr-c.el
├── emr-css.el
├── emr-elisp.el
├── emr-iedit.el
├── emr-js.el
├── emr-lisp.el
├── emr-prog.el
├── emr-ruby.el
├── emr-scheme.el
├── emr.el

目录介绍

• assets/: 存放项目资源文件。
• test/: 包含项目的测试文件，其中 ert-runner/ 是测试运行器。
• .gitignore: Git 忽略文件配置。
• CHANGELOG.md: 项目更新日志。
• CONTRIBUTING.md: 贡献指南。
• COPYING: 许可证文件。
• Cask: 项目依赖管理文件。
• README.md: 项目说明文档。
• emr-c.el, emr-css.el, emr-elisp.el, emr-iedit.el, emr-js.el, emr-lisp.el, emr-prog.el, emr-ruby.el, emr-scheme.el, emr.el: 项目的各个模块文件。

2. 项目的启动文件介绍

项目的启动文件是 emr.el。这个文件包含了项目的核心功能和初始化代码。以下是 emr.el 的部分代码示例：

(defgroup emacs-refactor nil
  "Provides refactoring tools for Emacs"
  :group 'tools
  :prefix "emr-")

(defcustom emr-report-actions t
  "Non-nil means display an indication when a refactoring results in an insertion."
  :type 'checkbox
  :group 'emacs-refactor)

(defcustom emr-lines-between-toplevel-forms 1
  "The number of lines to try to preserve between toplevel forms."
  :type 'integer
  :group 'emr)

(defcustom emr-popup-help-delay 1
  "The time to wait before showing documentation in the refactor menu."
  :type 'integer
  :group 'emr)

启动文件功能

• 定义了项目的配置组和自定义选项。
• 提供了项目的核心功能和初始化代码。

3. 项目的配置文件介绍

项目的配置文件主要是 Cask 文件。这个文件用于管理项目的依赖和环境。以下是 Cask 文件的部分内容示例：

(source gnu)
(source melpa)

(package-file "emr.el")

(depends-on "s" "1.3.1")
(depends-on "dash" "1.2.0")
(depends-on "cl-lib" "0.2")
(depends-on "popup" "0.5.0")
(depends-on "emacs" "24.1")
(depends-on "list-utils" "0.3.0")
(depends-on "paredit" "24.0.0")
(depends-on "projectile" "0.9.1")
(depends-on "clang-format" "0.0.1")
(depends-on "iedit" "0.97")

配置文件功能

• 定义了项目的依赖包和版本要求。
• 管理项目的开发环境。

通过以上内容，您可以了解 Emacs Refactor (EMR) 项目的目录结构、启动文件和配置文件的基本信息。希望这份教程对您有所帮助！

emacs-refactorlanguage-specific refactoring in Emacs项目地址:https://gitcode.com/gh_mirrors/em/emacs-refactor