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

Đang mở
  • Có gì không ổn?
#25 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
55/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
cmake, python
Lĩnh vực
tooling

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Python
Star
4
Fork
1
Merge trung bình
10 giờ 41 phút
Pull request đã merge (30 ngày)
79

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của cpp-best-practices/project_validator

Tất cả issue của cpp-best-practices/project_validator

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.