.pre-commit-config.yaml

# To enable this pre-commit hook run:
# `pip install pre-commit` or `brew install pre-commit`
# Then run `pre-commit install`

# Learn more about this config here: https://pre-commit.com/
default_language_version:
  python: python3.14

ci:
  submodules: true
  autoupdate_schedule: "monthly"

repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v6.0.0
    hooks:
      - id: check-toml
      - id: check-yaml
      - id: detect-private-key
      - id: end-of-file-fixer
        exclude: ^.*\.(po|pot|type|svg|ini|mr|mrc|pg_dump)$
      - id: mixed-line-ending
        args:
          - --fix=lf
      - id: requirements-txt-fixer
      - id: trailing-whitespace
        args:
          - --markdown-linebreak-ext=md

  - repo: https://github.com/MarcoGorelli/auto-walrus
    rev: 0.4.1
    hooks:
      - id: auto-walrus

  - repo: https://github.com/codespell-project/codespell
    rev: v2.4.3
    hooks:
      - id: codespell  # See pyproject.toml for args
        additional_dependencies:
          - tomli
        args: ["--skip", "*.mjs"]
        exclude: ^(openlibrary/plugins/upstream/utils\.py|openlibrary/catalog/marc/parse\.py|openlibrary/catalog/add_book/match\.py)$

  - repo: https://github.com/djlint/djLint
    rev: v1.43.2
    hooks:
      - id: djlint-reformat-jinja
      - id: djlint-jinja

  - repo: https://github.com/abravalheri/validate-pyproject
    rev: v0.25
    hooks:
      - id: validate-pyproject

  - repo: https://github.com/astral-sh/ruff-pre-commit
    rev: v0.16.1
    hooks:
      - id: ruff-check
        args: [--fix]
      - id: ruff-format

  - repo: https://github.com/MarcoGorelli/cython-lint
    rev: v0.21.0
    hooks:
    - id: cython-lint

  - repo: local
    hooks:
      - id: generate-solr-types
        name: Generate Solr types
        description: >
          Regenerates openlibrary/solr/solr_types.py from the Solr schema
          whenever the schema or generator changes.
        entry: python ./openlibrary/solr/generate_solr_types.py
        language: python
        files: ^(conf/solr/conf/(managed-schema|enumsConfig)\.xml|openlibrary/solr/(generate_solr_types|solr_types)\.py)$
        pass_filenames: false

  - repo: local
    hooks:
      - id: no-bare-httpx-async-client
        name: No bare httpx.AsyncClient() assignments
        description: >
          A directly-assigned httpx.AsyncClient() is unsafe to share across
          this codebase's event loops -- see cache_per_event_loop in
          openlibrary/utils/async_utils.py.
        entry: python ./scripts/check_no_bare_httpx_async_client.py
        language: python
        types: [python]
        exclude: (^|/)tests?/

  - repo: https://github.com/pre-commit/mirrors-mypy
    rev: v2.3.0
    hooks:
      - id: mypy  # See pyproject.toml for args
        additional_dependencies:
          - types-PyYAML
          - types-aiofiles
          - types-python-dateutil
          - types-requests
          - types-simplejson
          - fastapi

  - repo: https://github.com/awebdeveloper/pre-commit-stylelint
    rev: 0.0.2
    hooks:
      - id: stylelint
        files: \.css$
        additional_dependencies:
          - stylelint@16.22.0
          - stylelint-declaration-strict-value@1.11.1
          - stylelint-prettier@5.0.3
        # --allow-empty-input: pre-commit passes the staged .css files, and
        # stylelint fails with AllFilesIgnoredError if .stylelintignore excludes
        # all of them (e.g. a commit only touching static/css/tokens/).
        args: [--fix, --allow-empty-input]

  - repo: https://github.com/pre-commit/mirrors-eslint
    rev: v10.8.0
    hooks:
      - id: eslint
        types: [file]
        types_or: [javascript, vue]
        additional_dependencies:
          - eslint@9.39.4
          - "@eslint/js@9.39.4"
          - eslint-plugin-no-jquery@3.1.1
          - eslint-plugin-vue@9.32.0
          - globals@15.14.0
          - "@babel/eslint-parser@7.24.7"
          - "@babel/core@7.24.7"
          - "@babel/preset-env@7.24.7"
        args: [--fix]

  - repo: local
    hooks:
    - id: check-unused-templates
      name: Check for unused templates and macros
      description: >
        Fails if any Templetor or Jinja template/macro has no code reference
        anywhere in the repo (including vendor/infogami).
      entry: python ./scripts/check_unused_templates.py
      # Keep in sync with CORPUS_SUFFIXES in openlibrary/utils/template_usage.py.
      types_or: [python, javascript, ts, tsx, vue, html, jinja, yaml, json]
      language: python
      pass_filenames: false

  - repo: local
    hooks:
    - id: generate-pot
      name: Generate POT
      description: This hook generates the .pot file for internationalization.
      entry: python ./scripts/i18n-messages extract --skip-untracked
      types_or: [python, html, jinja]
      language: python
      pass_filenames: false
      # Dependencies must be manually updated to match versions in requirements.txt
      additional_dependencies:
        - Babel==2.18.0
        - Jinja2==3.1.6
        - multipart==1.3.1
        - "git+https://github.com/webpy/webpy.git@2598dfe693ff931a9c67196f0b904b13637ec19f"
        - fastapi==0.136.1 # annoyingly, these three needed to be added when we started using contextvars in i18n files
        - simplejson==3.20.2
        - requests==2.34.0

  - repo: local
    hooks:
    - id: detect-missing-i18n
      name: Detect missing i18n
      description: This hook checks .html files for i18n strings that might be missing.
      entry: python ./scripts/detect_missing_i18n.py
      types: [html]
      language: python
      require_serial: true

  - repo: https://github.com/sqlfluff/sqlfluff
    rev: 4.2.2
    hooks:
      - id: sqlfluff-lint
        args: [--dialect, postgres]
        files: \.sql$
        # Rule exclusions and their rationale are documented in pyproject.toml
        # under [tool.sqlfluff.core].
        # patron_data.sql contains raw PostgreSQL COPY data rows with tab-separated
        # values and \N nulls which sqlfluff cannot parse.
        # import-partial.sql uses a psql variable placeholder (:source) in a COPY
        # command which sqlfluff cannot parse.
        # See: https://github.com/internetarchive/openlibrary/issues/12245
        exclude: ^(scripts/dev-instance/patron_data\.sql|scripts/solr_builder/sql/import-partial\.sql)$

  - repo: https://github.com/zizmorcore/zizmor-pre-commit
    rev: v1.29.0
    hooks:
      - id: zizmor