Documentation
¶
Overview ¶
Package report generates the human-readable markdown reports for gograph.
Index ¶
- func GenerateConcurrency(g *graph.Graph) string
- func GenerateConfig(g *graph.Graph) string
- func GenerateDeps(g *graph.Graph) string
- func GenerateErrors(g *graph.Graph) string
- func GenerateIndex(g *graph.Graph) string
- func GenerateRoutes(g *graph.Graph) string
- func GenerateSQL(g *graph.Graph) string
- func GenerateSymbols(g *graph.Graph) string
- func GenerateTests(g *graph.Graph) string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GenerateConcurrency ¶ added in v1.2.0
GenerateConcurrency produces graph-concurrency.md (goroutines, channels, sync).
func GenerateConfig ¶ added in v1.2.0
GenerateConfig produces graph-config.md (Environment Variables).
func GenerateDeps ¶ added in v1.2.0
GenerateDeps produces graph-deps.md (external dependencies, package imports).
func GenerateErrors ¶ added in v1.2.0
GenerateErrors produces graph-errors.md (Errors and panics).
func GenerateIndex ¶ added in v1.2.0
GenerateIndex produces the main GRAPH_REPORT.md file containing the summary and routing table.
func GenerateRoutes ¶ added in v1.2.0
GenerateRoutes produces graph-routes.md (HTTP routes).
func GenerateSQL ¶ added in v1.2.0
GenerateSQL produces graph-sql.md (SQL queries).
func GenerateSymbols ¶ added in v1.2.0
GenerateSymbols produces graph-symbols.md (important files, important symbols, all packages).
func GenerateTests ¶ added in v1.2.0
GenerateTests produces graph-tests.md (Test edges).
Types ¶
This section is empty.
Source Files