VictoriaMetrics/.pre-commit-config.yaml

repos:
  - repo: https://github.com/streetsidesoftware/cspell-cli
    rev: v8.8.2
    hooks:
      - id: cspell
        args:
          - --no-progress
          - --no-summary
        # The lines below make pre-commit ignore the exit code while still
        # producing valuable spell checking suggestions.
        entry: bash -c 'cspell "$@" || true' --
        verbose: true
docs: Add spellcheck workflow (#6470) ### Describe Your Changes This is a follow-up PR containing workflow related part of the initial [PR#6362](https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6362). It adds spell checking control based on [cspell](https://github.com/streetsidesoftware/cspell). The related configs are consolidated under `cspell` directory. You can add VictoriaMetrics specific terms into `cspell/custom-dict.txt` (it contains ~30 items atm). All other absent commonly used terms should be added directly to respective [cspell-dicts](https://github.com/streetsidesoftware/cspell-dicts/blob/main/CONTRIBUTING.md). ### Checklist The following checks are mandatory: - [x] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/). --------- Signed-off-by: Arkadii Yakovets <ark@victoriametrics.com> (cherry picked from commit 92b22581e69f7b03a6a9a93364af7acbc7991447) 2024-06-21 18:56:20 +00:00			`repos:`
			`- repo: https://github.com/streetsidesoftware/cspell-cli`
			`rev: v8.8.2`
			`hooks:`
			`- id: cspell`
			`args:`
			`- --no-progress`
			`- --no-summary`
			`# The lines below make pre-commit ignore the exit code while still`
			`# producing valuable spell checking suggestions.`
			`entry: bash -c 'cspell "$@" \|\| true' --`
			`verbose: true`