godoc:vfs: extracted the vfs subpackage into an independent package

cmd/godoc/handlers.go

@@ -13,7 +13,7 @@ import (
 
 	"golang.org/x/tools/godoc"
 	"golang.org/x/tools/godoc/redirect"
-	"golang.org/x/tools/godoc/vfs"
+	"golang.org/x/tools/vfs"
 
 	_ "golang.org/x/tools/playground" // register "/compile" playground redirect
 )

cmd/godoc/main.go

@@ -41,11 +41,11 @@ import (
 
 	"golang.org/x/tools/godoc"
 	"golang.org/x/tools/godoc/static"
-	"golang.org/x/tools/godoc/vfs"
-	"golang.org/x/tools/godoc/vfs/gatefs"
-	"golang.org/x/tools/godoc/vfs/mapfs"
-	"golang.org/x/tools/godoc/vfs/zipfs"
 	"golang.org/x/tools/internal/gocommand"
+	"golang.org/x/tools/vfs"
+	"golang.org/x/tools/vfs/gatefs"
+	"golang.org/x/tools/vfs/mapfs"
+	"golang.org/x/tools/vfs/zipfs"
 )
 
 const defaultAddr = "localhost:6060" // default webserver address

godoc/corpus.go

@@ -11,7 +11,7 @@ import (
 
 	"golang.org/x/tools/godoc/analysis"
 	"golang.org/x/tools/godoc/util"
-	"golang.org/x/tools/godoc/vfs"
+	"golang.org/x/tools/vfs"
 )
 
 // A Corpus holds all the state related to serving and indexing a

godoc/dirtrees.go

@@ -17,7 +17,7 @@ import (
 	"sort"
 	"strings"
 
-	"golang.org/x/tools/godoc/vfs"
+	"golang.org/x/tools/vfs"
 )
 
 // Conventional name for directories containing test data.

godoc/dirtrees_test.go

@@ -11,8 +11,8 @@ import (
 	"sort"
 	"testing"
 
-	"golang.org/x/tools/godoc/vfs"
-	"golang.org/x/tools/godoc/vfs/gatefs"
+	"golang.org/x/tools/vfs"
+	"golang.org/x/tools/vfs/gatefs"
 )
 
 func TestNewDirTree(t *testing.T) {

godoc/index.go

@@ -64,7 +64,7 @@ import (
 	"unicode"
 
 	"golang.org/x/tools/godoc/util"
-	"golang.org/x/tools/godoc/vfs"
+	"golang.org/x/tools/vfs"
 )
 
 // ----------------------------------------------------------------------------

godoc/index_test.go

@@ -11,7 +11,7 @@ import (
 	"strings"
 	"testing"
 
-	"golang.org/x/tools/godoc/vfs/mapfs"
+	"golang.org/x/tools/vfs/mapfs"
 )
 
 func newCorpus(t *testing.T) *Corpus {

godoc/meta.go

@@ -14,7 +14,7 @@ import (
 	"strings"
 	"time"
 
-	"golang.org/x/tools/godoc/vfs"
+	"golang.org/x/tools/vfs"
 )
 
 var (

godoc/parser.go

@@ -14,7 +14,7 @@ import (
 	"go/token"
 	pathpkg "path"
 
-	"golang.org/x/tools/godoc/vfs"
+	"golang.org/x/tools/vfs"
 )
 
 var linePrefix = []byte("//line ")

godoc/pres.go

@@ -10,7 +10,7 @@ import (
 	"sync"
 	"text/template"
 
-	"golang.org/x/tools/godoc/vfs/httpfs"
+	"golang.org/x/tools/vfs/httpfs"
 )
 
 // SearchResultFunc functions return an HTML body for displaying search results.

godoc/server.go

@@ -28,7 +28,7 @@ import (
 
 	"golang.org/x/tools/godoc/analysis"
 	"golang.org/x/tools/godoc/util"
-	"golang.org/x/tools/godoc/vfs"
+	"golang.org/x/tools/vfs"
 )
 
 // handlerServer is a migration from an old godoc http Handler type.

godoc/server_test.go

@@ -14,7 +14,7 @@ import (
 	"testing"
 	"text/template"
 
-	"golang.org/x/tools/godoc/vfs/mapfs"
+	"golang.org/x/tools/vfs/mapfs"
 )
 
 // TestIgnoredGoFiles tests the scenario where a folder has no .go or .c files,

godoc/static/doc.go

@@ -4,5 +4,5 @@
 
 // Package static exports a map of static file content that supports the godoc
 // user interface. The map should be used with the mapfs package, see
-// golang.org/x/tools/godoc/vfs/mapfs.
+// golang.org/x/tools/vfs/mapfs.
 package static // import "golang.org/x/tools/godoc/static"

godoc/template.go

@@ -38,7 +38,7 @@ import (
 	"regexp"
 	"strings"
 
-	"golang.org/x/tools/godoc/vfs"
+	"golang.org/x/tools/vfs"
 )
 
 // Functions in this file panic on error, but the panic is recovered

godoc/util/util.go

@@ -11,7 +11,7 @@ import (
 	"time"
 	"unicode/utf8"
 
-	"golang.org/x/tools/godoc/vfs"
+	"golang.org/x/tools/vfs"
 )
 
 // An RWValue wraps a value and permits mutually exclusive

godoc/vfs/emptyvfs.go

@@ -5,85 +5,8 @@
 package vfs
 
 import (
-	"fmt"
-	"os"
-	"time"
+	"golang.org/x/tools/vfs"
 )
 
-// NewNameSpace returns a NameSpace pre-initialized with an empty
-// emulated directory mounted on the root mount point "/". This
-// allows directory traversal routines to work properly even if
-// a folder is not explicitly mounted at root by the user.
-func NewNameSpace() NameSpace {
-	ns := NameSpace{}
-	ns.Bind("/", &emptyVFS{}, "/", BindReplace)
-	return ns
-}
-
-// type emptyVFS emulates a FileSystem consisting of an empty directory
-type emptyVFS struct{}
-
-// Open implements Opener. Since emptyVFS is an empty directory, all
-// attempts to open a file should returns errors.
-func (e *emptyVFS) Open(path string) (ReadSeekCloser, error) {
-	if path == "/" {
-		return nil, fmt.Errorf("open: / is a directory")
-	}
-	return nil, os.ErrNotExist
-}
-
-// Stat returns os.FileInfo for an empty directory if the path
-// is root "/" or error. os.FileInfo is implemented by emptyVFS
-func (e *emptyVFS) Stat(path string) (os.FileInfo, error) {
-	if path == "/" {
-		return e, nil
-	}
-	return nil, os.ErrNotExist
-}
-
-func (e *emptyVFS) Lstat(path string) (os.FileInfo, error) {
-	return e.Stat(path)
-}
-
-// ReadDir returns an empty os.FileInfo slice for "/", else error.
-func (e *emptyVFS) ReadDir(path string) ([]os.FileInfo, error) {
-	if path == "/" {
-		return []os.FileInfo{}, nil
-	}
-	return nil, os.ErrNotExist
-}
-
-func (e *emptyVFS) String() string {
-	return "emptyVFS(/)"
-}
-
-func (e *emptyVFS) RootType(path string) RootType {
-	return ""
-}
-
-// These functions below implement os.FileInfo for the single
-// empty emulated directory.
-
-func (e *emptyVFS) Name() string {
-	return "/"
-}
-
-func (e *emptyVFS) Size() int64 {
-	return 0
-}
-
-func (e *emptyVFS) Mode() os.FileMode {
-	return os.ModeDir | os.ModePerm
-}
-
-func (e *emptyVFS) ModTime() time.Time {
-	return time.Time{}
-}
-
-func (e *emptyVFS) IsDir() bool {
-	return true
-}
-
-func (e *emptyVFS) Sys() any {
-	return nil
-}
+// Deprecated: use [vfs.NewNameSpace]
+var NewNameSpace = vfs.NewNameSpace

godoc/vfs/fs.go

@@ -3,78 +3,12 @@
 // license that can be found in the LICENSE file.
 
 //go:build go1.16
-// +build go1.16
 
 package vfs
 
 import (
-	"io/fs"
-	"os"
-	"path"
-	"strings"
+	"golang.org/x/tools/vfs"
 )
 
-// FromFS converts an fs.FS to the FileSystem interface.
-func FromFS(fsys fs.FS) FileSystem {
-	return &fsysToFileSystem{fsys}
-}
-
-type fsysToFileSystem struct {
-	fsys fs.FS
-}
-
-func (f *fsysToFileSystem) fsPath(name string) string {
-	name = path.Clean(name)
-	if name == "/" {
-		return "."
-	}
-	return strings.TrimPrefix(name, "/")
-}
-
-func (f *fsysToFileSystem) Open(name string) (ReadSeekCloser, error) {
-	file, err := f.fsys.Open(f.fsPath(name))
-	if err != nil {
-		return nil, err
-	}
-	if rsc, ok := file.(ReadSeekCloser); ok {
-		return rsc, nil
-	}
-	return &noSeekFile{f.fsPath(name), file}, nil
-}
-
-func (f *fsysToFileSystem) Lstat(name string) (os.FileInfo, error) {
-	return fs.Stat(f.fsys, f.fsPath(name))
-}
-
-func (f *fsysToFileSystem) Stat(name string) (os.FileInfo, error) {
-	return fs.Stat(f.fsys, f.fsPath(name))
-}
-
-func (f *fsysToFileSystem) RootType(name string) RootType { return "" }
-
-func (f *fsysToFileSystem) ReadDir(name string) ([]os.FileInfo, error) {
-	dirs, err := fs.ReadDir(f.fsys, f.fsPath(name))
-	var infos []os.FileInfo
-	for _, d := range dirs {
-		info, err1 := d.Info()
-		if err1 != nil {
-			if err == nil {
-				err = err1
-			}
-			continue
-		}
-		infos = append(infos, info)
-	}
-	return infos, err
-}
-
-func (f *fsysToFileSystem) String() string { return "io/fs" }
-
-type noSeekFile struct {
-	path string
-	fs.File
-}
-
-func (f *noSeekFile) Seek(offset int64, whence int) (int64, error) {
-	return 0, &fs.PathError{Op: "seek", Path: f.path, Err: fs.ErrInvalid}
-}
+// Deprecated: use [vfs.FromFS]
+var FromFS = vfs.FromFS