Add `compile-commands` check: compile_commands.json is exported

Aberta
#23 3 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
74/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
cmake, python
Domínio
build-system, tooling

Direção de pesquisa

Start by reading the checks and tests in this Python project to see how existing checks detect settings in CMake files, presets, and CI. Add a warning-level compile-commands check that passes when CMAKE_EXPORT_COMPILE_COMMANDS is enabled; use the linked StandardProjectSettings.cmake as the reference. Done means tests cover enabled and missing settings across the stated sources.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

Check

New check compile-commands.

Passes when CMAKE_EXPORT_COMPILE_COMMANDS is enabled in CMake files, presets, or CI, so clang-based tooling (clang-tidy, clangd, IDEs) can be used.
Fails otherwise. (Warning-level.)

Reference

set(CMAKE_EXPORT_COMPILE_COMMANDS ON) in cmake/StandardProjectSettings.cmake.


Part of #9. Reference implementation: cpp-best-practices/cmake_template.


Triage (language-neutral review): still valid for C/C++. Meson always writes compile_commands.json, so Meson projects pass automatically. Python and Rust: SKIP. Unblocked: build-system rules exist now (#59); this is a rule on the CMake (and Meson) BuildSystem.

Linguagem predominante
Python
Estrelas
4
Forks
1
Merge médio
10h 41min
PRs com merge (30d)
79

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de cpp-best-practices/project_validator

Todas as issues de cpp-best-practices/project_validator

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.