docs: document all test scripts in test/README.md - #2807
Conversation
Greptile SummaryThe PR expands
Confidence Score: 4/5The PR appears safe to merge, with a non-blocking documentation correction needed to avoid presenting an incomplete command as the full test suite. The documented files, fixtures, link, and suite descriptions are accurate, but Files Needing Attention: test/README.md
|
| Filename | Overview |
|---|---|
| test/README.md | The new test catalog is otherwise accurate, but the quick-start section overstates the coverage provided by npm test. |
Prompt To Fix All With AI
### Issue 1
test/README.md:11-12
**Full suite claim omits tests**
`npm test` does not execute the newly documented rehype-plugin and workflow-path-regex tests, so describing it as the full test suite gives contributors and CI users an inaccurate picture of which coverage has passed.
```suggestion
# Run the npm test suite
npm test
```
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.Reviews (1): Last reviewed commit: "docs: document all test scripts in test/..." | Re-trigger Greptile
| # Run the full test suite | ||
| npm test |
There was a problem hiding this comment.
npm test does not execute the newly documented rehype-plugin and workflow-path-regex tests, so describing it as the full test suite gives contributors and CI users an inaccurate picture of which coverage has passed.
| # Run the full test suite | |
| npm test | |
| # Run the npm test suite | |
| npm test |
Prompt To Fix With AI
This is a comment left during a code review.
Path: test/README.md
Line: 11-12
Comment:
**Full suite claim omits tests**
`npm test` does not execute the newly documented rehype-plugin and workflow-path-regex tests, so describing it as the full test suite gives contributors and CI users an inaccurate picture of which coverage has passed.
```suggestion
# Run the npm test suite
npm test
```
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Team Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review. 📝 WalkthroughWalkthroughThe test README now documents the full test command, eleven additional test suites, and the ChangesTest Documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to This documentation-only change adds descriptions for existing test scripts and fixtures without modifying runtime or product behavior; no actionable merge-blocking risk remains beyond normal checks and review. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Docstring CoverageExplanation No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.) ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
What
test/README.mdonly documented 2 of the 13 test scripts that currently exist undertest/(plus its fixtures and the separate adversarial-review eval suite). This adds a short entry for each undocumented script and fixture directory.Why
Several test files (channel resolution, source URL parsing, rehype plugins, shim policy, site URL, template sync, published implementation model, skill validation, workflow path regex, and the build-auto renderer) had no description in the README, making it hard to know what coverage already exists before adding new tests.
How
### <Name>section with file path and one-line description for each undocumentedtest/*.jsandtest/*.mjsscripttest/fixtures/validate-skills/to the fixtures tree (was missing)test/adversarial-review-tests/README.mdfor the separate manual eval suitenpm testto Quick Start alongside the existingnpm run qualityTesting
Ran
npm run lint:mdand the fullnpm testsuite (via the repo's pre-commit hook) — both pass. This is a documentation-only change with no code modifications.