gouml

README

Automatically generate PlantUML from Go Code.

example (self-reference):

Note that the interface of this library is still ALPHA level quality.
Breaking changes will be introduced frequently.

Usage

$ go get -u github.com/kazukousen/gouml/cmd/gouml
$ gouml --version

Run gouml init (or gouml i) . This will parse .go files and generate the plantUML file.

$ gouml i -f /path/to/package/subpackage1/ -f /path/to/package/subpackage2/foo.go

Fire or Directory you want to parse, you can use -f flag.

Ignore a target directory or file

You can use --ignore Flag.

$ gouml i -f /path/to/package/ --ignore /path/to/package/ignorepackage/

License

Copyright (c) 2019-present Kazuki Nitta

Licensed under MIT License

Documentation

Index

• func Compress(src string) string
• type Generator
  • func NewGenerator(logger log.Logger, parser Parser, isDebug bool) Generator
• type Parser
  • func PlantUMLParser(logger log.Logger) Parser

Functions

func Compress

func Compress(src string) string

Compress ...

Types

type Generator

type Generator interface {
	UpdateIgnore(files []string) error
	Read(files []string) error
	WriteTo(buf *bytes.Buffer) error
}

Generator ...

func NewGenerator

func NewGenerator(logger log.Logger, parser Parser, isDebug bool) Generator

NewGenerator ...

type Parser

type Parser interface {
	Build(pkgs []*types.Package)
	WriteTo(buf *bytes.Buffer)
}

Parser ...

func PlantUMLParser

func PlantUMLParser(logger log.Logger) Parser

PlantUMLParser ...