startgit

Static page generator for git repositories

git clone git://git.dimitrijedobrota.com/startgit.git

commit	0146a48f47bd4023c43bb5d026adfabdb8cc7a6e
parent	f2446da3ebe0005dc43f9f8fb9ac5d82f6afd095
author	Dimitrije Dobrota <mail@dimitrijedobrota.com>
date	Sun, 5 Jan 2025 21:26:48 +0100

Iterate over the branches and commits

Diffstat:

M	.clang-tidy	\|	++++++
M	CMakeLists.txt	\|	++++++++--
M	cmake/dev-mode.cmake	\|	-----
D	cmake/docs-ci.cmake	\|	---------------------------------------------------------------------------------
D	cmake/docs.cmake	\|	----------------------------------------------
D	docs/Doxyfile.in	\|	--------------------------------
D	docs/conf.py.in	\|	------
D	docs/pages/about.dox	\|	-------
M	source/main.cpp	\|	+++++++++++++++++++++++++++++++++++++++++++++------

9 files changed, 59 insertions(+), 216 deletions(-)

diff --git a/.clang-tidy b/.clang-tidy

@@ -11,9 +11,15 @@ Checks: "*,\

-llvm-include-order,\

-llvmlibc-*,\

-modernize-use-nodiscard,\

-modernize-use-trailing-return-type,\

-cppcoreguidelines-pro-type-vararg,\

-hicpp-vararg,\

-misc-include-cleaner,\

-misc-non-private-member-variables-in-classes"

WarningsAsErrors: ''

CheckOptions:

- key: 'misc-include-cleaner.IgnoreHeaders'

value: "git2.h"

- key: 'bugprone-argument-comment.StrictMode'

value: 'true'

# Prefer using enum classes with 2 values for parameters instead of bools

diff --git a/CMakeLists.txt b/CMakeLists.txt

@@ -4,7 +4,7 @@ include(cmake/prelude.cmake)

