Refactor platformify command to support non-interactive mode and improve context handling

Author: Antonis Kalipetis

commands/platformify.go

@@ -5,6 +5,7 @@ import (
 	"errors"
 	"fmt"
 	"io"
+	"io/fs"
 	"os"
 	"path"
 
@@ -22,8 +23,10 @@ type contextKey string
 
 var FlavorKey contextKey = "flavor"
 var NoInteractionKey contextKey = "no-interaction"
+var FSKey contextKey = "fs"
 
 func NewPlatformifyCmd(assets *vendorization.VendorAssets) *cobra.Command {
+	var noInteraction bool
 	cmd := &cobra.Command{
 		Use:           assets.Use,
 		Aliases:       []string{"ify"},
@@ -35,24 +38,30 @@ func NewPlatformifyCmd(assets *vendorization.VendorAssets) *cobra.Command {
 				cmd.Context(),
 				cmd.OutOrStderr(),
 				cmd.ErrOrStderr(),
+				noInteraction,
 				assets,
 			)
 		},
 	}
 
+	cmd.Flags().BoolVar(&noInteraction, "no-interaction", false, "Disable interactive prompts")
 	return cmd
 }
 
-func Platformify(ctx context.Context, stdout, stderr io.Writer, assets *vendorization.VendorAssets) error {
-	answers := models.NewAnswers()
-	answers.Flavor, _ = ctx.Value(FlavorKey).(string)
-	answers.NoInteraction, _ = ctx.Value(NoInteractionKey).(bool)
-	ctx = models.ToContext(ctx, answers)
-	ctx = colors.ToContext(
-		ctx,
-		stdout,
-		stderr,
-	)
+func Discover(
+	ctx context.Context,
+	flavor string,
+	noInteraction bool,
+	fileSystem fs.FS,
+) (*platformifier.UserInput, error) {
+	answers, _ := models.FromContext(ctx)
+	if answers == nil {
+		answers = models.NewAnswers()
+		ctx = models.ToContext(ctx, answers)
+	}
+	answers.Flavor = flavor
+	answers.NoInteraction = noInteraction
+	answers.WorkingDirectory = fileSystem
 	q := questionnaire.New(
 		&question.WorkingDirectory{},
 		&question.Welcome{},
@@ -73,20 +82,32 @@ func Platformify(ctx context.Context, stdout, stderr io.Writer, assets *vendoriz
 	)
 	err := q.AskQuestions(ctx)
 	if errors.Is(err, questionnaire.ErrSilent) {
-		return nil
+		return nil, nil
 	}
 
 	if err != nil {
-		fmt.Fprintln(stderr, colors.Colorize(colors.ErrorCode, err.Error()))
-		return err
+		return nil, err
 	}
 
-	input := answers.ToUserInput()
+	return answers.ToUserInput(), nil
+}
 
+func Platformify(
+	ctx context.Context,
+	stdout, stderr io.Writer,
+	noInteraction bool,
+	assets *vendorization.VendorAssets,
+) error {
+	ctx = colors.ToContext(ctx, stdout, stderr)
+	ctx = models.ToContext(ctx, models.NewAnswers())
+	input, err := Discover(ctx, assets.ConfigFlavor, noInteraction, nil)
+	if err != nil {
+		return err
+	}
+	answers, _ := models.FromContext(ctx)
 	pfier := platformifier.New(input, assets.ConfigFlavor)
 	configFiles, err := pfier.Platformify(ctx)
 	if err != nil {
-		fmt.Fprintln(stderr, colors.Colorize(colors.ErrorCode, err.Error()))
 		return fmt.Errorf("could not configure project: %w", err)
 	}
 

internal/colors/context.go

@@ -23,11 +23,11 @@ func ToContext(ctx context.Context, out, err io.Writer) context.Context {
 func FromContext(ctx context.Context) (out, err io.Writer, ok bool) {
 	out, ok = ctx.Value(outKey).(io.Writer)
 	if !ok {
-		return nil, nil, false
+		return io.Discard, io.Discard, false
 	}
 	err, ok = ctx.Value(errKey).(io.Writer)
 	if !ok {
-		return nil, nil, false
+		return out, io.Discard, false
 	}
 	return out, err, true
 }

internal/question/name.go

@@ -25,6 +25,9 @@ func (q *Name) Ask(ctx context.Context) error {
 		return nil
 	}
 	defaultName := slugify(path.Base(answers.Cwd))
+	if defaultName == "" {
+		defaultName = "app"
+	}
 	if answers.NoInteraction {
 		answers.Name = defaultName
 	}

internal/question/type.go

@@ -28,15 +28,17 @@ func (q *Type) Ask(ctx context.Context) error {
 			return
 		}
 
-		fmt.Fprintf(
-			stderr,
-			"%s %s\n",
-			colors.Colorize(colors.GreenCode, "✓"),
-			colors.Colorize(
-				colors.BrandCode,
-				fmt.Sprintf("Detected runtime: %s", answers.Type.Runtime.Title()),
-			),
-		)
+		if answers.Type.Runtime.Title() != "" {
+			fmt.Fprintf(
+				stderr,
+				"%s %s\n",
+				colors.Colorize(colors.GreenCode, "✓"),
+				colors.Colorize(
+					colors.BrandCode,
+					fmt.Sprintf("Detected runtime: %s", answers.Type.Runtime.Title()),
+				),
+			)
+		}
 	}()
 
 	typ, err := answers.Discoverer.Type()

internal/question/working_directory.go

@@ -19,22 +19,20 @@ import (
 type WorkingDirectory struct{}
 
 func (q *WorkingDirectory) Ask(ctx context.Context) error {
-	_, stderr, ok := colors.FromContext(ctx)
-	if !ok {
-		return nil
-	}
-
+	_, stderr, _ := colors.FromContext(ctx)
 	answers, ok := models.FromContext(ctx)
 	if !ok {
 		return nil
 	}
-	cwd, err := os.Getwd()
-	if err != nil {
-		return err
+	if answers.WorkingDirectory == nil {
+		cwd, err := os.Getwd()
+		if err != nil {
+			return err
+		}
+		answers.WorkingDirectory = os.DirFS(cwd)
+		answers.Cwd = cwd
+		answers.HasGit = false
 	}
-	answers.WorkingDirectory = os.DirFS(cwd)
-	answers.Cwd = cwd
-	answers.HasGit = false
 	answers.Discoverer = discovery.New(answers.WorkingDirectory)
 	if answers.NoInteraction {
 		return nil
@@ -44,7 +42,7 @@ func (q *WorkingDirectory) Ask(ctx context.Context) error {
 	cmd := exec.CommandContext(ctx, "git", "rev-parse", "--git-dir")
 	cmd.Stdout = &outBuf
 	cmd.Stderr = &errBuf
-	err = cmd.Run()
+	err := cmd.Run()
 	if err != nil {
 		fmt.Fprintln(
 			stderr,

internal/utils/utils.go

@@ -5,6 +5,7 @@ import (
 	"bytes"
 	"cmp"
 	"encoding/json"
+	"fmt"
 	"io"
 	"io/fs"
 	"os"
@@ -176,7 +177,12 @@ func GetTOMLValue(
 
 func CountFiles(fileSystem fs.FS) (map[string]int, error) {
 	fileCounter := make(map[string]int)
-	err := fs.WalkDir(fileSystem, ".", func(path string, d fs.DirEntry, _ error) error {
+	err := fs.WalkDir(fileSystem, ".", func(path string, d fs.DirEntry, err error) error {
+		if err != nil {
+			fmt.Println(err)
+			return err
+		}
+
 		if d.IsDir() {
 			if slices.Contains(skipDirs, d.Name()) {
 				return filepath.SkipDir