ASDC_Data_and_User_Services/.pre-commit-config.yaml at 12d66df42e7f2571f922fab99498423f0e0d597c · nasa/ASDC_Data_and_User_Services · 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
ci:
  autoupdate_schedule: "monthly" # Like dependabot
  autoupdate_commit_msg: "chore: update pre-commit hooks"
  autoupdate_branch: "main"
  autofix_prs: false # Comment "pre-commit.ci autofix" on a PR to trigger
  # markdown-link-check needs network access to validate URLs, but pre-commit.ci
  # runs hooks without internet, so every external link fails (Status: 0).
  # It still runs locally on commit. See PR #83.
  skip: [markdown-link-check]

default_language_version:
  python: python3.10

repos:
  - repo: https://github.com/gitleaks/gitleaks
    rev: v8.30.0
    hooks:
      - id: gitleaks

  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v6.0.0
    hooks:
      # Validate format
      - id: check-yaml
        args: [ '--allow-multiple-documents' ]
      - id: check-toml
      - id: check-json
      # Check for common mistakes
      - id: check-added-large-files
        args: ['--maxkb=2500']
      - id: check-case-conflict
      # - id: check-illegal-windows-names # TODO: Enable in next release
      - id: check-merge-conflict
      - id: check-executables-have-shebangs
        exclude: "_archive\/.*"
      - id: check-shebang-scripts-are-executable
        exclude: "_archive\/.*"
      - id: check-symlinks
      - id: check-vcs-permalinks
      - id: destroyed-symlinks
      - id: detect-private-key
      - id: end-of-file-fixer
        exclude_types: ["jupyter", "text"]
      - id: mixed-line-ending
      #      - id: no-commit-to-branch # protects `main` by default
      - id: debug-statements
      - id: trailing-whitespace
        exclude_types: ["jupyter", "text"]

  - repo: https://github.com/tcort/markdown-link-check
    rev: v3.14.2
    hooks:
      - id: markdown-link-check
        args: [ -q ]

  - repo: https://github.com/astral-sh/ruff-pre-commit
    rev: v0.15.15
    hooks:
      - id: ruff
        args: ["--fix", "--exit-non-zero-on-fix"]
      - id: ruff-format

  - repo: local # Use 'local' for custom hooks in the repository
    hooks:
      - id: check-notebook-headers
        name: Check notebook headers
        entry: python .git-hooks/check-notebook-headers.py
        language: system
        files: '\.ipynb$' # Optional: Regex to specify file types to check
        exclude: "(^|/)(additional_drafts|_archive)/" # Exclude additional_drafts and _archive directories

  - repo: local
    hooks:
      - id: check-notebook-imports
        name: Check notebook imports against pyproject.toml
        entry: python .git-hooks/check-notebook-imports.py --warn-only
        language: system
        types: [jupyter]
        verbose: true # Always show output since the hook won't block commits
        exclude: "(^|/)(additional_drafts|_archive)/" # Exclude additional_drafts and _archive directories