CleanupCode 命令行工具

--profile — 列出要执行的清理任务的代码清理配置文件。

默认情况下，CleanupCode 将应用 内置：完全清理配置文件中指定的代码清理任务，即所有 可用的清理任务 ，除了 更新文件头。

还有两个内置配置文件 — 内置：重新格式化代码 ，仅应用 代码格式首选项 ，以及 内置：重新格式化并应用语法样式 ，应用 代码格式首选项和 代码语法样式。

要使用这些配置文件之一或任何 自定义配置文件 ，请通过 --profile 参数传递配置文件名称，例如： --profile="Built-in: Reformat Code" YourSolution.sln。

--include/--exclude — 定义清理期间要包含/排除的文件的文件掩码。 如果 --include 和 --exclude 都已定义并覆盖相同的文件集， --exclude 将具有更高优先级。

您可以在文件掩码中使用 Ant 风格的通配符：

• ? 用于匹配单个字符（不包括目录分隔符）

• * 用于匹配零个或多个字符（不包括目录分隔符）

• ** 用于匹配任意数量的字符（包括目录分隔符）

• / 或 \ 用于匹配目录分隔符（无论操作系统路径格式如何）

例如，模式 **Test?\**.* 将匹配以下文件：

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

• /home/projects/TestY/file_two.xml

但不包括：

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

• /home/projects/TestY/file_two

要指定多个路径或通配符，请用分号 ； 分隔，或多次使用 --include/--exclude 参数。

--properties — 允许您覆盖 MSBuild 属性。 您可以单独设置每个属性（--properties:prop1=val1--properties:prop2=val2 ），或使用分号分隔多个属性 --properties:prop1=val1；prop2=val2。

请注意，分号不能用于值内部，例如： --properties:ReferencePath="r:\reference1\;r:\reference2\"。 在这种情况下，使用另一个 --properties 参数单独添加每个值 — 这些值将被组合。

指定的属性将应用于所有分析的项目。 目前，没有直接的方法仅为特定项目设置属性。 解决方法是，在此项目中创建一个自定义属性并将其分配给所需属性，然后在 CleanupCode 参数中使用该自定义属性。

--toolset — 使用此选项指定确切的 MSBuild 版本。 例如 12.0： --toolset=12.0 默认情况下，使用可用的最高 MSBuild 版本。 如果您有多个相同版本的安装，例如来自 Visual Studio 2019 的 16.0 和来自 .NET Core 3.x 的 16.0，此选项可能不起作用。

--toolset-path — 使用此选项指定 MSBuild 的确切路径。 如果您有自定义的 MSBuild 安装并希望与 CleanupCode 一起使用，这可能会有所帮助，例如： --toolset-path="c:\tools\msbuild\bin\MsBuild.exe"。

--dotnetcore — 默认情况下，.NET 安装会自动检测。 您可以使用此选项指向特定的 .NET 安装，如果自动检测导致冲突。 使用此选项时不带参数以忽略 .NET Core。 示例： --dotnetcore=/usr/local/share/dotnet/dotnet。

--dotnetcoresdk — 使用此选项指定应提供 MSBuild 的 .NET SDK 版本。 例如，如果您安装了 SDK 版本为 5.0.100 和 6.0.302 的 .NET，CleanupCode 将优先选择 6.0.302（最新版本，包括预览版本）。 现在，如果您希望使用 .NET SDK 5.0.100 运行 CleanupCode，请在命令行中添加 --dotnetcoresdk=5.0.100。

--mono — 默认情况下，Mono 安装会自动检测。 您可以使用此选项指向特定的 Mono 安装，如果自动检测导致冲突。 使用此选项时不带参数以忽略 Mono。 示例： --mono=/Library/Frameworks/Mono.framework/Versions/Current/bin/mono。

--targets-for-references — 自定义 MSBuild 目标的名称，这些目标将被执行以获取项目的引用程序集。 这些目标定义在项目文件或 .目标 文件中。 多个值用分号分隔。 例如： --targets-for-references="GetReferences"。

--targets-for-items — 自定义 MSBuild 目标的名称，这些目标将被执行以获取项目的其他项（例如，Compile 项）。 这些目标定义在项目文件或 .目标 文件中。 多个值用分号分隔。 例如： --targets-for-items="GetCompileItems"。

