folder-to-json

Convert any folder into a JSON tree or Markdown file — perfect for docs, CLI tools, and static site generators.

Features

- Converts directory structures into easy-to-read JSON or Markdown trees
- Exclude folders like node_modules, dist, etc.
- CLI support with flexible options
- Ideal for generating folder visualizations for documentation or tooling

Installation

``bash
npm install -g folder-to-json
``

Usage

`bash
folder-to-json ./src --output tree.json --format json --exclude node_modules,dist
folder-to-json ./src --output tree.md --format md
`

CLI Options

| Option | Description | Default |
| ----------- | --------------------------------------------- | ----------- |
| --output | Output file path | tree.json |
| --format | Output format: json or md | json |
| --exclude | Comma-separated list of directories to ignore | (none) |

Example Output

$3

`json
{
"src": {
"index.js": null,
"utils": {
"math.js": null
}
}
}
`

$3

`
src/
├── index.js
└── utils/
└── math.js
``

Why Use This?

Developers love file tree visualizations but hate maintaining them manually. This tool automates that process, making your docs and projects cleaner and easier to navigate.

License

MIT © MuerteSeguraZ