Vitest Llm Docs

What it does

The vitest-llm-docs skill allows AI agents to generate documentation from Vitest test files. It can extract information like test descriptions, expected outcomes, and assertions directly from the code, creating human-readable documentation. This streamlines the process of understanding and maintaining complex testing suites by automating a significant portion of the documentation effort.

When to use it

• Automated Documentation Generation: Quickly create documentation for existing Vitest test suites without manual writing.
• Onboarding New Team Members: Help new developers understand the purpose and functionality of tests by providing clear, generated documentation.
• Refactoring & Maintenance: Automatically update documentation when tests are modified or refactored.
• Generating API Documentation: Derive usage examples and expected behavior from Vitest integration tests for APIs.

Key capabilities

• Generates documentation directly from Vitest test files.
• Extracts test descriptions, assertions, and expected outcomes.
• Creates human-readable documentation from code.

Example prompts

• "Generate documentation for the src/components/button.test.ts file."
• "Explain the purpose of the tests in integration/api.test.js."
• "Create a summary of all assertions made in the utils/string-helpers.test.ts file."

Tips & gotchas

• The quality of generated documentation depends on clear and descriptive test comments within the Vitest files. Well-written tests will produce better results.