.pre-commit-config.yaml

# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0

# Pre-commit hooks for Holoscan SDK
# See https://pre-commit.com for more information
# Install: pip install pre-commit && pre-commit install  (or: uvx pre-commit install)
# Run manually: pre-commit run --all-files
default_language_version:
  python: python3

# Skip all hooks for skills/ - files in this directory are verbatim upstream
# copies intended to match the source byte-for-byte. Modifying them in transit
# (line endings, trailing whitespace, codespell auto-fixes, copyright year
# bumps, etc.) breaks that byte-for-byte property and invalidates the detached
# signature (`skill.oms.sig`) that ships alongside each skill - once the
# signature is attached, any in-place modification fails verification against
# the trust anchor.
exclude: ^skills/

repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.5.0
    hooks:
      - id: trailing-whitespace
        exclude: ^.*\.patch$
      - id: end-of-file-fixer
        exclude: ^.*\.patch$
      - id: check-yaml
        # Exclude .clang-format file because check-yaml do not support multi-document file
        exclude: ^.*\.patch|\.clang-format$
      - id: check-json
        exclude: ^\.vscode/|^\.devcontainer/|.*\.patch$
      - id: check-added-large-files
        exclude: ^.*\.patch$

  # Copyright header check (NVIDIA SPDX)
  - repo: local
    hooks:
      - id: check-copyright
        name: Check copyright headers
        # Commits check staged paths. Wide lists from ``--all-files`` are narrowed to the
        # main/release diff unless an explicit base is supplied. Use the script's ``--full-scan``
        # option for a deliberate full-tree audit.
        entry: python3 scripts/check_copyright.py
        args:
          - --reject-nvidia-proprietary-path
          - ^
          - --exclude
          - CodeCoverage.cmake
          - --exclude
          - common-debian.sh
          # Paths are rooted at the repository layout represented by this config.
          - --exclude
          - \.cache
          - --exclude
          - build
          - --exclude
          - install
          - --exclude
          - build-*
          - --exclude
          - install-*
          - --exclude
          - modules/holoviz/thirdparty/
          - --exclude
          - .*\.patch$
          # Fern bundled dist/ output (generated files, no NVIDIA copyright header).
          - --exclude
          - docs/fern/dist/
          - --update-current-year
        language: system
        pass_filenames: true

      - id: test-check-copyright
        name: Test copyright header checker
        entry: pytest scripts/test_check_copyright.py
        language: python
        additional_dependencies:
          - pytest
        pass_filenames: false
        files: ^scripts/(check_copyright|test_check_copyright)\.py$

      - id: check-doc-source-links
        name: Check documentation source links
        entry: python3 docs/scripts/render_source_links.py --docs-root docs --write
        language: system
        pass_filenames: true
        files: ^docs/.*\.mdx?$

      - id: test-gxf-entity-codec
        name: Test GXF entity codec
        entry: pytest scripts/test_gxf_entity_codec.py
        language: python
        additional_dependencies:
          - numpy
          - pytest
        pass_filenames: false
        files: ^scripts/(convert_gxf_entities_to_video|convert_video_to_gxf_entities|gxf_entity_codec|test_gxf_entity_codec)\.py$

      - id: check-doc-links
        name: Check documentation links
        entry: python3 docs/scripts/check_doc_links.py
        language: system
        pass_filenames: false
        files: ^docs/

      - id: check-local-markdown-links
        name: Check local Markdown file links
        entry: python3 docs/scripts/check_doc_links.py --local-files-only
        language: system
        pass_filenames: false
        always_run: true
        files: ^

  - repo: https://github.com/Lucas-C/pre-commit-hooks
    rev: v1.5.6
    hooks:
      - id: remove-tabs  # Replace tabs by whitespaces before committing
        args: [--whitespaces-count, '4']  # defaults to: 4
        exclude: |
          (?x)^(
            modules/holoviz/thirdparty/
          )
        types_or: [c++, cmake, dockerfile, markdown, python, shell]

  # Lint: Ruff
  - repo: https://github.com/astral-sh/ruff-pre-commit
    rev: v0.13.2
    hooks:
      - id: ruff-check
        args: [--fix]
        files: ^
        exclude: ^scripts/register_devzone_release\.py$
      - id: ruff-format
        files: ^
        exclude: ^scripts/register_devzone_release\.py$

  # Codespell
  - repo: https://github.com/codespell-project/codespell
    rev: v2.4.1
    hooks:
      - id: codespell
        additional_dependencies:
          - tomli>=2.0.1,<3.0; python_version<'3.11'
        files: ^
        args:
          - --skip=*.onnx,*NOTICE.txt,*.toml,*vale*,*.patch,*docs/fern/dist*
          - --ignore-regex=.*codespell-ignore$
          - --toml=.codespell.toml
          - --write-changes

  # Cpplint
  - repo: https://github.com/cpplint/cpplint
    rev: 2.0.2
    hooks:
      - id: cpplint
        args:
          - --quiet
          - --exclude=.cache
          - --exclude=.local
          - --exclude=tmp
          - --exclude=build
          - --exclude=install
          - --exclude=build-\*
          - --exclude=install-\*
          - --exclude=gxf-build-\*
          - --exclude=src/core/distributed/generated
          - --exclude=src/core/services/generated
          - --exclude=modules/holoviz/thirdparty/nvpro_core
          - --exclude=examples/custom_cuda_kernel_multi_sample/cpp/edge_detection.cu
          - --filter=-whitespace/indent_namespace,-build/c++17,-build/include_order
        files: ^.*\.(cpp|cu|cuh|h|hpp|cc|cxx)$
        # Paths are rooted at the repository layout represented by this config.
        exclude: |
          (?x)^(
            \.cache|
            \.local|
            tmp|
            build|
            install|
            build-|
            install-|
            gxf-build-|
            src/core/distributed/generated/|
            src/core/services/generated/|
            modules/holoviz/thirdparty/nvpro_core/|
            examples/custom_cuda_kernel_multi_sample/cpp/edge_detection\.cu$
          )

  # cmakelint
  - repo: local
    hooks:
      - id: cmakelint
        name: cmakelint
        entry: cmakelint
        language: python
        additional_dependencies: ["cmakelint>=1.4.2,<2.0"]
        args:
          - "--filter=-whitespace/indent,-linelength,-readability/wonkycase,-convention/filename,-package/stdargs"
        files: ^.*(CMakeLists\.txt|\.cmake)$
        exclude: ^(build|install|build-|install-|\.cache)/

  # markdownlint
  - repo: https://github.com/igorshubovych/markdownlint-cli
    rev: v0.47.0
    hooks:
      - id: markdownlint
        args: [--fix, --config, .markdownlint.yaml]
        files: ^.*\.mdx?$
        types_or: [markdown, mdx]
        exclude: ^swipat/summary\.md$

  # clang-format
  - repo: https://github.com/pre-commit/mirrors-clang-format
    rev: v21.1.8
    hooks:
      - id: clang-format