Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Wilfred/emacs-refactor
language-specific refactoring in Emacs
https://github.com/Wilfred/emacs-refactor
emacs lisp refactoring
Last synced: about 10 hours ago
JSON representation
language-specific refactoring in Emacs
- Host: GitHub
- URL: https://github.com/Wilfred/emacs-refactor
- Owner: Wilfred
- License: gpl-3.0
- Created: 2013-04-04T12:05:51.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2023-01-29T05:54:44.000Z (almost 2 years ago)
- Last Synced: 2024-10-30T19:04:45.396Z (10 days ago)
- Topics: emacs, lisp, refactoring
- Language: Emacs Lisp
- Homepage:
- Size: 494 KB
- Stars: 348
- Watchers: 18
- Forks: 27
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: COPYING
Awesome Lists containing this project
README
# emacs-refactor
[](https://coveralls.io/r/Wilfred/emacs-refactor)
[](http://melpa.org/#/emr)
[](http://stable.melpa.org/#/emr)
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](#user-content-summary)
- [Installation](#user-content-installation)
- [Language support](#user-content-language-support)
- [General](#user-content-general)
- [C](#user-content-c)
- [Lisps](#user-content-lisps)
- [Elisp](#user-content-elisp)
- [JavaScript](#user-content-javascript)
- [Ruby](#user-content-ruby)
- [Scheme](#user-content-scheme)
- [Extension](#user-content-extension)
## Summary
To use EMR when editing, simply move point to an expression and
`M-x emr-show-refactor-menu`.
![Example][example-pic]
EMR ships with many refactoring commands, and pull requests for extensions are
welcome. See [Extension](#user-content-extension) for details on extending EMR
to other language modes. It's easy (honest!).
## Installation
Install `emr` from [MELPA](http://www.melpa.org/), then configure your
init.el:
```emacs-lisp
(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:
* *comment region*
* *uncomment region*
### C
The following context-sensitive refactoring commands are available:
* *tidy includes*
The following buffer-wide actions are available:
* *insert include*
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:
* *comment form*
* *uncomment block*
### Elisp
The following context-sensitive refactoring commands are available:
* *delete unused definition*
* *delete unused let binding form*
* *eval and replace*
* *extract autoload*
* *extract constant*
* *extract function*
* *extract to let*
* *extract variable*
* *implement function*
* *inline function*
* *inline let variable*
* *inline variable*
* *insert autoload directive*
* *tidy autoloads*
The following buffer-wide actions are available:
* *find unused definitions*
### JavaScript
JavaScript refactoring support requires [js2 refactor][].
The following refactoring commands are available:
* *extract function*
* *extract method*
* *extract variable*
* *add parameter*
* *local variable to instance variable*
* *log region*
### Ruby
Ruby refactoring support requires [ruby refactor][].
The following refactoring commands are available:
* *extract function*
* *extract variable*
* *extract constant*
* *add parameter*
* *extract to let*
### Scheme
The following refactoring commands are available:
* *extract function*
* *extract variable*
## 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:
```lisp
(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.
[example-pic]: https://raw.github.com/Wilfred/emacs-refactor/master/assets/emr.png
[js2 refactor]: https://github.com/magnars/js2-refactor.el
[ruby refactor]: https://github.com/ajvargo/ruby-refactor
[git]: http://git-scm.com