Our goal is to provide you with easy-to-use, intuitive refactorings. They help you clean the code and understand what's going on.
Table of Contents
All refactorings are available through the Command Palette.
Some refactorings have default keybindings configured, but you can change that.
All other refactorings are available through VS Code Quick Fixes. You can access them by clicking on the lightbulb that appear next to the code 💡 or use the default shortcut
This refactoring allows you to rename things and make sure all references in your code follow! It's easier and safer to use than a classic "Find and Replace".
VS Code does this refactoring very well. That's why this refactoring is merely an alias. It delegates the work to VS Code.
This refactoring helps you give a meaning to the hardcoded constants and low-level expressions. It makes your source code easier to read and maintain.
It will extract the closest element from your cursor or partial selection.
It will also handle multiple occurrences.
Extract Generic Type
Just like for variables, this TS-specific refactoring will extract a type to make it generic.
This refactoring is the opposite of Extract Variable. It replaces a redundant usage of a variable or a constant with its initializer. It's usually helpful to inline things so you can extract them differently.
This refactoring is similar to Inline Variable, but for functions. It replaces each call to the function with the function body. It helps to remove needless indirections.
Move Statement Up
Moves the whole selected statement up. If the selected statement and the one above are one-liners, this is the same as doing VS Code Move Line Up. But if one of these statements is multi-lines, this refactoring is very handy!
As for all refactorings, it works even if you partially select the statement, or if the cursor is on the statement.
Move Statement Down
Same as Move Statement Up, but it moves the selected statement down. Like, the other direction. That's it.
Move Statement Up and Move Statement Down also work on object properties. They always produce valid code, so you don't have to bother with the trailing comma anymore!
Negates the logical expression while preserving behaviour. It can be useful to tweak a logical expression before extracting meaningful chunks out of it.
It will negate the closest expression from your cursor or partial selection.
Remove Redundant Else
Simplify ternary expressions that you might end up with after executing other refactorings.
Flips a ternary statement. It's really similar to Flip If/Else refactoring.
Convert If/Else to Ternary
Converts an if/else statement into a (shorter) ternary expression. This is very handy to improve code readability.
Convert Ternary to If/Else
Converts a ternary expression into an if/else statement. It reverses Convert If/Else to Ternary refactoring.
Convert If/Else to Switch
Converts an if/else statement into a switch statement. This is typically what you do before introducing polymorphism to clean object-oriented code.
Convert Switch to If/Else
Converts a switch statement into an if/else statement. It reverses Convert If/Else to Switch refactoring.
Split If Statement
Splits the logical expression of the closest if statement. This is an helpful tool to help you refactor complex branching logic, safely.
Merge If Statements
This is the opposite of Split If Statement. It consolidates nested ifs to clean up the code.
It also works with
Merge With Previous If Statement
Merges selected statement with the if statement that is above. This is handy when you want to decompose a conditional to clean the code.
If you want to merge 2 consecutive if statements, it will resolve the dead code for you:
Bubble up If Statement
Useful when you need to have the similar conditionals at the top level. If you get there, you'll be able to convert them into a top-level
Hocus, pocus… This refactoring takes care of the gymnastic for you! Resulting code will have the same behaviour.
Remove Dead Code
Sometimes, Abracadabra can determine that some code can't be reached. If so, it can also get rid of the dead code for you.
Split Declaration and Initialization
Splits the declaration of the variable and its initialization. If it's a
Convert let to const
Converts the declaration of a variable that is a
Add Braces to Arrow Function
Useful when you need to add code in the body of an arrow function.
VS Code provides this refactoring, but it only works if you have the correct selection. This one works wherever your cursor is!
Remove Braces from Arrow Function
Does the contrary of Add Braces to Arrow Function. Same advantages over VS Code: it works wherever your cursor is.
Add Braces to If Statement
Useful when you need to add code in the body of an
Remove Braces from If Statement
Does the contrary of Add Braces to If Statement: Removes braces from single-statement blocks in an
Convert to Template Literal
This refactoring is already handled by VS Code.
But there's one scenario they don't want to handle: convert simple strings into template literals.
This is too bad because it's convenient to turn an existing string into a template literal to start adding some variables inside.
Hence, Abracadabra is proposing the refactoring for such scenario!
Replace Binary with Assignment
This one might seem obscure, but it's really replacing
Convert For-Loop to Foreach
When it's possible, it converts an old-school for-loop into a
Extract the interface from a class.
This is very useful when you need to invert a dependency: create an interface from an existing class, so you can provide a different implementation of this interface.
Convert to Pure Component
This one is specific to React and comes from react codemod.
It converts ES6 classes that only have a
Add braces to JSX attribute
This refactoring is specific to React.
It adds curly braces to a JSX string literal, converting it into a JSX expression.
Remove braces from JSX attribute
This refactoring is specific to React.
If a JSX attribute is a JSX expression containing only a string literal, it refactors the JSX expression into a string literal by removing the curly braces.
Have a look at our CHANGELOG to get the details of all changes between versions.
We follow SemVer convention for versionning.
That means our releases use the following format:
Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Abracadabra.
To help you get your feet wet and become familiar with our contribution process, we have a list of good first issues that contains things with a relatively limited scope. This is a great place to get started!
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification.
Contributions of any kind are welcome!
VS Code native refactorings
VS Code ships with basic refactoring operations.
Pros of Abracadabra over these:
Cons of Abracadabra over these:
Abracadabra is quite similar. The differences are:
Abracadabra is very similar to this one. They both rely on VS Code Quick Fixes. The few differences are:
Why building yet another refactoring extension then?
Good question. The best move would surely have been to reach out one of the author of existing extensions to see how we could have improved them, instead of creating a new one.
But the motivations to build Abracadabra instead were:
For now, we have fun and do our best to build a great extension!
When we'll have more experience, we'll probably ping the authors of other extensions to see how we could consolidate our efforts for the community. That's why we encourage you to test Abracadabra and give us your feedback!