Skip to content

Latest commit

 

History

History
58 lines (37 loc) · 1.71 KB

README.md

File metadata and controls

58 lines (37 loc) · 1.71 KB
Raw

php-refactor-mode Build Status

This is a minor mode which provides convenient access to the refactoring methods provided by php-refactoring-browser.

Installation

The recommended way to install php-refactor-mode is through package.el. php-refactor-mode is available for installation through melpa.

Ensure that package-archives as been configured for melpa

(add-to-list 'package-archives '("melpa" . "http://melpa.milkbox.net/packages/") t)

Then install with

M-x package-refresh-contents
M-x package-install php-refactor-mode

Usage

You must require the minor-mode and then enable it.

(require 'php-refactor-mode)
(add-hook 'php-mode-hook 'php-refactor-mode)

Options either operate on the symbol at point, the selected region, or the file as a whole. Each operation can be triggered through the use of a particular keybinding.

Keybindings

All keybindings in php-refactor-mode start with C-c r followed by some mnemonic shortcut.

  • lv: Convert a local variable to an instance variable
  • rv: Rename a local variable
  • em: Select a region and extract it to a new method
  • ou: Optimize use statements for FQCNs

Development

To fetch the test dependencies, install cask if you haven't already, then:

$ cd /path/to/php-refactor-mode
$ cask

Run the tests with:

$ ./run-tests.sh

Or alternatively, if you have watchr installed, you can continuously run the tests with:

$ watchr watch-tests.watchr