Support clang-tidy (early PR for review)

README-clang-tidy-pull-request.md

@@ -0,0 +1,42 @@
+# Clang-tidy PR
+
+(temporary file, not to be included in final merge)
+
+I'm attempting to integrate clang-tidy with rules_lint, by integrating some of the aspect approaches from
+bazel_clang_tidy into this linter framework. The idea of integrating these linters has been suggested by
+maintainers of both repos (https://github.com/erenon/bazel_clang_tidy/issues/35)
+
+## Windows setup
+```
+copy clang-tidy.exe into examples/tools/lint
+del examples\\.bazeliskrc (aspect-cli does not support windows)
+BAZEL_SH=c:\msys64\usr\bin\bash.exe # git bash doesn't seem to work
+BAZEL_VC=c:\apps\MVS16\VC
+```
+
+## Example commands
+Run on a binary
+```
+cd example
+bazel build //src/cpp/main:hello-world --config=clang-tidy
+```
+
+Run with raw options, no config (this is exactly the same as above)
+```
+bazel build //src/cpp/main:hello-world --aspects=//tools/lint:linters.bzl%clang_tidy --output_groups=rules_lint_report
+```
+
+See clang-tidy command line for each invokation
+```
+bazel build //src/cpp/main:hello-world --config=clang-tidy -s
+```
+
+Run on a cc_library
+```
+bazel build //src/cpp/lib:hello-time --config=clang-tidy -s
+```
+
+## Questions
+- clang-tidy handles only a single source file at a time. This is different to all the other linters currently supported. What is the best way to structure this code in clang_tidy.bzl? Pass one file to each invokation of clang_tidy_action? Or loop inside clang_tidy_action?
+- Any other inputs?
+

README.md

@@ -23,7 +23,7 @@ New tools are being added frequently, so check this page again!
 
 | Language               | Formatter             | Linter(s)        |
 | ---------------------- | --------------------- | ---------------- |
-| C / C++                | [clang-format]        | ([#112])         |
+| C / C++                | [clang-format]        | ([clang-tidy])   |
 | CSS, Less, Sass        | [Prettier]            |                  |
 | Go                     | [gofmt] or [gofumpt]  |                  |
 | HCL (Hashicorp Config) | [terraform] fmt       |                  |
@@ -67,6 +67,7 @@ New tools are being added frequently, so check this page again!
 [shellcheck]: https://www.shellcheck.net/
 [shfmt]: https://github.com/mvdan/sh
 [clang-format]: https://clang.llvm.org/docs/ClangFormat.html
+[clang-tidy]: https://clang.llvm.org/extra/clang-tidy/
 [#112]: https://github.com/aspect-build/rules_lint/issues/112
 [vale]: https://vale.sh/
 [yamlfmt]: https://github.com/google/yamlfmt

docs/BUILD.bazel

@@ -52,4 +52,9 @@ stardoc_with_diff_test(
     bzl_library_target = "//lint:ktlint",
 )
 
+stardoc_with_diff_test(
+    name = "clang-tidy",
+    bzl_library_target = "//lint:clang-tidy",
+)
+
 update_docs(name = "update")

example/.bazelrc

@@ -4,3 +4,14 @@ build --repo_env=JAVA_HOME=../bazel_tools/jdk
 
 common --incompatible_enable_proto_toolchain_resolution
 common --@aspect_rules_ts//ts:skipLibCheck=always
+
+# For testing only clang-tidy only
+common:clang-tidy --aspects=//tools/lint:linters.bzl%clang_tidy
+common:clang-tidy --output_groups=rules_lint_report --norun_validations --remote_download_regex=".*AspectRulesLint.*"
+startup --windows_enable_symlinks
+
+# clang-tidy needs the INCLUDE variable set to the system value. 
+# Would prefer to do this inside the aspect, not sure if it is possible.
+common --action_env=INCLUDE
+# ensure that minimal other envvars are passed by clang-tidy run_shell
+common --incompatible_strict_action_env

example/.clang-tidy

@@ -0,0 +1,9 @@
+Checks: >
+  -*,
+  bugprone-*,
+  google-*,
+  misc-*,
+  modernize-*,
+  performance-*,
+  portability-*,
+  readability-*

example/BUILD.bazel

@@ -22,6 +22,7 @@ exports_files(
         ".vale.ini",
         ".editorconfig",
         "ktlint-baseline.xml",
+        ".clang-tidy",
     ],
     visibility = ["//visibility:public"],
 )

example/MODULE.bazel

@@ -17,6 +17,7 @@ bazel_dep(name = "rules_rust", version = "0.45.1")
 bazel_dep(name = "buildifier_prebuilt", version = "6.3.3")
 bazel_dep(name = "platforms", version = "0.0.8")
 bazel_dep(name = "rules_kotlin", version = "1.9.0")
+bazel_dep(name = "rules_cc", version = "0.0.9")
 
 local_path_override(
     module_name = "aspect_rules_lint",

example/lint.sh

@@ -24,7 +24,7 @@ filter='.namedSetOfFiles | values | .files[] | select(.name | endswith($ext)) |
 
 # NB: perhaps --remote_download_toplevel is needed as well with remote execution?
 args=(
-	"--aspects=$(echo //tools/lint:linters.bzl%{buf,eslint,flake8,ktlint,pmd,ruff,shellcheck,vale} | tr ' ' ',')"
+	"--aspects=$(echo //tools/lint:linters.bzl%{buf,eslint,flake8,ktlint,pmd,ruff,shellcheck,vale,clang_tidy} | tr ' ' ',')"
 	# Allow lints of code that fails some validation action
 	# See https://github.com/aspect-build/rules_ts/pull/574#issuecomment-2073632879
 	"--norun_validations"

example/src/cpp/lib/BUILD

@@ -0,0 +1,9 @@
+load("@rules_cc//cc:defs.bzl", "cc_library")
+
+cc_library(
+    name = "hello-time",
+    srcs = ["hello-time.cc"],
+    hdrs = ["hello-time.h", "xhello-time.h"],
+    includes = ["."],
+    visibility = ["//src/cpp/main:__pkg__"],
+)

example/src/cpp/lib/hello-time.cc

@@ -0,0 +1,9 @@
+#include "hello-time.h"
+#include <ctime>
+#include <iostream>
+
+void print_localtime() {
+  std::time_t result = std::time(nullptr);
+  std::string result_str = std::asctime(std::localtime(&result));
+  printf("%s\n", result_str.c_str());
+}

example/src/cpp/lib/hello-time.h

@@ -0,0 +1,16 @@
+#ifndef LIB_HELLO_TIME_H_
+#define LIB_HELLO_TIME_H_
+
+#include <string>
+#include <stdio.h>
+#include <xhello-time.h>
+
+void print_localtime();
+
+inline void print_localtime2() {
+    std::string a = "time";
+    for (int i=0; i<a.size(); ++i) {
+        printf("%s", a.c_str()[i]);
+    }
+}
+#endif

example/src/cpp/lib/xhello-time.h

@@ -0,0 +1,13 @@
+#ifndef LIB_HELLO_TIME2_H_
+#define LIB_HELLO_TIME2_H_
+
+#include <string>
+#include <stdio.h>
+
+inline void print_localtime3() {
+    std::string a = "time";
+    for (int i=0; i<a.size(); ++i) {
+        printf("%s", a.c_str()[i]);
+    }
+}
+#endif

example/src/cpp/main/BUILD

@@ -0,0 +1,18 @@
+load("@rules_cc//cc:defs.bzl", "cc_binary", "cc_library")
+
+cc_library(
+    name = "hello-greet",
+    srcs = ["hello-greet.cc"],
+    hdrs = ["hello-greet.h"],
+    includes = ["."],
+)
+
+cc_binary(
+    name = "hello-world",
+    srcs = ["hello-world.cc"],
+    deps = [
+        ":hello-greet",
+        "//src/cpp/lib:hello-time",
+    ],
+    includes = ["."],
+)

example/src/cpp/main/hello-greet.cc

@@ -0,0 +1,6 @@
+#include "hello-greet.h"
+#include <string>
+
+std::string get_greet(const std::string& who) {
+  return "Hello " + who;
+}

example/src/cpp/main/hello-greet.h

@@ -0,0 +1,8 @@
+#ifndef MAIN_HELLO_GREET_H_
+#define MAIN_HELLO_GREET_H_
+
+#include <string>
+
+std::string get_greet(const std::string &thing);
+
+#endif

example/src/cpp/main/hello-world.cc

@@ -0,0 +1,14 @@
+#include "hello-time.h"
+#include "hello-greet.h"
+#include <iostream>
+#include <string>
+
+int main(int argc, char** argv) {
+  std::string who = "world";
+  if (argc > 1) {
+    who = argv[1];
+  }
+  std::cout << get_greet(who) << std::endl;
+  print_localtime();
+  return 0;
+}

example/src/hello.cpp

@@ -1,3 +1,12 @@
 #include <stdio.h>
+#include <stdlib.h>
+
+int string_to_int(const char *num) {
+  return atoi(num);
+}
+
+void ls() {
+  system("ls");
+}
 
 int main() { printf("Hello, world!\n"); }

example/tools/lint/BUILD.bazel

@@ -20,6 +20,7 @@ alias(
         "@bazel_tools//src/conditions:linux_aarch64": "@ruff_aarch64-unknown-linux-gnu//:ruff",
         "@bazel_tools//src/conditions:darwin_arm64": "@ruff_aarch64-apple-darwin//:ruff",
         "@bazel_tools//src/conditions:darwin_x86_64": "@ruff_x86_64-apple-darwin//:ruff",
+        "@bazel_tools//src/conditions:windows_x64": "@ruff_x86_64-pc-windows-msvc//:ruff.exe",
     }),
 )
 
@@ -51,6 +52,7 @@ native_binary(
             "@bazel_tools//src/conditions:linux_aarch64": "@vale_Linux_arm64//:vale",
             "@bazel_tools//src/conditions:darwin_x86_64": "@vale_macOS_64-bit//:vale",
             "@bazel_tools//src/conditions:darwin_arm64": "@vale_macOS_arm64//:vale",
+            "@bazel_tools//src/conditions:windows_x64": "@vale_Windows_64-bit//:vale.exe",
         },
     ),
     out = "vale",
@@ -68,3 +70,17 @@ copy_to_directory(
     ],
     include_external_repositories = ["vale_*"],
 )
+
+native_binary(
+    name = "clang_tidy",
+    src = select(
+        {
+            "@bazel_tools//src/conditions:linux_x86_64": "@llvm_toolchain_llvm//:bin/clang-tidy",
+            "@bazel_tools//src/conditions:linux_aarch64": "@llvm_toolchain_llvm//:bin/clang-tidy",
+            "@bazel_tools//src/conditions:darwin_x86_64": "@llvm_toolchain_llvm//:bin/clang-tidy",
+            "@bazel_tools//src/conditions:darwin_arm64": "@llvm_toolchain_llvm//:bin/clang-tidy",
+            "@bazel_tools//src/conditions:windows_x64": "clang-tidy.exe",
+        },
+    ),
+    out = "clang_tidy",
+)

example/tools/lint/linters.bzl

@@ -9,6 +9,7 @@ load("@aspect_rules_lint//lint:pmd.bzl", "lint_pmd_aspect")
 load("@aspect_rules_lint//lint:ruff.bzl", "lint_ruff_aspect")
 load("@aspect_rules_lint//lint:shellcheck.bzl", "lint_shellcheck_aspect")
 load("@aspect_rules_lint//lint:vale.bzl", "lint_vale_aspect")
+load("@aspect_rules_lint//lint:clang_tidy.bzl", "lint_clang_tidy_aspect")
 
 buf = lint_buf_aspect(
     config = "@@//:buf.yaml",
@@ -71,3 +72,12 @@ ktlint = lint_ktlint_aspect(
 )
 
 ktlint_test = lint_test(aspect = ktlint)
+
+clang_tidy = lint_clang_tidy_aspect(
+    binary = "@@//tools/lint:clang_tidy",
+    config = "@@//:.clang-tidy",
+    lint_matching_header = True,
+    angle_includes_are_system = False,
+)
+
+clang_tidy_test = lint_test(aspect = clang_tidy)

example/workaround_windows.bat

@@ -0,0 +1,5 @@
+:: aspect-cli doesn't support windows, so disable it
+del %~dp0.bazeliskrc
+:: ../.bazelversion syntax not supported by windows bazelisk
+del %~dp0.bazelversion
+copy %~dp0\..\.bazelversion %~dp0

lint/BUILD.bazel

@@ -197,3 +197,9 @@ bzl_library(
         "@bazel_skylib//lib:dicts",
     ],
 )
+
+bzl_library(
+    name = "clang-tidy",
+    srcs = ["clang-tidy.bzl"],
+    visibility = ["//visibility:public"],
+)