Create a tree visualization of any project with this CLI tool. When ramping people up on an existing codebase, there's often a lot of state they have to understand about the project- where everything is, where everything starts, exceptional files. With this tool, you can generate a visualization of any project, as well modify certain directories to be open, or have notes that people can read through easily.
Installation
npm i -g project-explorer
Here's an example of what we'll be generating:
A working example of this exists here. I created this for Vue core off of notes taken at a core meeting as Evan You walked us through some of the file structure.
Prerequisites:
You need to be running Node 8 or higher
You have to have Yarn installed.
Usage:
To create the visualization in the same folder as your project…
I agree. I feel like we might even want to point to this for onboarding into our project
Looks like it would be the perfect use case for this:
🎋A CLI tool to create an annotated tree visualization of any project
Create a tree visualization of any project with this CLI tool. When ramping people up on an existing codebase, there's often a lot of state they have to understand about the project- where everything is, where everything starts, exceptional files. With this tool, you can generate a visualization of any project, as well modify certain directories to be open, or have notes that people can read through easily.
Installation
Here's an example of what we'll be generating:
A working example of this exists here. I created this for Vue core off of notes taken at a core meeting as Evan You walked us through some of the file structure.
Prerequisites:
Usage: