Add vanity imports to internal packages (#2280)

* `porto -w --include-internal .`

* Bump `porto` to 0.4.0 and include internal files

Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>

Makefile

@@ -145,7 +145,7 @@ lint: misspell lint-modules | $(GOLANGCI_LINT)
 
 .PHONY: vanity-import-check
 vanity-import-check: | $(PORTO)
-	$(PORTO) -l .
+	$(PORTO) --include-internal -l .
 
 .PHONY: misspell
 misspell: | $(MISSPELL)

bridge/opencensus/internal/handler.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package internal
+package internal // import "go.opentelemetry.io/otel/bridge/opencensus/internal"
 
 import "go.opentelemetry.io/otel"
 

bridge/opencensus/internal/oc2otel/attributes.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package oc2otel
+package oc2otel // import "go.opentelemetry.io/otel/bridge/opencensus/internal/oc2otel"
 
 import (
 	octrace "go.opencensus.io/trace"

bridge/opencensus/internal/oc2otel/span_context.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package oc2otel
+package oc2otel // import "go.opentelemetry.io/otel/bridge/opencensus/internal/oc2otel"
 
 import (
 	octrace "go.opencensus.io/trace"

bridge/opencensus/internal/oc2otel/tracer_start_options.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package oc2otel
+package oc2otel // import "go.opentelemetry.io/otel/bridge/opencensus/internal/oc2otel"
 
 import (
 	"fmt"

bridge/opencensus/internal/otel2oc/span_context.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package otel2oc
+package otel2oc // import "go.opentelemetry.io/otel/bridge/opencensus/internal/otel2oc"
 
 import (
 	octrace "go.opencensus.io/trace"

bridge/opencensus/internal/span.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package internal
+package internal // import "go.opentelemetry.io/otel/bridge/opencensus/internal"
 
 import (
 	"fmt"

bridge/opencensus/internal/tracer.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package internal
+package internal // import "go.opentelemetry.io/otel/bridge/opencensus/internal"
 
 import (
 	"context"

bridge/opentracing/internal/mock.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package internal
+package internal // import "go.opentelemetry.io/otel/bridge/opentracing/internal"
 
 import (
 	"context"

exporters/otlp/otlpmetric/internal/connection/connection.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package connection
+package connection // import "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal/connection"
 
 import (
 	"context"

exporters/otlp/otlpmetric/internal/metrictransform/attribute.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package metrictransform
+package metrictransform // import "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal/metrictransform"
 
 import (
 	"go.opentelemetry.io/otel/attribute"

exporters/otlp/otlpmetric/internal/metrictransform/metric.go

@@ -14,7 +14,7 @@
 
 // Package transform provides translations for opentelemetry-go concepts and
 // structures to otlp structures.
-package metrictransform
+package metrictransform // import "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal/metrictransform"
 
 import (
 	"context"

exporters/otlp/otlpmetric/internal/metrictransform/resource.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package metrictransform
+package metrictransform // import "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal/metrictransform"
 
 import (
 	resourcepb "go.opentelemetry.io/proto/otlp/resource/v1"

exporters/otlp/otlpmetric/internal/otlpconfig/envconfig.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package otlpconfig
+package otlpconfig // import "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal/otlpconfig"
 
 import (
 	"crypto/tls"

exporters/otlp/otlpmetric/internal/otlpconfig/options.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package otlpconfig // import "go.opentelemetry.io/otel/exporters/otlp/internal/otlpconfig"
+package otlpconfig // import "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal/otlpconfig"
 
 import (
 	"crypto/tls"

exporters/otlp/otlpmetric/internal/otlpconfig/tls.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package otlpconfig
+package otlpconfig // import "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal/otlpconfig"
 
 import (
 	"crypto/tls"

exporters/otlp/otlpmetric/internal/otlpmetrictest/client.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package otlpmetrictest
+package otlpmetrictest // import "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal/otlpmetrictest"
 
 import (
 	"context"

exporters/otlp/otlpmetric/internal/otlpmetrictest/collector.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package otlpmetrictest
+package otlpmetrictest // import "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal/otlpmetrictest"
 
 import (
 	collectormetricpb "go.opentelemetry.io/proto/otlp/collector/metrics/v1"

exporters/otlp/otlpmetric/internal/otlpmetrictest/data.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package otlpmetrictest
+package otlpmetrictest // import "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal/otlpmetrictest"
 
 import (
 	"context"

exporters/otlp/otlpmetric/internal/otlpmetrictest/otlptest.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package otlpmetrictest
+package otlpmetrictest // import "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal/otlpmetrictest"
 
 import (
 	"context"

exporters/otlp/otlptrace/internal/connection/connection.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package connection
+package connection // import "go.opentelemetry.io/otel/exporters/otlp/otlptrace/internal/connection"
 
 import (
 	"context"

exporters/otlp/otlptrace/internal/otlpconfig/envconfig.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package otlpconfig
+package otlpconfig // import "go.opentelemetry.io/otel/exporters/otlp/otlptrace/internal/otlpconfig"
 
 import (
 	"crypto/tls"

exporters/otlp/otlptrace/internal/otlpconfig/tls.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package otlpconfig
+package otlpconfig // import "go.opentelemetry.io/otel/exporters/otlp/otlptrace/internal/otlpconfig"
 
 import (
 	"crypto/tls"

exporters/otlp/otlptrace/internal/otlptracetest/client.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package otlptracetest
+package otlptracetest // import "go.opentelemetry.io/otel/exporters/otlp/otlptrace/internal/otlptracetest"
 
 import (
 	"context"

exporters/otlp/otlptrace/internal/otlptracetest/collector.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package otlptracetest
+package otlptracetest // import "go.opentelemetry.io/otel/exporters/otlp/otlptrace/internal/otlptracetest"
 
 import (
 	"sort"

exporters/otlp/otlptrace/internal/otlptracetest/data.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package otlptracetest
+package otlptracetest // import "go.opentelemetry.io/otel/exporters/otlp/otlptrace/internal/otlptracetest"
 
 import (
 	"time"

exporters/otlp/otlptrace/internal/otlptracetest/otlptest.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package otlptracetest
+package otlptracetest // import "go.opentelemetry.io/otel/exporters/otlp/otlptrace/internal/otlptracetest"
 
 import (
 	"context"

exporters/otlp/otlptrace/internal/retry/retry.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package retry
+package retry // import "go.opentelemetry.io/otel/exporters/otlp/otlptrace/internal/retry"
 
 import (
 	"context"

exporters/otlp/otlptrace/internal/tracetransform/attribute.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package tracetransform
+package tracetransform // import "go.opentelemetry.io/otel/exporters/otlp/otlptrace/internal/tracetransform"
 
 import (
 	"go.opentelemetry.io/otel/attribute"

exporters/otlp/otlptrace/internal/tracetransform/instrumentation.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package tracetransform
+package tracetransform // import "go.opentelemetry.io/otel/exporters/otlp/otlptrace/internal/tracetransform"
 
 import (
 	commonpb "go.opentelemetry.io/proto/otlp/common/v1"

exporters/otlp/otlptrace/internal/tracetransform/resource.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package tracetransform
+package tracetransform // import "go.opentelemetry.io/otel/exporters/otlp/otlptrace/internal/tracetransform"
 
 import (
 	resourcepb "go.opentelemetry.io/proto/otlp/resource/v1"

exporters/otlp/otlptrace/internal/tracetransform/span.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package tracetransform
+package tracetransform // import "go.opentelemetry.io/otel/exporters/otlp/otlptrace/internal/tracetransform"
 
 import (
 	"go.opentelemetry.io/otel/attribute"

internal/baggage/baggage.go

@@ -21,7 +21,7 @@ this need this package would not need to exist and the
 `go.opentelemetry.io/otel/baggage` package would be the singular place where
 W3C baggage is handled.
 */
-package baggage
+package baggage // import "go.opentelemetry.io/otel/internal/baggage"
 
 // List is the collection of baggage members. The W3C allows for duplicates,
 // but OpenTelemetry does not, therefore, this is represented as a map.

internal/baggage/context.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package baggage
+package baggage // import "go.opentelemetry.io/otel/internal/baggage"
 
 import "context"
 

internal/global/propagator.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package global
+package global // import "go.opentelemetry.io/otel/internal/global"
 
 import (
 	"context"

internal/global/state.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package global
+package global // import "go.opentelemetry.io/otel/internal/global"
 
 import (
 	"sync"

internal/global/trace.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package global
+package global // import "go.opentelemetry.io/otel/internal/global"
 
 /*
 This file contains the forwarding implementation of the TracerProvider used as

internal/internaltest/alignment.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package internaltest
+package internaltest // import "go.opentelemetry.io/otel/internal/internaltest"
 
 /*
 This file contains common utilities and objects to validate memory alignment

internal/internaltest/env.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package internaltest
+package internaltest // import "go.opentelemetry.io/otel/internal/internaltest"
 
 import (
 	"os"

internal/internaltest/errors.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package internaltest
+package internaltest // import "go.opentelemetry.io/otel/internal/internaltest"
 
 type TestError string
 

internal/internaltest/text_map_carrier.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package internaltest
+package internaltest // import "go.opentelemetry.io/otel/internal/internaltest"
 
 import (
 	"sync"

internal/internaltest/text_map_propagator.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package internaltest
+package internaltest // import "go.opentelemetry.io/otel/internal/internaltest"
 
 import (
 	"context"

internal/matchers/expectation.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package matchers
+package matchers // import "go.opentelemetry.io/otel/internal/matchers"
 
 import (
 	"fmt"

internal/matchers/expecter.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package matchers
+package matchers // import "go.opentelemetry.io/otel/internal/matchers"
 
 import (
 	"testing"

internal/matchers/temporal_matcher.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package matchers
+package matchers // import "go.opentelemetry.io/otel/internal/matchers"
 
 type TemporalMatcher byte
 

internal/metric/async.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package metric
+package metric // import "go.opentelemetry.io/otel/internal/metric"
 
 import (
 	"context"

internal/metric/global/meter.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package global
+package global // import "go.opentelemetry.io/otel/internal/metric/global"
 
 import (
 	"context"

internal/metric/global/metric.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package global
+package global // import "go.opentelemetry.io/otel/internal/metric/global"
 
 import (
 	"sync"

internal/rawhelpers.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package internal
+package internal // import "go.opentelemetry.io/otel/internal"
 
 import (
 	"math"

internal/tools/common.go

@@ -15,7 +15,7 @@
 // Package tools provides helper functions used in scripts within the
 // internal/tools module, as well as imports needed for a build with the
 // "tools" build tag.
-package tools
+package tools // import "go.opentelemetry.io/otel/internal/tools"
 
 import (
 	"errors"

internal/tools/go.mod

@@ -7,7 +7,7 @@ require (
 	github.com/gogo/protobuf v1.3.2
 	github.com/golangci/golangci-lint v1.42.1
 	github.com/itchyny/gojq v0.12.5
-	github.com/jcchavezs/porto v0.3.0
+	github.com/jcchavezs/porto v0.4.0
 	github.com/wadey/gocovmerge v0.0.0-20160331181800-b5bfa59ec0ad
 	go.opentelemetry.io/build-tools/multimod v0.0.0-20210920164323-2ceabab23375
 	go.opentelemetry.io/build-tools/semconvgen v0.0.0-20210920164323-2ceabab23375

internal/tools/go.sum

@@ -409,8 +409,8 @@ github.com/itchyny/timefmt-go v0.1.3 h1:7M3LGVDsqcd0VZH2U+x393obrzZisp7C0uEe921i
 github.com/itchyny/timefmt-go v0.1.3/go.mod h1:0osSSCQSASBJMsIZnhAaF1C2fCBTJZXrnj37mG8/c+A=
 github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A=
 github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo=
-github.com/jcchavezs/porto v0.3.0 h1:JSKeMsqexngzHUpiv4NPPADSNBF9bDyavGRDWedzNeM=
-github.com/jcchavezs/porto v0.3.0/go.mod h1:fESH0gzDHiutHRdX2hv27ojnOVFco37hg1W6E9EZF4A=
+github.com/jcchavezs/porto v0.4.0 h1:Zj7RligrxmDdKGo6fBO2xYAHxEgrVBfs1YAja20WbV4=
+github.com/jcchavezs/porto v0.4.0/go.mod h1:fESH0gzDHiutHRdX2hv27ojnOVFco37hg1W6E9EZF4A=
 github.com/jessevdk/go-flags v1.5.0/go.mod h1:Fw0T6WPc1dYxT4mKEZRfG5kJhaTDP9pj1c2EWnYs/m4=
 github.com/jgautheron/goconst v1.5.1 h1:HxVbL1MhydKs8R8n/HE5NPvzfaYmQJA3o879lE4+WcM=
 github.com/jgautheron/goconst v1.5.1/go.mod h1:aAosetZ5zaeC/2EfMeRswtxUFBpe2Hr7HzkgX4fanO4=

internal/tools/tools.go

@@ -15,7 +15,7 @@
 //go:build tools
 // +build tools
 
-package tools
+package tools // import "go.opentelemetry.io/otel/internal/tools"
 
 import (
 	_ "github.com/client9/misspell/cmd/misspell"

internal/trace/noop/noop.go

@@ -13,7 +13,7 @@
 // limitations under the License.
 
 // Package noop provides noop tracing implementations for tracer and span.
-package noop
+package noop // import "go.opentelemetry.io/otel/internal/trace/noop"
 
 import (
 	"context"

sdk/internal/sanitize.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package internal
+package internal // import "go.opentelemetry.io/otel/sdk/internal"
 
 import (
 	"strings"