clang-format: Add -disable-format option

[DaanDeMeyer]

When #27416 was fixed it became impossible to only use clang-format for include sorting. Let's introduce an option -disable-format to make it possible again to only sort includes with clang-format without doing any other formatting.

[llvmbot]

@llvm/pr-subscribers-clang

@llvm/pr-subscribers-clang-format

Author: Daan De Meyer (DaanDeMeyer)

Changes

When #27416 was fixed it became impossible to only use clang-format for include sorting. Let's introduce an option -disable-format to make it possible again to only sort includes with clang-format without doing any other formatting.

---

Full diff: https://github.com/llvm/llvm-project/pull/137617.diff

2 Files Affected:

• (modified) clang/docs/ClangFormat.rst (+2)
• (modified) clang/tools/clang-format/ClangFormat.cpp (+9-2)

diff --git a/clang/docs/ClangFormat.rst b/clang/docs/ClangFormat.rst
index 92af06e5083d6..a0de662b5c93b 100644
--- a/clang/docs/ClangFormat.rst
+++ b/clang/docs/ClangFormat.rst
@@ -95,6 +95,8 @@ to format C/C++/Java/JavaScript/JSON/Objective-C/Protobuf/C# code.
                                      determined by the QualifierAlignment style flag
     --sort-includes                - If set, overrides the include sorting behavior
                                      determined by the SortIncludes style flag
+    --disable-format               - If set, only sort includes if include sorting
+                                     is enabled
     --style=<string>               - Set coding style. <string> can be:
                                      1. A preset: LLVM, GNU, Google, Chromium, Microsoft,
                                         Mozilla, WebKit.
diff --git a/clang/tools/clang-format/ClangFormat.cpp b/clang/tools/clang-format/ClangFormat.cpp
index c45e3a2c28327..da3d7edf2649f 100644
--- a/clang/tools/clang-format/ClangFormat.cpp
+++ b/clang/tools/clang-format/ClangFormat.cpp
@@ -120,6 +120,12 @@ static cl::opt<bool>
                           "determined by the SortIncludes style flag"),
                  cl::cat(ClangFormatCategory));
 
+static cl::opt<bool>
+    DisableFormat("disable-format",
+                  cl::desc("If set, only sort includes if include sorting\n"
+                           "is enabled"),
+                  cl::cat(ClangFormatCategory));
+
 static cl::opt<std::string> QualifierAlignment(
     "qualifier-alignment",
     cl::desc("If set, overrides the qualifier alignment style\n"
@@ -506,8 +512,9 @@ static bool format(StringRef FileName, bool ErrorOnIncompleteFormat = false) {
   // Get new affected ranges after sorting `#includes`.
   Ranges = tooling::calculateRangesAfterReplacements(Replaces, Ranges);
   FormattingAttemptStatus Status;
-  Replacements FormatChanges =
-      reformat(*FormatStyle, *ChangedCode, Ranges, AssumedFileName, &Status);
+  Replacements FormatChanges;
+  if (DisableFormat.getNumOccurrences() == 0 || !DisableFormat)
+    FormatChanges = reformat(*FormatStyle, *ChangedCode, Ranges, AssumedFileName, &Status);
   Replaces = Replaces.merge(FormatChanges);
   if (DryRun) {
     return Replaces.size() > (IsJson ? 1u : 0u) &&

[github-actions]

✅ With the latest revision this PR passed the C/C++ code formatter.

[owenca]

This looks confusing. I would expect -disable-format to mean what it says. (But then why run clang-format?)

If we allow turning on SortIncludes only, people will start asking for QualifierAlignment only, IntegerLiteralSeparator only, etc. If @mydeveloperday is not against this, then we should upgrade DisableFormat to a struct with the supported exceptions as members.

[DaanDeMeyer]

I don't mind the exact interface too much tbh, I would just like to be able to run clang-format again to only sort includes without doing any other formatting. Happy to implement whatever makes folks happy.

[philnik777]

Can't you just run the llvm-include-order clang-tidy check instead?

[DaanDeMeyer]

Can't you just run the llvm-include-order clang-tidy check instead?

Does that take IncludeBlocks and IncludeCategories from .clang-format into account?

[philnik777]

Can't you just run the llvm-include-order clang-tidy check instead?

Does that take IncludeBlocks and IncludeCategories from .clang-format into account?

I don't think so, but it shouldn't be impossible to teach clang-tidy.