...

Package gopathwalk

import "golang.org/x/tools/internal/gopathwalk"
Overview
Index

Overview ▾

Package gopathwalk is like filepath.Walk but specialized for finding Go packages, particularly in $GOPATH and $GOROOT.

func Walk

func Walk(roots []Root, add func(root Root, dir string), opts Options)

Walk concurrently walks Go source directories ($GOROOT, $GOPATH, etc) to find packages.

For each package found, add will be called with the absolute paths of the containing source directory and the package directory.

Unlike filepath.WalkDir, Walk follows symbolic links (while guarding against cycles).

func WalkSkip

func WalkSkip(roots []Root, add func(root Root, dir string), skip func(root Root, dir string) bool, opts Options)

WalkSkip concurrently walks Go source directories ($GOROOT, $GOPATH, etc) to find packages.

For each package found, add will be called with the absolute paths of the containing source directory and the package directory. For each directory that will be scanned, skip will be called with the absolute paths of the containing source directory and the directory. If skip returns false on a directory it will be processed.

Unlike filepath.WalkDir, WalkSkip follows symbolic links (while guarding against cycles).

type Options

Options controls the behavior of a Walk call.

type Options struct {
    // If Logf is non-nil, debug logging is enabled through this function.
    Logf func(format string, args ...interface{})

    // Search module caches. Also disables legacy goimports ignore rules.
    ModulesEnabled bool

    // Maximum number of concurrent calls to user-provided callbacks,
    // or 0 for GOMAXPROCS.
    Concurrency int
}

type Root

A Root is a starting point for a Walk.

type Root struct {
    Path string
    Type RootType
}

type RootType

RootType indicates the type of a Root.

type RootType int
const (
    RootUnknown RootType = iota
    RootGOROOT
    RootGOPATH
    RootCurrentModule
    RootModuleCache
    RootOther
)