Add `top-level-guard` check: the project can be consumed as a subproject

Abierto
#25 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
55/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
cmake, python
Área
tooling

Línea de trabajo

Start by reading the check implementations and tests in the project validator, then compare their conventions with the referenced CMakeLists.txt and ProjectOptions.cmake. Add a warning-level top-level-guard check that recognizes both stated guard idioms and reports when tests or developer-only options lack a guard; done when the check passes and fails as described.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Check

New check top-level-guard.

Passes when tests and developer-only options (warnings as errors, sanitizers, static analysis) are conditioned on PROJECT_IS_TOP_LEVEL (or the older CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR idiom), so the project works with FetchContent / CPM / add_subdirectory.
Fails otherwise. (Warning-level.)

Reference

if(NOT PROJECT_IS_TOP_LEVEL) in CMakeLists.txt and ProjectOptions.cmake.


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


Triage (language-neutral review): still valid for C/C++. Add a Meson rule: tests and developer-only options guarded by meson.is_subproject(). Python and Rust: SKIP. Unblocked: build-system rules exist now (#59); this is a rule on the CMake (and Meson) BuildSystem.

Lenguaje dominante
Python
Estrellas
4
Forks
1
Merge medio
10 h 41 min
PR fusionados (30 d)
79

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de cpp-best-practices/project_validator

Todos los issues de cpp-best-practices/project_validator

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.