mirror
/
go
mirror of https://github.com/golang/go.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

cmd/bundle: quote command-line arguments in output 

The previous version of bundle simply joins together with a space " ".
While this works for simple arguments this causes problems when you
need to pass special strings like an empty string or a string
containing a space.

The following example shows how the previous version handles an empty
string argument `-prefix ""`.

    //go:generate bundle -o /dev/stdout -prefix  example.com/mod

This change quotes the arguments with strconv.Quote, if needed, before
joining together with a space:

    //go:generate bundle -o /dev/stdout -prefix "" example.com/mod

Change-Id: Ic706a3bd7916515ba91dbe5e0def956703ab2988
GitHub-Last-Rev: 8dc0c88fc17c73bb432ed60a9578ec222814e68b
GitHub-Pull-Request: golang/tools#411
Reviewed-on: https://go-review.googlesource.com/c/tools/+/444956
Run-TryBot: Alan Donovan <adonovan@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
gopls-CI: kokoro <noreply+kokoro@google.com>
Reviewed-by: Heschi Kreinick <heschi@google.com>
Auto-Submit: Alan Donovan <adonovan@google.com>
Reviewed-by: Alan Donovan <adonovan@google.com>
This commit is contained in:
eNV25 2022-10-25 18:45:13 +00:00 committed by Gopher Robot
parent de675d5479
commit 541f4c5166
1 changed files with 31 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
cmd/bundle/main.go
View File

@ -84,6 +84,7 @@ import (
"os"
"strconv"
"strings"
"unicode"
"golang.org/x/tools/go/packages"
)
@ -233,7 +234,7 @@ func bundle(src, dst, dstpkg, prefix, buildTags string) ([]byte, error) {
fmt.Fprintf(&out, "// Code generated by golang.org/x/tools/cmd/bundle. DO NOT EDIT.\n")
if *outputFile != "" && buildTags == "" {
fmt.Fprintf(&out, "//go:generate bundle %s\n", strings.Join(os.Args[1:], " "))
fmt.Fprintf(&out, "//go:generate bundle %s\n", strings.Join(quoteArgs(os.Args[1:]), " "))
} else {
fmt.Fprintf(&out, "// $ bundle %s\n", strings.Join(os.Args[1:], " "))
}
@ -447,6 +448,35 @@ func printSameLineComment(out *bytes.Buffer, comments []*ast.CommentGroup, fset
return pos
}
func quoteArgs(ss []string) []string {
// From go help generate:
//
// > The arguments to the directive are space-separated tokens or
// > double-quoted strings passed to the generator as individual
// > arguments when it is run.
//
// > Quoted strings use Go syntax and are evaluated before execution; a
// > quoted string appears as a single argument to the generator.
//
var qs []string
for _, s := range ss {
if s == "" || containsSpace(s) {
s = strconv.Quote(s)
}
qs = append(qs, s)
}
return qs
}
func containsSpace(s string) bool {
for _, r := range s {
if unicode.IsSpace(r) {
return true
}
}
return false
}
type flagFunc func(string)
func (f flagFunc) Set(s string) error {