cmake-format

What it is and what it does

cmake-format is a suite of QA tools for CMake build files. It includes a formatter that rewrites CMakeLists.txt and other listfiles to conform to a configurable style (line width, indentation, spacing rules), a linter that checks for problems, an annotator that generates HTML documentation, and a utility to parse ctest output into JSON or XML. Configuration is flexible—you can use YAML, JSON, or Python format files, and the tool searches parent directories for a matching config file if none is specified.

The package depends only on cmakelang, a single runtime dependency. It is designed as a command-line tool and integrates with editors (VSCode, Sublime) and pre-commit hooks. However, the project has been abandoned since August 2020 with no active maintenance, meaning it will not receive bug fixes, security updates, or compatibility patches for newer CMake or Python versions.

Use it for:

• Enforce consistent formatting across CMake files in a project to improve readability and reduce style drift.
• Detect common mistakes and style violations in CMakeLists.txt files during code review or CI/CD pipelines.
• Generate structured reports from ctest runs for integration with dashboards or test result aggregation systems.
• Automatically format CMake code as part of a pre-commit hook or editor integration workflow.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Formats, lints, and annotates CMake listfiles, and converts ctest output to structured formats like JSON or XML.

No, not recommended for new projects. The package is abandoned (last release 2020-08-19) and will not receive maintenance, security updates, or compatibility fixes. While it has low install friction and no known vulnerabilities, the lack of active development means it may break with newer CMake or Python versions. Consider a maintained alternative or community fork if CMake formatting is critical to your workflow.

Install

cmake-format on PyPI

pip install cmake-format

uv add cmake-format

poetry add cmake-format

Installing cmake-format

Before you install

Low install friction with a single runtime dependency. However, the package is abandoned—last release was 2020-08-19, over 2186 days ago. No active maintenance or security updates should be expected.

License in practice

Licensed under GPLv3 (copyleft). Any derivative work or distribution must also be licensed under GPLv3 and include source code.

Quickstart

pip install cmakelang

cmake-format --in-place path/to/CMakeLists.txt
cmake-lint path/to/CMakeLists.txt

Verify before relying

• Whether the package works with modern CMake versions and current Python releases
• Whether the abandoned status means critical bugs remain unfixed
• Whether community forks or maintained alternatives have superseded this project

Package facts

Evidence: cmake_format-0.6.13-py3-none-any.whl

Keywords: cmake, format, formatter

Tags

More Quality Assurance packages