[clang-tidy] Sort options in --dump-config

[PiotrZSL]

Summary

Sort printed options in --dump-config output.

Fixes: #64153

[carlosgalvezp]

Looks great, small comments!

clang-tools-extra/clang-tidy/ClangTidyOptions.cpp

89

Maybe add a one-line comment like Ensure check options are sorted to more quickly grasp what the block of code below does?

90

I believe you can pass this directly to the constructor in the previous line, to skip the reserve() part.

clang-tools-extra/test/clang-tidy/infrastructure/config-files.cpp

58

Use the long name of the option, i.e. --check, so it's easier to see what it's doing without having to check the manual.

[PiotrZSL]

clang-tools-extra/clang-tidy/ClangTidyOptions.cpp

90

No, constructor takes resize argument, not reserve.

[PiotrZSL]

Review comments

[carlosgalvezp]

LGTM, thanks for fixing!

clang-tools-extra/clang-tidy/ClangTidyOptions.cpp

90

You are right!

[thakis]

This might have broken tests: http://45.33.8.238/linux/113736/step_8.txt

Please take a look and revert for now if it takes a while to fix.

[PiotrZSL]

@thakis actually this test was already broken, simply folder '2' does not exist.. Let me fix that.
Thank you for information.

[thakis]

Thanks for the quick revert!

clang-tools-extra/clang-tidy/ClangTidyOptions.cpp

 #include "clang/Basic/LLVM.h"
 #include "llvm/ADT/SmallString.h"
 #include "llvm/Support/Debug.h"
 #include "llvm/Support/Errc.h"
 #include "llvm/Support/FileSystem.h"
 #include "llvm/Support/MemoryBufferRef.h"
 #include "llvm/Support/Path.h"
 #include "llvm/Support/YAMLTraits.h"
+#include <algorithm>
 #include <optional>
 #include <utility>
 
 #define DEBUG_TYPE "clang-tidy-options"
 
 using clang::tidy::ClangTidyOptions;
 using clang::tidy::FileFilter;
 using OptionsSource = clang::tidy::ClangTidyOptionsProvider::OptionsSource;
struct NOptionMap {
   }
   std::vector<ClangTidyOptions::StringPair> Options;
 };
 
 template <>
 void yamlize(IO &IO, ClangTidyOptions::OptionMap &Options, bool,
              EmptyContext &Ctx) {
   if (IO.outputting()) {
+    // Ensure check options are sorted
+    std::vector<std::pair<StringRef, StringRef>> SortedOptions;
+    SortedOptions.reserve(Options.size());
+    for (auto &Key : Options) {
+      SortedOptions.emplace_back(Key.getKey(), Key.getValue().Value);
+    }
+    std::sort(SortedOptions.begin(), SortedOptions.end());
+
     IO.beginMapping();
     // Only output as a map
-    for (auto &Key : Options) {
-      bool UseDefault;
-      void *SaveInfo;
-      IO.preflightKey(Key.getKey().data(), true, false, UseDefault, SaveInfo);
-      StringRef S = Key.getValue().Value;
-      IO.scalarString(S, needsQuotes(S));
+    for (auto &Option : SortedOptions) {
+      bool UseDefault = false;
+      void *SaveInfo = nullptr;
+      IO.preflightKey(Option.first.data(), true, false, UseDefault, SaveInfo);
+      IO.scalarString(Option.second, needsQuotes(Option.second));
       IO.postflightKey(SaveInfo);
     }
     IO.endMapping();
   } else {
     // We need custom logic here to support the old method of specifying check
     // options using a list of maps containing key and value keys.
     Input &I = reinterpret_cast<Input &>(IO);
     if (isa<SequenceNode>(I.getCurrentNode())) {

clang-tools-extra/docs/ReleaseNotes.rst

- Preprocessor-level module header parsing is now disabled by default due to
   <clang-tidy/checks/readability/identifier-naming>`. Those checks will no
   longer see macros defined in modules. Users can still enable this
   functionality using the newly added command line option
   `--enable-module-headers-parsing`.
 
 - Remove configuration option `AnalyzeTemporaryDestructors`, which was deprecated since
   :program:`clang-tidy` 16.
 
+- Improved `--dump-config` to print check options in alphabetical order.
+
 New checks
 ^^^^^^^^^^
 
 - New :doc:`bugprone-multi-level-implicit-pointer-conversion
   <clang-tidy/checks/bugprone/multi-level-implicit-pointer-conversion>` check.
 
   Detects implicit conversions between pointers of different levels of
   indirection.

clang-tools-extra/test/clang-tidy/infrastructure/config-files.cpp

 // CHECK-CHILD5-DAG: modernize-use-using.IgnoreMacros: 'false'
 
 // RUN: clang-tidy -dump-config \
 // RUN: --config='{InheritParentConfig: false, \
 // RUN: Checks: -llvm-qualified-auto}' \
 // RUN: %S/Inputs/config-files/4/44/- -- | FileCheck %s -check-prefix=CHECK-CHILD6
 // CHECK-CHILD6: Checks: {{.*-llvm-qualified-auto'? *$}}
 // CHECK-CHILD6-NOT: modernize-use-using.IgnoreMacros
+
+// Validate that check options are printed in alphabetical order:
+// RUN: clang-tidy --checks="-*,readability-identifier-*" --dump-config | grep readability-identifier-naming | sort --check