.pre-commit-config.yaml

repos:
  ##############################################################################
  #  General checks
  ##############################################################################
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v6.0.0
    hooks:
      - id: forbid-new-submodules
      - id: end-of-file-fixer
        types_or: [rust, cython, python, markdown]
      - id: mixed-line-ending
      - id: trailing-whitespace
      - id: debug-statements
      - id: detect-private-key
      - id: check-added-large-files
        exclude: ^crates/serialization/generated/capnp/
      - id: check-case-conflict
      - id: check-executables-have-shebangs
      - id: check-illegal-windows-names
      - id: check-json
      - id: check-merge-conflict
      - id: check-symlinks
      - id: check-toml
      - id: check-xml
      - id: check-yaml

  - repo: https://github.com/jorisroovers/gitlint
    rev: v0.19.1
    hooks:
      - id: gitlint

  - repo: https://github.com/scop/pre-commit-shfmt
    rev: v3.12.0-2
    hooks:
      - id: shfmt
        args: ["-i", "2", "-ci", "-sr", "-ln", "bash", "-w"]

  - repo: https://github.com/shellcheck-py/shellcheck-py
    rev: v0.11.0.1
    hooks:
      - id: shellcheck

  - repo: https://github.com/adrienverge/yamllint
    rev: v1.37.1
    hooks:
      - id: yamllint
        args: [--strict]

  - repo: https://github.com/ComPWA/taplo-pre-commit
    rev: v0.9.3
    hooks:
      - id: taplo-format

  - repo: https://github.com/hadolint/hadolint
    rev: v2.14.0
    hooks:
      - id: hadolint-docker
        name: dockerfile-lint
        description: Lint Dockerfiles for best practices and errors

  - repo: https://github.com/crate-ci/typos
    rev: v1.39.0 # v1.39.0 (reverts to v1 on updates)
    hooks:
      - id: typos
        description: Checks for common typos
        args: ["--force-exclude"]
        types_or: [rust, python, cython, toml, yaml, rst, markdown]

  - repo: https://github.com/codespell-project/codespell
    rev: v2.4.1
    hooks:
      - id: codespell
        description: Checks for common misspellings
        types_or: [rust, python, cython, toml, yaml, rst, markdown]

  - repo: https://github.com/gitleaks/gitleaks
    rev: v8.29.1
    hooks:
      - id: gitleaks
        name: gitleaks (secrets scan)
        description: Detects hard-coded secrets prior to commit
        args: ["--staged", "--redact"]

  - repo: https://github.com/google/osv-scanner
    rev: v2.3.0
    hooks:
      - id: osv-scanner
        name: osv-scanner (dependency vulnerabilities)
        description: Scans Cargo.lock and uv.lock for known vulnerabilities (defense-in-depth)
        args: ["--config=osv-scanner.toml", "--lockfile=Cargo.lock", "--lockfile=uv.lock"]

  ##############################################################################
  #  GitHub Actions linting (complementary tools covering different aspects)
  ##############################################################################
  - repo: https://github.com/rhysd/actionlint
    rev: v1.7.9
    hooks:
      - id: actionlint
        name: actionlint (syntax/structure)
        description: Checks GitHub Actions workflow syntax and structural correctness

  - repo: https://github.com/zizmorcore/zizmor-pre-commit
    rev: v1.16.3
    hooks:
      - id: zizmor
        name: zizmor (security)
        description: Scans GitHub Actions workflows for security misconfigurations
        args: ["--no-online-audits", "--min-severity", "medium"]

  ##############################################################################
  #  Custom hooks
  ##############################################################################
  - repo: local
    hooks:
      - id: check-hidden-chars
        name: check hidden unicode/control chars
        description: Fail on hidden control or zero-width unicode characters in source
        entry: .pre-commit-hooks/check_hidden_chars.sh
        language: script
        types_or: [rust, python, cython, toml, markdown, yaml, json, text]
        files: '\.(rs|py|pyx|toml|md|yml|yaml|json|sh|dockerfile)$|Dockerfile.*'

      - id: check-non-latin-text
        name: check non-Latin text
        description: Detect non-Latin characters (CJK, Cyrillic, Arabic, etc.) to enforce English-only
        entry: .pre-commit-hooks/check_non_latin_text.sh
        language: script
        types: [text]
        files: '\.(rs|py|pyx|md|toml|yaml|yml)$'

      - id: check-toml-codegen
        name: check toml-codegen
        description: Ensures TOML files don't contain the 'codegen-backend' keyword
        entry: .pre-commit-hooks/check_toml_codegen.sh
        language: script
        files: \.toml$

      - id: check-todo-exclamation
        name: check todo! markers
        description: Prevents committing TODO! markers that indicate incomplete work
        entry: .pre-commit-hooks/check_todo_exclamation.sh
        language: script
        types: [text]
        pass_filenames: false

      - id: check-copyright-year
        name: check copyright year
        description: Ensures copyright headers have current year
        entry: .pre-commit-hooks/check_copyright_year.sh
        language: script
        types_or: [rust, python]
        pass_filenames: false

      - id: check-error-conventions
        name: check error conventions
        description: Enforces error variable naming conventions
        entry: .pre-commit-hooks/check_error_conventions.sh
        language: script
        types_or: [rust, python, cython]
        pass_filenames: false

  ##############################################################################
  #  Rust formatting and linting
  ##############################################################################
  - repo: https://github.com/EmbarkStudios/cargo-deny
    rev: 0.18.6
    hooks:
      - id: cargo-deny
        name: cargo deny (dependency vulnerabilities)
        args: ["--all-features", "check"]

  - repo: local
    hooks:
      - id: check-anyhow-usage
        name: check anyhow usage
        description: Enforces anyhow conventions
        entry: .pre-commit-hooks/check_anyhow_usage.sh
        language: script
        files: '\.rs$'
        pass_filenames: false

      - id: check-logging-macro-usage
        name: check logging macro usage
        description: Enforces logging macro conventions
        entry: .pre-commit-hooks/check_logging_macro_usage.sh
        language: script
        files: '\.rs$'
        pass_filenames: false

      - id: check-pyo3-conventions
        name: check pyo3 conventions
        description: Enforces PyO3 naming conventions
        entry: .pre-commit-hooks/check_pyo3_conventions.sh
        language: script
        files: '\.rs$'
        pass_filenames: false

      - id: check-testing-conventions
        name: check testing conventions
        description: Enforces testing standardizations and conventions
        entry: .pre-commit-hooks/check_testing_conventions.sh
        language: script
        types_or: [rust]
        pass_filenames: false

      - id: fmt
        name: cargo fmt
        description: Format files with cargo fmt
        entry: bash .pre-commit-hooks/cargo_fmt_stable.sh
        language: system
        args: ["--all", "--", "--check"]
        files: '\.(rs|toml)$'
        types: [file]
        pass_filenames: false

      - id: cargo-clippy
        name: cargo clippy
        description: Run the Clippy linter on the workspace
        entry: cargo clippy
        language: system
        args:
          [
            "--workspace",
            "--all-targets",
            "--features",
            "ffi,python,high-precision,defi",
            "--profile",
            "nextest", # Reduce rebuild triggers between testing and linting
            "--",
            "-D",
            "warnings",
          ]
        files: '\.(rs|toml)$'
        types: [file]
        pass_filenames: false

      # TODO: Disabling for now as too slow
      # - id: cargo-doc
      #   name: cargo doc
      #   description: Check documentation builds without errors or warnings
      #   entry:
      #     cargo doc --workspace --features "ffi,python,high-precision,defi"
      #     --profile nextest --no-deps --quiet
      #   language: system
      #   files: '\.(rs|toml)$'
      #   types: [file]
      #   pass_filenames: false

  ##############################################################################
  #  Python/Cython formatting and linting
  ##############################################################################
  - repo: https://github.com/asottile/pyupgrade
    rev: v3.21.2
    hooks:
      - id: pyupgrade
        args: ["--py312-plus"]

  - repo: https://github.com/asottile/add-trailing-comma
    rev: v4.0.0
    hooks:
      - id: add-trailing-comma
        name: add-trailing-comma
        types: [python]

  - repo: https://github.com/astral-sh/ruff-pre-commit
    rev: v0.14.6
    hooks:
      - id: ruff
        name: ruff
        args: ["--fix"]

  - repo: https://github.com/pycqa/isort
    rev: 7.0.0
    hooks:
      - id: isort
        name: isort
        types_or: [python, pyi, cython]
        entry: "isort"
        args: ["--settings-file", "pyproject.toml"]

  - repo: https://github.com/PyCQA/docformatter
    rev: v1.7.7
    hooks:
      - id: docformatter
        language_version: python3.13 # Pin to 3.13 due to untokenize incompatibility with 3.14
        additional_dependencies: [tomli]
        args: [
          "--wrap-summaries", "88",
          "--wrap-descriptions", "88",
          "--make-summary-multi-line",
          "--pre-summary-newline",
          "--blank",
          "--recursive",
          "--in-place",
        ]

  - repo: https://github.com/pre-commit/mirrors-mypy
    rev: v1.18.2
    hooks:
      - id: mypy
        exclude: (^python/|^nautilus_trader/.*\.pyi$)
        args: [
          "--config", "pyproject.toml",
          "--allow-incomplete-defs",
        ]
        additional_dependencies: [
          msgspec,
          types-frozendict,
          types-pytz,
          types-redis,
          types-requests,
          types-toml,
        ]

  - repo: https://github.com/astral-sh/uv-pre-commit
    rev: 0.9.11 # Must match uv-version file
    hooks:
      - id: uv-lock
        files: ^python/uv\.lock$

  - repo: https://github.com/kynan/nbstripout
    rev: 0.8.2
    hooks:
      - id: nbstripout

  ##############################################################################
  #  Markdown formatting and linting
  ##############################################################################
  - repo: https://github.com/DavidAnson/markdownlint-cli2
    rev: v0.19.1
    hooks:
      - id: markdownlint-cli2
        name: markdownlint
        entry: markdownlint-cli2
        args:
          - --config
          - .markdownlint.jsonc
          - --fix
        files: "\\.md$"
        exclude: '^(CLA\.md|CONTRIBUTING\.md|RELEASES\.md)$'