diff options
| author | Leitwolf11 | 2026-11-01 22:16:14 +0300 |
|---|---|---|
| committer | Leitwolf11 | 2026-11-01 22:16:14 +0300 |
| commit | da3c9d0880dbd4a74e0e43f092d10f5ae42c5043 (patch) | |
| tree | 4676a526585dbb0e2f6d8c9c18978ed01092c2e2 /tools/RepositoryReport.hpp | |
| parent | 241b5567d09d59e82bff18287c32ada480deb8c0 (diff) | |
| download | catch3-da3c9d0880dbd4a74e0e43f092d10f5ae42c5043.tar.gz | |
Move the tools from Python to C++17 and Bazel
The scripts in use become programs run with `bazelisk run //tools:<tool>`,
and arguments follow `--`:
amalgamate the single-file distribution; --check only compares it
check licenses, convenience headers, header guards, file names,
versions and whether the distribution is up to date
third-party compares third_party/ with its archives, or writes it
version prints the version, or moves every place that states it
release-notes prints a section of the release notes
repo-info reports the checkout and the tools on PATH; --json writes
it through yyjson, with the fields of Tala's repo-info
amalgamate writes what the Python script wrote, byte for byte, except for
the time of generation. That line is gone so that the output is
deterministic and --check can compare it.
MODULE.bazel now pins the archives of third_party/ by version and sha256,
so Bazel fetches and checks them instead of a tool of ours, and Renovate
reads the versions there.
Scripts nobody used are gone: fixWhitespace, updateDocumentSnippets,
buildAndTest, and updateDocumentToC, which rewrote unrelated documents.
CheckConvenienceHeaders leaves CTest, since //tools:check runs it in CI.
The Python of tests/TestScripts stays: those are tests, not tools.
Diffstat (limited to 'tools/RepositoryReport.hpp')
| -rw-r--r-- | tools/RepositoryReport.hpp | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/tools/RepositoryReport.hpp b/tools/RepositoryReport.hpp new file mode 100644 index 00000000..83ef85b7 --- /dev/null +++ b/tools/RepositoryReport.hpp @@ -0,0 +1,47 @@ +// Copyright (c) 2026 Progmasoft. +// SPDX-License-Identifier: MPL-2.0 WITH AdditionRef-Progmasoft-Exception-2.0 +#pragma once + +#include <filesystem> +#include <string> +#include <vector> + +namespace Progmasoft::Catch3::Tools +{ + /// A program the checkout builds with, and where PATH finds it. + struct ToolInfo final + { + std::string Name; + std::string Path; + bool Available = false; + }; + + /// The state of a checkout and of the machine around it. It holds no + /// environment, remote URL or credential. + struct RepositoryReport final + { + std::string Root; + std::string Os; + std::string Architecture; + std::string Version; + std::string EngineVersion; + std::string Branch; + std::string Revision; + bool Dirty = false; + std::string GitError; + std::vector<ToolInfo> Tools; + }; + + /// Reads the checkout at `root`, without changing anything. + [[nodiscard]] RepositoryReport + CollectRepositoryReport(const std::filesystem::path &root); + + /// The report as lines for a person. + [[nodiscard]] std::string + FormatReport(const RepositoryReport &report); + + /// The report as JSON: empty texts are left out, the rest has the names + /// of Tala's repo-info, in camelCase. + [[nodiscard]] std::string + ReportToJson(const RepositoryReport &report); +} // namespace Progmasoft::Catch3::Tools |