.pre-commit-config.yaml

---
default_install_hook_types: [pre-commit, pre-push]
default_stages: [pre-commit, manual]
minimum_pre_commit_version: 3.5.0
fail_fast: true
repos:
  - repo: local
    hooks:
      - id: v8r
        name: v8r
        entry: npx -y v8r --ci .v8rrc.yaml
        language: system
        pass_filenames: true
        stages: [pre-commit, pre-push, manual]
        files: |
          (?x)(
            \.(yaml|yml|json)$
          )
        exclude: |
          (?x)(
            ^configs/site-config\.yaml$|
            ^bash-tools-framework-schema\.json$|
            ^\.?secretlintrc\.yml$|
            ^\.vscode/|
            ^\.?checkov\.yml$|
            ^\.?secretlintrc\.json$|
            ^\.?grype\.yaml$|
            ^\.?trivy\.yaml$|
            /testsData/
          )

  - repo: local
    hooks:
      # generate mermaid help with npx and save it in a file to be used in doc generation
      # mermaid binary will still use npx to get the help content at runtime,
      # This avoids having to install node and mermaid in docker image
      - id: generate-mermaid-help
        name: generate mermaid help
        entry: bash -o pipefail -c 'exec npx -y @mermaid-js/mermaid-cli --help > src/_binaries/mermaid/mermaid-help.txt'
        language: system
        pass_filenames: false
        stages: [pre-commit]
      - id: generate-rimage-help
        name: generate rimage help
        entry: |
          bash -o pipefail -c 'rimage --help | sed -E -e "s/[[:space:]]+$//" \
          >src/_binaries/rimageWrapper/rimage-help.txt'
        language: system
        pass_filenames: false
        stages: [pre-commit]
      - id: generate-kroki-help
        name: generate kroki help
        entry: |
          bash -o pipefail -c 'kroki --help | sed -E -e "s/[[:space:]]+$//" \
          >src/_binaries/krokiWrapper/kroki-help.txt'
        language: system
        pass_filenames: false
        stages: [pre-commit]

  - repo: https://github.com/executablebooks/mdformat
    # Do this before other tools "fixing" the line endings
    rev: 0.7.22
    hooks:
      - id: mdformat
        name: Format Markdown
        entry: mdformat # Executable to run, with fixed options
        language: python
        types: [markdown]
        args: [--wrap, "120", --number]
        additional_dependencies:
          - mdformat-frontmatter
          - mdformat-toc
          - mdformat-shfmt
          - mdformat-tables
          - mdformat-config
          - mdformat-web
          - mdformat-gfm
        exclude: |
          (?x)(
            ^\.github/
          )

  - repo: https://github.com/jsh9/markdown-heading-numbering
    rev: 0.1.0
    hooks:
      - id: markdown-heading-numbering
        args:
          - --start-from-level=2
          - --initial-numbering=1
        exclude: |
          (?x)(
            ^\.github/|
            ^doc/ai/|
            AGENTS\.md|
            commit-msg-template\.md
          )

  - repo: https://github.com/jsh9/markdown-toc-creator
    rev: 0.1.3
    hooks:
      - id: markdown-toc-creator
        args:
          - --proactive=False
          - --style=github
          - --quiet
          - --add-toc-title=False
          - --add-horizontal-rules=False
        exclude: |
          (?x)(
            ^\.github/|
            ^doc/ai/|
            AGENTS\.md
          )

  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v6.0.0
    hooks:
      - id: mixed-line-ending
      - id: end-of-file-fixer
        exclude: |
          (?x)(
            ^doc/images/.*\.svg$|
            testsData/.*\.result$
          )
      - id: check-executables-have-shebangs
      - id: check-shebang-scripts-are-executable
      - id: check-xml
      - id: check-merge-conflict
      - id: detect-private-key
      - id: fix-byte-order-marker
      - id: check-yaml
      - id: trailing-whitespace
        exclude: |
          (?x)(
            testsData/
          )
        stages: [pre-commit, pre-push, manual]
      - id: check-added-large-files
      - id: forbid-new-submodules
      - id: mixed-line-ending
        args: [--fix=lf]
      - id: check-json
        # x modifier: extended. Spaces and text after a # in the pattern are ignored
        exclude: |
          (?x)(
            .vscode\/.*\.json$
          )

  - repo: https://github.com/rhysd/actionlint
    rev: v1.7.12
    hooks:
      - id: actionlint
        stages: [pre-commit, pre-push, manual]

  - repo: https://github.com/codespell-project/codespell
    rev: v2.4.2
    hooks:
      - id: codespell
        args:
          - --dictionary
          - "-"
          - --dictionary
          - .cspell/codespellrc-dic.txt
          - --ignore-words
          - .cspell/codespellrc-ignore.txt
          - --quiet-level
          - "2"
          - --interactive
          - "0"
          - --check-filenames
          - --check-hidden
          - --write-changes
        exclude: >
          (?x)(
              ^installScripts/|
              ^bin/|
              ^install$|
              ^distro$|
              ^srcAlt|
              ^.cspell/codespellrc-.*.txt$
          )

  - repo: https://github.com/fchastanet/jumanjihouse-pre-commit-hooks
    rev: 3.0.2
    hooks:
      - id: shfmt
        args: [-i, "2", -ci]
        # x modifier: extended. Spaces and text after a # in the pattern are ignored
        exclude: |
          (?x)(
            ^vendor/|
            ^bin/|
            ^manualTests/data/|
            /testsData/
          )

      # Check both committed and uncommitted files for git conflict
      # markers and whitespace errors according to core.whitespace
      # and conflict-marker-size configuration in a git repo.
      - id: git-check
        # x modifier: extended. Spaces and text after a # in the pattern are ignored
        exclude: |
          (?x)(
            /testsData/
          )

  - repo: https://github.com/fchastanet/bash-tools-framework
    rev: 6.3.0
    hooks:
      - id: fixShebangExecutionBit
      - id: awkLint
      - id: shellcheckLint
      - id: hugoUpdateLastmod
        stages: [pre-commit]

  - repo: local
    hooks:
      - id: frameworkLint
        name: Bash Framework Lint
        description: |
          Check if your files uses the right syntax
          for using bash-tools-framework
        language: script
        entry: bin/frameworkLint
        args: [--expected-warnings-count, "61", --format, plain, --theme, default-force]
        pass_filenames: false
        types: ["executable", "file", "shell", "text"]
        always_run: false
        stages: [pre-commit]
      - id: buildDocFilesForGithubActions
        name: build doc files for github actions
        language: script
        entry: bin/doc
        args: [--verbose, --ci]
        pass_filenames: false
        require_serial: true
        stages: [] # GITHUB
      - id: cspellForbidden
        name: cspell with support to Forbidden Words
        description: ensure .cspell/forbidden.txt exists and is used by cspell
        language: script
        entry: bin/cspellForbidden
        args: []
        pass_filenames: false
        always_run: true
        stages: [pre-commit, pre-push]
      - id: plantuml
        name: Plantuml Converter
        description: Convert plantuml files to images
        language: script
        entry: bin/plantuml
        args: [--ci, --same-dir, -f, svg]
        pass_filenames: true
        types: ["file", "non-executable", "plantuml", "text"]
        always_run: false
        stages: [pre-commit, manual]

  - repo: https://github.com/fchastanet/bash-compiler
    rev: 3.2.1
    hooks:
      - id: buildBashBinaries