[refactor] Rename and move pkgcfg to plugins (#380)

## Summary

This is a no-op refactor. Moves the pkgcfg package to puglin and moves built in plugins (json files) to top level plugins directory.

## How was it tested?

* linter
* tested `devbox add`

Author: mikeland73

devbox.go

@@ -8,8 +8,8 @@ import (
 	"io"
 
 	"go.jetpack.io/devbox/internal/impl"
-	"go.jetpack.io/devbox/internal/pkgcfg"
 	"go.jetpack.io/devbox/internal/planner/plansdk"
+	"go.jetpack.io/devbox/internal/plugin"
 )
 
 // Devbox provides an isolated development environment.
@@ -34,7 +34,7 @@ type Devbox interface {
 	Remove(pkgs ...string) error
 	RunScript(scriptName string) error
 	RunScriptInShell(scriptName string) error
-	Services() (pkgcfg.Services, error)
+	Services() (plugin.Services, error)
 	// Shell generates the devbox environment and launches nix-shell as a child
 	// process.
 	Shell() error

devbox.json

@@ -6,7 +6,8 @@
   "shell": {
     "init_hook": "export \"GOROOT=$(go env GOROOT)\"",
     "scripts": {
-      "build": "go build -o dist/devbox cmd/devbox/main.go"
+      "build": "go build -o dist/devbox cmd/devbox/main.go",
+      "lint": "golangci-lint run"
     }
   },
   "nixpkgs": {

internal/impl/devbox.go

@@ -22,9 +22,9 @@ import (
 	"go.jetpack.io/devbox/internal/cuecfg"
 	"go.jetpack.io/devbox/internal/debug"
 	"go.jetpack.io/devbox/internal/nix"
-	"go.jetpack.io/devbox/internal/pkgcfg"
 	"go.jetpack.io/devbox/internal/planner"
 	"go.jetpack.io/devbox/internal/planner/plansdk"
+	"go.jetpack.io/devbox/internal/plugin"
 	"golang.org/x/exp/slices"
 )
 
@@ -51,7 +51,7 @@ type Devbox struct {
 	cfg *Config
 	// configDir is the directory where the config file (devbox.json) resides
 	configDir     string
-	pluginManager *pkgcfg.Manager
+	pluginManager *plugin.Manager
 	writer        io.Writer
 }
 
@@ -76,7 +76,7 @@ func Open(dir string, writer io.Writer) (*Devbox, error) {
 	box := &Devbox{
 		cfg:           cfg,
 		configDir:     cfgDir,
-		pluginManager: pkgcfg.NewManager(),
+		pluginManager: plugin.NewManager(),
 		writer:        writer,
 	}
 	return box, nil
@@ -110,13 +110,13 @@ func (d *Devbox) Add(pkgs ...string) error {
 		return err
 	}
 
-	d.pluginManager.ApplyOptions(pkgcfg.WithAddMode())
+	d.pluginManager.ApplyOptions(plugin.WithAddMode())
 	if err := d.ensurePackagesAreInstalled(install); err != nil {
 		return err
 	}
 	if featureflag.PKGConfig.Enabled() {
 		for _, pkg := range pkgs {
-			if err := pkgcfg.PrintReadme(
+			if err := plugin.PrintReadme(
 				pkg,
 				d.configDir,
 				d.writer,
@@ -151,7 +151,7 @@ func (d *Devbox) Remove(pkgs ...string) error {
 	}
 
 	if featureflag.PKGConfig.Enabled() {
-		if err := pkgcfg.Remove(d.configDir, uninstalledPackages); err != nil {
+		if err := plugin.Remove(d.configDir, uninstalledPackages); err != nil {
 			return err
 		}
 	}
@@ -207,14 +207,14 @@ func (d *Devbox) Shell() error {
 	}
 
 	if featureflag.PKGConfig.Enabled() {
-		env, err := pkgcfg.Env(plan.DevPackages, d.configDir)
+		env, err := plugin.Env(plan.DevPackages, d.configDir)
 		if err != nil {
 			return err
 		}
 		opts = append(
 			opts,
 			nix.WithEnvVariables(env),
-			nix.WithPKGConfigDir(filepath.Join(d.configDir, pkgcfg.VirtenvBinPath)),
+			nix.WithPKGConfigDir(filepath.Join(d.configDir, plugin.VirtenvBinPath)),
 		)
 	}
 
@@ -295,14 +295,14 @@ func (d *Devbox) RunScript(scriptName string) error {
 	}
 
 	if featureflag.PKGConfig.Enabled() {
-		env, err := pkgcfg.Env(plan.DevPackages, d.configDir)
+		env, err := plugin.Env(plan.DevPackages, d.configDir)
 		if err != nil {
 			return err
 		}
 		opts = append(
 			opts,
 			nix.WithEnvVariables(env),
-			nix.WithPKGConfigDir(filepath.Join(d.configDir, pkgcfg.VirtenvBinPath)),
+			nix.WithPKGConfigDir(filepath.Join(d.configDir, plugin.VirtenvBinPath)),
 		)
 	}
 
@@ -340,14 +340,14 @@ func (d *Devbox) Exec(cmds ...string) error {
 	env := []string{}
 	virtenvBinPath := ""
 	if featureflag.PKGConfig.Enabled() {
-		envMap, err := pkgcfg.Env(d.cfg.Packages, d.configDir)
+		envMap, err := plugin.Env(d.cfg.Packages, d.configDir)
 		if err != nil {
 			return err
 		}
 		for k, v := range envMap {
 			env = append(env, fmt.Sprintf("%s=%s", k, v))
 		}
-		virtenvBinPath = filepath.Join(d.configDir, pkgcfg.VirtenvBinPath) + ":"
+		virtenvBinPath = filepath.Join(d.configDir, plugin.VirtenvBinPath) + ":"
 	}
 	pathWithProfileBin := fmt.Sprintf("PATH=%s%s:$PATH", virtenvBinPath, profileBinDir)
 	cmds = append([]string{pathWithProfileBin}, cmds...)
@@ -381,7 +381,7 @@ func (d *Devbox) Info(pkg string, markdown bool) error {
 	); err != nil {
 		return errors.WithStack(err)
 	}
-	return pkgcfg.PrintReadme(
+	return plugin.PrintReadme(
 		pkg,
 		d.configDir,
 		d.writer,
@@ -453,22 +453,22 @@ func (d *Devbox) saveCfg() error {
 	return cuecfg.WriteFile(cfgPath, d.cfg)
 }
 
-func (d *Devbox) Services() (pkgcfg.Services, error) {
-	return pkgcfg.GetServices(d.cfg.Packages, d.configDir)
+func (d *Devbox) Services() (plugin.Services, error) {
+	return plugin.GetServices(d.cfg.Packages, d.configDir)
 }
 
 func (d *Devbox) StartService(serviceName string) error {
 	if !IsDevboxShellEnabled() {
 		return d.Exec("devbox", "services", "start", serviceName)
 	}
-	return pkgcfg.StartService(d.cfg.Packages, serviceName, d.configDir, d.writer)
+	return plugin.StartService(d.cfg.Packages, serviceName, d.configDir, d.writer)
 }
 
 func (d *Devbox) StopService(serviceName string) error {
 	if !IsDevboxShellEnabled() {
 		return d.Exec("devbox", "services", "stop", serviceName)
 	}
-	return pkgcfg.StopService(d.cfg.Packages, serviceName, d.configDir, d.writer)
+	return plugin.StopService(d.cfg.Packages, serviceName, d.configDir, d.writer)
 }
 
 func (d *Devbox) generateShellFiles() error {
@@ -523,7 +523,7 @@ func (d *Devbox) ensurePackagesAreInstalled(mode installMode) error {
 	fmt.Println("done.")
 
 	if featureflag.PKGConfig.Enabled() {
-		if err := pkgcfg.RemoveInvalidSymlinks(d.configDir); err != nil {
+		if err := plugin.RemoveInvalidSymlinks(d.configDir); err != nil {
 			return err
 		}
 	}

internal/impl/generate.go

@@ -15,16 +15,16 @@ import (
 	"github.com/pkg/errors"
 	"go.jetpack.io/devbox/internal/boxcli/featureflag"
 	"go.jetpack.io/devbox/internal/debug"
-	"go.jetpack.io/devbox/internal/pkgcfg"
 	"go.jetpack.io/devbox/internal/planner/plansdk"
+	"go.jetpack.io/devbox/internal/plugin"
 )
 
 //go:embed tmpl/* tmpl/.*
 var tmplFS embed.FS
 
 var shellFiles = []string{"development.nix", "shell.nix"}
 
-func generateForShell(rootPath string, plan *plansdk.ShellPlan, pluginManager *pkgcfg.Manager) error {
+func generateForShell(rootPath string, plan *plansdk.ShellPlan, pluginManager *plugin.Manager) error {
 	outPath := filepath.Join(rootPath, ".devbox/gen")
 
 	for _, file := range shellFiles {

internal/pkgcfg/files.go renamed to internal/plugin/files.go

@@ -1,36 +1,29 @@
-package pkgcfg
+package plugin
 
 import (
-	"embed"
-	"path/filepath"
 	"regexp"
 	"strings"
 
 	"github.com/pkg/errors"
+	"go.jetpack.io/devbox/plugins"
 )
 
-const pkgCfgDir = "package-configuration"
-
-//go:embed package-configuration/*
-var packageConfiguration embed.FS
-
 func getConfigIfAny(pkg, rootDir string) (*config, error) {
-	configFiles, err := packageConfiguration.ReadDir(pkgCfgDir)
+	configFiles, err := plugins.BuiltIn.ReadDir(".")
 	if err != nil {
 		return nil, errors.WithStack(err)
 	}
 
 	// Try to find perfect match first
 	for _, file := range configFiles {
-		if file.IsDir() {
+		if file.IsDir() || strings.HasSuffix(file.Name(), ".go") {
 			continue
 		}
-		content, err := packageConfiguration.ReadFile(
-			filepath.Join(pkgCfgDir, file.Name()),
-		)
+		content, err := plugins.BuiltIn.ReadFile(file.Name())
 		if err != nil {
 			return nil, errors.WithStack(err)
 		}
+
 		cfg, err := buildConfig(pkg, rootDir, string(content))
 		if err != nil {
 			return nil, errors.WithStack(err)
@@ -47,5 +40,5 @@ func getConfigIfAny(pkg, rootDir string) (*config, error) {
 }
 
 func getFileContent(contentPath string) ([]byte, error) {
-	return packageConfiguration.ReadFile(filepath.Join(pkgCfgDir, contentPath))
+	return plugins.BuiltIn.ReadFile(contentPath)
 }

internal/pkgcfg/info.go renamed to internal/plugin/info.go

@@ -1,4 +1,4 @@
-package pkgcfg
+package plugin
 
 import (
 	"fmt"

internal/pkgcfg/manager.go renamed to internal/plugin/manager.go

@@ -1,4 +1,4 @@
-package pkgcfg
+package plugin
 
 type Manager struct {
 	addMode bool

internal/pkgcfg/pkgcfg.go renamed to internal/plugin/pkgcfg.go

@@ -1,4 +1,4 @@
-package pkgcfg
+package plugin
 
 import (
 	"bytes"

internal/pkgcfg/rm.go renamed to internal/plugin/rm.go

@@ -1,4 +1,4 @@
-package pkgcfg
+package plugin
 
 import (
 	"os"

internal/pkgcfg/services.go renamed to internal/plugin/services.go

@@ -1,4 +1,4 @@
-package pkgcfg
+package plugin
 
 import (
 	"encoding/json"