feat: Coverage with visual progress bars#4
Merged
Conversation
binaryk
reviewed
Jan 26, 2026
Comment on lines
+597
to
+605
| **Supported frameworks:** | ||
| - **Next.js** - App Router routes and pages | ||
| - **React** - Function and class components | ||
| - **Vue/Svelte** - Single-file components | ||
| - **Express** - Route handlers | ||
| - **FastAPI/Flask** - Python API routes | ||
| - **Laravel** - PHP routes | ||
| - **Prisma** - Database models | ||
| - **TypeScript** - Interfaces and types |
Collaborator
Author
There was a problem hiding this comment.
remove only this part or all the changes in readme.md ?
There was a problem hiding this comment.
Pull request overview
This PR introduces a comprehensive documentation coverage analysis feature to the aidocs CLI, enabling developers to measure how well their codebase is documented. The feature scans for routes, components, and models across multiple frameworks and checks which items are mentioned in the documentation, providing coverage metrics with visual progress bars.
Changes:
- Added a new
coveragecommand that analyzes documentation coverage for routes, components, and models with support for Next.js, React, Vue, Svelte, Express, FastAPI, Flask, Laravel, and Prisma - Implemented multiple output formats (summary with progress bars, JSON, CSV) and CI integration with configurable coverage thresholds
- Updated documentation (README.md and CLAUDE.md) with usage examples and architecture details
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
src/aidocs_cli/coverage.py |
New module implementing coverage analysis with framework detection, pattern-based code scanning, and documentation reference matching |
src/aidocs_cli/cli.py |
Added coverage command with helper functions for progress bars, color coding, and three output format handlers (summary, JSON, CSV) |
pyproject.toml |
Bumped version to 0.18.0 to reflect new feature |
uv.lock |
Updated lock file with version 0.18.0 (dependencies python-dotenv and watchdog already used elsewhere) |
README.md |
Added comprehensive documentation for the coverage command including options, examples, supported frameworks, and CI/CD integration |
CLAUDE.md |
Updated architecture documentation to include the new coverage module and its responsibilities |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
This pull request introduces a new documentation coverage analysis feature to the
aidocsCLI, allowing users to assess how well their codebase is documented. The main changes include the addition of theaidocs coveragecommand, updates to documentation and architecture guides, and a version bump to reflect the new functionality.New Documentation Coverage Feature:
coveragecommand to the CLI that scans the codebase for routes, components, and models, and checks which items are mentioned in the documentation. The command supports summary, JSON, and CSV output formats, CI integration, custom thresholds, and various display options.CLAUDE.mdto include the newcoverage.pymodule and its responsibilities. [1] [2]aidocs coveragein the mainREADME.md, including example output, supported frameworks, and CI/CD integration instructions.Other Changes:
0.18.0inpyproject.tomlto reflect the addition of the coverage feature.