Skip to content

go/analysis/passes/shadow: include filename in cross-file shadow error messages #583

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 26 additions & 4 deletions go/analysis/passes/shadow/shadow.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@ package shadow

import (
_ "embed"
"fmt"
"go/ast"
"go/token"
"go/types"
"path/filepath"

"golang.org/x/tools/go/analysis"
"golang.org/x/tools/go/analysis/passes/inspect"
Expand Down Expand Up @@ -243,26 +245,46 @@ func checkShadowing(pass *analysis.Pass, spans map[types.Object]span, ident *ast
if shadowed.Parent() == types.Universe {
return
}

shadowedPos := pass.Fset.Position(shadowed.Pos())
identPos := pass.Fset.Position(ident.Pos())

if strict {
// The shadowed identifier must appear before this one to be an instance of shadowing.
if shadowed.Pos() > ident.Pos() {
return
}
} else {
// Don't complain if the span of validity of the shadowed identifier doesn't include
// the shadowing identifier.
// the shadowing identifier, except for cross-file shadowing where file processing
// order affects span checks.
span, ok := spans[shadowed]
if !ok {
pass.ReportRangef(ident, "internal error: no range for %q", ident.Name)
return
}
if !span.contains(ident.Pos()) {

if shadowedPos.Filename == identPos.Filename && !span.contains(ident.Pos()) {
return
}
}
// Don't complain if the types differ: that implies the programmer really wants two different things.
if types.Identical(obj.Type(), shadowed.Type()) {
line := pass.Fset.Position(shadowed.Pos()).Line
pass.ReportRangef(ident, "declaration of %q shadows declaration at line %d", obj.Name(), line)
// Build the message, adding filename only if in a different file
message := fmt.Sprintf("declaration of %q shadows declaration at line %d", obj.Name(), shadowedPos.Line)
if shadowedPos.Filename != identPos.Filename {
message += fmt.Sprintf(" in %s", filepath.Base(shadowedPos.Filename))
}

pass.Report(analysis.Diagnostic{
Pos: ident.Pos(),
End: ident.End(),
Message: message,
Related: []analysis.RelatedInformation{{
Pos: shadowed.Pos(),
End: shadowed.Pos() + token.Pos(len(shadowed.Name())),
Message: fmt.Sprintf("shadowed symbol %q declared here", obj.Name()),
}},
})
}
}
5 changes: 5 additions & 0 deletions go/analysis/passes/shadow/shadow_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,8 @@ func Test(t *testing.T) {
testdata := analysistest.TestData()
analysistest.Run(t, testdata, shadow.Analyzer, "a")
}

func TestCrossFile(t *testing.T) {
testdata := analysistest.TestData()
analysistest.Run(t, testdata, shadow.Analyzer, "crossfile")
}
15 changes: 15 additions & 0 deletions go/analysis/passes/shadow/testdata/src/crossfile/crossfile.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// Copyright 2025 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

// This file contains a test for the shadowed variable checker with cross-file reference.

package crossfile

func ShadowGlobal() {
{
global := 1 // want "declaration of .global. shadows declaration at line 7 in other.go"
_ = global
}
_ = global
}
7 changes: 7 additions & 0 deletions go/analysis/passes/shadow/testdata/src/crossfile/other.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
// Copyright 2025 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package crossfile

var global int