modfile: rename directory directive to use

matloob · matloob · commit 3a5865c02020 · 2021-11-02T18:19:07.000Z
For golang/go#48257 Change-Id: I9cbb222c93a066717595bec14ff26f2902ef05d9 Reviewed-on: https://go-review.googlesource.com/c/mod/+/359412 Trust: Michael Matloob <matloob@golang.org> Run-TryBot: Michael Matloob <matloob@golang.org> TryBot-Result: Go Bot <gobot@golang.org> Reviewed-by: Bryan C. Mills <bcmills@google.com>
diff --git a/modfile/rule.go b/modfile/rule.go
@@ -609,7 +609,7 @@ func (f *WorkFile) add(errs *ErrorList, line *Line, verb string, args []string,
 		f.Go = &Go{Syntax: line}
 		f.Go.Version = args[0]
 
-	case "directory":
+	case "use":
 		if len(args) != 1 {
 			errorf("usage: %s local/dir", verb)
 			return
@@ -619,7 +619,7 @@ func (f *WorkFile) add(errs *ErrorList, line *Line, verb string, args []string,
 			errorf("invalid quoted string: %v", err)
 			return
 		}
-		f.Directory = append(f.Directory, &Directory{
+		f.Use = append(f.Use, &Use{
 			Path:   s,
 			Syntax: line,
 		})
diff --git a/modfile/testdata/work/comment.golden b/modfile/testdata/work/comment.golden
@@ -1,10 +1,10 @@
 // comment
-directory x // eol
+use x // eol
 
 // mid comment
 
 // comment 2
 // comment 2 line 2
-directory y // eoy
+use y // eoy
 
 // comment 3
diff --git a/modfile/testdata/work/comment.in b/modfile/testdata/work/comment.in
@@ -1,8 +1,8 @@
 // comment
-directory "x" // eol
+use "x" // eol
 // mid comment
 
 // comment 2
 // comment 2 line 2
-directory "y" // eoy
+use "y" // eoy
 // comment 3
diff --git a/modfile/testdata/work/directory.golden b/modfile/testdata/work/directory.golden
diff --git a/modfile/testdata/work/directory.in b/modfile/testdata/work/directory.in
diff --git a/modfile/testdata/work/replace.golden b/modfile/testdata/work/replace.golden
@@ -1,4 +1,4 @@
-directory abc
+use abc
 
 replace xyz v1.2.3 => /tmp/z
 
diff --git a/modfile/testdata/work/replace.in b/modfile/testdata/work/replace.in
@@ -1,4 +1,4 @@
-directory "abc"
+use "abc"
 
 replace "xyz" v1.2.3 => "/tmp/z"
 
diff --git a/modfile/testdata/work/replace2.golden b/modfile/testdata/work/replace2.golden
@@ -1,4 +1,4 @@
-directory abc
+use abc
 
 replace (
 	xyz v1.2.3 => /tmp/z
diff --git a/modfile/testdata/work/replace2.in b/modfile/testdata/work/replace2.in
@@ -1,4 +1,4 @@
-directory "abc"
+use "abc"
 
 replace (
 	"xyz" v1.2.3 => "/tmp/z"
diff --git a/modfile/testdata/work/use.golden b/modfile/testdata/work/use.golden
@@ -0,0 +1,7 @@
+use ../foo
+
+use (
+	/bar
+
+	baz
+)
diff --git a/modfile/testdata/work/use.in b/modfile/testdata/work/use.in
@@ -0,0 +1,7 @@
+use "../foo"
+
+use (
+	"/bar"
+
+	"baz"
+)
diff --git a/modfile/work.go b/modfile/work.go
@@ -12,16 +12,16 @@ import (
 
 // A WorkFile is the parsed, interpreted form of a go.work file.
 type WorkFile struct {
-	Go        *Go
-	Directory []*Directory
-	Replace   []*Replace
+	Go      *Go
+	Use     []*Use
+	Replace []*Replace
 
 	Syntax *FileSyntax
 }
 
-// A Directory is a single directory statement.
-type Directory struct {
-	Path       string // Directory path of module.
+// A Use is a single directory statement.
+type Use struct {
+	Path       string // Use path of module.
 	ModulePath string // Module path in the comment.
 	Syntax     *Line
 }
@@ -67,7 +67,7 @@ func ParseWork(file string, data []byte, fix VersionFixer) (*WorkFile, error) {
 					Err:      fmt.Errorf("unknown block type: %s", strings.Join(x.Token, " ")),
 				})
 				continue
-			case "directory", "replace":
+			case "use", "replace":
 				for _, l := range x.Line {
 					f.add(&errs, l, x.Token[0], l.Token, fix)
 				}
@@ -87,13 +87,13 @@ func ParseWork(file string, data []byte, fix VersionFixer) (*WorkFile, error) {
 // Cleanup cleans out all the cleared entries.
 func (f *WorkFile) Cleanup() {
 	w := 0
-	for _, r := range f.Directory {
+	for _, r := range f.Use {
 		if r.Path != "" {
-			f.Directory[w] = r
+			f.Use[w] = r
 			w++
 		}
 	}
-	f.Directory = f.Directory[:w]
+	f.Use = f.Use[:w]
 
 	w = 0
 	for _, r := range f.Replace {
@@ -133,60 +133,60 @@ func (f *WorkFile) AddGoStmt(version string) error {
 	return nil
 }
 
-func (f *WorkFile) AddDirectory(diskPath, modulePath string) error {
+func (f *WorkFile) AddUse(diskPath, modulePath string) error {
 	need := true
-	for _, d := range f.Directory {
+	for _, d := range f.Use {
 		if d.Path == diskPath {
 			if need {
 				d.ModulePath = modulePath
-				f.Syntax.updateLine(d.Syntax, "directory", AutoQuote(diskPath))
+				f.Syntax.updateLine(d.Syntax, "use", AutoQuote(diskPath))
 				need = false
 			} else {
 				d.Syntax.markRemoved()
-				*d = Directory{}
+				*d = Use{}
 			}
 		}
 	}
 
 	if need {
-		f.AddNewDirectory(diskPath, modulePath)
+		f.AddNewUse(diskPath, modulePath)
 	}
 	return nil
 }
 
-func (f *WorkFile) AddNewDirectory(diskPath, modulePath string) {
-	line := f.Syntax.addLine(nil, "directory", AutoQuote(diskPath))
-	f.Directory = append(f.Directory, &Directory{Path: diskPath, ModulePath: modulePath, Syntax: line})
+func (f *WorkFile) AddNewUse(diskPath, modulePath string) {
+	line := f.Syntax.addLine(nil, "use", AutoQuote(diskPath))
+	f.Use = append(f.Use, &Use{Path: diskPath, ModulePath: modulePath, Syntax: line})
 }
 
-func (f *WorkFile) SetDirectory(dirs []*Directory) {
+func (f *WorkFile) SetUse(dirs []*Use) {
 	need := make(map[string]string)
 	for _, d := range dirs {
 		need[d.Path] = d.ModulePath
 	}
 
-	for _, d := range f.Directory {
+	for _, d := range f.Use {
 		if modulePath, ok := need[d.Path]; ok {
 			d.ModulePath = modulePath
 		} else {
 			d.Syntax.markRemoved()
-			*d = Directory{}
+			*d = Use{}
 		}
 	}
 
 	// TODO(#45713): Add module path to comment.
 
 	for diskPath, modulePath := range need {
-		f.AddNewDirectory(diskPath, modulePath)
+		f.AddNewUse(diskPath, modulePath)
 	}
 	f.SortBlocks()
 }
 
-func (f *WorkFile) DropDirectory(path string) error {
-	for _, d := range f.Directory {
+func (f *WorkFile) DropUse(path string) error {
+	for _, d := range f.Use {
 		if d.Path == path {
 			d.Syntax.markRemoved()
-			*d = Directory{}
+			*d = Use{}
 		}
 	}
 	return nil
diff --git a/modfile/work_test.go b/modfile/work_test.go

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-directory abc`
	`1`	`+use abc`
`2`	`2`
`3`	`3`	`replace xyz v1.2.3 => /tmp/z`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-directory "abc"`
	`1`	`+use "abc"`
`2`	`2`
`3`	`3`	`replace "xyz" v1.2.3 => "/tmp/z"`
`4`	`4`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,7 @@ @@
 +use ../foo
++
 +use (
 +	/bar
++
 +	baz
 +)