Fixed a bug where turning on and off the rendering of markdown files …

…in Workspace config wouldn't turn off rendering properly and would stay in read-only mode (fixes tuist#5196) (tuist#5261) * Fixed a bug where turning on and off the rendering of markdown files in Workspace config wouldn't turn off rendering properly and would stay in read-only mode (fixes tuist#5196) * chore: remove bugfix comment * remove trailing whitespace --------- Co-authored-by: Daniele Formichelli <[email protected]>
runtastic · Jul 4, 2023 · a9cc880 · a9cc880
1 parent 461eecd
commit a9cc880
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 7 deletions.
diff --git a/Sources/TuistKit/Mappers/Workspace/TuistWorkspaceRenderMarkdownMapper.swift b/Sources/TuistKit/Mappers/Workspace/TuistWorkspaceRenderMarkdownMapper.swift
@@ -5,21 +5,18 @@ import TuistSupport
 /// Tuist Workspace Markdown render Mapper.
 ///
 /// A mapper that includes a .xcodesample.plist file within the generated xcworkspace directory.
-/// This is used to render markdown inside the de workspace.
+/// This is used to render markdown inside the workspace.
 final class TuistWorkspaceRenderMarkdownReadmeMapper: WorkspaceMapping {
     func map(workspace: WorkspaceWithProjects) throws -> (WorkspaceWithProjects, [SideEffectDescriptor]) {
-        guard workspace.workspace.generationOptions.renderMarkdownReadme else {
-            return (workspace, [])
-        }
-
         let tuistGeneratedFileDescriptor = FileDescriptor(
             path: workspace
                 .workspace
                 .xcWorkspacePath
                 .appending(
                     component: ".xcodesamplecode.plist"
                 ),
-            contents: try PropertyListEncoder().encode([String]())
+            contents: try PropertyListEncoder().encode([String]()),
+            state: workspace.workspace.generationOptions.renderMarkdownReadme ? .present : .absent
         )
 
         return (workspace, [

diff --git a/Tests/TuistKitTests/Mappers/Workspace/TuistWorkspaceRenderMarkdownReadmeMapperTests.swift b/Tests/TuistKitTests/Mappers/Workspace/TuistWorkspaceRenderMarkdownReadmeMapperTests.swift
@@ -68,6 +68,15 @@ final class TuistWorkspaceRenderMarkdownReadmeMapperTests: TuistUnitTestCase {
             renderMarkdownReadme: false
         ))
 
+        let tuistGeneratedFileDescriptor = FileDescriptor(
+            path: workspace
+                .xcWorkspacePath
+                .appending(
+                    component: ".xcodesamplecode.plist"
+                ),
+            contents: try PropertyListEncoder().encode([String]()),
+            state: .absent // file should be deleted
+        )
         let workspaceWithProjects = WorkspaceWithProjects(workspace: workspace, projects: [])
         // When
         let (gotWorkspaceWithProjects, sideEffects) = try TuistWorkspaceRenderMarkdownReadmeMapper()
@@ -78,6 +87,11 @@ final class TuistWorkspaceRenderMarkdownReadmeMapperTests: TuistUnitTestCase {
             gotWorkspaceWithProjects.workspace.generationOptions.renderMarkdownReadme
         )
         XCTAssertTrue(gotWorkspaceWithProjects.workspace.projects.isEmpty)
-        XCTAssertEqual(sideEffects, [])
+        XCTAssertEqual(
+            sideEffects,
+            [
+                .file(tuistGeneratedFileDescriptor),
+            ]
+        )
     }
 }