A tool to automatically refactor large swaths of code - the natural continuation of "doing it all by hand" and "tinkering with regexes". You can define a rewriting process and have it executed on many files in a solution - repeatable, testable, predictable.
Get Started
$ dotnet add package Swallow.RefactorReadme
Swallow.Refactor
Refactor goes BRRR!
A tool that was originally designed as a way to enable reliably refactor a big code-base automatically, it has since turned into a generic interface to the Roslyn API to interact with any C# code, be it just reading and analyzing or even modifying.
What's BRRR short for, you ask? Boundless Roslyn Refactoring Runner.
BRRRusage
brrr refactor -s|--solution <solution> code [--filter-name <name>] [--filter-content <content>] <rewriters>
When calling refactor, instead of passing all rewriters via CLI you can instead pass the path to a JSON file.
This file must match the following scheme:
{
"filter": {
"name": "<some regex>", // A regex that filenames should match, optional
"content": "<some text>" // A text that files should contain, optional
},
"rewriters": [
{ "name": "<some rewriter>" }, // A rewriter without any parameters
{ "name": "<some rewriter>", "parameters": [ "parameter", "parameter" ] } // A rewriter with parameters
]
}
To find out what rewriters are available, you can use brrr rewriter list and brrr rewriter describe <rewriter>.
But it doesn't stop there - there's a lot of things you can do. Using brrr asyncify, for example, allows you to
turn a chain of calls into async calls automatically, fixing any GetAwaiter().GetResult()-calls along the way.
To see all commands that you can use, run
brrr --help
BRRRinstallation
Building and installing yourself
To install the tool (and thus make it available globally), you can use the following command:
dotnet pack -c Release -o packages/
dotnet tool install --global --no-cache --add-source packages/ Swallow.Refactor
This will make brrr be a globally executable tool. To uninstall it again, you can execute: