https://github.com/samlitowitz/goimportcycle

Tooling for Go import cycles
https://github.com/samlitowitz/goimportcycle

Last synced: about 2 months ago
JSON representation

Tooling for Go import cycles

• Host: GitHub
• URL: https://github.com/samlitowitz/goimportcycle
• Owner: samlitowitz
• License: apache-2.0
• Created: 2022-01-02T06:01:10.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-05-11T16:56:33.000Z (5 months ago)
• Last Synced: 2024-06-22T15:50:54.473Z (3 months ago)
• Language: Go
• Size: 977 KB
• Stars: 61
• Watchers: 2
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.markdown
  • License: LICENSE

Awesome Lists containing this project

README

        
# Go Import Cycle

[![Go Report Card](https://goreportcard.com/badge/github.com/samlitowitz/goimportcycle)](https://goreportcard.com/report/github.com/samlitowitz/goimportcycle)

`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

```shell

goimportcycle -path examples/simple/ -dot imports.dot

dot -Tpng -o assets/example.png imports.dot

```

![Example import graph resolved to the file level](assets/examples/simple/file.png?raw=true "Example import graph resolved to the file level")

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

```shell

goimportcycle -path examples/simple/ -dot imports.dot -resolution package

dot -Tpng -o assets/example.png imports.dot

```

![Example import graph resolved to the package level](assets/examples/simple/package.png?raw=true "Example import graph resolved to the package level")

Red lines indicate import cycles between packages.

## Configuration

The configuration file follows the JSON Schema outlined in [assets/config-schema](assets/config-schema).

The [simple-config example](examples/simple-config) uses the following schema...

```yaml

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...

![Example import graph resolved to the file level](assets/examples/simple-config/file.png?raw=true "Example import graph resolved to the file level")

![Example import graph resolved to the package level](assets/examples/simple-config/package.png?raw=true "Example import graph resolved to the package level")