Merge branch 'main' into adamb/remove-writing-env-snapshot

internal/cmd/beta/args.go

@@ -4,7 +4,7 @@ import (
 	"github.com/gobwas/glob"
 	"github.com/pkg/errors"
 
-	"github.com/stateful/runme/v3/internal/project"
+	"github.com/stateful/runme/v3/pkg/project"
 )
 
 func createProjectFilterFromPatterns(patterns []string) (project.Filter, error) {

internal/cmd/beta/list_cmd.go

@@ -12,9 +12,9 @@ import (
 	"go.uber.org/zap"
 
 	"github.com/stateful/runme/v3/internal/config/autoconfig"
-	"github.com/stateful/runme/v3/internal/project"
 	"github.com/stateful/runme/v3/internal/shell"
 	"github.com/stateful/runme/v3/internal/term"
+	"github.com/stateful/runme/v3/pkg/project"
 )
 
 func listCmd(*commonFlags) *cobra.Command {

internal/cmd/beta/print_cmd.go

@@ -9,7 +9,7 @@ import (
 	"go.uber.org/zap"
 
 	"github.com/stateful/runme/v3/internal/config/autoconfig"
-	"github.com/stateful/runme/v3/internal/project"
+	"github.com/stateful/runme/v3/pkg/project"
 )
 
 func printCmd(*commonFlags) *cobra.Command {

internal/cmd/beta/run_cmd.go

@@ -9,8 +9,8 @@ import (
 
 	"github.com/stateful/runme/v3/internal/command"
 	"github.com/stateful/runme/v3/internal/config/autoconfig"
-	"github.com/stateful/runme/v3/internal/project"
 	"github.com/stateful/runme/v3/pkg/document"
+	"github.com/stateful/runme/v3/pkg/project"
 )
 
 func runCmd(*commonFlags) *cobra.Command {

internal/cmd/common.go

@@ -16,13 +16,13 @@ import (
 	"github.com/spf13/cobra"
 	"go.uber.org/zap"
 
-	"github.com/stateful/runme/v3/internal/project"
 	"github.com/stateful/runme/v3/internal/runner/client"
 	"github.com/stateful/runme/v3/internal/tui"
 	"github.com/stateful/runme/v3/internal/tui/prompt"
 	runnerv1 "github.com/stateful/runme/v3/pkg/api/gen/proto/go/runme/runner/v1"
 	"github.com/stateful/runme/v3/pkg/document"
 	"github.com/stateful/runme/v3/pkg/document/identity"
+	"github.com/stateful/runme/v3/pkg/project"
 )
 
 const envStackDepth = "__RUNME_STACK_DEPTH"

internal/cmd/fmt.go

@@ -1,22 +1,11 @@
 package cmd
 
 import (
-	"bytes"
-	"encoding/json"
 	"fmt"
-	"io"
-	"net/http"
-	"os"
-	"strings"
-	"time"
 
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
-
-	"github.com/stateful/runme/v3/internal/renderer/cmark"
-	"github.com/stateful/runme/v3/pkg/document"
-	"github.com/stateful/runme/v3/pkg/document/editor"
-	"github.com/stateful/runme/v3/pkg/document/identity"
+	"github.com/stateful/runme/v3/pkg/project"
 )
 
 func fmtCmd() *cobra.Command {
@@ -50,7 +39,7 @@ func fmtCmd() *cobra.Command {
 				}
 			}
 
-			return fmtFiles(files, flatten, formatJSON, write, func(file string, formatted []byte) error {
+			return project.FormatFiles(files, flatten, formatJSON, write, func(file string, formatted []byte) error {
 				out := cmd.OutOrStdout()
 				_, _ = fmt.Fprintf(out, "===== %s =====\n", file)
 				_, _ = out.Write(formatted)
@@ -68,111 +57,3 @@ func fmtCmd() *cobra.Command {
 
 	return &cmd
 }
-
-type funcOutput func(string, []byte) error
-
-func fmtFiles(files []string, flatten bool, formatJSON bool, write bool, outputter funcOutput) error {
-	logger, err := getLogger(false, false)
-	if err != nil {
-		return err
-	}
-	identityResolver := identity.NewResolver(identity.DefaultLifecycleIdentity)
-
-	for _, file := range files {
-		data, err := readMarkdown(file)
-		if err != nil {
-			return err
-		}
-
-		var formatted []byte
-
-		if flatten {
-			notebook, err := editor.Deserialize(data, editor.Options{LoggerInstance: logger, IdentityResolver: identityResolver})
-			if err != nil {
-				return errors.Wrap(err, "failed to deserialize")
-			}
-
-			if formatJSON {
-				var buf bytes.Buffer
-				enc := json.NewEncoder(&buf)
-				enc.SetIndent("", "  ")
-				if err := enc.Encode(notebook); err != nil {
-					return errors.Wrap(err, "failed to encode to JSON")
-				}
-				formatted = buf.Bytes()
-			} else {
-				formatted, err = editor.Serialize(notebook, nil, editor.Options{LoggerInstance: logger})
-				if err != nil {
-					return errors.Wrap(err, "failed to serialize")
-				}
-			}
-		} else {
-			doc := document.New(data, identityResolver)
-			astNode, err := doc.RootAST()
-			if err != nil {
-				return errors.Wrap(err, "failed to parse source")
-			}
-			formatted, err = cmark.Render(astNode, data)
-			if err != nil {
-				return errors.Wrap(err, "failed to render")
-			}
-		}
-
-		if write {
-			err = writeMarkdown(file, formatted)
-		} else {
-			err = outputter(file, formatted)
-		}
-		if err != nil {
-			return err
-		}
-	}
-
-	return nil
-}
-
-func readMarkdown(source string) ([]byte, error) {
-	var (
-		data []byte
-		err  error
-	)
-
-	if source == "-" {
-		data, err = io.ReadAll(os.Stdin)
-		if err != nil {
-			return nil, errors.Wrap(err, "failed to read from stdin")
-		}
-	} else if strings.HasPrefix(source, "https://") {
-		client := http.Client{
-			Timeout: time.Second * 5,
-		}
-		resp, err := client.Get(source)
-		if err != nil {
-			return nil, errors.Wrapf(err, "failed to get a file %q", source)
-		}
-		defer func() { _ = resp.Body.Close() }()
-		data, err = io.ReadAll(resp.Body)
-		if err != nil {
-			return nil, errors.Wrap(err, "failed to read body")
-		}
-	} else {
-		data, err = os.ReadFile(source)
-		if err != nil {
-			return nil, errors.Wrapf(err, "failed to read from file %q", source)
-		}
-	}
-
-	return data, nil
-}
-
-func writeMarkdown(destination string, data []byte) error {
-	if destination == "-" {
-		_, err := os.Stdout.Write(data)
-		return errors.Wrap(err, "failed to write to stdout")
-	}
-	if strings.HasPrefix(destination, "https://") {
-		return errors.New("cannot write to HTTPS location")
-	}
-	err := os.WriteFile(destination, data, 0o600)
-	return errors.Wrapf(err, "failed to write data to %q", destination)
-}

internal/cmd/list.go

@@ -11,8 +11,8 @@ import (
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 
-	"github.com/stateful/runme/v3/internal/project"
 	"github.com/stateful/runme/v3/internal/shell"
+	"github.com/stateful/runme/v3/pkg/project"
 )
 
 type row struct {

internal/cmd/project_loader.go

@@ -10,7 +10,7 @@ import (
 	tea "github.com/charmbracelet/bubbletea"
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
-	"github.com/stateful/runme/v3/internal/project"
+	"github.com/stateful/runme/v3/pkg/project"
 )
 
 type projectLoader struct {

internal/cmd/run.go

@@ -19,10 +19,10 @@ import (
 	"github.com/pkg/errors"
 	"github.com/rwtodd/Go.Sed/sed"
 	"github.com/spf13/cobra"
-	"github.com/stateful/runme/v3/internal/project"
 	"github.com/stateful/runme/v3/internal/runner/client"
 	"github.com/stateful/runme/v3/internal/tui"
 	"github.com/stateful/runme/v3/pkg/document"
+	"github.com/stateful/runme/v3/pkg/project"
 )
 
 type CommandExportExtractMatch struct {

internal/cmd/run_test.go

@@ -8,8 +8,8 @@ import (
 	"testing"
 
 	"github.com/spf13/cobra"
-	"github.com/stateful/runme/v3/internal/project"
 	"github.com/stateful/runme/v3/internal/runner/client"
+	"github.com/stateful/runme/v3/pkg/project"
 	"github.com/stretchr/testify/assert"
 )
 

internal/cmd/tui.go

@@ -10,10 +10,10 @@ import (
 	"github.com/mgutz/ansi"
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
-	"github.com/stateful/runme/v3/internal/project"
 	"github.com/stateful/runme/v3/internal/runner"
 	"github.com/stateful/runme/v3/internal/runner/client"
 	"github.com/stateful/runme/v3/internal/version"
+	"github.com/stateful/runme/v3/pkg/project"
 	"golang.org/x/exp/constraints"
 )
 

internal/command/command.go

@@ -9,7 +9,7 @@ import (
 
 	"github.com/pkg/errors"
 
-	"github.com/stateful/runme/v3/internal/project"
+	"github.com/stateful/runme/v3/pkg/project"
 )
 
 type Command interface {

internal/command/factory.go

@@ -6,9 +6,9 @@ import (
 	"go.uber.org/zap"
 
 	"github.com/stateful/runme/v3/internal/dockerexec"
-	"github.com/stateful/runme/v3/internal/project"
 	"github.com/stateful/runme/v3/internal/ulid"
 	runnerv2alpha1 "github.com/stateful/runme/v3/pkg/api/gen/proto/go/runme/runner/v2alpha1"
+	"github.com/stateful/runme/v3/pkg/project"
 )
 
 var (

internal/config/autoconfig/autoconfig.go

@@ -21,7 +21,7 @@ import (
 	"github.com/stateful/runme/v3/internal/command"
 	"github.com/stateful/runme/v3/internal/config"
 	"github.com/stateful/runme/v3/internal/dockerexec"
-	"github.com/stateful/runme/v3/internal/project"
+	"github.com/stateful/runme/v3/pkg/project"
 )
 
 var (

internal/owl/store_test.go

@@ -147,6 +147,7 @@ HOMEBREW_REPOSITORY=where homebrew lives # Plain`)
 }
 
 func Test_Store_Specless(t *testing.T) {
+	t.Skip("Restore fixture data")
 	t.Parallel()
 
 	rawEnvLocal, err := os.ReadFile("../../pkg/project/test_project/.env.local")