Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/nicoespeon/abracadabra

Automated refactorings for VS Code (JS & TS) ✨ It's magic ✨
https://github.com/nicoespeon/abracadabra

javascript legacy-code magic refactoring typescript vscode-extension

Last synced: 2 months ago
JSON representation

Automated refactorings for VS Code (JS & TS) ✨ It's magic ✨

Lists

README 

        
# 🧙‍ 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]



[![All Contributors](https://img.shields.io/badge/all_contributors-58-orange.svg?style=flat-square)](#contributors)



![](https://img.shields.io/badge/it%27s-magic-purple.svg)



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).

1. Search for "Abracadabra".

1. 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`                   |



For the glob patterns, read [glob's documentation](https://github.com/isaacs/node-glob/blob/f5a57d3d6e19b324522a3fa5bdd5075fd1aa79d1/README.md#glob-primer) 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



We follow [SemVer][semver] convention for versioning.



That means our releases use the following format:



```

..

```



- Breaking changes bump `` (and reset `` & ``)

- Backward compatible changes bump `` (and reset ``)

- Bug fixes bump ``



## Contributing



### [Contributing Guide][contributing]



Read our [contributing guide][contributing] to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Abracadabra.



### [Good First Issues][good-first-issues]



To help you get your feet wet and become familiar with our contribution process, we have a list of [good first issues][good-first-issues] that contains things with a relatively limited scope. This is a great place to get started!



## Contributors



Thanks goes to these wonderful people ([emoji key][all-contributors-emoji]):



  

    

      Nicolas Carlo
Nicolas Carlo
🤔 💻 📖 👀 💬

      Fabien BERNARD
Fabien BERNARD
🤔 💻 🎨

      David
David
🐛

      GUL
GUL
🤔 💻

      Alexander Rose
Alexander Rose
🤔 💻

      Tim van Cleef
Tim van Cleef
💻 📖

      Tobias Hann
Tobias Hann
🐛 💻 📖

    

    

      Jiri Spac
Jiri Spac
🐛

      YuTengjing
YuTengjing
🐛 🚇 💻

      delaaxe
delaaxe
🤔 💻

      James Nail
James Nail
🐛

      Nick Ebbitt
Nick Ebbitt
🤔 💻 📖

      Oliver Joseph Ash
Oliver Joseph Ash
🤔 🐛 💻 📖

      Alberto Xamin
Alberto Xamin
🤔

    

    

      Sakumatti Luukkonen
Sakumatti Luukkonen
🐛 🤔

      Sergey Klevakin
Sergey Klevakin
🤔 💻

      Andrew Janian
Andrew Janian
🐛

      leosdad
leosdad
🤔 🐛

      Iuliu Pop
Iuliu Pop
📖 💻 🐛

      Christina Braun
Christina Braun
💻 🐛

      Zak Miller
Zak Miller
🐛 💻 🤔

    

    

      Marcus
Marcus
🐛

      Jonathan Boiser
Jonathan Boiser
🐛

      Vlad GURDIGA
Vlad GURDIGA
🐛

      Sam Hasler
Sam Hasler
🤔

      Nicolas Favre-Felix
Nicolas Favre-Felix
🐛

      Wout Mertens
Wout Mertens
🤔

      Luke Harold Miles
Luke Harold Miles
🐛 🤔

    

    

      Ikko Ashimine
Ikko Ashimine
📖

      Viktor
Viktor
🤔

      sumbatx15
sumbatx15
🐛 💻

      j4k0xb
j4k0xb
🐛 💻 🚇

      Ian Obermiller
Ian Obermiller
💻 📖 🤔

      Emily Marigold Klassen
Emily Marigold Klassen
📖

      Vitaly
Vitaly
💻 🚇 🤔

    

    

      Alan Hussey
Alan Hussey
🐛

      Kevin Coleman
Kevin Coleman
🐛

      Roberts Slisans
Roberts Slisans
🐛

      Josh
Josh
🤔

      brunnerh
brunnerh
🤔

      Jose Cabrera
Jose Cabrera
🤔 💻

      Sebastian Schlatow
Sebastian Schlatow
🐛

    

    

      jtwigg
jtwigg
🐛

      Andy Bulka
Andy Bulka
🐛

      Andrew Ash
Andrew Ash
📖

      Artem Zhivoderov
Artem Zhivoderov
🤔 💻

      Simon Holmes
Simon Holmes
🤔 💻

      Ramunas
Ramunas
🤔

      Simon Chan
Simon Chan
🐛

    

    

      byron wall
byron wall
🐛

      Jeroen van Warmerdam
Jeroen van Warmerdam
📖

      Steve Beaugé
Steve Beaugé
🐛

      Samuel Bronson
Samuel Bronson
🐛

      Timon Jurschitsch
Timon Jurschitsch
💻

      Leo Driesch
Leo Driesch
🤔

      Romain Guerin
Romain Guerin
🐛

    

    

      Victor Homyakov
Victor Homyakov
🐛

      Michal Srb
Michal Srb
🐛

    

  



This project follows the [all-contributors][all-contributors] specification.



Contributions of any kind are welcome!



## Alternatives



Building automated refactoring for JavaScript is not easy, and it takes time. Since this is a side-project, it doesn't get as much time as it should to cover everything you need.



If Abracadabra doesn't fit your need for something, here are the other extensions I recommend you check:



- [JS CodeFormer](https://marketplace.visualstudio.com/items?itemName=cmstead.js-codeformer) which is built by [Chris Stead](https://twitter.com/cm_stead). Chris built the first JS refactorings extension in VS Code back in the days, so he knows his stuff 👍

- [P42 JavaScript assistant](https://marketplace.visualstudio.com/items?itemName=p42ai.refactor) is a recent and impressive tool built by [Lars Grammel](https://twitter.com/lgrammel). I had the opportunity to chat with Lars and we really think alike. The main difference is that Lars is dedicated full-time into building this. It's not open-source, but it may solve the problem you have 😉

- [JavaScript Booster](https://marketplace.visualstudio.com/items?itemName=sburg.vscode-javascript-booster) is a popular extension that mimics Webstorm's UX for refactoring—which was a source of inspiration for Abracadabra. Worth having a look.



There are some things I think Abracadabra does better. Other things Abracadabra does worse. The goal with this extension is to provide automated refactorings that are easy to use and VS Code misses. If others are implementing them, I'm more than happy to recommend (and use) their tool!



Have a look, give them a try, use a combination of tools that work best for you.



---



![](https://github.com/nicoespeon/abracadabra/blob/main/docs/demo/magic.gif?raw=true)



## License



💁 [MIT][license]



[hocus-pocus]: https://marketplace.visualstudio.com/items?itemName=nicoespeon.hocus-pocus

[command-palette]: https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette

[change-keybindings]: https://code.visualstudio.com/docs/getstarted/keybindings

[vscode-refactorings]: https://code.visualstudio.com/docs/editor/refactoring

[vscode-quick-fixes]: https://code.visualstudio.com/docs/editor/refactoring#_code-actions-quick-fixes-and-refactorings

[vscode-settings]: https://code.visualstudio.com/docs/getstarted/settings

[js-refactor]: https://marketplace.visualstudio.com/items?itemName=cmstead.jsrefactor

[js-booster]: https://marketplace.visualstudio.com/items?itemName=sburg.vscode-javascript-booster

[changelog]: https://github.com/nicoespeon/abracadabra/blob/main/CHANGELOG.md

[all-refactorings]: https://github.com/nicoespeon/abracadabra/blob/main/REFACTORINGS.md

[contributing]: https://github.com/nicoespeon/abracadabra/blob/main/CONTRIBUTING.md

[license]: https://github.com/nicoespeon/abracadabra/blob/main/LICENSE.md

[good-first-issues]: https://github.com/nicoespeon/abracadabra/issues?q=is%3Aissue+is%3Aopen+label%3A%22%3Awave%3A+Good+first+issue%22

[semver]: http://semver.org/

[all-contributors]: https://allcontributors.org

[all-contributors-emoji]: https://allcontributors.org/docs/en/emoji-key



[demo-toggle-highlights]: https://github.com/nicoespeon/abracadabra/blob/main/docs/demo/toggle-highlights.gif?raw=true

[demo-command-palette]: https://github.com/nicoespeon/abracadabra/blob/main/docs/demo/command-palette.png?raw=true

[demo-abracadabra]: https://github.com/nicoespeon/abracadabra/blob/main/docs/demo/extract-variable-multiple-occurrences.gif?raw=true



[logo-abracadabra]: https://github.com/nicoespeon/abracadabra/blob/main/docs/logo/abracadabra-logo.png?raw=true