Choose an import ordering convention and write a tool to format imports that way

[grantr]

From #1078. There are a few different ideas of how to order imports and where the line breaks should be. Let's decide which style makes sense to the most people, then implement a formatter in sockpuppet that can reformat imports automatically.

Examples of conventions that have been proposed:

import (
  // standard lib, enforced by gofmt
  "log"

  // vendored code. These packages cannot be changed by the developer.
  corev1 "k8s.io/api/core/v1"

  // in-repo code. These packages can be changed by the developer.
  "github.com/knative/eventing/pkg/broker"

  // dot imports. These are separate because the developer must recognize them in advance
  // to understand the code.
  . "github.com/knative/pkg/controller/testing"
)

import (
  // standard lib, enforced by gofmt
  "log"

  // vendored code. These packages cannot be changed by the developer.
  corev1 "k8s.io/api/core/v1"

  // vendored code. These packages cannot be changed by the developer.
  cloudevents "github.com/cloudevents/sdk-go"

  // in-repo code. These packages can be changed by the developer.
  "github.com/knative/eventing/pkg/broker"

  // dot imports. These are separate because the developer must recognize them in advance
  // to understand the code.
  . "github.com/knative/pkg/controller/testing"
)

import (
  // standard lib, enforced by gofmt
  "log"

  // dot imports. These are separate because the developer must recognize them in advance
  // to understand the code. These are also quite rare.
  . "github.com/knative/pkg/controller/testing"

  // All 'normal' imports that aren't part of the standard lib, regardless of whether they are in repo or vendored.
  corev1 "k8s.io/api/core/v1"
  "github.com/knative/eventing/pkg/broker"
)

/good-first-issue

[knative-prow-robot]

@grantr:
This request has been marked as suitable for new contributors.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.

Details

In response to this:

From #1078. There are a few different ideas of how to order imports and where the line breaks should be. Let's decide which style makes sense to the most people, then implement a formatter in sockpuppet that can reformat imports automatically.

Examples of conventions that have been proposed:

import (
 // standard lib, enforced by gofmt
 "log"

 // vendored code. These packages cannot be changed by the developer.
 corev1 "k8s.io/api/core/v1"

 // in-repo code. These packages can be changed by the developer.
 "github.com/knative/eventing/pkg/broker"

 // dot imports. These are separate because the developer must recognize them in advance
 // to understand the code.
 . "github.com/knative/pkg/controller/testing"
)

import (
 // standard lib, enforced by gofmt
 "log"

 // vendored code. These packages cannot be changed by the developer.
 corev1 "k8s.io/api/core/v1"

 // vendored code. These packages cannot be changed by the developer.
 cloudevents "github.com/cloudevents/sdk-go"

 // in-repo code. These packages can be changed by the developer.
 "github.com/knative/eventing/pkg/broker"

 // dot imports. These are separate because the developer must recognize them in advance
 // to understand the code.
 . "github.com/knative/pkg/controller/testing"
)

import (
 // standard lib, enforced by gofmt
 "log"

 // dot imports. These are separate because the developer must recognize them in advance
 // to understand the code. These are also quite rare.
 . "github.com/knative/pkg/controller/testing"

 // All 'normal' imports that aren't part of the standard lib, regardless of whether they are in repo or vendored.
 corev1 "k8s.io/api/core/v1"
 "github.com/knative/eventing/pkg/broker"
)

/good-first-issue

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[evankanderson]

My $0.02:

1. dot imports are a bad idea, let's not do them.
2. Can we just use gofmt and pack things together such that gofmt produces only one reasonable choice?

I don't see a particular reason to try to separate out the github.com/knative/blah imports further than sorting already provides.

[n3wscott]

1. dot imports are a bad idea, let's not do them.

Agreed, except in tests.

2. Can we just use gofmt and pack things together such that gofmt produces only one reasonable choice?

Yes, but also make a block of k8s.io imports for readability.

[vaikas]

I think knobots handle this now for us.
@grantr if you don't think this has been fixed, please reopen.