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

オープン
#25 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
55/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
cmake, python
領域
tooling

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
Python
スター
4
フォーク
1
平均マージ
10時間 41分
マージ済み PR(30日)
79

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

cpp-best-practices/project_validator のほかの issue

cpp-best-practices/project_validator の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。