Go Import Cycle

goimportcycle is a tool to visualize Go imports resolved to the package or file level.

Installation

go install github.com/samlitowitz/goimportcycle/cmd/[email protected]

Usage

goimportcycle -path examples/simple/ -dot imports.dot
dot -Tpng -o assets/example.png imports.dot

Red lines indicate files causing import cycles between packages. Packages involved in a cycle have their backgrounds colored red.

goimportcycle -path examples/simple/ -dot imports.dot -resolution package
dot -Tpng -o assets/example.png imports.dot

Red lines indicate import cycles between packages.

Configuration

The configuration file follows the JSON Schema outlined in assets/config-schema.

The simple-config example uses the following schema...

palette:
  base:
    packageName: "rgb(174, 209, 230)"
    packageBackground: "rgb(207, 232, 239)"
    fileName: "rgb(160, 196, 226)"
    fileBackground: "rgb(198, 219, 240)"
    importArrow: "rgb(133, 199, 222)"
  cycle:
    packageName: "#FFB3C6"
    packageBackground: "#FFE5EC"
    fileName: "#FF8FAB"
    fileBackground: "#FFC2D1"
    importArrow: "#FB6F92"

...to produce the following outputs...