project(

startgit

VERSION 0.1.0

VERSION 0.1.1

DESCRIPTION "Static page generator for git repositories"

HOMEPAGE_URL "https://git.dimitrijedobrota.com/stargit.git"

LANGUAGES CXX

@@ -13,6 +13,10 @@ project(

include(cmake/project-is-top-level.cmake)

include(cmake/variables.cmake)

# ---- Declare dependencies ----

find_package(git2wrap CONFIG REQUIRED)

# ---- Declare library ----

add_library(

@@ -20,6 +24,8 @@ add_library(

source/lib.cpp

)

target_link_libraries(startgit_lib PUBLIC git2wrap::git2wrap)

target_include_directories(

startgit_lib ${warning_guard}

PUBLIC

@@ -37,7 +43,7 @@ set_property(TARGET startgit_exe PROPERTY OUTPUT_NAME startgit)

target_compile_features(startgit_exe PRIVATE cxx_std_20)

target_link_libraries(startgit_exe PRIVATE startgit_lib)

target_link_libraries(startgit_exe PRIVATE git2wrap startgit_lib)

# ---- Install rules ----

diff --git a/cmake/dev-mode.cmake b/cmake/dev-mode.cmake

@@ -12,11 +12,6 @@ add_custom_target(

)

add_dependencies(run-exe startgit_exe)

option(BUILD_MCSS_DOCS "Build documentation using Doxygen and m.css" OFF)

if(BUILD_MCSS_DOCS)

include(cmake/docs.cmake)

endif()

option(ENABLE_COVERAGE "Enable coverage support separate from CTest's" OFF)

if(ENABLE_COVERAGE)

include(cmake/coverage.cmake)

diff --git a/cmake/docs-ci.cmake b/cmake/docs-ci.cmake

@@ -1,112 +0,0 @@

cmake_minimum_required(VERSION 3.14)

foreach(var IN ITEMS PROJECT_BINARY_DIR PROJECT_SOURCE_DIR)

if(NOT DEFINED "${var}")

message(FATAL_ERROR "${var} must be defined")

endif()

endforeach()

set(bin "${PROJECT_BINARY_DIR}")

set(src "${PROJECT_SOURCE_DIR}")

# ---- Dependencies ----

set(mcss_SOURCE_DIR "${bin}/docs/.ci")

if(NOT IS_DIRECTORY "${mcss_SOURCE_DIR}")

file(MAKE_DIRECTORY "${mcss_SOURCE_DIR}")

file(

DOWNLOAD

https://github.com/friendlyanon/m.css/releases/download/release-1/mcss.zip

"${mcss_SOURCE_DIR}/mcss.zip"

STATUS status

EXPECTED_MD5 00cd2757ebafb9bcba7f5d399b3bec7f

)

if(NOT status MATCHES "^0;")

message(FATAL_ERROR "Download failed with ${status}")

endif()

execute_process(

COMMAND "${CMAKE_COMMAND}" -E tar xf mcss.zip

WORKING_DIRECTORY "${mcss_SOURCE_DIR}"

RESULT_VARIABLE result

)

if(NOT result EQUAL "0")

message(FATAL_ERROR "Extraction failed with ${result}")

endif()

file(REMOVE "${mcss_SOURCE_DIR}/mcss.zip")

endif()

find_program(Python3_EXECUTABLE NAMES python3 python)

if(NOT Python3_EXECUTABLE)

message(FATAL_ERROR "Python executable was not found")

endif()

# ---- Process project() call in CMakeLists.txt ----

file(READ "${src}/CMakeLists.txt" content)

string(FIND "${content}" "project(" index)

if(index EQUAL "-1")

message(FATAL_ERROR "Could not find \"project(\"")

endif()

string(SUBSTRING "${content}" "${index}" -1 content)

string(FIND "${content}" "\n)\n" index)

if(index EQUAL "-1")

message(FATAL_ERROR "Could not find \"\\n)\\n\"")

endif()

string(SUBSTRING "${content}" 0 "${index}" content)

file(WRITE "${bin}/docs-ci.project.cmake" "docs_${content}\n)\n")

macro(list_pop_front list out)

list(GET "${list}" 0 "${out}")

list(REMOVE_AT "${list}" 0)

endmacro()

function(docs_project name)

cmake_parse_arguments(PARSE_ARGV 1 "" "" "VERSION;DESCRIPTION;HOMEPAGE_URL" LANGUAGES)

set(PROJECT_NAME "${name}" PARENT_SCOPE)

if(DEFINED _VERSION)

set(PROJECT_VERSION "${_VERSION}" PARENT_SCOPE)

string(REGEX MATCH "^[0-9]+(\\.[0-9]+)*" versions "${_VERSION}")

string(REPLACE . ";" versions "${versions}")

set(suffixes MAJOR MINOR PATCH TWEAK)

while(NOT versions STREQUAL "" AND NOT suffixes STREQUAL "")

list_pop_front(versions version)

list_pop_front(suffixes suffix)

set("PROJECT_VERSION_${suffix}" "${version}" PARENT_SCOPE)

endwhile()

endif()

if(DEFINED _DESCRIPTION)

set(PROJECT_DESCRIPTION "${_DESCRIPTION}" PARENT_SCOPE)

endif()

if(DEFINED _HOMEPAGE_URL)

set(PROJECT_HOMEPAGE_URL "${_HOMEPAGE_URL}" PARENT_SCOPE)

endif()

endfunction()

include("${bin}/docs-ci.project.cmake")

# ---- Generate docs ----

if(NOT DEFINED DOXYGEN_OUTPUT_DIRECTORY)

set(DOXYGEN_OUTPUT_DIRECTORY "${bin}/docs")

endif()

set(out "${DOXYGEN_OUTPUT_DIRECTORY}")

foreach(file IN ITEMS Doxyfile conf.py)

configure_file("${src}/docs/${file}.in" "${bin}/docs/${file}" @ONLY)

endforeach()

set(mcss_script "${mcss_SOURCE_DIR}/documentation/doxygen.py")

set(config "${bin}/docs/conf.py")

file(REMOVE_RECURSE "${out}/html" "${out}/xml")

execute_process(

COMMAND "${Python3_EXECUTABLE}" "${mcss_script}" "${config}"

WORKING_DIRECTORY "${bin}/docs"

RESULT_VARIABLE result

)

if(NOT result EQUAL "0")

message(FATAL_ERROR "m.css returned with ${result}")

endif()

diff --git a/cmake/docs.cmake b/cmake/docs.cmake

@@ -1,46 +0,0 @@

# ---- Dependencies ----

set(extract_timestamps "")

if(CMAKE_VERSION VERSION_GREATER_EQUAL "3.24")

set(extract_timestamps DOWNLOAD_EXTRACT_TIMESTAMP YES)

endif()

include(FetchContent)

FetchContent_Declare(

mcss URL

https://github.com/friendlyanon/m.css/releases/download/release-1/mcss.zip

URL_MD5 00cd2757ebafb9bcba7f5d399b3bec7f

SOURCE_DIR "${PROJECT_BINARY_DIR}/mcss"

UPDATE_DISCONNECTED YES

${extract_timestamps}

)

FetchContent_MakeAvailable(mcss)

find_package(Python3 3.6 REQUIRED)

# ---- Declare documentation target ----

set(

DOXYGEN_OUTPUT_DIRECTORY "${PROJECT_BINARY_DIR}/docs"

CACHE PATH "Path for the generated Doxygen documentation"

)

set(working_dir "${PROJECT_BINARY_DIR}/docs")

foreach(file IN ITEMS Doxyfile conf.py)

configure_file("docs/${file}.in" "${working_dir}/${file}" @ONLY)

endforeach()

set(mcss_script "${mcss_SOURCE_DIR}/documentation/doxygen.py")

set(config "${working_dir}/conf.py")

add_custom_target(

docs

COMMAND "${CMAKE_COMMAND}" -E remove_directory

"${DOXYGEN_OUTPUT_DIRECTORY}/html"

"${DOXYGEN_OUTPUT_DIRECTORY}/xml"

COMMAND "${Python3_EXECUTABLE}" "${mcss_script}" "${config}"

COMMENT "Building documentation using Doxygen and m.css"

WORKING_DIRECTORY "${working_dir}"

VERBATIM

)

diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in

@@ -1,32 +0,0 @@

# Configuration for Doxygen for use with CMake

# Only options that deviate from the default are included

# To create a new Doxyfile containing all available options, call `doxygen -g`

# Get Project name and version from CMake

PROJECT_NAME = "@PROJECT_NAME@"

PROJECT_NUMBER = "@PROJECT_VERSION@"

# Add sources

INPUT = "@PROJECT_SOURCE_DIR@/README.md" "@PROJECT_SOURCE_DIR@/include" "@PROJECT_SOURCE_DIR@/source" "@PROJECT_SOURCE_DIR@/docs/pages"

EXTRACT_ALL = YES

RECURSIVE = YES

OUTPUT_DIRECTORY = "@DOXYGEN_OUTPUT_DIRECTORY@"

# Use the README as a main page

USE_MDFILE_AS_MAINPAGE = "@PROJECT_SOURCE_DIR@/README.md"

# set relative include paths

FULL_PATH_NAMES = YES

STRIP_FROM_PATH = "@PROJECT_SOURCE_DIR@/include" "@PROJECT_SOURCE_DIR@"

STRIP_FROM_INC_PATH =

# We use m.css to generate the html documentation, so we only need XML output

GENERATE_XML = YES

GENERATE_HTML = NO

GENERATE_LATEX = NO

XML_PROGRAMLISTING = NO

CREATE_SUBDIRS = NO

# Include all directories, files and namespaces in the documentation

# Disable to include only explicitly documented objects

M_SHOW_UNDOCUMENTED = YES

diff --git a/docs/conf.py.in b/docs/conf.py.in

@@ -1,6 +0,0 @@

DOXYFILE = 'Doxyfile'

LINKS_NAVBAR1 = [

(None, 'pages', [(None, 'about')]),

(None, 'namespaces', []),

]

diff --git a/docs/pages/about.dox b/docs/pages/about.dox

@@ -1,7 +0,0 @@

/**

* @page about About

* @section about-doxygen Doxygen documentation

* This page is auto generated using

* <a href="https://www.doxygen.nl/">Doxygen</a>, making use of some useful

* <a href="https://www.doxygen.nl/manual/commands.html">special commands</a>.

diff --git a/source/main.cpp b/source/main.cpp

@@ -1,12 +1,51 @@

#include <format>

#include <iostream>

#include <string>

#include "lib.hpp"

#include <git2.h>

#include <git2wrap/error.hpp>

#include <git2wrap/libgit2.hpp>

#include <git2wrap/object.hpp>

#include <git2wrap/repository.hpp>

#include <git2wrap/revwalk.hpp>

#include <git2wrap/signature.hpp>

auto main() -> int

int main()

{

auto const lib = library {};

auto const message = "Hello from " + lib.name + "!";

std::cout << message << '\n';

try {

using namespace git2wrap; // NOLINT

const libgit2 libgit;

repository repo = repository::open(

"../maintain/stellar", GIT_REPOSITORY_OPEN_NO_SEARCH, nullptr);

for (auto it = repo.branch_begin(GIT_BRANCH_LOCAL); it != repo.branch_end();

++it)

{

const object obj = repo.revparse(it->get_name().c_str());

std::cout << it->get_name() << " " << obj.get_id() << '\n';

revwalk rwalk(repo);

rwalk.push(obj.get_id());

while (const auto commit = rwalk.next()) {

std::cout << std::format("{}: {} ({})\n",

commit.get_time(),

commit.get_summary(),

commit.get_author().get_name());

}

break;

}

} catch (const git2wrap::error& err) {

std::cerr << std::format("({}:{}) Error {}/{}: {}\n",

err.get_file(),

err.get_line(),

err.get_error(),

err.get_klass(),

err.get_message());

}

return 0;

}