dotfiles/.pre-commit-config.yaml at main · serin-varghese/dotfiles · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
# =============================================================================
# Pre-commit Configuration for Data Science Projects
# =============================================================================
# Install: pip install pre-commit
# Setup: pre-commit install
# Run manually: pre-commit run --all-files
# Update hooks: pre-commit autoupdate

repos:
  # =============================================================================
  # General File Checks
  # =============================================================================
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.5.0
    hooks:
      - id: trailing-whitespace
        exclude: '\.md$'  # Allow trailing whitespace in markdown
      - id: end-of-file-fixer
      - id: check-yaml
      - id: check-json
      - id: check-toml
      - id: check-added-large-files
        args: ['--maxkb=10000']  # 10MB max
      - id: check-case-conflict
      - id: check-merge-conflict
      - id: detect-private-key
      - id: mixed-line-ending
        args: ['--fix=lf']
      - id: check-docstring-first
      - id: debug-statements

  # =============================================================================
  # Python Code Formatting with Ruff
  # =============================================================================
  - repo: https://github.com/astral-sh/ruff-pre-commit
    rev: v0.1.9
    hooks:
      # Run the linter
      - id: ruff
        args: ['--fix']
        types_or: [python, pyi, jupyter]
      # Run the formatter
      - id: ruff-format
        types_or: [python, pyi, jupyter]

  # =============================================================================
  # Jupyter Notebook Cleanup
  # =============================================================================
  - repo: https://github.com/kynan/nbstripout
    rev: 0.6.1
    hooks:
      - id: nbstripout
        # Strips output from notebooks before committing
        # Install: pip install nbstripout

  # Alternative: Use nbqa to run tools on notebooks
  # - repo: https://github.com/nbQA-dev/nbQA
  #   rev: 1.7.1
  #   hooks:
  #     - id: nbqa-ruff
  #       args: ['--fix']

  # =============================================================================
  # Security Checks
  # =============================================================================
  - repo: https://github.com/Yelp/detect-secrets
    rev: v1.4.0
    hooks:
      - id: detect-secrets
        args: ['--baseline', '.secrets.baseline']
        exclude: package.lock.json

  # Check for common security issues
  - repo: https://github.com/PyCQA/bandit
    rev: 1.7.5
    hooks:
      - id: bandit
        args: ['-c', 'pyproject.toml']
        additional_dependencies: ['bandit[toml]']
        exclude: '^tests/'

  # =============================================================================
  # Type Checking (Optional - can be slow)
  # =============================================================================
  # - repo: https://github.com/pre-commit/mirrors-mypy
  #   rev: v1.7.1
  #   hooks:
  #     - id: mypy
  #       additional_dependencies: [types-all]
  #       args: ['--ignore-missing-imports']

  # =============================================================================
  # Markdown & Documentation
  # =============================================================================
  - repo: https://github.com/igorshubovych/markdownlint-cli
    rev: v0.38.0
    hooks:
      - id: markdownlint
        args: ['--fix']

  # =============================================================================
  # YAML Formatting
  # =============================================================================
  - repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
    rev: v2.11.0
    hooks:
      - id: pretty-format-yaml
        args: ['--autofix', '--indent', '2']

  # =============================================================================
  # Docker
  # =============================================================================
  - repo: https://github.com/hadolint/hadolint
    rev: v2.12.0
    hooks:
      - id: hadolint-docker
        # Dockerfile linter

  # =============================================================================
  # SQL Formatting (Optional)
  # =============================================================================
  # - repo: https://github.com/sqlfluff/sqlfluff
  #   rev: 2.3.5
  #   hooks:
  #     - id: sqlfluff-lint
  #     - id: sqlfluff-fix

  # =============================================================================
  # Check for Common Issues
  # =============================================================================
  - repo: local
    hooks:
      # Prevent committing to main/master directly
      - id: prevent-main-commit
        name: Prevent commits to main
        entry: bash -c 'if [ "$(git rev-parse --abbrev-ref HEAD)" = "main" ] || [ "$(git rev-parse --abbrev-ref HEAD)" = "master" ]; then echo "Direct commits to main/master are not allowed"; exit 1; fi'
        language: system
        pass_filenames: false
        always_run: true

      # Check for TODO/FIXME comments (warning only)
      - id: check-todos
        name: Check for TODO/FIXME
        entry: bash -c 'grep -rn "TODO\|FIXME" --include="*.py" . || true'
        language: system
        pass_filenames: false
        always_run: true
        verbose: true

# =============================================================================
# Configuration
# =============================================================================
default_language_version:
  python: python3.11

# Fail fast - stop on first failure
fail_fast: false

# Files to exclude from all hooks
exclude: |
  (?x)^(
      \.git/|
      \.venv/|
      venv/|
      \.mypy_cache/|
      \.pytest_cache/|
      \.ruff_cache/|
      __pycache__/|
      build/|
      dist/|
      \.eggs/|
      data/|
      models/|
      checkpoints/
  )

# =============================================================================
# CI Configuration (for GitHub Actions, Azure DevOps, etc.)
# =============================================================================
ci:
  autofix_commit_msg: |
    [pre-commit.ci] auto fixes from pre-commit hooks

    for more information, see https://pre-commit.ci
  autofix_prs: true
  autoupdate_branch: ''
  autoupdate_commit_msg: '[pre-commit.ci] pre-commit autoupdate'
  autoupdate_schedule: weekly
  skip: []
  submodules: false