CHANGELOG.md

Changelog

1.15.1 (2026-05-08)

Bug Fixes

• cli: avoid click<8.2 incompatibility in progressbar hidden kwarg (#407) (00dbb82), closes #404

1.15.0 (2026-03-27)

Features

• cli: add docvet fix subcommand with dry-run and discovery (#386) (7f76477)
• cli: add inline suppression comments for findings (#393) (14ba0b7)
• enrichment: add scaffold category, scaffolding engine, and scaffold-incomplete rule (#385) (782cd27)
• enrichment: add scaffold-incomplete enrichment rule (782cd27)

Bug Fixes

• cli: address code review findings for fix subcommand (7f76477)
• cli: prevent uppercase rule IDs from degrading to blanket (14ba0b7)
• config: address PR #379 review feedback (#380) (134e428)
• enrichment: handle docstring-only stubs, multi-statement stubs, and deprecated abstract decorators (#391) (bc2445d), closes #387 #388 #389
• griffe: replace production assert, fix dep vulns, add vuln handling docs (#395) (7273e56)
• test: move _active_style reset to shared conftest fixture (#363) (b8b6586)

Documentation

• cli: add missing subcommands to quick references (#397) (d92af72), closes #396
• enrichment: add scaffold-incomplete rule page and config docs (782cd27)

1.14.1 (2026-03-22)

Bug Fixes

• enrichment: add independent config toggles for reverse checks (643ca49), closes #359

1.14.0 (2026-03-22)

Features

• enrichment: add missing-deprecation rule (#353) (6df6405)
• enrichment: add missing-return-type rule (#356) (2a2db8d)
• enrichment: add param agreement checks for Args section (#349) (724b81e)
• enrichment: add reverse enrichment checks (#354) (7bdfbcf)
• enrichment: add trivial-docstring rule (#355) (eb42c4d)
• enrichment: add undocumented-init-params rule (#357) (8aca259)

Bug Fixes

• docs: address code review findings for missing-return-type story (2a2db8d)
• docs: remove undocumented Raises entry in write_report (eb42c4d)
• enrichment: correct positional-only param handling in (8aca259)

Documentation

• enrichment: add param agreement config keys and migration notes (724b81e)
• enrichment: update enrichment check page with missing rules (6df6405)

1.13.0 (2026-03-08)

Features

• enrichment: add missing-returns rule for undocumented return values (#334) (31faf3d)
• enrichment: add NumPy-style section recognition (#344) (62ce6ed)
• enrichment: add Sphinx/RST docstring style support (#332) (1bbd18f)
• presence: add overload-has-docstring rule (0d83358)

Bug Fixes

• enrichment: address code review findings for Story 34.1 (1bbd18f)

1.12.1 (2026-03-07)

Bug Fixes

• cli: catch ImportError in mcp command for missing extras (062072d)
• docs: wrap GitHub Actions code blocks with raw tags (3f1763d)

1.12.0 (2026-03-07)

Features

• ci: add badge outputs to GitHub Action and dynamic badge docs (#313) (4e4a09a)
• cli: add --summary flag for per-check quality percentages (#314) (3a225d3)
• cli: add docvet config command and remove interrogate (#316) (b4f4789)

Bug Fixes

• checks: replace <module> sentinel with display names in findings (#315) (6f52258)
• cli: fix compute_quality key iteration and griffe guard (3a225d3)

Documentation

• bmad: add Growth phase PRD, architecture, and epics for Epics 31-33 (#311) (8ec1abd)

1.11.0 (2026-03-06)

Features

• enrichment: report both doctest and rST findings for prefer-fenced-code-blocks (#302) (d51edfd)

Documentation

• site: add Concepts page with research-backed quality narrative (#297) (f88d3fc), closes #296
• site: expand glossary with 16 new terms and fix six-layer model (#301) (f396d0c), closes #263

1.10.0 (2026-03-06)

Features

• ci: add structured inputs, annotations, and step summary to GitHub Action (#295) (e932356), closes #294

Documentation

• planning: add Epic 30 sprint status and story artifacts (1def643)
• site: add license attribution page and copyright footer (#293) (780cb91), closes #292

1.9.0 (2026-03-05)

Features

• mcp: add guidance and fix_example to rule catalog (#277) (5108e73)

Bug Fixes

• plugin: add marketplace.json and update install instructions (79887fa)

Documentation

• add privacy policy page (fa5b977)
• mcp: add per-client MCP config snippets (a4bbbbf)

1.8.1 (2026-03-04)

Bug Fixes

• mcp: correct server.json for MCP Registry compatibility (ca3a212)

1.8.0 (2026-03-04)

Features

• mcp: add core MCP server with docvet_check and docvet_rules tools (#261) (36b3dde), closes #260
• mcp: add docvet mcp CLI subcommand and integration tests (#267) (c223a63), closes #266

Bug Fixes

• ci: replace TestPyPI gate with local wheel smoke test (574aa74)
• ci: replace TestPyPI gate with local wheel smoke test (#255) (574aa74), closes #252
• mcp: address code review findings for directory scoping and test (36b3dde)
• mcp: address code review findings for story 29.2 (c223a63)

Documentation

• mcp: add MCP server docs, registry manifest, and version tracking (4823bf0), closes #268
• readme: reorder badges to industry standard convention (574aa74)

1.7.0 (2026-03-03)

Features

• presence: add core presence detection and configuration (#240) (a48edd3), closes #239
• presence: wire presence check into CLI pipeline and reporting (#244) (067fbbd), closes #243

Bug Fixes

• ci: remove unsafe-best-match index strategy from smoke test (f7cf9d3)
• config: pin griffe <2 for broken 2.0.0 release (#251) (d408b7f)
• presence: extract PresenceStats.percentage and strengthen tests (067fbbd)
• release: guard fromJSON with short-circuit to prevent empty parse (#242) (6a944d0)

Documentation

• presence: add presence check and rule documentation with migration guide (#249) (bef4fd5), closes #245

1.6.4 (2026-03-02)

Bug Fixes

• ci: add TestPyPI staging to publish pipeline (63267ff)

1.6.3 (2026-03-02)

Bug Fixes

• enrichment: detect rST :: indented code blocks in prefer-fenced-code-blocks rule (21e3567), closes #225

1.6.2 (2026-03-01)

Bug Fixes

• cli: replace nested ternary in _output_and_exit format resolution (f8e7984), closes #204

1.6.1 (2026-02-28)

Bug Fixes

• bmad: add feature branch creation step to dev-story workflow (a32582a)
• freshness: eliminate hunk-to-symbol false positives (12a0314), closes #218

Documentation

• docs: add architecture page with Mermaid check pipeline diagram (b9666fb), closes #214
• docs: add docs scope to commit conventions (f7bde04), closes #209
• docs: add editor integration page (15a83fa), closes #212
• docs: fix misleading link text and zero-config claim (15a83fa)

1.6.0 (2026-02-28)

Features

• ci: add cross-platform CI matrix and path normalization (#174) (e418fbc), closes #101
• ci: add pre-commit hook definition and tests (#180) (5f11287)
• cli: add --format json for structured machine-readable output (#177) (da8e51d), closes #151
• cli: add positional file arguments to all subcommands (#175) (dee57cc), closes #152
• docs: add "How to Fix" guidance to all 19 rule pages (#166) (817f43c), closes #155
• docs: add AGENTS.md and AI Agent Integration docs page (#171) (bc662a2), closes #161
• docs: add AI Agent Integration section and enhance competitive positioning (#170) (df51114), closes #153 #162
• docs: add CONTRIBUTING.md contributor guide (#172) (4ff286f), closes #104
• lsp: add Claude Code plugin configuration (#185) (17be1f3), closes #63
• lsp: add pygls-based LSP server for real-time diagnostics (#184) (e121c38), closes #159
• reporting: add format_json() for structured JSON output (da8e51d)

Bug Fixes

• ci: strengthen pre-commit hook YAML test assertions (5f11287)
• docs: code review fixes for AGENTS.md and ai-integration page (bc662a2)
• lsp: decouple server global, narrow exception, fix handler test (e121c38)

Documentation

• cli: document --format json schema and usage (da8e51d)
• meta: reserve # references for GitHub issues and PRs only (5f11287)

1.5.0 (2026-02-26)

Features

• cli: add --quiet flag and dual-register --verbose on check subcommand (#144) (206ab22)
• cli: add --verbose and --quiet flags to individual subcommands (#145) (ba1bbd5)
• cli: replace Completed-in with Vetted summary line (#141) (18db009)
• cli: replace Completed-in with Vetted summary line on check (18db009)
• config: suppress overlap warnings for default warn-on values (#143) (384a44a)

Bug Fixes

• cli: correct --quiet flag docs and harden griffe quiet test (#146) (bf1ca08)
• cli: resolve verbose/quiet dual-resolution ordering in check (206ab22)
• cli: suppress verbose header for single-check subcommands (ba1bbd5)
• config: update overlap warning docs and strengthen AC3 test (384a44a)

1.4.0 (2026-02-26)

Features

• ci: add post-publish PyPI smoke test (#134) (5b89f3d)
• cli: add per-check timing and total execution time (#140) (56c6c62), closes #24
• cli: add progress bar for file processing (#139) (0f5e5dd), closes #24
• discovery: add trailing-slash and double-star pattern support (3696e6a)
• discovery: add trailing-slash and double-star pattern support (#137) (3696e6a)
• docs: add breadcrumb back-links to rule pages (#136) (17e985b)

Bug Fixes

• docs: remove redundant f-string in rule_header macro (17e985b)

Documentation

• cli: add story 20.2 implementation record (56c6c62)

1.3.0 (2026-02-25)

Features

• config: add extend-exclude configuration key (#131) (15aa4ff), closes #18

Documentation

• config: add extend-exclude to configuration reference (6711525)

1.2.1 (2026-02-25)

Bug Fixes

• ci: add retry logic to TestPyPI publish workflow (08bff6f)
• ci: drop check-url that conflicts with --index in uv publish (799237b)
• ci: make test-publish resilient to TestPyPI 503s (cc51369)
• ci: use env var for check-url to avoid flag conflict (3b6d114)

Documentation

• add social preview and update tagline (#129) (b88f441)
• fix stale branch refs and version numbers across documentation (#118) (36912ff)
• site: bump version examples to v1.2.0 in CI integration page (36912ff)
• site: update CI badge to target main branch (36912ff)
• update development guide for single-branch workflow (36912ff)

1.2.0 (2026-02-25)

Features

• enrichment: tighten cross-reference rule to require linkable syntax (9520248)

Documentation

• add develop-main sync strategy to CLAUDE.md (ca0ad3f)
• config: mkdocstrings configuration overhaul (bb736eb)
• enrichment: convert See Also entries to clickable cross-reference links (f2ba236)
• enrichment: update cross-reference rule page for bracket syntax (9520248)

1.1.2 (2026-02-25)

Bug Fixes

• ci: rename action to Docvet Check for marketplace publishing (6ea3fbb)

1.1.1 (2026-02-24)

Bug Fixes

• ci: clean up duplicate changelog entries and phantom v1.0.1 section (99ca054)
• ci: resolve release-please changelog duplication (#93) (99ca054)
• ci: update release-please manifest version from 1.0.2 to 1.1.0 (99ca054)

Documentation

• add CI Integration page with GitHub Action and pre-commit snippets (#96) (af9b92d)
• add navigation links row to README for marketplace visitors (1889d8a)
• update docvet badge to purple branding (4e29e04)

1.0.2 (2026-02-23)

Bug Fixes

• add missing Change Log subsection to story template (#77) (46055de)
• api-ref: add error handling to _has_empty_all in gen_ref_pages (1704fce)
• ci: add contents read permission to test-publish workflow (601b035)
• ci: add target-branch main to release-please action (538d06b)
• ci: add target-branch to release-please config (#85) (3d8c02e)
• ci: add TestPyPI index config for uv publish --index testpypi (8da04cc)
• ci: use --index testpypi for correct OIDC token exchange (e344731)
• ci: use correct attest-action version (v0.0.4, not v1) (2cf75fd)
• remove sonar.branch.name property incompatible with Community Edition (50aaf65)

Documentation

• api-ref: auto-generated API reference pages (#81) (1704fce)
• cli: add 19 rule reference pages with YAML catalog and macros scaffold (#71) (6ab45f6)
• cli: add check pages, configuration reference, and site design (#68) (2408d1c)
• cli: scaffold documentation site with Getting Started and CLI Reference (#67) (42d43d6)
• config: add Configuration Reference page (2408d1c)
• coverage: add Coverage Check documentation page (2408d1c)
• enrichment: add Enrichment Check documentation page (2408d1c)
• freshness: add Freshness Check documentation page (2408d1c)
• glossary: add abbreviations file with 22 domain term tooltips (6c64670)
• glossary: add browsable glossary reference page (6c64670)
• glossary: add capitalized variants for complete tooltip coverage (6c64670)
• glossary: add domain glossary with inline tooltips (#79) (6c64670)
• griffe: add Griffe Check documentation page (2408d1c)

1.0.0 (2026-02-21)

Features

• enrichment: 10 rules detecting missing docstring sections — Raises, Yields, Receives, Warns, Other Parameters, Attributes, Typed Attributes, Examples, Cross-references, and fenced code blocks
• freshness: 5 rules detecting stale docstrings — signature changes (HIGH), body changes (MEDIUM), import changes (LOW), git-blame drift, and age-based staleness
• coverage: missing __init__.py detection for mkdocs discoverability
• griffe: 3 rules capturing griffe parser warnings for mkdocs rendering compatibility
• reporting: markdown and terminal output with configurable formats
• cli: 5 subcommands (check, enrichment, freshness, coverage, griffe) with --staged, --all, --files, --format, and --output options
• integrations: pre-commit hook and GitHub Action for CI/CD pipelines
• config: [tool.docvet] section in pyproject.toml with per-check configuration