CleanupCode Command-Line Tool

--profile — a code cleanup profile that lists cleanup tasks to execute.

By default, CleanupCode will apply code cleanup tasks specified in the Built-in: Full Cleanup profile, that is all available cleanup tasks except updating file header.

There are two more built-in profiles — Built-in: Reformat Code, which only applies code formatting preferences and Built-in: Reformat & Apply Syntax Style, which applies code formatting preferences and code syntax styles.

To use one of these profiles or any custom profile, pass the profile name via the --profile parameter, for example: --profile="Built-in: Reformat Code" YourSolution.sln.

--include/--exclude — file masks that define which files to include/exclude during the cleanup. If both --include and --exclude are defined and cover the same set of files, --exclude will have higher priority.

You can use Ant-style wildcards in file masks:

• ? to match a single character excluding directory separators

• * to match zero or more characters excluding directory separators

• ** to match any number of characters including directory separators

• / or \ to match directory separators regardless of the OS path format

For example a pattern **Test?\**.* will match the following files:

• C:\Projects\MyTestX\data\file_one.txt

• /home/projects/TestY/file_two.xml

But not:

• C:\Projects\Test\data\file_one.txt

• /home/projects/TestY/file_two

To specify multiple paths or wildcards, separate them with the semicolon ; or use the --include/--exclude parameters multiple times.

--properties — lets you override MSBuild properties. You can set each property separately (--properties:prop1=val1 --properties:prop2=val2), or use a semicolon to separate multiple properties --properties:prop1=val1;prop2=val2.

Note that the semicolon cannot be used inside values, for example: --properties:ReferencePath="r:\reference1\;r:\reference2\". In such cases, add each value separately using another --properties parameter — the values will be combined.

The specified properties are applied to all analyzed projects. Currently, there is no direct way to set a property to a specific project only. The workaround is to create a custom property in this project and assign it to the desired property, then use the custom property in CleanupCode parameters.

--toolset — use this option to specify the exact MSBuild version. For example 12.0: --toolset=12.0 By default the highest available MSBuild version is used. This option might not work if you have several installations with the same version, for example 16.0 from Visual Studio 2019 and 16.0 from .NET Core 3.x.

--toolset-path — use this option to specify the exact path to MSBuild. This might be helpful if you have a custom MSBuild installation and want to use it with CleanupCode, for example: --toolset-path="c:\tools\msbuild\bin\MsBuild.exe".

--dotnetcore — by default, .NET installation is auto-detected. You can use this option to point to the specific .NET installation if the auto-detection results in a conflict. Use it without arguments to ignore .NET Core. Example: --dotnetcore=/usr/local/share/dotnet/dotnet.

--dotnetcoresdk — use this option to specify .NET SDK version that should provide MSBuild. For example, if you have installed .NET with SDKs 5.0.100 and 6.0.302, CleanupCode will prefer 6.0.302 (the latest, including preview versions). Now if you want to run CleanupCode with .NET SDK 5.0.100, add --dotnetcoresdk=5.0.100 to the command line.

--mono — by default, Mono installation is auto-detected. You can use this option to point to the specific Mono installation if the auto-detection results in a conflict. Use it without arguments to ignore Mono. Example: --mono=/Library/Frameworks/Mono.framework/Versions/Current/bin/mono.

--targets-for-references — Names of custom MSBuild targets that will be executed to get referenced assemblies of projects. The targets are defined either in the project file or in the .targets file. Multiple values are separated with the semicolon. For example, --targets-for-references="GetReferences".

--targets-for-items — Names of custom MSBuild targets that will be executed to get other items (for example, a Compile item) of projects. The targets are defined either in the project file or in the .targets file. Multiple values are separated with the semicolon. For example, --targets-for-items="GetCompileItems".

--verbosity — by default, CleanupCode only displays error messages in the output. Use this parameter to change the amount of information written to the output by the following levels (the order is from less to more detailed): [OFF, FATAL, ERROR, WARN, INFO, VERBOSE, TRACE].

--LogLevel — use this parameter to control the amount of information written to the log file, specified via --LogFile or --LogFolder. There are following levels (the order is from less to more detailed): [OFF, FATAL, ERROR, WARN, INFO, VERBOSE, TRACE].

For example, if something goes wrong with CleanupCode, you can contact ReSharper support and share a log file with all TRACE messages: --LogLevel=TRACE.

--LogFile — use this parameter to specify an absolute path to the log file for messages from CleanupCode. If you also need logs from MSBuild and Roslyn, use the --LogFolder parameter instead.

--LogFolder — use this parameter to specify an absolute path to a directory where logs from CleanupCode as well as logs from MSBuild and Roslyn should be written. If you only need logs from CleanupCode, use the --LogFile parameter instead.

--caches-home — lets you specify a custom location for the data that CleanupCode caches. By default, the %LOCALAPPDATA% directory is used, unless there are settings files, in which case the one specified there is used. This parameter can be helpful if you want to use a fast SSD disk for the cache or if you want to store all your build processing data in a single place.

--config-create and --config — these options allow you to pass the parameters described above with a configuration file. The first option will create a configuration file according to the current parameters; the second option is used to load the parameters from this file.

--debug (-d) — use this option to add execution details of CleanupCode to the output. If you have problems with CleanupCode, these details will be helpful when contacting the support team.

--eXtensions (-x) — installs and enables the specified plugin.

Plugins are specified by their IDs, which you can find on the plugin's page of JetBrains Marketplace: find the desired plugin, click Versions, and then click the latest version.

For example, the plugin ID of the StyleCop by JetBrains plugin is StyleCop.StyleCop and to run CleanupCode with this plugin, you need to add -x=StyleCop.StyleCop to the command line.

To specify multiple plugins, separate their IDs with the semicolon.

--source — lets you specify a custom package source to install the plugin from, that is a directory where the .nupkg file with the plugin is located, for example, --source="C:\plugins". If nothing is specified, CleanupCode will look for plugins in JetBrains Marketplace.

--measure — a diagnostic option that can help you if you experience suboptimal performance when running the tool on specific hardware with a specific target solution. Use this option with one of the following arguments [sampling | timeline (Windows-only) | memory] to define the kind of profiling, for example:

When the execution is finished, CleanupCode creates an execution snapshot and displays the path to the snapshot file. You can study the snapshot using JetBrains tools:

• Sampling or Timeline profiling: to analyze the resulting .zip file, unzip it and open the sampling snapshot files (.dtp) or timeline snapshot files (.dtt) with JetBrains dotTrace.

• Memory profiling: to analyze the resulting dotMemory workspace file (.dmw), open it with JetBrains dotMemory.

--version (-v) — use this option to display the current version of the tool and exit.

--settings — by default, CleanupCode will override its default settings with ReSharper settings from the 'Solution team-shared' layer SolutionName.DotSettings, if it exists. If necessary, you can use this parameter to specify another .DotSettings file, which will override all other settings. For example,

.

--disable-settings-layers (-dsl) — disables specified settings layers. Accepted values: GlobalAll, GlobalPerProduct, SolutionShared, SolutionPersonal

--no-buildin-settings — suppresses settings from global, solution, and project setting layers. Equivalent to --disable-settings-layers: GlobalAll; GlobalPerProduct; SolutionShared; SolutionPersonal; ProjectShared; ProjectPersonal