TeaForge

Convert pytest and Jest tests into PCL documents and Mermaid coverage reports.

Updated Mar 15, 2026
One-click install
npx skills add https://github.com/cyberyimein/TeaForge --skill teaforge
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: TeaForge
Source: https://github.com/cyberyimein/TeaForge/tree/main/skill
Command: npx skills add https://github.com/cyberyimein/TeaForge --skill teaforge

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

TeaForge empowers AI agents to convert Python pytest and TypeScript/Jest suites into Japanese-style unit test documentation and Mermaid-enhanced coverage reports, giving clear guidance on parameter and branch coverage while preventing undisciplined test generation.

Core Features & Use Cases

  • Japanese-style test methodology: Identify normal, boundary, and abnormal parameters plus every branch to reach C1 coverage and maintain single-responsibility, minimal-delta test cases.
  • PCL and export pipeline: Use teaforge pcl generate, optionally export HTML to PDF, and query individual test cases with teaforge get.
  • Coverage with flowcharts: Select business functions with non-trivial branching, author Mermaid flowchart TD diagrams, validate and persist them, then run teaforge coverage generate with the repeated --function flags to produce coverage reports that include those diagrams.

Quick Start

Use TeaForge to convert the pytest suite for user_service into PCL HTML and Mermaid coverage diagrams for its branching business functions.

Frequently Asked Questions about TeaForge

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

FAQPage Schema
How do I convert pytest and jest tests into structured documentation?

You can convert pytest and jest tests into structured documentation by running TeaForge CLI commands to generate Japanese-style PCL HTML and Mermaid coverage flowcharts for every non-trivial business function.

What is a PCL document in unit test coverage reporting?

A PCL document is a Japanese-style unit test report that identifies normal, boundary, and abnormal parameters to guarantee parameter and branch coverage visibility for your test suites.

How do I generate Mermaid flowcharts for branch coverage auditing?

You generate Mermaid flowcharts by authoring `flowchart TD` diagrams for branching business functions, then running `teaforge coverage generate` with repeated `--function` flags to produce coverage reports that include those diagrams.

Can I export pytest test documentation to PDF using TeaForge?

Yes, you can export pytest test documentation to PDF by first generating PCL HTML and then optionally exporting the HTML output to PDF format using the TeaForge CLI pipeline.

Does TeaForge work with TypeScript Jest modules?

Yes, TeaForge works with TypeScript Jest modules to automate test documentation and auditing, ensuring single-responsibility, minimal-delta test cases and C1 branch coverage visibility.

Why use Japanese-style test methodology for branch coverage?

Japanese-style test methodology enforces identifying every branch to reach C1 coverage and maintains single-responsibility test cases, preventing undisciplined test generation across your Python pytest and TypeScript Jest suites.