Wilfred / emacs-refactor

language-specific refactoring in Emacs
GNU General Public License v3.0
348 stars 27 forks source link
emacs lisp refactoring

emacs-refactor

Coverage Status MELPA MELPA stable

Emacs Refactor (EMR) is a framework for providing language-specific refactoring in Emacs. It includes refactoring commands for a variety of languages, including elisp itself!

Summary

To use EMR when editing, simply move point to an expression and M-x emr-show-refactor-menu.

Example

EMR ships with many refactoring commands, and pull requests for extensions are welcome. See Extension for details on extending EMR to other language modes. It's easy (honest!).

Installation

Install emr from MELPA, then configure your init.el:

(define-key prog-mode-map (kbd "M-RET") 'emr-show-refactor-menu)

Language support

Most EMR commands are context-sensitive and are available through the refactor menu. Some actions affect the whole buffer and are available in the menu bar.

General

These commands are available for all programming languages.

The following context-sensitive refactoring commands are available:

C

The following context-sensitive refactoring commands are available:

The following buffer-wide actions are available:

Refactoring support for C is a work in progress. Contributions are welcome.

Lisps

These commands are available to all Lisp dialects, including Clojure, Elisp and Common Lisp.

The following context-sensitive refactoring commands are available:

Elisp

The following context-sensitive refactoring commands are available:

The following buffer-wide actions are available:

JavaScript

JavaScript refactoring support requires js2 refactor.

The following refactoring commands are available:

Ruby

Ruby refactoring support requires ruby refactor.

The following refactoring commands are available:

Scheme

The following refactoring commands are available:

Extension

Use the emr-declare-command function to declare a refactoring action. The action will automatically become available in the refactoring popup menu.

This function supports predicate expressions, allowing the options displayed to be context-sensitive.

As an example, here is the declaration for a refactoring command that ships with EMR:

(emr-declare-command 'emr-el-extract-constant
  :title "constant"
  :description "defconst"
  :modes 'emacs-lisp-mode
  :predicate (lambda ()
               (not (or (emr-el:looking-at-definition?)
                        (emr-el:looking-at-let-binding-symbol?)))))

This wires the emr-el-extract-constant function to be displayed in emacs-lisp-mode, provided point is not looking at an Elisp definition or let-binding form.

If your favourite language mode already offers refactoring commands, it is simple to wire them up with EMR using this interface.