cmake language tools

The cmakelang project provides Quality Assurance (QA) and other language tools for cmake:

• cmake-annotate can generate pretty HTML from your listfiles
• cmake-format can format your listfiles nicely so that they don’t look like crap.
• cmake-lint can check your listfiles for problems
• ctest-to can parse a ctest output tree and translate it into a more structured format (either JSON or XML).

• Installation
  • Install with pip
  • Install from source
  • IDE Integrations
  • Pre-commit
  • Docker Images
• Configuration
• cmake-annotate
• cmake-format
  • Features
  • Usage
  • Example
  • Formatting Algorithm
  • Case Studies
• cmake-lint
  • Usage
  • Inline Directives
  • Example
  • Linter Checks List
  • Lint Code Reference
  • Linter notes
• ctest-to
  • Usage
  • Example
• Various configuration options and parameters
  • Options affecting listfile parsing
  • Options affecting formatting.
  • Options affecting comment reflow and formatting.
  • Options affecting the linter
  • Options affecting file encoding
  • Miscellaneous configurations options.
• Implementing Custom Parsers
  • Using the simple specification
  • Generating simple specifications
• CMake Parse Tree
  • Tokenizer
  • Parser: Syntax Tree
  • Formatter: Layout Tree
  • Example file
• Parser Algorithm
• Automatic Parsers
  • Expect Objects
  • Case studies
  • Conclusion
• Contributing to cmake-format
  • General Rules
  • Build Systems
  • Sidecar Tests
  • Debugging
  • Pull Requests
  • Copyright Assignment
  • Un-Assigned contributions
• Release Process
  • Update master
  • Cut a Release
• Release Notes
  • v0.6 series
  • v0.5 series
  • v0.4 series
• Changelog
  • v0.6 series
  • v0.5 series
  • v0.4 series
  • v0.3 series
  • v0.2 series
• cmake_format package
  • Module contents
  • Submodules
  • cmake_format.configuration module
  • cmake_format.common module
  • cmake_format.lexer module
  • cmake_format.markup module
  • cmake_format.parse module
  • cmake_format.parse.funs module

Indices and tables

• Index
• Module Index
• Search Page