GitHub - julz/importas at d0bf5cb4e1db1eb8b99c8f20891c72938e60b385

julz / importas Public

Notifications You must be signed in to change notification settings
Fork 15
Star 16

linter to enforce consistent import aliases

16 stars 15 forks Branches Tags Activity

Notifications

Name		Name	Last commit message	Last commit date
Latest commit History 5 Commits
.github/workflows		.github/workflows
cmd/importas		cmd/importas
testdata/src		testdata/src
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
analyzer.go		analyzer.go
analyzer_test.go		analyzer_test.go
flags.go		flags.go
go.mod		go.mod
go.sum		go.sum

Repository files navigation

A linter to enforce importing certain packages consistently.

What is this for?

Ideally, go imports should avoid aliasing. Sometimes though, especially with Kubernetes API code, it becomes unavoidable, because many packages are imported as e.g. "[package]/v1alpha1" and you end up with lots of collisions if you use "v1alpha1".

This linter lets you enforce that whenever (for example) "pkg/apis/serving/v1alpha1" is aliased, it is aliased as "servingv1alpha1".

Usage

importas \
  -alias knative.dev/serving/pkg/apis/autoscaling/v1alpha1:autoscalingv1alpha1 \
  -alias knative.dev/serving/pkg/apis/serving/v1:servingv1 \
  ./...