Skip to content

Added pre-commit hooks support (#1138) #1149

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

Open
gvatsal60 wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Added pre-commit hooks support (#1138) #1149

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0425c3a
Resolved Merge Conflicts
gvatsal60 Sep 18, 2025
963b43a
Removed default options
gvatsal60 Sep 18, 2025
8278513
Merge branch 'main' into feature/pre-commit-hook_support_1138
gvatsal60 Sep 18, 2025
2c153b1
Merge branch 'main' into feature/pre-commit-hook_support_1138
gvatsal60 Oct 27, 2025
2180b36
Merge branch 'main' into feature/pre-commit-hook_support_1138
gvatsal60 Dec 29, 2025
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
70 changes: 70 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
repos:
Copy link

Copilot AI Dec 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The indentation at the start of this file is incorrect. The "repos:" key should have no leading spaces. Currently, it has 2 leading spaces which will cause YAML parsing errors.

Copilot uses AI. Check for mistakes.
# Syncs pre-commit dependencies with the latest versions.
- repo: https://github.com/mxr/sync-pre-commit-deps
rev: "v0.0.1"
Copy link

Copilot AI Dec 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The version for the sync-pre-commit-deps hook appears to be very old (v0.0.1). This is the initial release and may not be stable or feature-complete. Consider using a more recent stable version to ensure better reliability and functionality.

Suggested change
rev: "v0.0.1"
rev: "v0.0.5"

Copilot uses AI. Check for mistakes.
hooks:
- id: sync-pre-commit-deps
# Pre-commit hooks for general file checks
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: "v5.0.0"
hooks:
- id: check-added-large-files
- id: check-case-conflict
# - id: check-executables-have-shebangs
# - id: check-json
# - id: check-shebang-scripts-are-executable
# - id: check-symlinks
# - id: check-vcs-permalinks
# - id: check-yaml
# - id: destroyed-symlinks
# - id: detect-private-key
Copy link

Copilot AI Dec 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The commented-out detect-private-key hook should be enabled to prevent accidentally committing sensitive information like private keys to the repository. This is a critical security feature that should be active, especially in a project that will be shared or made public.

Suggested change
# - id: detect-private-key
- id: detect-private-key

Copilot uses AI. Check for mistakes.
# - id: double-quote-string-fixer
# - id: end-of-file-fixer
# - id: fix-byte-order-marker
# - id: mixed-line-ending
# - id: pretty-format-json
# args: [--autofix, --no-sort-keys]
# - id: trailing-whitespace
Comment on lines +22 to +27
Copy link

Copilot AI Dec 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The end-of-file-fixer and trailing-whitespace hooks should be enabled to maintain consistent formatting across the codebase. These are low-impact hooks that automatically fix common formatting issues and help maintain code quality standards without requiring significant modifications.

Suggested change
# - id: end-of-file-fixer
# - id: fix-byte-order-marker
# - id: mixed-line-ending
# - id: pretty-format-json
# args: [--autofix, --no-sort-keys]
# - id: trailing-whitespace
- id: end-of-file-fixer
# - id: fix-byte-order-marker
# - id: mixed-line-ending
# - id: pretty-format-json
# args: [--autofix, --no-sort-keys]
- id: trailing-whitespace

Copilot uses AI. Check for mistakes.
# ShellCheck hook for linting shell scripts
# - repo: https://github.com/shellcheck-py/shellcheck-py
# rev: "v0.10.0.1"
# hooks:
# - id: shellcheck
# name: shellcheck
# description: This hook runs shellcheck for linting shell scripts
# Bashate hook for linting shell scripts
# - repo: https://github.com/openstack/bashate
# rev: "2.1.1"
# hooks:
# - id: bashate
# name: bashate
# description: This hook runs bashate for linting shell scripts
# entry: bashate
# language: python
# types: [shell]
# Actionlint for linting GitHub Actions YAML files
# - repo: https://github.com/rhysd/actionlint
# rev: "v1.7.3"
# hooks:
# - id: actionlint
# Yamlfmt for formatting YAML files
# - repo: https://github.com/google/yamlfmt
# rev: "v0.13.0"
# hooks:
# - id: yamlfmt
# Codespell for detecting common misspellings in code
# - repo: https://github.com/codespell-project/codespell
# rev: "v2.3.0"
# hooks:
# - id: codespell
# Gitleaks for detecting secrets in Git repositories
# - repo: https://github.com/gitleaks/gitleaks
# rev: "v8.19.3"
# hooks:
# - id: gitleaks
# Talisman for pre-commit Git hooks to detect sensitive files
# - repo: https://github.com/thoughtworks/talisman
# rev: "v1.32.0"
# hooks:
# - id: talisman-commit
# entry: cmd --githook pre-commit