cpp-code-quality

Run clang-format, cpplint, editorconfig-checker, markdownlint, yamllint, and platformio check on C++ projects.

25|7|Updated Mar 4, 2019
One-click install
npx skills add https://github.com/smart-swimmingpool/pool-controller --skill cpp-code-quality
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: cpp-code-quality
Source: https://github.com/smart-swimmingpool/pool-controller/tree/main/.opencode/skills/cpp-code-quality
Command: npx skills add https://github.com/smart-swimmingpool/pool-controller --skill cpp-code-quality

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

C++ projects, especially embedded ones like pool-controller, often suffer from inconsistent formatting, lint errors, and missing CI-quality gates, causing delayed PR reviews and unstable builds.

Core Features & Use Cases

  • Centralized code-quality checks across the repository (formatting, linting, editorconfig compliance, and static analysis) to streamline PR reviews.
  • CI-friendly gates that enforce style and documentation linting, reducing merge risks and improving maintainability.
  • Local quick-start guidance to run checks before pushing changes and iterate quickly.

Quick Start

Run the linting and formatting checks on your project to identify and fix code quality issues.

Frequently Asked Questions about cpp-code-quality

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add C++ code quality checks to my CI workflow?

To add C++ code quality checks to your CI workflow, you can configure automated gates that run clang-format, cpplint, and static analysis during pull requests. This enforces formatting and editorconfig compliance to reduce merge risks.

Does clang-format work with PlatformIO and ESP32 embedded projects?

Yes, clang-format works with PlatformIO and ESP32 embedded projects. You can run local formatting checks alongside platformio check in your CI pipeline to ensure consistent C++ code quality for embedded style repositories.

What is the best way to lint C++ formatting and editorconfig compliance before pushing?

The best way to lint C++ formatting and editorconfig compliance before pushing is to run local tooling like clang-format, cpplint, and editorconfig-checker. This quick-start guidance helps iterate quickly and catch issues before they reach PR reviews.

Can I run cpplint and static analysis in the same CI pipeline for a C++ project?

Yes, you can run cpplint and static analysis in the same CI pipeline for a C++ project. The centralized checks validate formatting, linting, and editorconfig compliance together, streamlining PR reviews and maintaining stable builds.

Why does my C++ PR fail CI checks due to formatting and markdownlint errors?

Your C++ PR fails CI checks because automated quality gates enforce style and documentation linting. Running local tools like clang-format and markdownlint before pushing helps identify and fix these formatting errors early.

Do I need yamllint and editorconfig-checker to validate my C++ project configuration?

Yes, you need yamllint and editorconfig-checker to validate your C++ project configuration files. These tools ensure YAML configurations and editor settings comply with repository standards during local checks and CI workflows.