Command line option for allowing use of ./platform.sketch.txt file

Author: phd

add_build_properties_from_platform_sketch_txt_file.go

@@ -42,6 +42,10 @@ import (
 type AddBuildPropertiesFromPlatformSketchTxtFile struct{}
 
 func (s *AddBuildPropertiesFromPlatformSketchTxtFile) Run(ctx *types.Context) error {
+	if !ctx.UsePlatformSketchTxt {
+		return nil
+	}
+
 	path := filepath.Join(filepath.Dir(ctx.Sketch.MainFile.Name), constants.FILE_PLATFORM_SKETCH_TXT)
 	if !utils.IsFileReadable(path) {
 		return nil

arduino-builder/main.go

@@ -89,6 +89,7 @@ const FLAG_VID_PID = "vid-pid"
 const FLAG_JOBS = "jobs"
 const FLAG_TRACE = "trace"
 const FLAG_EXPERIMENTAL = "experimental"
+const FLAG_USE_PLATFORM_SKETCH_TXT = "use-platform-sketch-txt"
 
 type foldersFlag []string
 
@@ -151,6 +152,7 @@ var vidPidFlag *string
 var jobsFlag *int
 var traceFlag *bool
 var experimentalFeatures *bool
+var usePlatformSketchTxt *bool
 
 func init() {
 	compileFlag = flag.Bool(FLAG_ACTION_COMPILE, false, "compiles the given sketch")
@@ -179,6 +181,7 @@ func init() {
 	jobsFlag = flag.Int(FLAG_JOBS, 0, "specify how many concurrent gcc processes should run at the same time. Defaults to the number of available cores on the running machine")
 	traceFlag = flag.Bool(FLAG_TRACE, false, "traces the whole process lifecycle")
 	experimentalFeatures = flag.Bool(FLAG_EXPERIMENTAL, false, "enables experimental features")
+	usePlatformSketchTxt = flag.Bool(FLAG_USE_PLATFORM_SKETCH_TXT, false, "allow reading additional platform build properies from an optional platform.sketch.txt file")
 }
 
 func main() {
@@ -374,6 +377,11 @@ func main() {
 		}
 	}
 
+	// FLAG_USE_PLATFORM_SKETCH_TXT
+	if *usePlatformSketchTxt {
+		ctx.UsePlatformSketchTxt = true
+	}
+
 	if *warningsLevelFlag != "" {
 		ctx.WarningsLevel = *warningsLevelFlag
 	}

test/add_build_properties_from_platform_sketch_txt_file_test.go

@@ -39,10 +39,22 @@ import (
 
 func TestAddBuildBoardPropertiesFromPlatformSketchTxtFile(t *testing.T) {
 	ctx := makeDefaultContext(t)
+	ctx.UsePlatformSketchTxt = true
 
 	sketchLocation := filepath.Join("sketch_with_platform_sketch_txt", "sketch_with_platform_sketch_txt.ino")
 	ctx.SketchLocation = sketchLocation
 
 	err := builder.RunBuilder(ctx)
 	require.NoError(t, err, "Unexpected build error for "+sketchLocation)
 }
+
+func TestAddBuildBoardPropertiesFromPlatformSketchTxtFileDisabled(t *testing.T) {
+	ctx := makeDefaultContext(t)
+	ctx.UsePlatformSketchTxt = false
+
+	sketchLocation := filepath.Join("sketch_with_platform_sketch_txt", "sketch_with_platform_sketch_txt.ino")
+	ctx.SketchLocation = sketchLocation
+
+	err := builder.RunBuilder(ctx)
+	require.Error(t, err, "No expected build error for "+sketchLocation)
+}

types/context.go

@@ -64,6 +64,8 @@ type Context struct {
 	SourceGccMinusE string
 	CodeCompletions string
 
+	UsePlatformSketchTxt bool
+
 	WarningsLevel string
 
 	// Libraries handling