From 77f36c404cd0b1c2bc2a499c7c1b9026d54a050e Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Fri, 1 May 2026 03:40:30 +0300 Subject: [PATCH 1/4] Add search plugin to MkDocs configuration --- mkdocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/mkdocs.yml b/mkdocs.yml index a173f2b..48d1cde 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -66,6 +66,7 @@ markdown_extensions: emoji_generator: !!python/name:material.extensions.emoji.to_svg plugins: + - search - blog extra_css: From ca115168cfd799a783d7bc1e19e05c9720d1e0f5 Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Fri, 1 May 2026 03:45:57 +0300 Subject: [PATCH 2/4] Update getting started guide and index documentation for cpp-linter - Enhance the "Getting Started" section with detailed cpp-linter features and integration options. - Update the version of cpp-linter-hooks in the index documentation to v1.4.0 and simplify clang-tidy checks. --- docs/getting-started.md | 16 ++++++++++++++++ docs/index.md | 16 ++++------------ 2 files changed, 20 insertions(+), 12 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index fae91c6..432f69d 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -2,12 +2,28 @@ Welcome to cpp-linter! This guide will help you integrate C/C++ linting into your workflow quickly and efficiently. +## What is cpp-linter? + +cpp-linter connects the standard LLVM linting tools, `clang-format` and `clang-tidy`, to the places where C/C++ projects need checks: pull requests, pre-commit hooks, local scripts, and CI jobs. + +- `clang-format` checks formatting against a named style or your `.clang-format` file. +- `clang-tidy` runs static-analysis and modernization checks, usually configured by `.clang-tidy`. +- cpp-linter packages those tools into integrations with consistent defaults, reporting, and failure controls. + ## Choose Your Integration Select the method that best fits your development workflow: +| Use case | Recommended entry point | +| --- | --- | +| GitHub pull request checks | [cpp-linter-action](https://cpp-linter.github.io/cpp-linter-action/) | +| Local checks before commits | [cpp-linter-hooks](https://github.com/cpp-linter/cpp-linter-hooks) | +| Custom scripts or CI jobs | [cpp-linter CLI](https://cpp-linter.github.io/cpp-linter/) | +| High-performance local runs | [cpp-linter-rs](https://cpp-linter.github.io/cpp-linter-rs/) | + +
- :material-github: **GitHub Actions** diff --git a/docs/index.md b/docs/index.md index ba3b756..090f362 100644 --- a/docs/index.md +++ b/docs/index.md @@ -177,20 +177,12 @@ title: C/C++ Linting ```yaml repos: - repo: https://github.com/cpp-linter/cpp-linter-hooks - rev: v1.2.0 # Use the tag or commit you want + rev: v1.4.0 # Use the tag or commit you want hooks: - - id: clang-format + - id: clang-format args: [--style=Google] # Other coding style: LLVM, GNU, Chromium, Microsoft, Mozilla, WebKit. - - id: clang-tidy - args: - - --checks='boost-* - - bugprone-* - - performance-* - - readability-* - - portability-* - - modernize-* - - clang-analyzer-* - - cppcoreguidelines-*' + - id: clang-tidy + args: [--checks=-*,bugprone-*,performance-*,readability-*] ``` === "Command Line" From 382b9169ced063ef2275a96160992581ac8db1ec Mon Sep 17 00:00:00 2001 From: Xianpeng Shen Date: Fri, 1 May 2026 08:14:08 +0300 Subject: [PATCH 3/4] Update getting-started.md Co-authored-by: Brendan <2bndy5@gmail.com> --- docs/getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 432f69d..b71b2db 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -8,7 +8,7 @@ cpp-linter connects the standard LLVM linting tools, `clang-format` and `clang-t - `clang-format` checks formatting against a named style or your `.clang-format` file. - `clang-tidy` runs static-analysis and modernization checks, usually configured by `.clang-tidy`. -- cpp-linter packages those tools into integrations with consistent defaults, reporting, and failure controls. +- cpp-linter wraps those tools into integrations with consistent defaults, reporting, and failure controls. ## Choose Your Integration From cac6248b8176b4de62b36363acc482ca628c19ef Mon Sep 17 00:00:00 2001 From: Xianpeng Shen Date: Fri, 1 May 2026 08:14:29 +0300 Subject: [PATCH 4/4] Update getting-started.md Co-authored-by: Brendan <2bndy5@gmail.com> --- docs/getting-started.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index b71b2db..ff5b1d3 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -21,7 +21,6 @@ Select the method that best fits your development workflow: | GitHub pull request checks | [cpp-linter-action](https://cpp-linter.github.io/cpp-linter-action/) | | Local checks before commits | [cpp-linter-hooks](https://github.com/cpp-linter/cpp-linter-hooks) | | Custom scripts or CI jobs | [cpp-linter CLI](https://cpp-linter.github.io/cpp-linter/) | -| High-performance local runs | [cpp-linter-rs](https://cpp-linter.github.io/cpp-linter-rs/) |