JS Refactor is a Visual Studio Code extension for adding a few useful refactorings to help speed development and reduce the time a Javascript developer has to spend performing repeated actions. It may only take a few extra seconds to do these things by hand, but those seconds add up quite quickly.
JS Refactor has two key components: automated refactorings and code snippets.
Open VS Code, press F1 and enter ext install jsrefactor
For early release access prior to deployment to the Visual Studio Marketplace, this extension can be downloaded and side-loaded into your editor.
- Added refactorings to context (right-click) menu
- Moved to DJect IoC library for dependency management to enhance testing
- Removed potentially buggy indent logic
- Added lambda function snippet (lfn)
- Fixed indentation issue in code block wrapping
- Shift parameters left
- Shift parameters right
- Added keybindings for common actions
- Added extract variable behavior.
- Enhanced refactor to named function behavior to work with member functions
- Added export function action
- Fixed inconsistent indentation for wrap refactorings
Basic usage: Press F1 and type JS Refactorings to select from a list of all refactorings
Alternative options: You can also press F1 then simply type the name of the refactoring and press enter if you know the name of the refactoring you need. Finally, there are hotkey combinations for some of the most common refactorings you might want.
JS Refactor supports the following refactorings (explanations below):
-
Convert To Member Function
- (ctrl+shift+j ctrl+shift+m)
-
Convert To Named Function
- (ctrl+shift+j ctrl+shift+n)
-
Export Function
- (ctrl+shift+j ctrl+shift+x)
-
Extract Variable
- (ctrl+shift+j ctrl+shift+e)
-
Shift Parameters Left
- (ctrl+shift+j ctrl+shift+s)
-
Wrap in function
- (ctrl+shift+j ctrl+shift+w)
-
Wrap in IIFE
- (ctrl+shift+j ctrl+shift+i)
-
Shift Parameters Right
-
Wrap In Condition
-
Wrap In Executed Function
All keybindings are available using cmd instead of ctrl on a Mac
Select the code you wish to refactor and then press the F1 key to open the command pallette. Begin typing the name of the refactoring and select the correct refactoring from the list. You will be prompted for any necessary information.
Convert To Member Function Converts a named function to a member function for an object prototype definition.
Convert To Named Function Converts selected anonymous function assignment or member function declaration and converts it into a named function declaration. Convert to named function only searches the first line of your selection and will only convert one function at a time.
Export Function creates new export declaration for selected function or function name
Extract Variable Creates new assigned variable declaration and extracts repeated values.
Shift Parameters Left Shifts all selected parameters to the left
Shift Parameters Right Shifts all selected parameters to the right
Wrap In Condition Wraps selected code in an if statement, adding indentation as necessary
Wrap In Executed Function is an extra step on top of wrap in function. Instead of simply wrapping your selected code in a new function declaration, JS Refactor encloses your code in a named function and immediately executes the new function on the next line. This makes the "extract method/function" refactoring trivial to implement since the only work needed is to move the new function to an appropriate location in the code.
Wrap in function takes your selected code, at line-level precision, and wraps all of the lines in a named function.
Wrap in IIFE wraps selected code in an immediately invoked function expression (IIFE).
JS Refactor supports several common code snippets:
- Anonymous Function (anon)
- Condition Block (cond)
- Export statement -- single variable (export)
- Export statement -- object literal (exportObj)
- Function (fn)
- Lambda function (lfn)
- Immediately Invoked Function Expression (iife)
- Member Function (mfn)
- Prototypal Object Definition (proto)
- Require statement (require)
- Use Strict (strict)
Type the abbreviation, such as fn, in your code and hit enter. When the snippet is executed, the appropriate code will be inserted into your document. Any snippets which require extra information like names or arguments will have named tab-stops where you can fill in the information unique to your program.
anon Inserts a tab-stopped anonymous function snippet into your code
export Adds a module.exports single var assignment in your module
exportObj Adds a module.exports assignment with an object literal
fn Inserts a tab-stopped named function snippet into your code
lfn Inserts a tab-stopped lambda function snippet into your code
iife Inserts a new, tab-stopped IIFE into your code
mfn Inserts a new color-delimited member function to your prototype -- Protip be inside a prototype object when using this.
require Inserts a new require statement in your module
strict Inserts 'use strict' into your code