[clang-tidy] add option to avoid "no checks enabled" error #96122

HerrCai0907 · 2024-06-19T23:20:36Z

When clang-tidy get an empty checks, it will throw "no checks enabled" error and exit with non-zero return value.
It make clang-tidy's wrapper program confused when in big project some files don't want to be checked and use -checks=-* to disable all checks.

When clang-tidy get an empty checks, it will throw "no checks enabled" error and exit with non-zero return value. It make clang-tidy's wrapper program confused when in big project some files don't want to be checked and use `-checks=-*` to disable all checks.

llvmbot · 2024-06-19T23:21:07Z

@llvm/pr-subscribers-clang-tools-extra

@llvm/pr-subscribers-clang-tidy

Author: Congcong Cai (HerrCai0907)

Changes

When clang-tidy get an empty checks, it will throw "no checks enabled" error and exit with non-zero return value.
It make clang-tidy's wrapper program confused when in big project some files don't want to be checked and use -checks=-* to disable all checks.

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

2 Files Affected:

(modified) clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp (+10-2)
(modified) clang-tools-extra/docs/ReleaseNotes.rst (+3)

diff --git a/clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp b/clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
index 7388f20ef288e..b579aff4394c9 100644
--- a/clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
+++ b/clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
@@ -325,6 +325,14 @@ option is recognized.
 )"),
                                   cl::init(false), cl::cat(ClangTidyCategory));
 
