Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A JavaScript refactoring library for emacs
Emacs Lisp Cucumber Other
tree: 65319657e7

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
README.md
js2-refactor.el
js2r-conveniences.el
js2r-formatting.el
js2r-functions.el
js2r-iife.el
js2r-vars.el

README.md

js2-refactor.el

The beginnings of a JavaScript refactoring library in emacs.

This is a collection of small refactoring functions to further the idea of a JavaScript IDE in Emacs that started with js2-mode.

Installation

Start by installing the dependencies:

It is also recommended to get expand-region to more easily mark vars, method calls and functions for refactorings.

Then add this to your emacs settings:

(require 'js2-refactor)

Usage

All refactorings start with C-c C-m and then a two-letter mnemonic shortcut.

  • eo is expand-object: Converts a one line object literal to multiline.
  • co is contract-object: Converts a multiline object literal to one line.
  • wi is wrap-buffer-in-iife: Wraps the entire buffer in an immediately invoked function expression
  • ig is inject-global-in-iife: Creates a shortcut for a marked global by injecting it in the wrapping immediately invoked function expression
  • ev is extract-variable: Takes a marked expression and replaces it with a var.
  • rv is rename-var: Renames the variable on point and all occurrences in its lexical scope.

There are also some minor conveniences bundled:

  • C-S-down and C-S-up moves the current line up or down. If the line is an element in an object or array literal, it makes sure that the commas are still correctly placed.

Bugs

  • Undoing past an extract-variable messes up the buffer. It's definitely because of mark-multiple being used in an interactive command that also modifies the buffer. The contents of master is mirrored. One possible solution is to modify mark-multiple to be more like multiple-cursors. Other solutions are most welcome.

Todo

A list of some wanted improvements for the current refactorings.

  • expand- and contract-object: should work for arrays.
  • expand- and contract-object: should work for simple functions.
  • wrap-buffer-in-iife: should skip comments and namespace initializations at buffer start.
  • extract-variable: could end with a query-replace of the expression in its scope.
  • rename-var: should skip keys in object literals

Contribute

This project is still in its infancy, and everything isn't quite sorted out yet. If you're eager to contribute, please add an issue here on github and we can discuss your changes a little before diving into the elisp. :-)

License

Copyright (C) 2012 Magnar Sveen

Author: Magnar Sveen magnars@gmail.com Keywords: javascript refactorings

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Something went wrong with that request. Please try again.