[cleanup] plansdk (#1188)

## Summary

- Remove `devbox plan` command. This is no longer used anywhere.
- this means we can remove `devbox.ShellPlan` from the public interface
- Move `plansdk.Analyzer` to `initrec/analyzer/analyzer.go`. It is
exclusively used in `initrec/recommenders`.
- Move plansdk/version to analyzer/version. It is also exclusively used
in `initrec/recommenders`.

My next PR will likely refactor `plansdk` further since it now has two
unrelated structs: `FlakeInput` and `NixpkgsInfo`.

## How was it tested?

- opened `devbox shell` in `examples/development/go/hello-world/`.
  - ran `go run .`

- [ ] testscripts should pass

Author: savil

devbox.go

@@ -11,7 +11,6 @@ import (
 	"go.jetpack.io/devbox/internal/devconfig"
 	"go.jetpack.io/devbox/internal/impl"
 	"go.jetpack.io/devbox/internal/impl/devopt"
-	"go.jetpack.io/devbox/internal/planner/plansdk"
 	"go.jetpack.io/devbox/internal/services"
 )
 
@@ -46,9 +45,6 @@ type Devbox interface {
 	Services() (services.Services, error)
 	// Shell generates the devbox environment and launches nix-shell as a child process.
 	Shell(ctx context.Context) error
-	// ShellPlan creates a plan of the actions that devbox will take to generate its
-	// shell environment.
-	ShellPlan(ctx context.Context) (*plansdk.FlakePlan, error)
 	StartProcessManager(ctx context.Context, requestedServices []string, background bool, processComposeFileOrDir string) error
 	StartServices(ctx context.Context, services ...string) error
 	StopServices(ctx context.Context, allProjects bool, services ...string) error

internal/boxcli/plan.go

@@ -59,7 +59,6 @@ func RootCmd() *cobra.Command {
 	command.AddCommand(installCmd())
 	command.AddCommand(integrateCmd())
 	command.AddCommand(logCmd())
-	command.AddCommand(planCmd())
 	command.AddCommand(removeCmd())
 	command.AddCommand(runCmd())
 	command.AddCommand(searchCmd())

internal/boxcli/root.go

@@ -1,7 +1,7 @@
 // Copyright 2023 Jetpack Technologies Inc and contributors. All rights reserved.
 // Use of this source code is governed by the license in the LICENSE file.
 
-package plansdk
+package analyzer
 
 import (
 	"path/filepath"

internal/planner/plansdk/analyzer.go renamed to internal/initrec/analyzer/analyzer.go

@@ -1,7 +1,7 @@
 // Copyright 2023 Jetpack Technologies Inc and contributors. All rights reserved.
 // Use of this source code is governed by the license in the LICENSE file.
 
-package plansdk
+package analyzer
 
 import (
 	"regexp"

internal/planner/plansdk/version.go renamed to internal/initrec/analyzer/version.go

@@ -1,7 +1,7 @@
 // Copyright 2023 Jetpack Technologies Inc and contributors. All rights reserved.
 // Use of this source code is governed by the license in the LICENSE file.
 
-package plansdk
+package analyzer
 
 import (
 	"testing"

internal/planner/plansdk/version_test.go renamed to internal/initrec/analyzer/version_test.go

@@ -8,10 +8,10 @@ import (
 	"strings"
 
 	"github.com/pkg/errors"
+	"go.jetpack.io/devbox/internal/initrec/analyzer"
 
 	"go.jetpack.io/devbox/internal/cuecfg"
 	"go.jetpack.io/devbox/internal/initrec/recommenders"
-	"go.jetpack.io/devbox/internal/planner/plansdk"
 )
 
 type Project struct {
@@ -31,7 +31,7 @@ type Recommender struct {
 var _ recommenders.Recommender = (*Recommender)(nil)
 
 func (r *Recommender) IsRelevant() bool {
-	a, err := plansdk.NewAnalyzer(r.SrcDir)
+	a, err := analyzer.NewAnalyzer(r.SrcDir)
 	if err != nil {
 		// We should log that an error has occurred.
 		return false
@@ -56,7 +56,7 @@ func (r *Recommender) Packages() []string {
 }
 
 func project(srcDir string) (*Project, error) {
-	a, err := plansdk.NewAnalyzer(srcDir)
+	a, err := analyzer.NewAnalyzer(srcDir)
 	if err != nil {
 		// We should log that an error has occurred.
 		return nil, err

internal/initrec/recommenders/dotnet/dotnet.go

@@ -4,8 +4,8 @@
 package haskell
 
 import (
+	"go.jetpack.io/devbox/internal/initrec/analyzer"
 	"go.jetpack.io/devbox/internal/initrec/recommenders"
-	"go.jetpack.io/devbox/internal/planner/plansdk"
 )
 
 // This Project struct corresponds to the package.yaml generated during `stack new <project-name>`.
@@ -27,7 +27,7 @@ type Recommender struct {
 var _ recommenders.Recommender = (*Recommender)(nil)
 
 func (r *Recommender) IsRelevant() bool {
-	a, err := plansdk.NewAnalyzer(r.SrcDir)
+	a, err := analyzer.NewAnalyzer(r.SrcDir)
 	if err != nil {
 		// We should log that an error has occurred.
 		return false

internal/initrec/recommenders/haskell/haskell.go

@@ -11,11 +11,11 @@ import (
 
 	"github.com/creekorful/mvnparser"
 	"github.com/pkg/errors"
+	"go.jetpack.io/devbox/internal/initrec/analyzer"
 
 	"go.jetpack.io/devbox/internal/cuecfg"
 	"go.jetpack.io/devbox/internal/fileutil"
 	"go.jetpack.io/devbox/internal/initrec/recommenders"
-	"go.jetpack.io/devbox/internal/planner/plansdk"
 )
 
 // misc. nix packages
@@ -113,8 +113,8 @@ func getJavaPackage(srcDir string, builderTool string) (string, error) {
 	return defaultJava, nil
 }
 
-func parseJavaVersion(srcDir string, builderTool string) (*plansdk.Version, error) {
-	sourceVersion, _ := plansdk.NewVersion("0")
+func parseJavaVersion(srcDir string, builderTool string) (*analyzer.Version, error) {
+	sourceVersion, _ := analyzer.NewVersion("0")
 
 	if builderTool == MavenType {
 		pomXMLPath := filepath.Join(srcDir, mavenFileName)
@@ -126,7 +126,7 @@ func parseJavaVersion(srcDir string, builderTool string) (*plansdk.Version, erro
 		}
 		compilerSourceVersion, ok := parsedPom.Properties["maven.compiler.source"]
 		if ok {
-			sourceVersion, err = plansdk.NewVersion(compilerSourceVersion)
+			sourceVersion, err = analyzer.NewVersion(compilerSourceVersion)
 			if err != nil {
 				return nil, errors.WithMessage(err, "error parsing java version from pom file")
 			}
@@ -144,7 +144,7 @@ func parseJavaVersion(srcDir string, builderTool string) (*plansdk.Version, erro
 			line := fileScanner.Text()
 			if strings.Contains(line, "sourceCompatibility = ") {
 				compilerSourceVersion := strings.TrimSpace(strings.Split(line, "=")[1])
-				sourceVersion, err = plansdk.NewVersion(compilerSourceVersion)
+				sourceVersion, err = analyzer.NewVersion(compilerSourceVersion)
 				if err != nil {
 					return nil, errors.WithMessage(err, "error parsing java version from gradle file")
 				}

internal/initrec/recommenders/java/java.go

@@ -8,8 +8,8 @@ import (
 
 	"go.jetpack.io/devbox/internal/cuecfg"
 	"go.jetpack.io/devbox/internal/fileutil"
+	"go.jetpack.io/devbox/internal/initrec/analyzer"
 	"go.jetpack.io/devbox/internal/initrec/recommenders"
-	"go.jetpack.io/devbox/internal/planner/plansdk"
 )
 
 type Recommender struct {
@@ -62,9 +62,9 @@ func (r *Recommender) nodePackage(project *nodeProject) string {
 	return defaultNodeJSPkg
 }
 
-func (r *Recommender) nodeVersion(project *nodeProject) *plansdk.Version {
+func (r *Recommender) nodeVersion(project *nodeProject) *analyzer.Version {
 	if r != nil {
-		if v, err := plansdk.NewVersion(project.Engines.Node); err == nil {
+		if v, err := analyzer.NewVersion(project.Engines.Node); err == nil {
 			return v
 		}
 	}