FRB now reports why a file was added to the .csproj (#1763)

Author: vchelaru

FRBDK/Glue/Glue/Plugins/EmbeddedPlugins/SyncedProjects/SyncedProjectLogic.cs

@@ -34,7 +34,9 @@ public void SyncContentFromTo(VisualStudioProject from, VisualStudioProject to)
                         !(to is CombinedEmbeddedContentProject);
                 }
 
-                GlueCommands.Self.ProjectCommands.UpdateFileMembershipInProject(to, absoluteFileName, useContentPipeline: forceToContent, shouldLink: true, recursive:false);
+                GlueCommands.Self.ProjectCommands.UpdateFileMembershipInProject(to, absoluteFileName, useContentPipeline: forceToContent, shouldLink: true,
+                    recursive:false,
+                    reasonForAdd: $"{from} (original project) references file");
             }
         }
 

FRBDK/Glue/Glue/Plugins/ExportedImplementations/CommandInterfaces/ProjectCommands.cs

@@ -236,7 +236,8 @@ public bool UpdateFileMembershipInProject(ReferencedFileSave referencedFileSave,
                 wasAnythingAdded = UpdateFileMembershipInProject(GlueState.Self.CurrentMainProject, absoluteFilePath,
                     useContentPipeline, false,
                     fileRfs: referencedFileSave,
-                    reEvaluateAfterAdd: reEvaluateAfterAdd);
+                    reEvaluateAfterAdd: reEvaluateAfterAdd,
+                    reasonForAdd: $"{referencedFileSave} Explicitly added as file in FRB");
             }
 
             foreach (ProjectSpecificFile projectSpecificFile in referencedFileSave.ProjectSpecificFiles)
@@ -262,9 +263,13 @@ public bool UpdateFileMembershipInProject(ReferencedFileSave referencedFileSave,
     /// <param name="shouldLink"></param>
     /// <param name="parentFile"></param>
     /// <returns>Whether the project was modified.</returns>
-    public bool UpdateFileMembershipInProject(VisualStudioProject project, FilePath fileName, bool useContentPipeline, bool shouldLink,
-        string parentFile = null, bool recursive = true, List<string> alreadyReferencedFiles = null, ReferencedFileSave fileRfs = null,
-        bool reEvaluateAfterAdd = true)
+    public bool UpdateFileMembershipInProject(VisualStudioProject project,
+        FilePath fileName, bool useContentPipeline, bool shouldLink,
+        string parentFile = null, bool recursive = true,
+        List<string> alreadyReferencedFiles = null,
+        ReferencedFileSave fileRfs = null,
+        bool reEvaluateAfterAdd = true,
+        string reasonForAdd = "")
     {
         bool wasProjectModified = false;
         ///////////////////Early Out/////////////////////
@@ -368,7 +373,7 @@ project.ContentProject is VisualStudioProject &&
 
             if (needsToBeInContentProject)
             {
-                AddFileToContentProject(project, useContentPipeline, shouldLink, fileToAddAbsolute, fileRfs, reEvaluateAfterAdd);
+                AddFileToContentProject(project, useContentPipeline, shouldLink, fileToAddAbsolute, fileRfs, reEvaluateAfterAdd, reasonForAdd:reasonForAdd);
             }
             else
             {
@@ -421,7 +426,9 @@ project.ContentProject is VisualStudioProject &&
                 }
                 else
                 {
-                    wasProjectModified |= UpdateFileMembershipInProject(project, file, useContentPipeline, shouldLink, fileToAddAbsolute, recursive: true, alreadyReferencedFiles: alreadyReferencedFiles, reEvaluateAfterAdd:reEvaluateAfterAdd);
+                    wasProjectModified |= UpdateFileMembershipInProject(project, file, useContentPipeline, shouldLink, fileToAddAbsolute,
+                        recursive: true, alreadyReferencedFiles: alreadyReferencedFiles, reEvaluateAfterAdd:reEvaluateAfterAdd,
+                        reasonForAdd:$"Referenced by {fileName}");
                 }
             }
         }
@@ -477,7 +484,9 @@ private static bool ShouldFileBeInContentProject(FilePath filePath)
     }
 
     private static void AddFileToContentProject(ProjectBase project, bool useContentPipeline,
-        bool shouldLink, string fileToAddAbsolute, ReferencedFileSave rfs, bool reEvaluateAfterAdd = true)
+        bool shouldLink, string fileToAddAbsolute,
+        ReferencedFileSave rfs, bool reEvaluateAfterAdd = true,
+        string reasonForAdd = "")
     {
         string relativeFileName = FileManager.MakeRelative(
             fileToAddAbsolute,
@@ -515,7 +524,14 @@ private static void AddFileToContentProject(ProjectBase project, bool useContent
 
         }
 
-        PluginManager.ReceiveOutput("Added " + relativeFileName + $" to {project.Name} as content");
+        if(reasonForAdd != string.Empty)
+        {
+            PluginManager.ReceiveOutput("Added " + relativeFileName + $" to {project.Name} as content. Reason: {reasonForAdd}");
+        }
+        else
+        {
+            PluginManager.ReceiveOutput("Added " + relativeFileName + $" to {project.Name} as content");
+        }
     }
 
     public void CreateAndAddCodeFile(string relativeFileName)

FRBDK/Glue/Glue/Plugins/ExportedInterfaces/CommandInterfaces/IProjectCommands.cs

@@ -98,7 +98,9 @@ bool UpdateFileMembershipInProject(VisualStudioProject project, FilePath fileNam
             string parentFile = null,
             bool recursive = true,
             List<string> alreadyReferencedFiles = null,
-            ReferencedFileSave fileRfs = null, bool reEvaluateAfterAdd = true);
+            ReferencedFileSave fileRfs = null,
+            bool reEvaluateAfterAdd = true,
+            string reasonForAdd = "");
 
         ProjectBase AddSyncedProject(FilePath filePath);