mirror of
https://github.com/kvcache-ai/ktransformers.git
synced 2026-04-20 14:29:22 +00:00
aef6672dd8
* [feat]: update kt-kernel hooks and add contribution guide * [docs]: add contributing guide * [style]: format the python file and cpp file in kt-kernel
69 lines
2.5 KiB
Bash
Executable File
69 lines
2.5 KiB
Bash
Executable File
#!/usr/bin/bash
|
|
# Pre-commit hook: run clang-format via kt-kernel's CMake 'format' target and Black for Python
|
|
# before allowing commit. If formatting makes changes, stage them and abort so user can review.
|
|
set -euo pipefail
|
|
|
|
REPO_ROOT="$(git rev-parse --show-toplevel)"
|
|
# kt-kernel project directory within the monorepo
|
|
KERNEL_DIR="$REPO_ROOT/kt-kernel"
|
|
BUILD_DIR="$KERNEL_DIR/build"
|
|
FORMAT_TARGET="format"
|
|
CLANG_FORMAT_BIN="${CLANG_FORMAT_BIN:-clang-format}"
|
|
BLACK_BIN="${BLACK_BIN:-black}"
|
|
|
|
# Simple check clang-format present (optional)
|
|
# clang-format optional: if missing, skip C/C++ formatting
|
|
if ! command -v "$CLANG_FORMAT_BIN" >/dev/null 2>&1; then
|
|
echo "[pre-commit] clang-format not found (looked for $CLANG_FORMAT_BIN). Skipping C/C++ format." >&2
|
|
fi
|
|
|
|
# black optional: if missing, skip Python formatting
|
|
if ! command -v "$BLACK_BIN" >/dev/null 2>&1; then
|
|
echo "[pre-commit] black not found (looked for $BLACK_BIN). Skipping Python format." >&2
|
|
fi
|
|
|
|
# Configure kt-kernel build directory if missing (quiet)
|
|
if [ ! -d "$BUILD_DIR" ] || { [ ! -f "$BUILD_DIR/Makefile" ] && [ ! -f "$BUILD_DIR/build.ninja" ]; }; then
|
|
echo "[pre-commit] configuring kt-kernel (cmake) ..." >&2
|
|
cmake -S "$KERNEL_DIR" -B "$BUILD_DIR" >/dev/null
|
|
fi
|
|
|
|
# Run format target (prefer ninja if present)
|
|
# Run clang-format target when available and tool present
|
|
if command -v "$CLANG_FORMAT_BIN" >/dev/null 2>&1; then
|
|
if [ -f "$BUILD_DIR/build.ninja" ]; then
|
|
(cd "$BUILD_DIR" && ninja -k0 "$FORMAT_TARGET" >/dev/null)
|
|
else
|
|
(cd "$BUILD_DIR" && make "$FORMAT_TARGET")
|
|
fi
|
|
fi
|
|
|
|
# Run black on staged python files (or entire repo if you prefer)
|
|
if command -v "$BLACK_BIN" >/dev/null 2>&1; then
|
|
# Run black only on kt-kernel's python and scripts directories
|
|
BLACK_PATHS=""
|
|
if [ -d "$KERNEL_DIR/python" ]; then
|
|
BLACK_PATHS="$BLACK_PATHS $KERNEL_DIR/python"
|
|
fi
|
|
if [ -d "$KERNEL_DIR/scripts" ]; then
|
|
BLACK_PATHS="$BLACK_PATHS $KERNEL_DIR/scripts"
|
|
fi
|
|
if [ -n "$BLACK_PATHS" ]; then
|
|
echo "[pre-commit] running black on:$BLACK_PATHS" >&2
|
|
# shellcheck disable=SC2086
|
|
$BLACK_BIN $BLACK_PATHS
|
|
fi
|
|
fi
|
|
|
|
# Stage any formatting changes for tracked files
|
|
if ! git diff --quiet --exit-code; then
|
|
echo "[pre-commit] Formatting applied; updating index." >&2
|
|
# Add only modified tracked files (exclude untracked new files not staged yet unless user staged them)
|
|
git add -u
|
|
echo "[pre-commit] Re-run git commit to proceed after reviewing changes." >&2
|
|
exit 1
|
|
fi
|
|
|
|
echo "[pre-commit] format OK." >&2
|
|
exit 0
|