pkgforbid

README

pkgforbid

pkgforbid is a linter for checking if a package imports a particular package.

Use cases

If you want to prohibit dependencies on internal packages

graph TD

domain --> repository

If you want to prohibit dependencies on standard libralies

graph TD

domain --> net/http

If you want to prohibit dependencies on standard libralies via internal packages

graph TD

domain --> util --> net/http

How to run

pkgforbid --config=pkgforbid.yaml ./...

Config file

packageConfigs:
  "github.com/foo/bar/domain":
    forbiddenPackages:
      - net/http
      - database/sql
      - gorm.io/gorm
      - github.com/foo/bar/repository
  "github.com/foo/bar/service":
    forbiddenPackages:
      - github.com/foo/bar/repository
debug: false

Documentation

Index

• Variables

Variables

var (
	ConfigFile *string

	Dependencies map[string]map[string]bool

	Analyzer = &analysis.Analyzer{
		Name: "pkgforbid",
		Doc:  "pkgforbid",
		Run:  run,
	}
)