verify-docs-tests

Name: verify-docs-tests
Availability: InStock
Author: Wayne

Compare public API exports with documentation and test coverage across fe-tools packages.

207|39|Updated Aug 29, 2017

Search Tags:#testing #docs #verify #package #tests #exports #fe-tools

Ready to run

npx skills add https://github.com/MichealWayne/fe-tools --skill verify-docs-tests

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: verify-docs-tests
Source: https://github.com/MichealWayne/fe-tools/tree/main/utils/.cursor/skills/verify-docs-tests
Command: npx skills add https://github.com/MichealWayne/fe-tools --skill verify-docs-tests

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

fe-tools projects often suffer from drift between API exports and their documentation, making it hard to keep user-facing docs in sync.

Core Features & Use Cases

Verify that exported APIs in packages/*/src/index.ts match the documented behavior and API surface.
Ensure new or changed functions have corresponding tests in packages/*/tests/.
Provide actionable recommendations and commands to fix drift, re-run tests, and refresh docs.

Quick Start

Run the verify-docs-tests workflow for all packages to validate exports, tests, and documentation alignment.

Frequently Asked Questions about verify-docs-tests

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I verify that my package exports match the public documentation?▼

To verify package exports match documentation, you need to check the API surface in your source index files against the docs. This skill identifies mismatches between exported APIs and their documentation across fe-tools packages, outputting a concise report of discrepancies.

How do I ensure tests exist for new API exports in my monorepo?▼

To ensure tests exist for new API exports, you must validate that corresponding test files are present. This skill checks packages/*/__tests__/ directories to confirm that exported functions have associated tests, highlighting any gaps in test coverage.

Why does my frontend tools documentation drift from the actual API exports?▼

Documentation drifts from API exports when changes to source files are not reflected in user-facing docs. This skill detects such drift by comparing packages/*/src/index.ts exports against public documentation to pinpoint inconsistencies.

What is the best way to sync API docs and tests across multiple packages?▼

The best way to sync API docs and tests is to run an automated verification workflow. This skill validates alignment across fe-tools packages, providing actionable commands to re-run tests and refresh docs when discrepancies are found.

Can I automatically generate commands to fix documentation and test drift?▼

Yes, you can generate commands to fix documentation and test drift. Upon detecting mismatches between exports and docs, this skill suggests specific commands to run tests and generate docs to resolve the discrepancies.

Does this verification tool work with monorepo structures like fe-tools?▼

Yes, this verification tool works with monorepo structures like fe-tools. It applies to all packages where exports exist, specifically checking the index.ts files and test directories within the packages/* path.