Add basic interactive overwrite strategy
Available options: - Do not copy - Overwrite dest - Copy source as dest.dist
This commit is contained in:
parent
7b694845f4
commit
3563860ede
|
@ -16,7 +16,7 @@ func main() {
|
|||
}
|
||||
|
||||
if err := app.Run(os.Args); err != nil {
|
||||
fmt.Printf("%+v", err)
|
||||
fmt.Printf("%+v\n", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
}
|
||||
|
|
2
go.mod
2
go.mod
|
@ -7,10 +7,12 @@ require (
|
|||
github.com/Masterminds/semver v1.5.0 // indirect
|
||||
github.com/Masterminds/sprig v2.22.0+incompatible
|
||||
github.com/antonmedv/expr v1.4.5
|
||||
github.com/davecgh/go-spew v1.1.1
|
||||
github.com/google/uuid v1.1.1 // indirect
|
||||
github.com/huandu/xstrings v1.3.0 // indirect
|
||||
github.com/imdario/mergo v0.3.8 // indirect
|
||||
github.com/manifoldco/promptui v0.7.0
|
||||
github.com/mattn/go-zglob v0.0.1
|
||||
github.com/mitchellh/copystructure v1.0.0 // indirect
|
||||
github.com/pkg/errors v0.9.1
|
||||
github.com/urfave/cli/v2 v2.1.1
|
||||
|
|
2
go.sum
2
go.sum
|
@ -67,6 +67,8 @@ github.com/mattn/go-colorable v0.0.9/go.mod h1:9vuHe8Xs5qXnSaW/c/ABM9alt+Vo+STaO
|
|||
github.com/mattn/go-isatty v0.0.4 h1:bnP0vzxcAdeI1zdubAl5PjU6zsERjGZb7raWodagDYs=
|
||||
github.com/mattn/go-isatty v0.0.4/go.mod h1:M+lRXTBqGeGNdLjl/ufCoiOlB5xdOkqRJdNxMWT7Zi4=
|
||||
github.com/mattn/go-runewidth v0.0.4/go.mod h1:LwmH8dsx7+W8Uxz3IHJYH5QSwggIsqBzpuz5H//U1FU=
|
||||
github.com/mattn/go-zglob v0.0.1 h1:xsEx/XUoVlI6yXjqBK062zYhRTZltCNmYPx6v+8DNaY=
|
||||
github.com/mattn/go-zglob v0.0.1/go.mod h1:9fxibJccNxU2cnpIKLRRFA7zX7qhkJIQWBb449FYHOo=
|
||||
github.com/mitchellh/copystructure v1.0.0 h1:Laisrj+bAB6b/yJwB5Bt3ITZhGJdqmxquMKeZ+mmkFQ=
|
||||
github.com/mitchellh/copystructure v1.0.0/go.mod h1:SNtv71yrdKgLRyLFxmLdkAbkKEFWgYaq1OVrnRcwhnw=
|
||||
github.com/mitchellh/go-homedir v1.1.0 h1:lukF9ziXFxDFPkA1vsr5zpc1XuPDn/wFntq5mG+4E0Y=
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
package command
|
||||
|
||||
import (
|
||||
"log"
|
||||
"fmt"
|
||||
"net/url"
|
||||
"os"
|
||||
|
||||
|
@ -32,6 +32,12 @@ func fromCommand() *cli.Command {
|
|||
Usage: "The scaffold manifest `FILE`",
|
||||
Value: "scaffold.yml",
|
||||
},
|
||||
&cli.StringSliceFlag{
|
||||
Name: "ignore",
|
||||
Aliases: []string{"i"},
|
||||
Usage: "Ignore files matching pattern",
|
||||
Value: cli.NewStringSlice(".git", ".git/**", "./.git/**/*"),
|
||||
},
|
||||
},
|
||||
Action: fromAction,
|
||||
}
|
||||
|
@ -78,13 +84,13 @@ func fromAction(c *cli.Context) error {
|
|||
return errors.Wrapf(err, "could not read manifest '%s'", manifestPath)
|
||||
}
|
||||
|
||||
log.Println("Could not find scaffold manifest.")
|
||||
fmt.Println("Could not find scaffold manifest.")
|
||||
}
|
||||
|
||||
if manifestFile != nil {
|
||||
defer manifestFile.Close()
|
||||
|
||||
log.Println("Loading template scaffold manifest...")
|
||||
fmt.Println("Loading scaffold manifest.")
|
||||
|
||||
manifest, err := template.Load(manifestFile)
|
||||
if err != nil {
|
||||
|
@ -95,6 +101,7 @@ func fromAction(c *cli.Context) error {
|
|||
return errors.Wrapf(err, "could not validate manifest '%s'", manifestPath)
|
||||
}
|
||||
|
||||
fmt.Println("Prompting for templates variables.")
|
||||
if err := template.Prompt(manifest, templateData); err != nil {
|
||||
return errors.Wrap(err, "could not prompt for template data")
|
||||
}
|
||||
|
@ -102,9 +109,22 @@ func fromAction(c *cli.Context) error {
|
|||
|
||||
directory := c.String("directory")
|
||||
|
||||
return template.CopyDir(vfs, ".", directory, &template.Option{
|
||||
TemplateData: templateData,
|
||||
TemplateExt: ".gotpl",
|
||||
IgnorePatterns: []string{manifestPath},
|
||||
ignore := c.StringSlice("ignore")
|
||||
ignore = append(ignore, manifestPath)
|
||||
|
||||
fmt.Println("Generating project tree.")
|
||||
|
||||
err = template.CopyDir(vfs, ".", directory, &template.Option{
|
||||
TemplateData: templateData,
|
||||
TemplateExt: ".gotpl",
|
||||
IgnorePatterns: ignore,
|
||||
PreferredStrategy: template.Undefined,
|
||||
})
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
fmt.Println("Done.")
|
||||
|
||||
return nil
|
||||
}
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
package project
|
||||
|
||||
import (
|
||||
"log"
|
||||
"fmt"
|
||||
"net/url"
|
||||
"os"
|
||||
"strings"
|
||||
|
@ -51,7 +51,7 @@ func (f *GitFetcher) Fetch(url *url.URL) (billy.Filesystem, error) {
|
|||
url.Fragment = ""
|
||||
}
|
||||
|
||||
log.Printf("Cloning repository '%s'...", url.String())
|
||||
fmt.Printf("Cloning repository '%s'.\n", url.String())
|
||||
|
||||
repo, err := git.Clone(memory.NewStorage(), fs, &git.CloneOptions{
|
||||
URL: url.String(),
|
||||
|
@ -72,7 +72,7 @@ func (f *GitFetcher) Fetch(url *url.URL) (billy.Filesystem, error) {
|
|||
return nil, errors.Wrap(err, "could not retrieve worktree")
|
||||
}
|
||||
|
||||
log.Printf("Checking out branch '%s'...", branchName)
|
||||
fmt.Printf("Checking out branch '%s'.\n", branchName)
|
||||
|
||||
err = worktree.Checkout(&git.CheckoutOptions{
|
||||
Force: true,
|
||||
|
|
|
@ -1,9 +1,9 @@
|
|||
package template
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"io"
|
||||
"io/ioutil"
|
||||
"log"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
|
@ -13,6 +13,7 @@ import (
|
|||
"gopkg.in/src-d/go-billy.v4"
|
||||
|
||||
"github.com/Masterminds/sprig"
|
||||
"github.com/mattn/go-zglob"
|
||||
"github.com/pkg/errors"
|
||||
)
|
||||
|
||||
|
@ -43,12 +44,12 @@ func CopyDir(vfs billy.Filesystem, baseDir string, dst string, opts *Option) err
|
|||
}
|
||||
|
||||
for _, p := range opts.IgnorePatterns {
|
||||
match, err := filepath.Match(p, srcPath)
|
||||
match, err := zglob.Match(p, strings.TrimPrefix(srcPath, "./"))
|
||||
if err != nil {
|
||||
return errors.Wrap(err, "could not match ignored file")
|
||||
}
|
||||
if match {
|
||||
log.Printf("Ignoring %s.", srcPath)
|
||||
fmt.Printf("Ignoring %s.\n", srcPath)
|
||||
return nil
|
||||
}
|
||||
}
|
||||
|
@ -61,7 +62,7 @@ func CopyDir(vfs billy.Filesystem, baseDir string, dst string, opts *Option) err
|
|||
dstPath := filepath.Join(dst, relSrcPath)
|
||||
|
||||
if info.IsDir() {
|
||||
log.Printf("creating dir '%s'", dstPath)
|
||||
fmt.Printf("Creating dir '%s'.\n", dstPath)
|
||||
if err := os.MkdirAll(dstPath, 0755); err != nil {
|
||||
return errors.Wrapf(err, "could not create directory '%s'", dstPath)
|
||||
}
|
||||
|
@ -89,6 +90,44 @@ func CopyFile(vfs billy.Filesystem, src, dst string, opts *Option) (err error) {
|
|||
opts = &Option{}
|
||||
}
|
||||
|
||||
stat, err := os.Stat(dst)
|
||||
if err != nil && !os.IsNotExist(err) {
|
||||
return err
|
||||
}
|
||||
|
||||
// If dst exists
|
||||
if stat != nil {
|
||||
strategy := opts.PreferredStrategy
|
||||
|
||||
if opts.Unnattended && opts.PreferredStrategy == -1 {
|
||||
strategy = defaultStrategy
|
||||
}
|
||||
|
||||
if opts.PreferredStrategy == -1 {
|
||||
var useAsPreferredStrategy bool
|
||||
|
||||
strategy, useAsPreferredStrategy, err = askOverwriteStrategy(dst)
|
||||
if err != nil {
|
||||
return errors.Wrap(err, "could not ask for overwrite strategy")
|
||||
}
|
||||
|
||||
if useAsPreferredStrategy {
|
||||
opts.PreferredStrategy = strategy
|
||||
}
|
||||
}
|
||||
|
||||
switch strategy {
|
||||
case CopyAsDist:
|
||||
fmt.Printf("Using '%s.dist' as destination file.\n", dst)
|
||||
dst += ".dist"
|
||||
case DoNotCopy:
|
||||
fmt.Printf("Skipping existing file '%s'.\n", dst)
|
||||
return nil
|
||||
default:
|
||||
return nil
|
||||
}
|
||||
}
|
||||
|
||||
if !strings.HasSuffix(src, opts.TemplateExt) {
|
||||
return copyFile(vfs, src, dst)
|
||||
}
|
||||
|
@ -111,7 +150,7 @@ func CopyFile(vfs billy.Filesystem, src, dst string, opts *Option) (err error) {
|
|||
|
||||
dst = strings.TrimSuffix(dst, opts.TemplateExt)
|
||||
|
||||
log.Printf("templating file from '%s' to '%s'", src, dst)
|
||||
fmt.Printf("Templating file from '%s' to '%s'.\n", src, dst)
|
||||
|
||||
out, err := os.Create(dst)
|
||||
if err != nil {
|
||||
|
@ -135,7 +174,7 @@ func CopyFile(vfs billy.Filesystem, src, dst string, opts *Option) (err error) {
|
|||
}
|
||||
|
||||
func copyFile(vfs billy.Filesystem, src, dst string) (err error) {
|
||||
log.Printf("copying file '%s' to '%s'", src, dst)
|
||||
fmt.Printf("Copying file '%s' to '%s'.\n", src, dst)
|
||||
|
||||
in, err := vfs.Open(src)
|
||||
if err != nil {
|
||||
|
|
|
@ -0,0 +1,7 @@
|
|||
package template
|
||||
|
||||
import "github.com/pkg/errors"
|
||||
|
||||
var (
|
||||
ErrUnexpectedOverwriteStrategy = errors.New("unexpected overwrite strategy")
|
||||
)
|
|
@ -1,7 +1,9 @@
|
|||
package template
|
||||
|
||||
type Option struct {
|
||||
IgnorePatterns []string
|
||||
TemplateData Data
|
||||
TemplateExt string
|
||||
IgnorePatterns []string
|
||||
TemplateData Data
|
||||
TemplateExt string
|
||||
Unnattended bool
|
||||
PreferredStrategy Strategy
|
||||
}
|
||||
|
|
|
@ -0,0 +1,62 @@
|
|||
package template
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/manifoldco/promptui"
|
||||
"github.com/pkg/errors"
|
||||
)
|
||||
|
||||
type Strategy int
|
||||
|
||||
const (
|
||||
Undefined Strategy = -1
|
||||
Overwrite Strategy = iota
|
||||
CopyAsDist
|
||||
DoNotCopy
|
||||
)
|
||||
|
||||
// nolint: gochecknoglobals
|
||||
var defaultStrategy = CopyAsDist
|
||||
|
||||
func askOverwriteStrategy(dst string) (Strategy, bool, error) {
|
||||
strategyPrompt := promptui.Select{
|
||||
Label: fmt.Sprintf("The file '%s' already exists. What do you want to do ?", dst),
|
||||
Items: []string{
|
||||
"Leave <dest> file as is",
|
||||
"Copy source file as '<dest>.dist'",
|
||||
"Overwrite '<dest>' with source file",
|
||||
},
|
||||
}
|
||||
|
||||
strategySelectedIndex, _, err := strategyPrompt.Run()
|
||||
if err != nil {
|
||||
return -1, false, errors.Wrap(err, "could not prompt for overwrite strategy")
|
||||
}
|
||||
|
||||
asPreferredStrategyPrompt := promptui.Select{
|
||||
Label: "Do you want to apply this strategy to all files ?",
|
||||
Items: []string{
|
||||
"Yes",
|
||||
"No",
|
||||
},
|
||||
}
|
||||
|
||||
preferredSelectedIndex, _, err := asPreferredStrategyPrompt.Run()
|
||||
if err != nil {
|
||||
return -1, false, errors.Wrap(err, "could not prompt for preferred strategy")
|
||||
}
|
||||
|
||||
useAsPreferredStrategy := preferredSelectedIndex == 0
|
||||
|
||||
switch strategySelectedIndex {
|
||||
case 0:
|
||||
return DoNotCopy, useAsPreferredStrategy, nil
|
||||
case 1:
|
||||
return CopyAsDist, useAsPreferredStrategy, nil
|
||||
case 2:
|
||||
return Overwrite, useAsPreferredStrategy, nil
|
||||
default:
|
||||
return -1, false, ErrUnexpectedOverwriteStrategy
|
||||
}
|
||||
}
|
Loading…
Reference in New Issue