feat(config): add extend-exclude configuration key - #131
Merged
Conversation
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Pull request overview
Adds support for an additive extend-exclude configuration key in pyproject.toml so projects can append their own exclude patterns without re-listing docvet’s defaults.
Changes:
- Accept
extend-excludeas a valid[tool.docvet]key with type validation (list[str]). - Merge
extend-excludeinto the finalexcludelist duringload_config. - Add unit tests covering
extend-excludebehavior (defaults-only, exclude-only, composed, validation errors, and edge cases).
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
src/docvet/config.py |
Adds extend-exclude key validation and merges it into exclude during config load. |
tests/unit/test_config.py |
Adds unit tests for the new extend-exclude behavior and validation cases. |
_bmad-output/planning-artifacts/epics-extend-exclude.md |
Adds planning artifact for the extend-exclude epic and stories. |
_bmad-output/implementation-artifacts/sprint-status.yaml |
Updates generated date and tracks Epic 16 story status. |
_bmad-output/implementation-artifacts/16-1-config-parsing-and-merge-logic.md |
Adds implementation notes and AC/test mapping for Story 16.1. |
This was referenced Feb 25, 2026
Alberto-Codes
added a commit
that referenced
this pull request
Feb 25, 2026
🤖 I have created a release *beep* *boop* --- ## [1.3.0](v1.2.1...v1.3.0) (2026-02-25) ### Features * **config:** add extend-exclude configuration key ([#131](#131)) ([15aa4ff](15aa4ff)), closes [#18](#18) ### Documentation * **config:** add extend-exclude to configuration reference ([6711525](6711525)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
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.
Developers can now add project-specific exclude patterns on top of docvet's defaults without repeating them, using the same
extend-excludeconvention as ruff, black, and flake8. Previously, settingexcludereplaced the defaults entirely, forcing users to re-list["tests", "scripts"]alongside their custom patterns.extend-excludeto valid top-level keys with type validation (list of strings)load_config:final = (user_exclude or defaults) + extend_excludediscovery.pyor any check module — merge is purely a config concernTest:
uv run pytest tests/unit/test_config.py -k extend_exclude -vCloses #18
test(config): add extend-exclude unit tests for all 7 ACs
PR Review
Checklist
uv run pytest)uv run ruff check .)uv run ty check)!in title andBREAKING CHANGE:in bodyReview Focus
Merge logic in
load_config(lines 577-583) — the newbase_excludevariable replaces the old inline ternary. Validation block in_parse_docvet_section(lines 432-437) mirrors the existingexcludepattern.Related
_bmad-output/implementation-artifacts/16-1-config-parsing-and-merge-logic.md_bmad-output/planning-artifacts/epics-extend-exclude.md