feat: add initial test framework#157
Merged
SecondSkoll merged 20 commits intocanonical:mainfrom Nov 24, 2025
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a data-driven test framework for Vale rules using pytest, replacing manual test files with automated testing infrastructure. The framework validates Vale linting rules against expected outcomes defined in a manifest.
Key changes:
- Implements pytest-based test infrastructure with fixtures and parametrized tests
- Adds initial test coverage for two rules (000-US-spellcheck and 500-Repeated-words)
- Updates Vale configuration to enable repeated words rule and add RST directive ignores
Reviewed Changes
Copilot reviewed 41 out of 42 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/conftest.py | Core pytest configuration providing fixtures for manifest loading, Vale execution, and result validation |
| tests/test_rules.py | Main test functions implementing data-driven rule validation |
| tests/data/manifest.yml | Test manifest defining expected behaviors for two initial rules |
| tests/requirements.txt | Python dependencies including pytest, pyyaml, and vale 3.13.0.0 |
| .github/workflows/pytest.yml | GitHub Actions workflow to run tests on Python 3.10 and 3.12 |
| vale.ini | Configuration updates: enables repeated words rule, adds RST directive token ignores |
| test/.md, test/.rst, test/*.html | Removal of legacy manual test files |
| styles/Canonical/*.yml | Rule refinements including scope changes and pattern updates |
| styles/config/vocabularies/Canonical/accept.txt | Added "LTS" to accepted vocabulary |
| getting-started.md | Documentation addition about conditionally ignoring rules |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
chore: apply review suggestions Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
akcano
requested changes
Nov 14, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Moves to a manifest generated test framework, implements some low level fixes, and adjust some rules.