feat: add support for build log output

Author: damienbutt

.gitignore

@@ -42,3 +42,6 @@ dist/
 # SIMPL+
 SPlsWork/
 *.ush
+
+# Log files
+*.log

Makefile

@@ -52,7 +52,7 @@ test:
 	@go test ./...
 
 test-coverage:
-	@go test -race -coverprofile=coverage.out ./...
+# 	@go test -race -coverprofile=coverage.out ./...
 	@go tool cover -html=coverage.out -o coverage.html
 	@go tool cover -func=coverage.out | tail -1
 

README.md

@@ -15,6 +15,7 @@ spc [command] [options] <file> [file...]
 
 - `-t, --target string`: Target series to compile for (e.g., 3, 34, 234)
 - `-v, --verbose`: Verbose output
+- `-o, --out string`: Output file for compilation logs
 - `--version`: Show version information
 
 ### Examples

cmd/build.go

@@ -10,6 +10,8 @@ import (
 
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
+
+	"github.com/Norgate-AV/spc/internal/codes"
 )
 
 var buildCmd = &cobra.Command{
@@ -72,6 +74,8 @@ func runBuild(cmd *cobra.Command, args []string) error {
 	// bind flag
 	_ = viper.BindPFlag("target", cmd.Flags().Lookup("target"))
 	_ = viper.BindPFlag("verbose", cmd.Flags().Lookup("verbose"))
+	_ = viper.BindPFlag("silent", cmd.Flags().Lookup("silent"))
+	_ = viper.BindPFlag("out", cmd.Flags().Lookup("out"))
 	target := viper.GetString("target")
 	if target == "" {
 		return fmt.Errorf("target series not specified")
@@ -89,7 +93,7 @@ func runBuild(cmd *cobra.Command, args []string) error {
 	cmdArgs = append(cmdArgs, "/target")
 	cmdArgs = append(cmdArgs, series...)
 	cmdArgs = append(cmdArgs, "/rebuild")
-	
+
 	for _, file := range args {
 		absFile, err := filepath.Abs(file)
 		if err != nil {
@@ -99,23 +103,41 @@ func runBuild(cmd *cobra.Command, args []string) error {
 		cmdArgs = append(cmdArgs, absFile)
 	}
 
+	out := viper.GetString("out")
+	if out != "" {
+		absOut, err := filepath.Abs(out)
+		if err != nil {
+			return fmt.Errorf("failed to resolve absolute path for output file: %w", err)
+		}
+		cmdArgs = append(cmdArgs, "/out", absOut)
+	}
+
+	silent := viper.GetBool("silent")
+	if silent {
+		cmdArgs = append(cmdArgs, "/silent")
+	}
+
 	if verbose {
-		fmt.Printf("Compiler: %s\nTarget: %s\nSeries: %v\nFiles: %v\nCommand: %s %s\n", compiler, target, series, args, compiler, strings.Join(cmdArgs, " "))
+		fmt.Printf("Compiler: %s\nTarget: %s\nSeries: %v\nFiles: %v\nOut: %s\nCommand: %s %s\n", compiler, target, series, args, out, compiler, strings.Join(cmdArgs, " "))
 	}
 
 	c := execCommand(compiler, cmdArgs...)
 	if cmd, ok := c.(*exec.Cmd); ok {
 		cmd.Stdout = os.Stdout
 		cmd.Stderr = os.Stderr
 	}
-
 	err = c.Run()
 	if err != nil {
-		if exitErr, ok := err.(*exec.ExitError); ok && exitErr.ExitCode() == 116 {
-			// Crestron compiler success code
-			return nil
-		}
+		if exitErr, ok := err.(*exec.ExitError); ok {
+			code := exitErr.ExitCode()
+			if codes.IsSuccess(code) {
+				// Crestron compiler success (may have warnings)
+				return nil
+			}
 
+			// Print descriptive error message
+			fmt.Fprintf(os.Stderr, "Compilation failed (exit code %d): %s\n", code, codes.GetErrorMessage(code))
+		}
 		return err
 	}
 

cmd/root.go

@@ -11,7 +11,7 @@ import (
 var rootCmd = &cobra.Command{
 	Use:          "spc",
 	Short:        "Crestron SIMPL+ compiler wrapper",
-	Long:         `A CLI wrapper for the Crestron SIMPL+ compiler tool.`,
+	Long:         `A CLI wrapper for the Crestron SIMPL+ compiler`,
 	RunE:         runBuild,
 	SilenceUsage: true,
 	Args:         cobra.ArbitraryArgs,
@@ -27,6 +27,8 @@ func Execute() {
 func init() {
 	rootCmd.Version = fmt.Sprintf("%s (%s) %s", version.Version, version.Commit, version.BuildTime)
 	rootCmd.PersistentFlags().StringP("target", "t", "", "Target series to compile for (e.g., 3, 34, 234)")
+	rootCmd.PersistentFlags().BoolP("silent", "s", false, "Suppress console output from the SIMPL+ compiler")
 	rootCmd.PersistentFlags().BoolP("verbose", "v", false, "Verbose output")
+	rootCmd.PersistentFlags().StringP("out", "o", "", "Output file for compilation logs")
 	rootCmd.AddCommand(buildCmd)
 }

example/example.usp

@@ -1,130 +0,0 @@
-/*******************************************************************************************
-  Compiler Directives
-  (Uncomment and declare compiler directives as needed)
-*******************************************************************************************/
-// #ENABLE_DYNAMIC
-// #SYMBOL_NAME
-// #HINT ""
-// #DEFINE_CONSTANT
-// #CATEGORY
-#PRINT_TO_TRACE
-// #DIGITAL_EXPAND
-// #ANALOG_SERIAL_EXPAND
-// #OUTPUT_SHIFT
-// #HELP_PDF_FILE ""
-#DEFAULT_VOLATILE
-#ENABLE_STACK_CHECKING
-#ENABLE_TRACE
-#ENCODING_ASCII
-// #ENCODING_UTF16
-// #ENCODING_INHERIT_FROM_PARENT
-// #ENCODING_INHERIT_FROM_PROGRAM
-/*
-#HELP_BEGIN
-   (add additional lines of help lines)
-#HELP_END
-*/
-
-/*******************************************************************************************
-  Include Libraries
-  (Uncomment and include additional libraries as needed)
-*******************************************************************************************/
-// #CRESTRON_LIBRARY ""
-// #USER_LIBRARY ""
-
-/*******************************************************************************************
-  DIGITAL, ANALOG and SERIAL INPUTS and OUTPUTS
-  (Uncomment and declare inputs and outputs as needed)
-*******************************************************************************************/
-// DIGITAL_INPUT
-// ANALOG_INPUT
-// STRING_INPUT
-// BUFFER_INPUT
-
-// DIGITAL_OUTPUT
-// ANALOG_OUTPUT
-// STRING_OUTPUT
-
-/*******************************************************************************************
-  SOCKETS
-  (Uncomment and define socket definitions as needed)
-*******************************************************************************************/
-// TCP_CLIENT
-// TCP_SERVER
-// UDP_SOCKET
-
-/*******************************************************************************************
-  Parameters
-  (Uncomment and declare parameters as needed)
-*******************************************************************************************/
-// INTEGER_PARAMETER
-// SIGNED_INTEGER_PARAMETER
-// LONG_INTEGER_PARAMETER
-// SIGNED_LONG_INTEGER_PARAMETER
-// STRING_PARAMETER
-
-/*******************************************************************************************
-  Parameter Properties
-  (Uncomment and declare parameter properties as needed)
-*******************************************************************************************/
-/*
-#BEGIN_PARAMETER_PROPERTIES parameter_variable, parameter_variable, ...
-   // propValidUnits = // unitString or unitDecimal|unitHex|unitPercent|unitCharacter|unitTime|unitTicks;
-   // propDefaultUnit = // unitString, unitDecimal, unitHex, unitPercent, unitCharacter, unitTime or unitTicks;
-   // propBounds = lower_bound , upper_bound;
-   // propDefaultValue = ;  // or, propDefaultValue = "";
-   // propList = // { "value" , "label" } , { "value" , "label" } , ... ;
-   // propShortDescription = "status_bar_hint_text";
-   // #BEGIN_PROP_FULL_DESCRIPTION  line_1...  line_2...  line_n  #END_PROP_FULL_DESCRIPTION
-   // #BEGIN_PROP_NOTES line_1...  line_2...  line_n  #END_PROP_NOTES
-#END_PARAMETER_PROPERTIES
-*/
-
-/*******************************************************************************************
-  Structure Definitions
-  (Uncomment and define structure definitions as needed)
-  Note:  Be sure to initialize all declared STRING variables as needed
-         For example, in Function Main: struct.myString = "";
-*******************************************************************************************/
-/*
-STRUCTURE MyStruct1
-{
-};
-
-MyStruct1 struct;
-*/
-
-/*******************************************************************************************
-  Global Variables
-  (Uncomment and declare global variables as needed)
-  Note:  Be sure to initialize all declared STRING variables as needed
-         For example, in Function Main: myString = "";
-*******************************************************************************************/
-// INTEGER
-// LONG_INTEGER
-// SIGNED_INTEGER
-// SIGNED_LONG_INTEGER
-// STRING
-
-/*******************************************************************************************
-  Functions
-  (Add any additional functions here)
-  Note:  Functions must be physically placed before the location in
-         the code that calls them.
-*******************************************************************************************/
-
-
-/*******************************************************************************************
-  Event Handlers
-  (Uncomment and declare additional event handlers as needed)
-*******************************************************************************************/
-
-
-/*******************************************************************************************
-  Main()
-  Uncomment and place one-time startup code here
-  (This code will get called when the system starts up)
-*******************************************************************************************/
-Function Main() {
-
-}

internal/.gitkeep

@@ -0,0 +1,51 @@
+package codes
+
+// ErrorCodes maps Crestron SIMPL+ compiler exit codes to their descriptions
+var ErrorCodes = map[int]string{
+	0:   "Success",
+	100: "General failure",
+	101: "Cannot open module",
+	102: "Cannot create new makefile",
+	103: "Cannot create new globals.h",
+	104: "Cannot open master makefile",
+	105: "Cannot write new makefile",
+	106: "Compile errors",
+	107: "Link errors",
+	108: "Cannot copy output file to LinkMakeFileDir",
+	109: "Cannot copy gnu files to LinkMakeFileDir",
+	110: "Cannot launch gnu compiler",
+	111: "Cannot retrieve total number of NVRam in module",
+	112: "GNU not installed",
+	113: "System.CodeDom.Compiler wrapper can not be instantiated",
+	114: "The CompilerObj instance is invalid",
+	115: "Invalid compiler results object",
+	116: "The system.CodeDom.Compiler finished successfully, but with errors",
+	117: "CompilerResult class is NULL or there is a problem with it",
+	118: "Error extracting reference files from Include.dat",
+	119: ".cs file doesn't exist",
+	120: "Error launching NVRAM utility",
+	121: "NVRAM Utility ran - no output generated",
+	122: "Error saving temporary certificate file",
+	123: "Invalid writer object",
+	124: "Unable to create temporary file",
+	125: "Unable to translate the certificate hex string to byte array",
+	126: "Signing process failed",
+	127: "Cleanup of the temp file failed",
+	128: "The registry key for signing assemblies does not exist.",
+	129: "CAPICOM is either not installed properly or not registered!",
+	130: "Error found while signing. Unable to cleanup unsigned assembly.",
+}
+
+// IsSuccess returns true if the exit code indicates successful compilation
+func IsSuccess(code int) bool {
+	return code == 0 || code == 116
+}
+
+// GetErrorMessage returns the error message for a given exit code, or a generic message if unknown
+func GetErrorMessage(code int) string {
+	if msg, ok := ErrorCodes[code]; ok {
+		return msg
+	}
+
+	return "Unknown error"
+}