Merge pull request #2 from hmerritt/dev

Feat: major refactor of run logic

Author: hmerritt

command/run.go

@@ -2,12 +2,11 @@ package command
 
 import (
 	"fmt"
-	"io/fs"
 	"os"
-	"path"
 	"regexp"
 	"strings"
 
+	"github.com/hmerritt/reactenv/reactenv"
 	"github.com/hmerritt/reactenv/ui"
 )
 
@@ -22,7 +21,7 @@ func (c *RunCommand) Synopsis() string {
 func (c *RunCommand) Help() string {
 	jsInfo := c.UI.Colorize(".js", c.UI.InfoColor)
 	helpText := fmt.Sprintf(`
-Usage: reactenv run [options] ASSET_PATH
+Usage: reactenv run [options] PATH
   
 Inject environment variables into a built react app.
 
@@ -33,7 +32,7 @@ Example:
     ├── index.css
     ├── index-csxw0qbp%s
     ├── login.lazy-b839zm%s
-    └── user.lazy-c7942lh%s  <- Runs on all %s files in ASSET_PATH
+    └── user.lazy-c7942lh%s  <- Runs on all %s files in PATH
 `, jsInfo, jsInfo, jsInfo, jsInfo)
 
 	return strings.TrimSpace(helpText)
@@ -49,116 +48,94 @@ func (c *RunCommand) Run(args []string) int {
 	args = c.Flags().Parse(c.UI, args)
 
 	if len(args) == 0 {
-		c.UI.Error("No asset path entered.")
+		c.UI.Error("No asset PATH entered.")
 		c.exitWithHelp()
 	}
 
 	pathToAssets := args[0]
 
 	if _, err := os.Stat(pathToAssets); os.IsNotExist(err) {
-		c.UI.Error(fmt.Sprintf("Asset path '%s' does not exist.", pathToAssets))
+		c.UI.Error(fmt.Sprintf("File PATH '%s' does not exist.", pathToAssets))
 		c.exitWithHelp()
 	}
 
-	// Find all .js files
-	files, err := os.ReadDir(pathToAssets)
-	javascriptFiles := make([]fs.DirEntry, 0, len(files))
+	// @TODO: Add flag to specify matcher
+	fileMatchExpression := `.*\.js`
+	_, err := regexp.Compile(fileMatchExpression)
 
 	if err != nil {
-		c.UI.Error(fmt.Sprintf("Error when reading asset directory files.\n"))
+		c.UI.Error(fmt.Sprintf("File match expression '%s' is not valid.\n", fileMatchExpression))
 		c.UI.Error(fmt.Sprintf("%v", err))
-		os.Exit(1)
+		c.exitWithHelp()
 	}
 
-	for _, file := range files {
-		if file.IsDir() || !strings.HasSuffix(file.Name(), ".js") {
-			continue
-		}
-		javascriptFiles = append(javascriptFiles, file)
-	}
+	renv := reactenv.NewReactenv(c.UI)
 
-	if len(javascriptFiles) == 0 {
-		c.UI.Error("No JavaScript (.js) files found in asset directory.")
+	err = renv.FindFiles(pathToAssets, fileMatchExpression)
+
+	if err != nil {
+		c.UI.Error(fmt.Sprintf("Error reading files in PATH '%s'.\n", pathToAssets))
+		c.UI.Error(fmt.Sprintf("%v", err))
 		os.Exit(1)
 	}
 
-	allOccurrences := 0
-
-	// @TODO:
-	// - Loop all JS files, find all occurrences
-	// - Log: Total occurrences, Each file occurrences, All found occurrences + the ENV value to be injected
-	// - Re-loop all JS files, replace all occurrences
-	// - Log errors, warnings and successes
-
-	// Inject environment variables into .js files
-	for _, file := range javascriptFiles {
-		// Read .js file
-		filePath := path.Join(pathToAssets, file.Name())
-		fileContents, err := os.ReadFile(filePath)
-		fileContentsNew := make([]byte, 0, len(fileContents))
-
-		if err != nil {
-			c.UI.Error(fmt.Sprintf("Error when reading file '%s'.\n", file.Name()))
-			c.UI.Error(fmt.Sprintf("%v", err))
-			os.Exit(1)
-		}
-
-		// Find every occurrence of `reactenv.`
-		occurrences := regexp.MustCompile(`(__reactenv\.[a-zA-Z_$][0-9a-zA-Z_$]*)`).FindAllStringIndex(string(fileContents), -1)
-		occurrenceReplacementValues := make([]string, len(occurrences))
-
-		if len(occurrences) == 0 {
-			continue
-		}
-
-		allOccurrences += len(occurrences)
-
-		// For each occurrence, find the corresponding environment variable,
-		// exits if any environment variable is not set.
-		for index, occurrence := range occurrences {
-			occurrenceText := string(fileContents[occurrence[0]:occurrence[1]])
-			envName := strings.Replace(occurrenceText, "__reactenv.", "", 1)
-			envValue, envExists := os.LookupEnv(envName)
-
-			if !envExists {
-				c.UI.Error(fmt.Sprintf("Environment variable not set: %s", envName))
-				os.Exit(1)
-			}
-
-			occurrenceReplacementValues[index] = envValue
-		}
-
-		// Run replacement of all occurrences
-		lastIndex := 0
-		for index, occurrence := range occurrences {
-			envValue := occurrenceReplacementValues[index]
-			start, end := occurrence[0], occurrence[1]
-
-			fileContentsNew = append(fileContentsNew, fileContents[lastIndex:start]...)
-			fileContentsNew = append(fileContentsNew, envValue...)
-			lastIndex = end
-		}
-		fileContentsNew = append(fileContentsNew, fileContents[lastIndex:]...)
-
-		// Write .js file
-		if err := os.WriteFile(filePath, fileContentsNew, 0644); err != nil {
-			c.UI.Error(fmt.Sprintf("Error when writing to file '%s'.\n", filePath))
-			c.UI.Error(fmt.Sprintf("%v", err))
-			os.Exit(1)
-		}
+	if len(renv.Files) == 0 {
+		c.UI.Error(fmt.Sprintf("No files found in path '%s' using matcher '%s'", pathToAssets, fileMatchExpression))
+		os.Exit(1)
 	}
 
-	if allOccurrences == 0 {
-		c.UI.Warn(ui.WrapAtLength(fmt.Sprintf("No reactenv environment variables were found in any of the .js files within '%s', therefore nothing was injected.\n", pathToAssets), 0))
+	renv.FindOccurrences()
+
+	if renv.OccurrencesTotal == 0 {
+		c.UI.Warn(ui.WrapAtLength(fmt.Sprintf("No reactenv environment variables were found in any of the %d '%s' files within '%s', therefore nothing was injected.\n", renv.FilesMatchTotal, fileMatchExpression, pathToAssets), 0))
 		c.UI.Warn(ui.WrapAtLength("Possible causes:", 4))
+		c.UI.Warn(ui.WrapAtLength("  - reactenv has already ran on these files", 4))
 		c.UI.Warn(ui.WrapAtLength("  - Environment variables were not replaced with `__reactenv.<name>` during build", 4))
-		c.UI.Warn(ui.WrapAtLength("  - 'reactenv' has already ran on these files", 4))
 		c.UI.Warn("")
 		duration.In(c.UI.WarnColor, "")
 		return 1
 	}
 
-	duration.In(c.UI.SuccessColor, fmt.Sprintf("Injected '%d' environment variables", allOccurrences))
+	c.UI.Output(
+		fmt.Sprintf(
+			"Found %d reactenv environment %s in %d/%d matching files:",
+			renv.OccurrencesTotal,
+			ui.Pluralize("variable", renv.OccurrencesTotal),
+			len(renv.Files),
+			renv.FilesMatchTotal,
+		),
+	)
+	for fileIndex, fileOccurrencesTotal := range renv.OccurrencesByFile {
+		c.UI.Output(
+			fmt.Sprintf(
+				"  - %4dx in %s",
+				len(fileOccurrencesTotal.Occurrences),
+				(*renv.Files[fileIndex]).Name(),
+			),
+		)
+	}
+	c.UI.Output("")
+
+	c.UI.Output(fmt.Sprintf("Environment %s checklist (ticked if value has been set):", ui.Pluralize("variable", renv.OccurrencesTotal)))
+	envValuesMissing := 0
+	for occurrenceKey := range renv.OccurrenceKeys {
+		check := "✅"
+		if _, ok := renv.OccurrenceKeysReplacement[occurrenceKey]; !ok {
+			check = "❌"
+			envValuesMissing++
+		}
+		c.UI.Output(fmt.Sprintf("  - %4s %s", check, occurrenceKey))
+	}
+	c.UI.Output("")
+
+	if envValuesMissing > 0 {
+		c.UI.Error(fmt.Sprintf("Environment %s not set. See above checklist for missing values.", ui.Pluralize("variable", envValuesMissing)))
+		os.Exit(1)
+	}
+
+	renv.ReplaceOccurrences()
+
+	duration.In(c.UI.SuccessColor, fmt.Sprintf("Injected all environment variables"))
 	return 0
 }
 

npm/reactenv-darwin-arm64/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@reactenv/cli-darwin-arm64",
-    "version": "0.1.64",
+    "version": "0.1.73",
     "description": "The macOS ARM 64-bit binary for reactenv, an experimental solution to inject env variables after a build.",
     "license": "Apache-2.0",
     "os": [

npm/reactenv-darwin-x64/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@reactenv/cli-darwin-x64",
-    "version": "0.1.64",
+    "version": "0.1.73",
     "description": "The macOS 64-bit binary for reactenv, an experimental solution to inject env variables after a build.",
     "license": "Apache-2.0",
     "os": [

npm/reactenv-linux-arm64/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@reactenv/cli-linux-arm64",
-    "version": "0.1.64",
+    "version": "0.1.73",
     "description": "The Linux ARM 64-bit binary for reactenv, an experimental solution to inject env variables after a build.",
     "license": "Apache-2.0",
     "os": [

npm/reactenv-linux-x64/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@reactenv/cli-linux-x64",
-    "version": "0.1.64",
+    "version": "0.1.73",
     "description": "The Linux 64-bit binary for reactenv, an experimental solution to inject env variables after a build.",
     "license": "Apache-2.0",
     "os": [

npm/reactenv-win32-x64/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@reactenv/cli-win32-x64",
-    "version": "0.1.64",
+    "version": "0.1.73",
     "description": "The Windows 64-bit binary for reactenv, an experimental solution to inject env variables after a build.",
     "license": "Apache-2.0",
     "os": [

npm/reactenv/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@reactenv/cli",
-    "version": "0.1.64",
+    "version": "0.1.73",
     "description": "reactenv, an experimental solution to inject env variables after a build.",
     "license": "Apache-2.0",
     "bin": {