TheLartians/ModernCppStarter
ModernCppStarter
ModernCppStarter is a pre-configured project boilerplate and bootstrapping environment for C++ libraries and executables. It provides a standardized set of CMake build configurations and templates to automate the initialization of new projects.
The project integrates a comprehensive static analysis suite and documentation automation. It includes systems for enforcing code quality through sanitizers and analyzers, as well as a pipeline for generating and deploying technical documentation during project releases.
The template covers broader development infrastructure, including dependency management, automated testing with code coverage, and continuous integration pipelines. It also incorporates build performance optimizations through compilation caching and automated code formatting enforcement.
Features
- Project Boilerplates - Provides a pre-configured project template with integrated build systems and automation for C++.
- C++ Project Templates - Provides a pre-configured boilerplate and bootstrapping environment to automate the initialization of new C++ projects.
- Build Orchestration - Uses CMake to provide a standardized meta-build system for cross-platform compilation and flag management.
- Build Configurations - Ships a set of CMake scripts for managing compilation, dependency resolution, and installation.
- Code Quality and Analysis - Integrates a comprehensive suite of static analyzers and sanitizers to enforce coding standards and detect bugs during the build process.
- Project Templates - Provides an automated workflow template for running tests, coverage, and formatting for C++.
- Documentation Generators - Automatically extracts technical documentation from source code comments using Doxygen.
- Code Formatting Tools - Enforces consistent source and build file styles using integrated automated formatting tools.
- Dependency Management - Retrieves and integrates external libraries to ensure consistent and reproducible C++ builds.
- CI CD Pipelines - Automates testing, coverage monitoring, and documentation deployment for C++ projects.
- Continuous Integration Pipelines - Automates the execution of test suites and coverage monitoring within the CI pipeline.
- Documentation Automation - Automates the generation and deployment of technical documentation during the release process.
- GitHub Actions - Provides GitHub Actions workflows to automate building, testing, and formatting checks.
- Library Dependency Managers - Implements CPM for downloading and configuring external git repositories during the build phase.
- Build Performance Optimization - Implements compilation caching to reduce redundant work and minimize build durations across repeated cycles.
- Code Coverage Analysis - Executes test suites and collects code coverage data to verify project correctness.
- Code Quality Analyzers - Uses static analyzers, sanitizers, and formatters to ensure a consistent and bug-free C++ codebase.
- Static Analysis - Provides integrated Clang-Tidy analysis to identify bug-prone patterns and enforce C++ coding standards.
- Static and Dynamic Analysis Suites - Includes an integrated suite of sanitizers and static analyzers to detect bugs during builds.
- Test Suite Execution - Uses CTest to run test suites and collect code coverage through standardized interface hooks.
- Developer Tools - Template for modern C++ project development.
- Project Templates - Starter template with CI, coverage, and dependency management.
