Abracadabra, refactor this! installs statistics

🧙‍ Abracadabra

Refactoring (noun): a change made to the internal structure of software to make it easier to understand and cheaper to modify without changing its observable behavior.

— "Refactoring: Improving the Design of Existing Code" by Martin Fowler

![][logo-abracadabra]

<!-- prettier-ignore-start --> <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->

<!-- ALL-CONTRIBUTORS-BADGE:END --> <!-- prettier-ignore-end -->

With Abracadabra, you can quickly and safely refactor existing code in VS Code.

VS Code ships with [a few basic refactorings][vscode-refactorings]. Abracadabra supercharges your editor with:

• 🎁 Much, much more refactorings
• ⚡ Shortcuts to trigger the most useful ones in no-time
• 💡 Quick Fixes to suggest refactorings when appropriate
• 🛠 Options to customize the UX to your needs
• 💬 Refactorings that work with .js, .jsx, .ts, .tsx, .vue and .svelte files

Refactor Legacy Code in a snap! 👌

![Abracadabra in action][demo-abracadabra]

Installation

1. Click on the Extensions icon (usually on the left-hand side of your editor).
2. Search for "Abracadabra".
3. Find the extension in the list and click the install button.

List of available refactorings

We have 40+ automated refactorings such as Extract Variable, Extract Type, Flip If/Else, etc.

👉 [Here's the full catalog of refactorings available][all-refactorings]

All refactorings are available through the [Command Palette][command-palette].

![][demo-command-palette]

Some refactorings have default keybindings configured, but [you can change that][change-keybindings].

All other refactorings are available through [VS Code Quick Fixes][vscode-quick-fixes]. You can access them by clicking on the lightbulb that appear next to the code 💡 or use the default shortcut Alt ↵.

Pro Tip: You can also disable the Quick Fixes you never use in [VS Code settings][vscode-settings] 🔥 (look for Abracadabra)

Features that support refactorings

Besides refactorings, Abracadabra also gives you some extra features that are here to support refactoring work.

Highlight Identifiers

![][demo-toggle-highlights]

When working with Legacy Code, a very useful refactoring consists in extracting pure logic out of the I/O code that is hard to test (eg. HTTP calls).

To help you spot all the I/O bits in a chunk of code, Abracadabra can highlight them for you!

Feature	Keybinding	On Mac
Toggle Highlight	Ctrl + Alt + H	⌃ H
Refresh Highlights	Shift + Alt + H	⌃ ⌥ H
Remove All Highlights	Ctrl + Shift + Alt + H	⇧ ⌃ H

1. Put your cursor over an Identifier you want to highlight
2. Press Ctrl + Alt + H

All references to this Identifier will be highlighted. The highlight will persist even when you modify the code.

To remove, either:

• Put your cursor over a highlighted reference and press Ctrl + Alt + H again
• Press Ctrl + Shift + Alt + H from anywhere, to remove all highlights

This is handy for marking I/O code when refactoring, but you can use it to highlight any interesting Identifier and its references. Here are a few typical use cases:

• Mark all usages of a variable, to help you regroup them
• Identify variables that are always passed together in function calls

Does it highlights new references automatically?

Say you have highlighted a variable. Now you add some more code that refers to the same variable.

It won't be automatically highlighted.

We could. But a naive implementation of this would constantly parse the AST of the code you are working with, which would probably affect your editor performances (not good).

One way to do it would be to toggle highlight over the reference once to remove the old highlight, then again to get the new reference! But that's annoying!

That's why you have a "Refresh Highlights" command. Hit Shift + Alt + H and references will be recomputed again for you!

Configuration

Setting	Description	Default
abracadabra.ignoredFolders	Folders where it won't propose refactorings	["node_modules"]
abracadabra.ignoredPatterns	Glob patterns where it won't propose refactorings	["dist/*", "build/*"]
abracadabra.maxFileLinesCount	Don't propose refactorings on files that have more lines of code than this threshold	10.000
abracadabra.getMaxFileSizeKb	Don't propose refactorings on files that bigger than this threshold (in kB)	250
abracadabra.autoConvertToTemplateLiteral	Automatically convert a string into a template literal when you insert ${}	true

For the glob patterns, read glob's documentation to see what you can filter out.

All refactorings that appear in Quick Fix suggestions can also be disabled in [your VS Code settings][vscode-settings] 🔥 (look for Abracadabra)

Release Notes

[Have a look at our CHANGELOG][changelog] to get the details of all changes between versions.

Versioning…