golang/go

x/tools/go/analysis/cmd/vet: add -cgoinclude check for #include of code in subdirectories

Open

#26,506 opened on Jul 20, 2018

View on GitHub
 (8 comments) (2 reactions) (0 assignees)Go (19,008 forks)batch import
AnalysisNeedsFixhelp wanted

Repository metrics

Stars
 (133,883 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

The go build model is that all code for a package is in one directory. The cache relies on this. Vendoring tools rely on this. Probably many other things rely on this.

One of the few ways a package can violate this rule is by using #include in cgo source code to access code in nearby directories. This appears to work, in that the package builds, but it doesn't cache properly, doesn't vendor properly, and so on.

It seems reasonable for cmd/vet to notice such #includes and complain about them, and we could enable that check as one of the automatic ones run during go test.

Suggested in #26366.

Contributor guide

Research direction
Study the golang.org/x/tools/go/analysis framework and implement a new checker that detects #include directives in cgo files that reference directories outside the current package. Use the go vet infrastructure to register the check.
Tech stack
go
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Gocgo
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40