Feature: Handle Nested JSON Conversion to Markdown

[krishana7911]

Description:

Currently, the CLI converts only flat JSON structures into Markdown tables. However, when the JSON contains nested objects or arrays, the output becomes inconsistent. We need to brainstorm and decide how to represent nested structures effectively in Markdown.

Possible Approaches:

• Flattening: Convert nested keys into dot notation (e.g., user.name, user.address.street).
• Multi-line cells: Display nested objects as multi-line content within a single cell.
• Separate tables: Create sub-tables for each nested object.
• Custom formatting: Provide a user-defined template for complex structures.

Open Questions:

• Should we handle arrays differently from objects?
• How do we maintain readability while keeping the table concise?
• Do we need additional CLI flags to toggle the handling mode?

Next Steps:

• Discuss preferred approaches.
• Choose a solution based on feasibility and usability.
• Implement and test.

[krishana7911]

🔑 1. Unlimited (Deep) Nesting

How it works: Recursively flatten the JSON, converting all levels into table-friendly key-value pairs.

{
  "id": 1,
  "name": "Alice",
  "address": {
    "city": "New York",
    "geo": {
      "lat": 40.7128,
      "lng": -74.0060
    }
  }
}

Becomes:

id	name	address.city	address.geo.lat	address.geo.lng
1	Alice	New York	40.7128	-74.0060

• Pros: Handles any complexity.
• Cons: Can lead to wide tables, making readability hard.

2. Limited Nesting (Best Practice)

How it works: Only flatten up to a defined depth (e.g., 2 or 3 levels).

Example (depth 2):

id	name	address.city	address.geo
1	alice	New York	[object]

• Pros: Clean output, easier for users to work with.
• Cons: Deep data may get truncated.

What Should You Choose?

• If it's user-facing and readability matters, go with limited nesting and offer a --depth flag.
• If you want raw data conversion, unlimited nesting works but requires careful formatting.

My suggestion: Support both. Default to --depth=2, but allow users to override it (--depth=5 or --depth=all). This gives flexibility while maintaining clarity.