+static cl::opt<bool> AllowEmptyCheckList("allow-empty-checks", desc(R"(
+Allow empty enabled checks. This suppresses
+the "no checks enabled" error when disabling
+all of the checks.
+)"),
+                                         cl::init(false),
+                                         cl::cat(ClangTidyCategory));
+
 namespace clang::tidy {
 
 static void printStats(const ClangTidyStats &Stats) {
@@ -598,7 +606,7 @@ int clangTidyMain(int argc, const char **argv) {
   }
 
   if (ListChecks) {
-    if (EnabledChecks.empty()) {
+    if (EnabledChecks.empty() && !AllowEmptyCheckList) {
       llvm::errs() << "No checks enabled.\n";
       return 1;
     }
@@ -651,7 +659,7 @@ int clangTidyMain(int argc, const char **argv) {
     return 0;
   }
 
-  if (EnabledChecks.empty()) {
+  if (EnabledChecks.empty() && !AllowEmptyCheckList) {
     llvm::errs() << "Error: no checks enabled.\n";
     llvm::cl::PrintHelpMessage(/*Hidden=*/false, /*Categorized=*/true);
     return 1;
diff --git a/clang-tools-extra/docs/ReleaseNotes.rst b/clang-tools-extra/docs/ReleaseNotes.rst
index 3bdd735f7dcf7..54cfcafd121b6 100644
--- a/clang-tools-extra/docs/ReleaseNotes.rst
+++ b/clang-tools-extra/docs/ReleaseNotes.rst
@@ -125,6 +125,9 @@ Improvements to clang-tidy
 - Added argument `--exclude-header-filter` and config option `ExcludeHeaderFilterRegex`
   to exclude headers from analysis via a RegEx.
 
+- Added argument `--allow-empty-checks` and config option `AllowEmptyCheckList`
+  to suppress "no checks enabled" error when disabling all of the checks.
+
 New checks
 ^^^^^^^^^^

clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp

PiotrZSL

if a reason for this parameter is not to fail wrapper scripts, then maybe run-clang-tidy.py / run-clang-tidy-diff.py should also be updated.

clang-tools-extra/docs/ReleaseNotes.rst

HerrCai0907 · 2024-06-20T09:56:14Z

if a reason for this parameter is not to fail wrapper scripts, then maybe run-clang-tidy.py / run-clang-tidy-diff.py should also be updated.

Both of them is fine because they only count the failed file and don't do any check about failure.

5chmidti

´run-clang-tidy.pyandclang-tidy-diff.py` should probably expose an option to enable this option via the script (maybe with an adjustment to the release notes).

5chmidti · 2024-06-20T11:40:32Z

clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp

+  if (EnabledChecks.empty() && !AllowNoChecks) {
    llvm::errs() << "Error: no checks enabled.\n";
    llvm::cl::PrintHelpMessage(/*Hidden=*/false, /*Categorized=*/true);
    return 1;


I think it would be better to exit clang-tidy at this point, when there are no checks present and AllowNoChecks is enabled. The current behavior of this PR for invoking clang-tidy to check a file would be:

if no checks are enabled and AllowNoChecks is true

continue executing clang-tidy even though no checks are enabled

I think it should be:

if no checks are enabled

if AllowNoChecks is true then return 0, else error out with return 1

clang-tools-extra/docs/ReleaseNotes.rst

Co-authored-by: Danny Mösch <[email protected]>

5chmidti · 2024-06-23T14:06:30Z

clang-tools-extra/test/clang-tidy/infrastructure/allow-no-checks.cpp

+// RUN: clang-tidy %s -checks='-*' --allow-no-checks | FileCheck --match-full-lines %s
+
+
+// CHECK: No checks enabled.


missing newline

5chmidti · 2024-06-23T14:06:57Z

clang-tools-extra/clang-tidy/tool/run-clang-tidy.py

the same should probably be done for diff-clang-tidy.py

Where is diff-clang-tidy.py?

I found it. It is named clang-tidy-diff.py

…i0907/llvm-project into tidy-support-empty-checks

5chmidti

LGTM

When clang-tidy get an empty checks, it will throw "no checks enabled" error and exit with non-zero return value. It make clang-tidy's wrapper program confused when in big project some files don't want to be checked and use `-checks=-*` to disable all checks. --------- Co-authored-by: Danny Mösch <[email protected]>

llvmbot added clang-tools-extra clang-tidy labels Jun 19, 2024

HerrCai0907 requested review from PiotrZSL, SimplyDanny and 5chmidti June 19, 2024 23:33

SimplyDanny reviewed Jun 20, 2024

View reviewed changes

clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp Outdated Show resolved Hide resolved

PiotrZSL requested changes Jun 20, 2024

View reviewed changes

clang-tools-extra/docs/ReleaseNotes.rst Outdated Show resolved Hide resolved

clang-tools-extra/docs/ReleaseNotes.rst Outdated Show resolved Hide resolved

fix acc comment

9302fee

5chmidti reviewed Jun 20, 2024

View reviewed changes

fix

8171fb5

HerrCai0907 requested review from SimplyDanny, 5chmidti and PiotrZSL June 20, 2024 14:14

HerrCai0907 and others added 3 commits June 20, 2024 14:19

support in run-clang-tidy

78cb07b

Merge remote-tracking branch 'origin' into tidy-support-empty-checks

874bad1

fix

586283e

SimplyDanny approved these changes Jun 22, 2024

View reviewed changes

clang-tools-extra/docs/ReleaseNotes.rst Outdated Show resolved Hide resolved

Update clang-tools-extra/docs/ReleaseNotes.rst

fb7b211

Co-authored-by: Danny Mösch <[email protected]>

5chmidti reviewed Jun 23, 2024

View reviewed changes

HerrCai0907 added 3 commits June 24, 2024 20:59

new line

cd9077a

add option in clang-tidy-diff.py

d70e54d

Merge branch 'tidy-support-empty-checks' of https://github.com/HerrCa…

0292ce7

…i0907/llvm-project into tidy-support-empty-checks

5chmidti approved these changes Jun 25, 2024

View reviewed changes

HerrCai0907 merged commit 4558e45 into llvm:main Jun 26, 2024
8 checks passed

HerrCai0907 deleted the tidy-support-empty-checks branch June 26, 2024 23:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[clang-tidy] add option to avoid "no checks enabled" error #96122

[clang-tidy] add option to avoid "no checks enabled" error #96122

Uh oh!

HerrCai0907 commented Jun 19, 2024

Uh oh!

llvmbot commented Jun 19, 2024 •

edited

Loading

Uh oh!

Uh oh!

PiotrZSL left a comment

Uh oh!

Uh oh!

Uh oh!

HerrCai0907 commented Jun 20, 2024

Uh oh!

5chmidti left a comment

Uh oh!

5chmidti Jun 20, 2024

Uh oh!

Uh oh!

5chmidti Jun 23, 2024

Uh oh!

5chmidti Jun 23, 2024

Uh oh!

HerrCai0907 Jun 24, 2024

Uh oh!

HerrCai0907 Jun 24, 2024 •

edited

Loading

Uh oh!

5chmidti left a comment

Uh oh!

Uh oh!

Uh oh!

		// RUN: clang-tidy %s -checks='-*' --allow-no-checks \| FileCheck --match-full-lines %s


		// CHECK: No checks enabled.

[clang-tidy] add option to avoid "no checks enabled" error #96122

[clang-tidy] add option to avoid "no checks enabled" error #96122

Uh oh!

Conversation

HerrCai0907 commented Jun 19, 2024

Uh oh!

llvmbot commented Jun 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

PiotrZSL left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

HerrCai0907 commented Jun 20, 2024

Uh oh!

5chmidti left a comment

Choose a reason for hiding this comment

Uh oh!

5chmidti Jun 20, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

5chmidti Jun 23, 2024

Choose a reason for hiding this comment

Uh oh!

5chmidti Jun 23, 2024

Choose a reason for hiding this comment

Uh oh!

HerrCai0907 Jun 24, 2024

Choose a reason for hiding this comment

Uh oh!

HerrCai0907 Jun 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

5chmidti left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

llvmbot commented Jun 19, 2024 •

edited

Loading

HerrCai0907 Jun 24, 2024 •

edited

Loading