depslint

This tool is a linter that checks dependencies based on import statements.
This will help you practice things like clean architecture.

Installation

go install github.com/ogugu9/depslint/cmd/depslint@latest

Usage

First, create .depslint.puml like below.

@startuml "clean arachitecture"
[adapter] --> [usecase]
[usecase] --> [entity]
@enduml

Then, execute like below.

go vet -vettool=$(which depslint) -depslint.root=`pwd` ./...

Example

Here is example for .depslint.puml.

@startuml "layer"
[aa] --> [bb]
[cc] --> [bb]
@enduml

And then target go file is below.

package bb

import (
	"log"

	"github.com/ogugu9/a/aa"
	//lint:ignore depslint
	"github.com/ogugu9/a/cc"
	"go.uber.org/zap"
)

func BBB() {
	aa.AAA()
	cc.CCC()
	log.Println("AAA")
	logger, _ := zap.NewDevelopment()
	logger.Info("AAA")
}

The result will be like...

go vet -vettool=$(which depslint) -depslint.root=`pwd` ./...
# github.com/ogugu9/a/bb
bb/bb.go:6:2: dependency violation: github.com/ogugu9/a/bb -> github.com/ogugu9/a/aa