chore(pre-commit): bump cspell-cli to v9.4.0, drop merge-conflict hook #26
Conversation
hyp3rd
commented
Dec 23, 2025
hyp3rd
commented
- Update .pre-commit-config.yaml
- Remove check-merge-conflict hook
- Upgrade streetsidesoftware/cspell-cli from v9.3.3 to v9.4.0
…resh docs - Add cspell custom dictionary and extend cspell.config.yaml (ignorePaths, dictionaryDefinitions, and words) to cover project-specific terms. - Introduce markdownlint config (.mdlrc, .mdl_style.rb) for consistent MD style. - Update .pre-commit-config.yaml: add check-merge-conflict, check-json, pretty-format-json, mixed-line-ending; scope/tune check-yaml; add requirements-txt-fixer and no-commit-to-branch. - Normalize and reword documentation across docs/* and README.md (ordered lists, headings, examples, and terminology). - Adjust docs/requirements.txt dependency pinning for mkdocs-material. Rationale: improve docs quality and consistency; enforce formatting and spelling in CI/pre-commit; reduce noise from false positives.
- Deduplicate `mixed-line-ending` entry in `.pre-commit-config.yaml`. - Prevents the hook from running twice and reduces noise in commit output. - No code changes; configuration-only update.
- Deduplicate `mixed-line-ending` entry in `.pre-commit-config.yaml`. - Prevents the hook from running twice and reduces noise in commit output. - No code changes; configuration-only update.
…ad-artifact@v6) - Update actions/cache to v5 in: - .github/lint.yml - .github/workflows/pre-commit.yml - .github/workflows/security.yml - .github/workflows/test.yml - Update actions/checkout to v6 in .github/workflows/go.yml - Update actions/upload-artifact to v6 in .github/workflows/test.yml Rationale: keep CI dependencies current and secure; align with latest maintained releases; no workflow behavior changes intended.
- Update .pre-commit-config.yaml - Remove check-merge-conflict hook - Upgrade streetsidesoftware/cspell-cli from v9.3.3 to v9.4.0
…nd Go verification hooks Introduce .pre-commit-ci-config.yaml to standardize quality checks before commits: - pre-commit-hooks v6.0.0: check-json, pretty-format-json (excludes cspell.json), end-of-file-fixer, mixed-line-ending, trailing-whitespace, fix-byte-order-marker, check-executables-have-shebangs, debug-statements, check-yaml (excludes mkdocs.yml; allows multi-doc), requirements-txt-fixer. - yamllint v1.37.1 (strict) for *.y(a)ml files. - hadolint v2.14.0 (docker) for Dockerfile best practices. - cspell-cli v9.3.3: spell-check changed files and commit messages (commit-msg on .git/COMMIT_EDITMSG). - markdownlint v0.15.0 (mdl) for Markdown. - local hooks: go-verify (.pre-commit/go-mod-hook) and gci (.pre-commit/gci-hook), run serially. Motivation: catch formatting and lint issues early, enforce consistent standards, and verify Go modules/imports. Scope: CI configuration only—no runtime code changes.
There was a problem hiding this comment.
Pull request overview
This PR updates the pre-commit configuration and modernizes various tooling dependencies. The main focus is bumping cspell-cli from v9.3.3 to v9.4.0 and restructuring pre-commit hooks. Additionally, the PR includes widespread formatting changes to documentation markdown files, converting numbered lists to use consistent "1." numbering (Markdown auto-numbering), updates to GitHub Actions versions, and consolidation of spell-checking configuration.
- Upgrade cspell-cli to v9.4.0 and expand spell-checking configuration
- Update GitHub Actions dependencies (cache v4→v5, upload-artifact v5→v6, checkout v4→v6)
- Standardize markdown list formatting across documentation to use auto-numbering (all items numbered "1.")
- Consolidate spell-checking configuration by moving word lists from VS Code settings to cspell.config.yaml
Reviewed changes
Copilot reviewed 24 out of 25 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
.pre-commit-config.yaml |
Bump cspell-cli to v9.4.0, reorder hooks, add new hooks (check-json, pretty-format-json, requirements-txt-fixer, no-commit-to-branch) |
cspell.config.yaml |
Expand ignorePaths list and add many new words to custom dictionary |
.vscode/settings.json |
Remove cSpell.words array (now managed in cspell.config.yaml) |
.vscode/extensions.json |
Format JSON with consistent indentation |
.mdlrc |
Add new markdownlint configuration file |
.mdl_style.rb |
Add Ruby style configuration for markdownlint |
.cspell/custom-dictionary.txt |
Create custom dictionary file with project-specific words |
docs/requirements.txt |
Alphabetically reorder mkdocs dependencies |
| Documentation files (9 files) | Convert numbered lists from sequential numbering to auto-numbering format (all "1.") and remove question mark from "Why ewrap" heading |
| GitHub workflow files (5 files) | Update GitHub Actions versions and modify pre-commit workflow to use separate config file |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - repo: https://github.com/pre-commit/pre-commit-hooks | ||
| rev: v6.0.0 | ||
| hooks: | ||
| - id: check-merge-conflict |
There was a problem hiding this comment.
The PR description states "Remove check-merge-conflict hook" but the diff shows that the check-merge-conflict hook is still present at line 6. It appears the hook was reordered to be first in the list rather than removed. The description should be corrected to reflect that the hook was reordered, not removed.
| curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/HEAD/install.sh | sh -s -- -b "$(go env GOPATH)/bin" "${{ steps.settings.outputs.golangci_lint_version }}" | ||
| - name: Run pre-commit | ||
| run: pre-commit run --all-files | ||
| run: pre-commit run --config .pre-commit-ci-config.yaml --all-files |
There was a problem hiding this comment.
The workflow references a configuration file .pre-commit-ci-config.yaml that does not appear to exist in the repository. This will cause the pre-commit workflow to fail when it tries to run with a non-existent config file.
| run: pre-commit run --config .pre-commit-ci-config.yaml --all-files | |
| run: pre-commit run --all-files |
| # default in next version, remove then | ||
| rule 'MD007', :indent => 3 | ||
|
|
||
| rule "MD029", style => "one" |
There was a problem hiding this comment.
There's a syntax error in this Ruby code. The hash syntax is inconsistent - line 5 uses the correct syntax :indent => 3, but this line uses style => "one" without the leading colon. It should be :style => "one" to match the Ruby hash syntax used elsewhere.
| rule "MD029", style => "one" | |
| rule "MD029", :style => "one" |
| To start using ewrap in your project, visit the [Installation](getting-started/installation.md) guide, followed by the [Quick Start](getting-started/quickstart.md) tutorial. | ||
|
|
||
| ## Why ewrap? | ||
| ## Why ewrap |
There was a problem hiding this comment.
The heading was changed from "## Why ewrap?" to "## Why ewrap" removing the question mark. This change should be intentional as it affects the documentation structure. If this is an intentional style decision, consider whether other headings need similar updates for consistency.
| ## Why ewrap | |
| ## Why ewrap? |
