Draft: Exclude compile_commands.json from sketch loading

This allows users to create a symlink to the autogenerated file in the
sketch directory, without that file being handled or causing failure
when the target file does not exist yet (or anymore).

Draft: This abuses FilterOutSuffix, it should match the filename, but
go-paths-helper does not support this now.

Draft: Is this really the right place/approach to exclude this file?

Author: matthijskooijman

Diff for: arduino/sketch/sketch.go

@@ -166,6 +166,14 @@ func (s *Sketch) supportedFiles() (*paths.PathList, error) {
 	}
 	files.FilterOutDirs()
 	files.FilterOutHiddenFiles()
+	// Exclude files named compile_commands.json, to allow the user
+	// creating a symlink to the autogenerated file in the sketch
+	// directory, without that being handled or causing failure when
+	// the target file does not exist yet.
+	// TODO: This abuses FilterOutSuffix, it should match the
+	// filename, but go-paths-helper does not support this now.
+	files.FilterOutSuffix("compile_commands.json")
+
 	validExtensions := []string{}
 	for ext := range globals.MainFileValidExtensions {
 		validExtensions = append(validExtensions, ext)

Diff for: test/test_compile.py

@@ -228,6 +228,15 @@ def test_broken_symlink(sketch_name, link_name, target_name, expect_error):
     test_broken_symlink("CompileIntegrationTestSymlinkBrokenH", "link.h", "doesnotexist.h", expect_error=True)
     test_broken_symlink("CompileIntegrationTestSymlinkBrokenJson", "link.json", "doesnotexist.json", expect_error=True)
     test_broken_symlink("CompileIntegrationTestSymlinkBrokenXXX", "link.xxx", "doesnotexist.xxx", expect_error=False)
+    # Support a usecase where a user makes a symlink to
+    # compile_commands.json in the sketch root, even when it does not
+    # exist yet/anymore
+    test_broken_symlink(
+        "CompileIntegrationTestSymlinkBrokenCompileCommands",
+        "compile_commands.json",
+        "doesnotexist.json",
+        expect_error=False,
+    )
 
 
 def test_compile_blacklisted_sketchname(run_command, data_dir):