feat(lint): Add tasks for linting C++ files with clang-tidy; Refactor tasks for linting C++ files (resolves #64). (#125)

Author: davidlion

.clang-format

@@ -47,6 +47,17 @@ jobs:
         shell: "bash"
         run: "npm install -g @go-task/cli"
 
+      - name: "Install uv"
+        shell: "bash"
+        run: |-
+          curl \
+            --fail \
+            --location \
+            --silent \
+            --show-error \
+            https://astral.sh/uv/0.8.4/install.sh \
+          | sh
+
       - name: "Build and run unit tests"
         run: "task test:run-${{matrix.build_type}}"
 

.github/workflows/build.yaml

@@ -33,5 +33,25 @@ jobs:
       - name: "Install task"
         run: "npm install -g @go-task/cli"
 
+      - name: "Install uv"
+        shell: "bash"
+        run: |-
+          curl \
+            --fail \
+            --location \
+            --silent \
+            --show-error \
+            https://astral.sh/uv/0.8.4/install.sh \
+          | sh
+
+      # We use clang for linting so CMake doesn't generate compile_commands.json with any gcc
+      # specific flags that would confuse clang-tidy.
+      - if: "matrix.os == 'ubuntu-24.04'"
+        name: "Install clang."
+        run: |-
+          curl https://apt.llvm.org/llvm.sh | sudo bash -s -- 20
+          sudo ln -s /usr/bin/clang-20 /usr/local/bin/cc
+          sudo ln -s /usr/bin/clang++-20 /usr/local/bin/c++
+
       - name: "Run lint task"
         run: "task lint:check"

.github/workflows/lint.yaml

@@ -90,6 +90,7 @@ Requirements:
 * [fmt] >= 8.0.1
 * [GSL] >= 4.0.0
 * [Task] >= 3.38
+* [uv] >= 0.7.10
 
 To build and install the project to `$HOME/.local`:
 
@@ -153,45 +154,15 @@ is set to true and unit tests are built.
 Before submitting a PR, ensure you've run our linting tools and either fixed any violations or
 suppressed the warning.
 
-### Requirements
-
-We currently support running our linting tools on Linux and macOS. If you're developing on another
-OS, you can submit a [feature request][feature-req]. If you can't run the linting workflows
-locally, you can enable and run the [lint] workflow in your fork.
-
-To run the linting tools, besides commonly installed tools like `tar`, you'll need:
-
-* [clang-tidy]
-* `md5sum`
-* Python 3.8 or newer
-* python3-venv
-* [Task]
-
-### Setup
-
-```shell
-./tools/init.sh
-```
-
 ### Running the linters
 
-Currently, `clang-tidy` has to be run manually:
-
-```shell
-find src tests \
-    -type f \
-    \( -iname "*.cpp" -o -iname "*.hpp" \) \
-    -print0 | \
-        xargs -0 clang-tidy --config-file .clang-tidy -p build
-```
-
-To report all errors run:
+To report all errors, run:
 
 ```shell
 task lint:check
 ```
 
-To fix cpp errors, and report yaml errors, run:
+To automatically fix any supported format or linting errors, run:
 
 ```shell
 task lint:fix
@@ -217,9 +188,8 @@ The following are issues we're aware of and working on:
 
 [bug-report]: https://github.com/y-scope/log-surgeon/issues/new?assignees=&labels=bug&template=bug-report.yaml
 [Catch2]: https://github.com/catchorg/Catch2/tree/devel
-[clang-tidy]: https://clang.llvm.org/extra/clang-tidy/
 [feature-req]: https://github.com/y-scope/log-surgeon/issues/new?assignees=&labels=enhancement&template=feature-request.yaml
 [fmt]: https://github.com/fmtlib/fmt
 [GSL]: https://github.com/microsoft/GSL
-[lint]: https://github.com/y-scope/log-surgeon/blob/main/.github/workflows/lint.yaml
 [Task]: https://taskfile.dev/
+[uv]: https://docs.astral.sh/uv

README.md

@@ -1,6 +1,13 @@
 cmake_minimum_required(VERSION 3.22.1)
 project(log-surgeon-examples)
 
+set(CMAKE_EXPORT_COMPILE_COMMANDS
+    ON
+    CACHE BOOL
+    "Enable/Disable output of compile commands during generation."
+    FORCE
+)
+
 if (NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
     set(default_build_type "Release")
     message(STATUS "No build type specified. Setting to '${default_build_type}'.")

examples/CMakeLists.txt

@@ -14,7 +14,7 @@
 using namespace std;
 using namespace log_surgeon;
 
-auto process_logs(string& schema_path, string const& input_path) -> void {
+auto process_logs(string const& schema_path, string const& input_path) -> void {
     BufferParser parser{schema_path};
     optional<uint32_t> loglevel_id{parser.get_variable_id("loglevel")};
     if (false == loglevel_id.has_value()) {
@@ -91,11 +91,10 @@ auto process_logs(string& schema_path, string const& input_path) -> void {
 }
 
 auto main(int argc, char* argv[]) -> int {
-    if (int err{check_input(argc, argv)}; 0 != err) {
+    std::vector<std::string> const args(argv + 1, argv + argc);
+    if (int const err{check_input(args)}; 0 != err) {
         return err;
     }
-    string schema_path{argv[1]};
-    string input_path{argv[2]};
-    process_logs(schema_path, input_path);
+    process_logs(args[0], args[1]);
     return 0;
 }

examples/buffer-parser.cpp

@@ -1,30 +1,31 @@
 #include "common.hpp"
 
+#include <cstdint>
 #include <filesystem>
-#include <fstream>
 #include <iostream>
 #include <string>
 #include <vector>
 
 #include <log_surgeon/LogEvent.hpp>
+#include <log_surgeon/Token.hpp>
 
 using namespace std;
 using namespace log_surgeon;
 
-auto check_input(int argc, char* argv[]) -> int {
+auto check_input(std::vector<std::string> const& args) -> int {
     int ret{0};
-    if (3 != argc) {
+    if (2 != args.size()) {
         ret = 1;
-        cout << "Not enough arguments." << endl;
-    } else if (filesystem::path f{argv[1]}; false == filesystem::exists(f)) {
+        cout << "Not enough arguments.\n";
+    } else if (filesystem::path const f{args[0]}; false == filesystem::exists(f)) {
         ret = 2;
-        cout << "Schema file does not exist." << endl;
-    } else if (filesystem::path f{argv[2]}; false == filesystem::exists(f)) {
+        cout << "Schema file does not exist.\n";
+    } else if (filesystem::path const f{args[1]}; false == filesystem::exists(f)) {
         ret = 3;
-        cout << "Input file does not exist." << endl;
+        cout << "Input file does not exist.\n";
     }
     if (0 != ret) {
-        cout << "usage: <path to schema file> <path to input log file>" << endl;
+        cout << "usage: <path to schema file> <path to input log file>\n";
     }
     return ret;
 }
@@ -45,5 +46,5 @@ auto print_timestamp_loglevel(LogEventView const& event, uint32_t loglevel_id) -
         cout << ", loglevel:";
         cout << loglevel->to_string_view();
     }
-    cout << endl;
+    cout << "\n";
 }

examples/common.cpp

@@ -1,12 +1,13 @@
 #ifndef COMMON_HPP
 #define COMMON_HPP
 
+#include <cstdint>
 #include <string>
 #include <vector>
 
 #include <log_surgeon/LogEvent.hpp>
 
-auto check_input(int argc, char* argv[]) -> int;
+auto check_input(std::vector<std::string> const& args) -> int;
 
 auto print_timestamp_loglevel(log_surgeon::LogEventView const& event, uint32_t loglevel_id) -> void;
 

examples/common.hpp

@@ -13,7 +13,7 @@
 using namespace std;
 using namespace log_surgeon;
 
-auto process_logs(string& schema_path, string const& input_path) -> void {
+auto process_logs(string const& schema_path, string const& input_path) -> void {
     ReaderParser parser{schema_path};
     optional<uint32_t> loglevel_id{parser.get_variable_id("loglevel")};
     if (false == loglevel_id.has_value()) {
@@ -60,11 +60,10 @@ auto process_logs(string& schema_path, string const& input_path) -> void {
 }
 
 auto main(int argc, char* argv[]) -> int {
-    if (int err{check_input(argc, argv)}; 0 != err) {
+    std::vector<std::string> const args(argv + 1, argv + argc);
+    if (int const err{check_input(args)}; 0 != err) {
         return err;
     }
-    string schema_path{argv[1]};
-    string input_path{argv[2]};
-    process_logs(schema_path, input_path);
+    process_logs(args[0], args[1]);
     return 0;
 }