bbmoz/gochu

View a graph of your project

Gochu

View a graph of your project!

Get Started

$ npm install -g gochu

There are two ways to generate a graph:

1. Screenshot

$ gochu start
$ gochu run -s -t 'example/**/*.js'   # see .gochu/ for screenshots

2. Live Graph

$ gochu start
$ gochu run -t 'example/**/*.js'  # open http://localhost:8080

*Make sure to start the gochu web server before generating a graph.

CLI

$ gochu start             # start web server at localhost:8080
$ gochu stop              # stop web server
$ gochu run [-s|--screenshot] [-t|--target '<glob>']  # generate graph
$ gochu [-h|--help]       # show all commands
$ gochu run [-h|--help]   # show "run" command info

Features

• visual graph of project files and their relationships
• real-time graph each time gochu run -t is executed
• generate screenshots with -s option
• support ES6 modules (import and export)

Enjoy!

gochu's Issues

single-run HTML generation and screenshots

Execute binary to either generate HTML as a single-run or spin up a server that updates localhost:5050 with a new graph upon changes to the specified target files in .gochurc. It may also be worth to look into screenshots instead of generating an HTML file.

#2
#3

start gochu-web automatically when gochu starts

It is too inconvenient to run gochu-web and then open a new tab to run gochu. Simply running gochu should start (if not already started) the gochu web server and then run gochu as usual. There should be a new option to stop the server. For example, gochu stop. It would also be nice to have gochu start to start the server by itself without running gochu.

visual studio code / atom plugin

Plugin:

• show gochu graph (like preview mode for markdown files) on hotkey combo
• navigate project by clicking on a node on the graph

support files with flow types

When running gochu on files with flow types, an error occurs regarding an unexpected token :.

For now if you come across this issue, you would have to first strip away the flow types before running gochu. Maybe we can look into flow-parser.

generate HTML file that displays the graph

This includes combining the execution of the client, server, and lib that ends when the HTML file is generated.

The .gochurc #2 should allow the user to specify the directory to generate the HTML file as well as the filename itself. If dir doesn't exist, create it during generation. The default filename could be gochu.html.

Currently, the client relies on a browser window environment to generate the cytoscape graph. Maybe we can use jsdom or something similar and then generate the html from that, so that the gochu tool can run in headless CI. This should be a single binary.

.gochurc config file to specify various options

.gochurc

In addition to the default path to parse, style options for the graph visualization can be specified. It would be nice to do gochu init to generate a default config file.

support nested hierarchies when parsing files

The globber and parser have trouble looking into nested hierarchies.

edges show what is imported

TODO items before publishing to npm

TODO:

1. hook up semantic release for auto versioning and publishing
2. create README
3. incorporate flow types e40891d 890e976
4. CLI 2de1a0f (precursor to #7)

support additional module formats

Atm, only es6 modules (import, export) are supported. It would be great if we supported other module formats.

• es6 (import, export)
• commonjs (require)
• amd (define)

npm deps should be bundled for dist/

When running gochu, it complains about not being able to find some npm modules. These should come included.

node hover reveals file location