jps-pre-commit-utils 1.1.0

Custom pre-commit utility for scanning diffs for debug/test patterns, hardcoded paths, and other configurable checks.

jps-pre-commit-utils

Custom pre-commit utilities for detecting debug/test leftovers, hardcoded paths, and environment-specific code fragments
in Python, Perl, and YAML files before they are committed.
These checks catch issues that are not easily detected by flake8, black, mypy, or bandit.

---

🧩 Features

✅ Scans staged diffs (git diff --cached) before commit
✅ Detects newly added lines containing:

• Debugging and testing statements (e.g., print, sys.exit, pdb.set_trace, logger.debug)
• Hardcoded filesystem paths (e.g., /mnt/synth-genomics3/...)
• Hardcoded environment variables or hostnames
• Inline comments with “test” or “TODO” ✅ Supports Python, Perl, and YAML files
  ✅ Configurable via .my-pre-commit-checks.yaml or ~/.config/my-pre-commit-checks.yaml
  ✅ Integrates easily with manual usage or .pre-commit-config.yaml

---

🧩 Installation

pip install jps-pre-commit-utils

For local development:

git clone [e-mail]:jai-python3/jps-pre-commit-utils.git
cd jps-pre-commit-utils
pip install -e '.[dev]'

---

🧩 Usage

Run manually:

jps-pre-commit-checks

Or integrate with Git pre-commit:

# .git/hooks/pre-commit
#!/bin/bash
python3 -m jps_pre_commit_utils.check_inserted_lines

---

🧩 Example Configuration

Configuration file:
.my-pre-commit-checks.yaml (in repo root)
or
~/.config/my-pre-commit-checks.yaml (global fallback)

# Example configuration for jps-pre-commit-utils
base_paths:
  - /mnt/synth-genomics3
  - /Users
ignore_patterns:
  - /mnt/synth-genomics3/bioinfo/shared/
extra_regexes:
  - "jira/[A-Z]+-[0-9]+"

---

🧩 Example Output

---------------------------------------------------------
🔧 Performing the following checks:
---------------------------------------------------------
• 🐍 Python debug/test statements
• 🐪 Perl debug/test statements
• 📁 Hardcoded absolute paths
• 🧪 Comments containing 'test' or 'testing'
---------------------------------------------------------
Scanning inserted lines ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% • 45/45
---------------------------------------------------------
🔍 Pre-commit inserted-line scan results
---------------------------------------------------------
⚠️  File: src/example.py, Line: 18
    Added line contains pattern: "#[ 	]*.*test"
    → # test
---------------------------------------------------------
⚠️  Total findings: 1
---------------------------------------------------------

---

🧱 Development

Install dependencies for linting, formatting, and testing:

pip install -e '.[dev]'

Run all development checks:

make lint
make test

Build the distribution:

make build

---

🧪 Testing

pytest -v --disable-warnings

---

🚀 Publishing

make publish

This command builds and uploads the package to PyPI via twine.

---

🧾 License

MIT License
© 2025 Jaideep Sundaram

---

🧠 Notes

• The utility is designed for use with Git repositories that follow a Gitflow workflow.
• Configuration is fully customizable; extend .my-pre-commit-checks.yaml to add your own regexes.
• Future versions will include additional checks for breakpoints, asserts, sleep statements, and other runtime risks.

---

🧩 Example Workflow

# Edit a file
echo '# test' >> src/sample.py

# Stage and check
git add src/sample.py
jps-pre-commit-checks

If issues are found, they are listed as warnings.
If none are found, you’ll see:

✅ No issues detected. (0 findings)