.pre-commit-config.yaml

# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
repos:
  - repo: "https://github.com/pre-commit/pre-commit-hooks"
    rev: v5.0.0
    hooks:
      - id: trailing-whitespace
      - id: end-of-file-fixer
        exclude: "[.](svg|drawio.xml)$"
      - id: check-yaml
        # Helm templates are not reaaaally YAML.
        exclude: "[/]templates[/]"
        args:
          # Needed by mkdocs.yaml
          # Implies --allow-multiple-documents
          - "--unsafe"
      - id: check-added-large-files
      - id: check-merge-conflict
      - id: no-commit-to-branch

  - repo: https://github.com/codespell-project/codespell
    rev: v2.2.4
    hooks:
      - id: codespell
        name: check spelling
        args:
          - -I
          - .codespellignore
        exclude: ^(site/.*|.*\.dot|.*\.svg|.*\.xml|.*\.min\.js|package-lock.json)$

  - repo: https://github.com/pre-commit/mirrors-eslint
    rev: v8.56.0
    hooks:
      - id: eslint
        exclude: ^(user-demo/|docs/customer-quotes/|docs/tech-radar/)

  - repo: https://github.com/DavidAnson/markdownlint-cli2
    rev: v0.12.1
    hooks:
      - id: markdownlint-cli2
        name: lint markdown files
        exclude: ^.github/
        args:
          - --fix

  - repo: https://github.com/pre-commit/mirrors-prettier
    rev: v3.1.0
    hooks:
      - id: prettier
        exclude: /templates/|\.min\.|\.css$|\.html$|\.js$|\.md$|\.scss$|docs/img/|user-demo/|user-demo-dotnet/

  - repo: local
    hooks:
      # must be before vale-run to install vale without conflict
      - id: vale
        name: lint prose in markdown files with vale - sync
        alias: vale-sync
        types: [markdown]
        language: python
        pass_filenames: false
        require_serial: true
        additional_dependencies:
          - vale==3.9.1.0
        entry: vale
        args:
          - sync

      # must be after vale-sync to install vale without conflict
      - id: vale
        name: lint prose in markdown files with vale - run
        alias: vale-run
        types: [markdown]
        language: python
        additional_dependencies:
          - vale==3.9.1.0
        entry: vale
        args:
          - --output=line

      - id: svg-must-embed
        name: SVGs must embed all images
        entry: 'image[^>]* xlink:href="https'
        language: pygrep
        files: ".*[.]svg$"
      - id: svg-must-not-embed-PNG
        name: SVGs must NOT embed PNGs
        entry: 'image[^>]* xlink:href="data:image/png'
        language: pygrep
        files: ".*[.]svg$"
        # We'll deal with these later.
        exclude: '(\.drawio|ideal-dx|ideal-promotion)\.svg$'
      - id: use-relative-urls
        name: Use relative URLs for internal links
        # Why? Mkdocs wants you to: https://www.mkdocs.org/user-guide/writing-your-docs/#linking-to-pages
        entry: '\[[^\]]*\][(][/].*[)]'
        language: pygrep
        files: ".*[.]md$"
      - id: use-relative-urls-to-files
        # Why? This ensures the docs are readable from GitHub and allows mkdocs
        # to do some internal link checking.
        name: Internal links should point to files
        # NOTE: I'm unsure the rule above can be precisely implemented using a
        # regex. What I'm essentially ask here is:
        # - link should not start with anchor `#`;
        # - ignore leading `../..` from relative links;
        # - there should be `:` (as in `https://`) or `.` (as in `index.md`)
        #   somewhere in the link.
        entry: '\[[^\]]*\][(][^#][.\/]*[^.:]*[)]'
        language: pygrep
        files: ".*[.]md$"
      - id: capitalize-common-names
        name: Please capitalize common names
        entry: "^[^`]{0,100} (git[Hh]ub|kubernetes|trivy|starboard|welkin)( |, |[.] )"
        language: pygrep
        files: ".*[.]md$"
      - id: avoid-absolute-urls-for-internal-links
        name: Avoid absolute URLs (https://elastisys.io) for internal links
        entry: '\/\/(elastisys.io)\/'
        language: pygrep
        files: ".*[.]md$"
      - id: avoid-old-website-url
        name: Avoid old URLs (https://elastisys.io/compliantkubernetes)
        entry: "elastisys.io/compliantkubernetes"
        language: pygrep
        files: ".*[.]md$"
      - id: avoid-old-github-urls
        name: Avoid old URLs (https://github.com/elastisys/compliantkubernetes)
        entry: "github.com/elastisys/compliantkubernetes[^-]"
        language: pygrep
        files: ".*[.]md$"
      - id: avoid-non-descriptive-link-text
        name: Avoid non-descriptive link text (see https://developers.google.com/search/docs/crawling-indexing/links-crawlable#write-good-anchor-text)
        entry: "(?i)<a[^>]*>(read more|click here|learn more)</a>"
        language: pygrep
        files: ".*[.]md$"
      - id: avoid-old-names
        name: Use Welkin consistently
        entry: "(Compliant[ ]Kubernetes|C[kK]8[sS][^_]|Complaint)"
        language: pygrep
        files: ".*[.]md$"