carlosgalvezp updated this revision to Diff 512037.
carlosgalvezp retitled this revision from "[WIP][clang-tidy] Support specifying
Checks as a list in the config file" to "[clang-tidy] Support introducing
checks as a list in the config file
Specifying checks as a string is convenient for quickly using
clang-tidy to run a handful of checks. However it is not
suitable for projects that have a long list of enabled or...".
carlosgalvezp edited the summary of this revision.
carlosgalvezp added a comment.
Update commit message
Updating D147876: [clang-tidy] Support introducing checks as a list in the
config file
======================================================================================
Specifying checks as a string is convenient for quickly using
clang-tidy to run a handful of checks. However it is not
suitable for projects that have a long list of enabled or...
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D147876/new/
https://reviews.llvm.org/D147876
Files:
clang-tools-extra/clang-tidy/ClangTidyOptions.cpp
clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
clang-tools-extra/docs/ReleaseNotes.rst
clang-tools-extra/docs/clang-tidy/index.rst
clang-tools-extra/test/clang-tidy/infrastructure/Inputs/config-file/config-file-list-bracket
clang-tools-extra/test/clang-tidy/infrastructure/Inputs/config-file/config-file-list-dash
clang-tools-extra/test/clang-tidy/infrastructure/config-file.cpp
Index: clang-tools-extra/test/clang-tidy/infrastructure/config-file.cpp
===================================================================
--- clang-tools-extra/test/clang-tidy/infrastructure/config-file.cpp
+++ clang-tools-extra/test/clang-tidy/infrastructure/config-file.cpp
@@ -6,3 +6,15 @@
// CHECK-SPACES-NEXT: hicpp-use-auto
// CHECK-SPACES-NEXT: hicpp-use-emplace
// CHECK-SPACES-EMPTY:
+// RUN: clang-tidy -config-file=%S/Inputs/config-file/config-file-list-dash --list-checks -- | FileCheck %s -check-prefix=CHECK-LIST-DASH
+// CHECK-LIST-DASH: Enabled checks:
+// CHECK-LIST-DASH-NEXT: hicpp-uppercase-literal-suffix
+// CHECK-LIST-DASH-NEXT: hicpp-use-auto
+// CHECK-LIST-DASH-NEXT: hicpp-use-emplace
+// CHECK-LIST-DASH-EMPTY:
+// RUN: clang-tidy -config-file=%S/Inputs/config-file/config-file-list-bracket --list-checks -- | FileCheck %s -check-prefix=CHECK-LIST-BRACKET
+// CHECK-LIST-BRACKET: Enabled checks:
+// CHECK-LIST-BRACKET-NEXT: hicpp-uppercase-literal-suffix
+// CHECK-LIST-BRACKET-NEXT: hicpp-use-auto
+// CHECK-LIST-BRACKET-NEXT: hicpp-use-emplace
+// CHECK-LIST-BRACKET-EMPTY:
Index: clang-tools-extra/test/clang-tidy/infrastructure/Inputs/config-file/config-file-list-dash
===================================================================
--- /dev/null
+++ clang-tools-extra/test/clang-tidy/infrastructure/Inputs/config-file/config-file-list-dash
@@ -0,0 +1,5 @@
+Checks:
+ - "-*"
+ - "hicpp-uppercase-literal-suffix"
+ - "hicpp-use-auto"
+ - "hicpp-use-emplace"
Index: clang-tools-extra/test/clang-tidy/infrastructure/Inputs/config-file/config-file-list-bracket
===================================================================
--- /dev/null
+++ clang-tools-extra/test/clang-tidy/infrastructure/Inputs/config-file/config-file-list-bracket
@@ -0,0 +1,6 @@
+Checks: [
+ "-*",
+ "hicpp-uppercase-literal-suffix",
+ "hicpp-use-auto",
+ "hicpp-use-emplace",
+]
Index: clang-tools-extra/docs/clang-tidy/index.rst
===================================================================
--- clang-tools-extra/docs/clang-tidy/index.rst
+++ clang-tools-extra/docs/clang-tidy/index.rst
@@ -259,7 +259,9 @@
options. Example:
CheckOptions:
some-check.SomeOption: 'some value'
- Checks - Same as '--checks'.
+ Checks - Same as '--checks'. Additionally, the list of
+ globs can be specified as a list instead of a
+ string.
ExtraArgs - Same as '--extra-args'.
ExtraArgsBefore - Same as '--extra-args-before'.
FormatStyle - Same as '--format-style'.
Index: clang-tools-extra/docs/ReleaseNotes.rst
===================================================================
--- clang-tools-extra/docs/ReleaseNotes.rst
+++ clang-tools-extra/docs/ReleaseNotes.rst
@@ -98,6 +98,9 @@
`ImplementationFileExtensions`, replacing the check-local options of the
same name.
+- Support specifying `Checks` as a YAML list in the `.clang-tidy` configuration
+ file.
+
New checks
^^^^^^^^^^
@@ -298,7 +301,7 @@
``DISABLED_`` in the test suite name.
- Fixed an issue in :doc:`modernize-concat-nested-namespaces
- <clang-tidy/checks/modernize/concat-nested-namespaces>` when using macro between
+ <clang-tidy/checks/modernize/concat-nested-namespaces>` when using macro between
namespace declarations could result incorrect fix.
- Fixed a false positive in :doc:`performance-no-automatic-move
Index: clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
===================================================================
--- clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
+++ clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
@@ -52,7 +52,9 @@
options. Example:
CheckOptions:
some-check.SomeOption: 'some value'
- Checks - Same as '--checks'.
+ Checks - Same as '--checks'. Additionally, the list of
+ globs can be specified as a list instead of a
+ string.
ExtraArgs - Same as '--extra-args'.
ExtraArgsBefore - Same as '--extra-args-before'.
FormatStyle - Same as '--format-style'.
Index: clang-tools-extra/clang-tidy/ClangTidyOptions.cpp
===================================================================
--- clang-tools-extra/clang-tidy/ClangTidyOptions.cpp
+++ clang-tools-extra/clang-tidy/ClangTidyOptions.cpp
@@ -70,7 +70,8 @@
NOptionMap(IO &, const ClangTidyOptions::OptionMap &OptionMap) {
Options.reserve(OptionMap.size());
for (const auto &KeyValue : OptionMap)
- Options.emplace_back(std::string(KeyValue.getKey()), KeyValue.getValue().Value);
+ Options.emplace_back(std::string(KeyValue.getKey()),
+ KeyValue.getValue().Value);
}
ClangTidyOptions::OptionMap denormalize(IO &) {
ClangTidyOptions::OptionMap Map;
@@ -117,10 +118,49 @@
}
}
+struct ChecksVariant {
+ std::optional<std::string> AsString;
+ std::optional<std::vector<std::string>> AsVector;
+};
+
+template <>
+void yamlize(IO &IO, ChecksVariant &Checks, bool, EmptyContext &Ctx) {
+ if (!IO.outputting()) {
+ // Special case for reading from YAML
+ // Must support reading from both a string or a list
+ Input &I = reinterpret_cast<Input &>(IO);
+ if (isa<ScalarNode>(I.getCurrentNode()) ||
+ isa<BlockScalarNode>(I.getCurrentNode())) {
+ Checks.AsString = std::string();
+ yamlize(IO, *Checks.AsString, true, Ctx);
+ } else if (isa<SequenceNode>(I.getCurrentNode())) {
+ Checks.AsVector = std::vector<std::string>();
+ yamlize(IO, *Checks.AsVector, true, Ctx);
+ } else {
+ IO.setError("expected string or sequence");
+ }
+ }
+}
+
+static void mapChecks(IO &IO, std::optional<std::string> &Checks) {
+ if (IO.outputting()) {
+ // Output always a string
+ IO.mapOptional("Checks", Checks);
+ } else {
+ // Input as either a string or a list
+ ChecksVariant ChecksAsVariant;
+ IO.mapOptional("Checks", ChecksAsVariant);
+ if (ChecksAsVariant.AsString)
+ Checks = ChecksAsVariant.AsString;
+ else if (ChecksAsVariant.AsVector)
+ Checks = llvm::join(*ChecksAsVariant.AsVector, ",");
+ }
+}
+
template <> struct MappingTraits<ClangTidyOptions> {
static void mapping(IO &IO, ClangTidyOptions &Options) {
bool Ignored = false;
- IO.mapOptional("Checks", Options.Checks);
+ mapChecks(IO, Options.Checks);
IO.mapOptional("WarningsAsErrors", Options.WarningsAsErrors);
IO.mapOptional("HeaderFileExtensions", Options.HeaderFileExtensions);
IO.mapOptional("ImplementationFileExtensions",
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
