roadmap2xlsx

📌 Roadmap2XLSX

Roadmap2XLSX converts your GitHub project roadmap (in TSV format) into a beautifully formatted Excel Gantt chart.

[!NOTE] The repository's example folder contains the sample input (roadmap.tsv) and the generated demo output (gantt.xlsx)

📚 Table of Contents

• 🚀 Features
• 📥 How to Export Your GitHub Roadmap Data
• 📦 Installation & Usage
• 🔧 Development
• 📁 Project Structure
• 📜 License & Credits

🚀 Features

• 📝 TSV Parsing: Reads GitHub project roadmaps exported as TSV.
• 🗂️ Task Grouping: Automatically groups tasks by repository.
• 📆 Gantt Timeline: Generates a full-week Gantt chart.
• 🎨 Conditional Formatting: Creates a polished Excel output.
• ⚡ CLI Simplicity: Run directly via npx roadmap2xlsx or install globally.

📥 How to Export Your GitHub Roadmap Data

Refer to GitHub's guide on Exporting Your Projects Data.

📦 Installation & Usage

Run without installation:

npx roadmap2xlsx --input path/to/tasks.tsv --output path/to/roadmap.xlsx

Or install globally:

npm install -g roadmap2xlsx

roadmap2xlsx --input path/to/tasks.tsv --output path/to/roadmap.xlsx

🔧 Development

# Install dependencies
pnpm install

# Run the CLI in development mode
pnpm dev

# Build the project
pnpm build

# Lint & format
pnpm lint
pnpm lint:fix
pnpm format
pnpm format:fix

# Run tests
pnpm test

📁 Project Structure

• 🏗️ src/cli.ts – CLI entry point
• 📄 src/parse.ts – TSV parsing logic
• 📏 src/config/ – Style, layout, and color configurations
• 📊 src/roadmap/ – Excel Gantt chart generation

📜 License & Credits

📝 Licensed under MIT. Created by Ben Wolf.

🙏 This project leverages ExcelJS for Excel file generation, commander for CLI argument parsing, and csv-parser for TSV/CSV processing.

✨ Contributions are welcome! Open an issue or submit a pull request on GitHub.