--verbosity — 默认情况下，CleanupCode 仅在输出中显示错误消息。 使用此参数更改写入输出的信息量，以下是级别（从少到多详细）： [OFF，FATAL，ERROR，WARN，INFO，VERBOSE，TRACE]。

--LogLevel — 使用此参数控制写入日志文件的信息量，通过 --LogFile 或 --LogFolder 指定。 以下是级别（从少到多详细）： [OFF，FATAL，ERROR，WARN，INFO，VERBOSE，TRACE]。

例如，如果 CleanupCode 出现问题，您可以联系 ReSharper 支持并分享包含所有 TRACE 消息的日志文件： --LogLevel=TRACE。

--LogFile — 使用此参数指定 CleanupCode 消息日志文件的绝对路径。 如果您还需要 MSBuild 和 Roslyn 的日志，请改用 --LogFolder 参数。

--LogFolder — 使用此参数指定一个目录的绝对路径，CleanupCode 的日志以及 MSBuild 和 Roslyn 的日志将写入该目录。 如果您只需要 CleanupCode 的日志，请改用 --LogFile 参数。

--caches-home — 允许您指定 CleanupCode 缓存数据的自定义位置。 默认情况下，使用 %LOCALAPPDATA% 目录，除非存在设置文件，在这种情况下使用指定的目录。 此参数在您希望使用快速 SSD 磁盘作为缓存或希望将所有构建处理数据存储在一个位置时非常有用。

--config-create 和 --config — 这些选项允许您通过配置文件传递上述参数。 第一个选项将根据当前参数创建一个配置文件；第二个选项用于从该文件加载参数。

--debug (-d) — 使用此选项将 CleanupCode 的执行详细信息添加到输出中。 如果您在使用 CleanupCode 时遇到问题，这些详细信息在联系 支持团队时会很有帮助。

--eXtensions (-x) — 安装并启用指定的插件。

插件通过其 ID 指定，您可以在 JetBrains Marketplace的插件页面上找到：找到所需插件并滚动到 概览 选项卡的底部。

例如， StyleCop by JetBrains 插件的插件 ID 是 StyleCop.StyleCop ，若要使用此插件运行 CleanupCode，您需要在命令行中添加 -x=StyleCop.StyleCop。

要指定多个插件，请用分号分隔它们的 ID。

--source — 允许您指定自定义包源以安装插件，即包含插件的 .nupkg 文件所在的目录，例如： --source="C:\plugins"。 如果未指定任何内容，CleanupCode 将在 JetBrains Marketplace中查找插件。

--measure — 一个诊断选项，如果您在特定硬件和目标解决方案上运行工具时遇到性能问题，可以帮助您。 使用此选项和以下参数之一 [sampling、timeline（仅限 Windows）、memory] 定义分析类型，例如：

执行完成后，CleanupCode 会创建一个执行快照并显示快照文件的路径。 您可以使用 JetBrains 工具研究快照：

• 采样或 时间线分析：要分析生成的 .zip 文件，请解压并使用 JetBrains dotTrace打开采样快照文件（ .dtp ）或时间线快照文件（ .dtt ）。

• 内存分析：要分析生成的 dotMemory 工作区文件（ .dmw ），请使用 JetBrains dotMemory打开它。

--version (-v) — 使用此选项显示工具的当前版本并退出。

--no-updates — 默认情况下，CleanupCode 在每次运行时检查更新。 使用此选项禁用更新检查。

--settings — 默认情况下，CleanupCode 会使用 “解决方案团队共享”层 SolutionName.DotSettings 中的 ReSharper 设置覆盖其默认设置（如果存在）。 如果需要，您可以使用此参数指定另一个 .DotSettings 文件，该文件将覆盖所有其他设置。 例如，

.

--disable-settings-layers (-dsl) — 禁用指定的 设置层。 接受的值： GlobalAll、 GlobalPerProduct、 SolutionShared、 SolutionPersonal

--no-buildin-settings — 禁用全局、解决方案和项目设置层的设置。 等同于 --disable-settings-layers: GlobalAll；GlobalPerProduct；SolutionShared；SolutionPersonal；ProjectShared；ProjectPersonal