output-format

Output Format Guide

All plugin outputs should be visually clear and beautiful. Choose the format that best fits the content.

---

EXECUTION INSTRUCTIONS

When generating output for any OAS plugin command, Claude MUST:

1. Select appropriate format based on content type (see Format Selection below)
2. Use consistent styling within a single output
3. Keep width under 80 characters for terminal compatibility
4. Use emojis sparingly - only for status indicators
5. Add blank lines between sections for readability

This is a REFERENCE skill - use it to format outputs from other commands.

---

Format Selection

Content Type           → Best Format
─────────────────────────────────────
Key-Value pairs        → Table or Aligned
Process/Steps          → Flow Diagram
Hierarchy/Structure    → Tree
Before/After           → Comparison
Status/Progress        → Progress Bar
Summary                → Box
List with status       → Checklist
Timeline               → Timeline

---

1. Tables (Structured Data)

For structured key-value or multi-column data:

┌──────────────┬─────────────────────────────────────┐
│     Item     │              Content                │
├──────────────┼─────────────────────────────────────┤
│ File         │ src/api/user-api.ts                 │
│ Location     │ getUserById() function (line 45-52) │
│ Reason       │ Response type: email field added    │
└──────────────┴─────────────────────────────────────┘

Simple aligned format (for fewer columns):

File:     src/api/user-api.ts
Location: getUserById() function (line 45-52)
Reason:   Response type: email field added

---

2. Flow Diagrams (Process/Steps)

Horizontal flow:

┌─────────┐    ┌─────────┐    ┌─────────┐    ┌─────────┐
│  Fetch  │───▶│  Parse  │───▶│  Diff   │───▶│ Generate│
│  Spec   │    │  Schema │    │ Compare │    │  Code   │
└─────────┘    └─────────┘    └─────────┘    └─────────┘

Vertical flow with details:

    ┌──────────────────────────────┐
    │   1. Fetch OpenAPI Spec      │
    │      GET /openapi.json       │
    └──────────────┬───────────────┘
                   │
                   ▼
    ┌──────────────────────────────┐
    │   2. Compare with Cache      │
    │      Hash: abc123 → def456   │
    └──────────────┬───────────────┘
                   │
          ┌───────┴───────┐
          ▼               ▼
    ┌──────────┐    ┌──────────┐
    │ Changed  │    │ No Change│
    │ Continue │    │   Done   │
    └────┬─────┘    └──────────┘
         │
         ▼
    ┌──────────────────────────────┐
    │   3. Generate Code           │
    └──────────────────────────────┘