Skip to content

Feat/allow cmake agnostic use by oneshot manual script #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
devmarkusb merged 3 commits into from
Apr 1, 2026
Merged

Feat/allow cmake agnostic use by oneshot manual script #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a7a1230
Refactor pre-commit setup: replace CMake logic with Python script, im…
Mar 29, 2026
79d56b7
Merge remote-tracking branch 'origin/main' into feat/allow-cmake-agno…
Apr 1, 2026
415ad39
Clarify pre-commit behavior in README.md
Apr 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions CMakePresets.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,10 @@
"hidden": true,
"inherits": [".mbpc-base"],
"generator": "Ninja",
"description": "Ninja — fast, predictable, IDE-friendly"
"description": "Ninja — fast, predictable, IDE-friendly (needs `ninja` on PATH; CLion may omit Homebrew — see PATH below)",
"environment": {
"PATH": "/opt/homebrew/bin:/usr/local/bin:$penv{PATH}"
}
},
{
"name": ".mbpc-make",
Expand All @@ -38,7 +41,7 @@
{
"name": "default",
"displayName": "Default (Ninja, Debug)",
"description": "Everyday configure: Ninja + Debug-ish flags (harmless for LANGUAGES NONE)",
"description": "Everyday configure: Ninja + Debug. If configure fails (missing Ninja), install `ninja` or use preset `unix-makefiles`.",
"inherits": [".mbpc-ninja"],
"cacheVariables": {
"CMAKE_BUILD_TYPE": "Debug"
Expand All @@ -47,7 +50,7 @@
{
"name": "release",
"displayName": "Release",
"description": "Release build type (useful if you later add compiled targets)",
"description": "Release build type (Ninja). If Ninja is not found, use `unix-makefiles`.",
"inherits": [".mbpc-ninja"],
"cacheVariables": {
"CMAKE_BUILD_TYPE": "Release"
Expand All @@ -56,7 +59,7 @@
{
"name": "dev-verbose",
"displayName": "Dev — verbose CMake",
"description": "Louder configure output while hacking on cmake/mb-pre-commit.cmake",
"description": "Louder configure output (inherits Ninja default). Use `unix-makefiles` if Ninja is unavailable.",
"inherits": ["default"],
"cacheVariables": {
"CMAKE_MESSAGE_LOG_LEVEL": "VERBOSE"
Expand All @@ -65,7 +68,7 @@
{
"name": "ci",
"displayName": "CI / automation",
"description": "Strict warnings, deterministic env; pair with workflow ci",
"description": "Strict warnings, deterministic env; pair with workflow ci (Ninja + prepended PATH like default)",
"inherits": [".mbpc-ninja"],
"cacheVariables": {
"CMAKE_BUILD_TYPE": "Release",
Expand Down
14 changes: 11 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@
[![CMake][badge-cmake]][cmake-presets]
[![Release][badge-release]][releases]

The kind of pre-commit out-of-the-box setup everybody wants, cmake users exclusively for now.
The kind of pre-commit out-of-the-box setup everybody wants,
making cmake users especially happy, but also usable via one-shot
`$ ./python/mb-pre-commit-setup.py`.

By default, you get pre-commit behavior without annoying
failing commits and manual amends or separate formatting
commits.
failing commits (except markdown or things not fixable automatically)
and manual amends or separate formatting commits.

## Usage, quick start

Expand All @@ -29,6 +31,12 @@ FetchContent_MakeAvailable(mb_pre_commit)
mb_pre_commit_setup()
```

Or without CMake:

```
./python/mb-pre-commit-setup.py
```

### What it does, and alternative setup

`FetchContent_MakeAvailable` runs this dependency’s root [`CMakeLists.txt`](CMakeLists.txt), which pulls in
Expand Down
251 changes: 34 additions & 217 deletions cmake/mb-pre-commit.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,6 @@ function(mb_pre_commit_setup)
)
endif()

find_package(Git QUIET)
find_package(Python3 REQUIRED COMPONENTS Interpreter)

# Inside function(), CMAKE_CURRENT_LIST_DIR is the caller's file — use the directory of
Expand All @@ -83,54 +82,27 @@ function(mb_pre_commit_setup)
else()
set(_tool_module_dir "${_MB_PRE_COMMIT_CMAKE_DIR}")
endif()

set(_configs_root "${_tool_module_dir}/../configs")
set(_hook_template "${_tool_module_dir}/pre-commit.in")
set(_generated_hook "${PC_PROJECT_BINARY_DIR}/pre-commit")

set(_git_dir "${PC_PROJECT_SOURCE_DIR}/.git")
set(_git_hooks_dir "${_git_dir}/hooks")
set(_hook_target "${_git_hooks_dir}/pre-commit")

if(WIN32)
set(_venv_python "${PC_PRE_COMMIT_VENV_DIR}/Scripts/python.exe")
else()
set(_venv_python "${PC_PRE_COMMIT_VENV_DIR}/bin/python3")
endif()

if(
NOT GIT_FOUND
OR NOT EXISTS "${_git_dir}"
OR NOT EXISTS "${_git_hooks_dir}"
get_filename_component(
_setup_script
"${_tool_module_dir}/../python/mb-pre-commit-setup.py"
ABSOLUTE
)
message(
STATUS
"Git checkout not detected in ${PC_PROJECT_SOURCE_DIR}; skipping pre-commit setup"
)
return()
endif()

if(NOT EXISTS "${_hook_template}")
if(NOT EXISTS "${_setup_script}")
message(
FATAL_ERROR
"mb_pre_commit_setup: hook template not found: ${_hook_template}"
)
endif()

if(
NOT PC_PRE_COMMIT_MODE STREQUAL "CUSTOM"
AND NOT PC_PRE_COMMIT_MODE STREQUAL "NATIVE"
)
message(
FATAL_ERROR
"mb_pre_commit_setup: invalid PRE_COMMIT_MODE='${PC_PRE_COMMIT_MODE}', expected CUSTOM or NATIVE"
"mb_pre_commit_setup: setup script not found: ${_setup_script}"
)
endif()

# Re-run configure if the hook template or shipped example configs change.
set_property(
DIRECTORY
APPEND
PROPERTY CMAKE_CONFIGURE_DEPENDS "${_hook_template}"
PROPERTY CMAKE_CONFIGURE_DEPENDS "${_hook_template}" "${_setup_script}"
)
# CONFIGURE_DEPENDS registers these files with the build tool so CMake re-runs when
# they change. Do not also append them to CMAKE_CONFIGURE_DEPENDS — that duplicates
Expand All @@ -143,195 +115,40 @@ function(mb_pre_commit_setup)
"${_configs_root}/v*/.markdownlint.yaml"
)

# Forward-slash path works better in generated shell script, including Git Bash on Windows.
file(TO_CMAKE_PATH "${_venv_python}" PRE_COMMIT_VENV_PYTHON_FOR_HOOK)

configure_file("${_hook_template}" "${_generated_hook}" @ONLY)

if(NOT EXISTS "${_venv_python}")
message(
STATUS
"Creating Python virtual environment for pre-commit: ${PC_PRE_COMMIT_VENV_DIR}"
)
execute_process(
COMMAND "${Python3_EXECUTABLE}" -m venv "${PC_PRE_COMMIT_VENV_DIR}"
RESULT_VARIABLE _venv_result
)
if(NOT _venv_result EQUAL 0)
message(
FATAL_ERROR
"Failed to create Python virtual environment: ${PC_PRE_COMMIT_VENV_DIR}"
)
endif()
endif()

set(_install_pre_commit TRUE)
execute_process(
COMMAND "${_venv_python}" -m pre_commit --version
OUTPUT_VARIABLE _pc_version_out
ERROR_VARIABLE _pc_version_err
RESULT_VARIABLE _pc_version_res
OUTPUT_STRIP_TRAILING_WHITESPACE
ERROR_STRIP_TRAILING_WHITESPACE
set(_setup_args
"${Python3_EXECUTABLE}"
"${_setup_script}"
--project-source-dir
"${PC_PROJECT_SOURCE_DIR}"
--project-binary-dir
"${PC_PROJECT_BINARY_DIR}"
--mode
"${PC_PRE_COMMIT_MODE}"
--version
"${PC_PRE_COMMIT_VERSION}"
--venv-dir
"${PC_PRE_COMMIT_VENV_DIR}"
--tool-root
"${_tool_module_dir}"
--python
"${Python3_EXECUTABLE}"
)

if(_pc_version_res EQUAL 0)
string(
REGEX MATCH "[0-9]+\\.[0-9]+\\.[0-9]+"
_installed_version
"${_pc_version_out}"
)
if(_installed_version STREQUAL "${PC_PRE_COMMIT_VERSION}")
set(_install_pre_commit FALSE)
endif()
if(NOT PC_PRE_COMMIT_INSTALL_EXAMPLE_CONFIG)
list(APPEND _setup_args --no-install-example-config)
endif()

if(_install_pre_commit)
message(
STATUS
"Installing pre-commit ${PC_PRE_COMMIT_VERSION} into ${PC_PRE_COMMIT_VENV_DIR}"
)
execute_process(
COMMAND
"${_venv_python}" -m pip install --upgrade pip
"pre-commit==${PC_PRE_COMMIT_VERSION}"
RESULT_VARIABLE _pip_result
)
if(NOT _pip_result EQUAL 0)
message(
FATAL_ERROR
"Failed to install pre-commit ${PC_PRE_COMMIT_VERSION}"
)
endif()
else()
message(
STATUS
"pre-commit ${PC_PRE_COMMIT_VERSION} already available in ${PC_PRE_COMMIT_VENV_DIR}"
)
endif()

# Match pre-commit's guard: unset `core.hooksPath`, otherwise `.git/hooks` is ignored.
execute_process(
COMMAND "${GIT_EXECUTABLE}" config core.hooksPath
WORKING_DIRECTORY "${PC_PROJECT_SOURCE_DIR}"
OUTPUT_VARIABLE _pc_hooks_path_out
ERROR_QUIET
OUTPUT_STRIP_TRAILING_WHITESPACE
)
string(STRIP "${_pc_hooks_path_out}" _pc_hooks_path_stripped)
if(NOT _pc_hooks_path_stripped STREQUAL "")
execute_process(COMMAND ${_setup_args} RESULT_VARIABLE _mb_pc_setup_result)
if(NOT _mb_pc_setup_result EQUAL 0)
message(
FATAL_ERROR
"Cowardly refusing to install hooks with `core.hooksPath` set.\n"
"(As it wouldn't make sense to install something that won't be used.)\n"
"Hint: `git config --unset-all core.hooksPath`"
)
endif()

if(PC_PRE_COMMIT_MODE STREQUAL "CUSTOM")
file(COPY_FILE "${_generated_hook}" "${_hook_target}" ONLY_IF_DIFFERENT)

if(NOT WIN32)
file(
CHMOD "${_hook_target}"
PERMISSIONS
OWNER_READ
OWNER_WRITE
OWNER_EXECUTE
GROUP_READ
GROUP_EXECUTE
WORLD_READ
WORLD_EXECUTE
)
endif()

message(STATUS "Installed custom pre-commit hook: ${_hook_target}")
elseif(PC_PRE_COMMIT_MODE STREQUAL "NATIVE")
execute_process(
COMMAND
"${_venv_python}" -m pre_commit install --install-hooks
--hook-type pre-commit
WORKING_DIRECTORY "${PC_PROJECT_SOURCE_DIR}"
RESULT_VARIABLE _install_result
)
if(NOT _install_result EQUAL 0)
message(FATAL_ERROR "pre-commit install failed")
endif()

message(
STATUS
"Installed native pre-commit hook in ${PC_PROJECT_SOURCE_DIR}"
"mb_pre_commit_setup: mb-pre-commit-setup.py failed (exit ${_mb_pc_setup_result})"
)
endif()

if(PC_PRE_COMMIT_INSTALL_EXAMPLE_CONFIG)
string(
REGEX MATCH "^([0-9]+)"
_pc_major_match
"${PC_PRE_COMMIT_VERSION}"
)
if(NOT _pc_major_match)
message(
FATAL_ERROR
"mb_pre_commit_setup: could not parse major from PRE_COMMIT_VERSION='${PC_PRE_COMMIT_VERSION}'"
)
endif()
set(_pc_major "${CMAKE_MATCH_1}")

file(
GLOB _versioned_config_dirs
LIST_DIRECTORIES true
"${_configs_root}/v*"
)
set(_best_config_n 0)
set(_best_config_src "")
foreach(_vdir ${_versioned_config_dirs})
get_filename_component(_vname "${_vdir}" NAME)
if(_vname MATCHES "^v([0-9]+)$")
set(_vn "${CMAKE_MATCH_1}")
if(
_vn GREATER_EQUAL 1
AND _vn LESS_EQUAL _pc_major
AND _vn GREATER _best_config_n
)
set(_candidate "${_vdir}/.pre-commit-config.yaml")
if(EXISTS "${_candidate}")
set(_best_config_n "${_vn}")
set(_best_config_src "${_candidate}")
endif()
endif()
endif()
endforeach()

if(_best_config_src)
set(_config_dest "${PC_PROJECT_SOURCE_DIR}/.pre-commit-config.yaml")
configure_file("${_best_config_src}" "${_config_dest}" COPYONLY)
message(
STATUS
"Installed example pre-commit config (configs/v${_best_config_n}) -> ${_config_dest}"
)

get_filename_component(
_best_config_dir
"${_best_config_src}"
DIRECTORY
)
set(_markdownlint_src "${_best_config_dir}/.markdownlint.yaml")
if(EXISTS "${_markdownlint_src}")
set(_markdownlint_dest
"${PC_PROJECT_SOURCE_DIR}/.markdownlint.yaml"
)
configure_file(
"${_markdownlint_src}"
"${_markdownlint_dest}"
COPYONLY
)
message(
STATUS
"Installed example markdownlint config (configs/v${_best_config_n}) -> ${_markdownlint_dest}"
)
endif()
endif()
if(WIN32)
set(_venv_python "${PC_PRE_COMMIT_VENV_DIR}/Scripts/python.exe")
else()
set(_venv_python "${PC_PRE_COMMIT_VENV_DIR}/bin/python3")
endif()

# One-word build target: pre-commit on the whole tree (not just staged files).
Expand Down
Loading
Loading