fix: Ensure files do not get regenerated when deleted and unmodified

[kingston]

Summary by CodeRabbit

• Bug Fixes

  • Patched behavior to ensure that files removed in previous versions are not unexpectedly regenerated if their content remains unchanged.

• Refactor & Documentation

  • Streamlined the file processing logic and updated descriptive text for improved clarity.

• Tests

  • Added a test to verify that deleted files with unchanged content are correctly handled.

[linear]

ENG-567 Files get regenerated even though they've been deleted

[changeset-bot]

🦋 Changeset detected

Latest commit: 5375bf7

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 11 packages

Name	Type
@halfdomelabs/sync	Patch
@halfdomelabs/core-generators	Patch
@halfdomelabs/fastify-generators	Patch
@halfdomelabs/project-builder-common	Patch
@halfdomelabs/project-builder-lib	Patch
@halfdomelabs/project-builder-server	Patch
@halfdomelabs/project-builder-test	Patch
@halfdomelabs/react-generators	Patch
@halfdomelabs/baseplate-plugin-storage	Patch
@halfdomelabs/project-builder-cli	Patch
@halfdomelabs/project-builder-web	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[coderabbitai]

Walkthrough

The changes introduce a new changeset entry for the @halfdomelabs/sync package, patching its behavior to avoid regenerating files that have been deleted and remain unmodified. Additionally, documentation and code logic within the generator file preparation have been updated: terminology in the findPreviousRelativePath function was revised to reference the generated rather than working codebase, and the logic in prepareGeneratorFile was simplified using the nullish coalescing operator. A new unit test has also been added to verify that a deleted file with unchanged content is not re-written.

Changes

File(s)	Change Summary
.changeset/two-garlics-try.md	Added a changeset entry indicating a patch for @halfdomelabs/sync to ensure deleted, unmodified files are not regenerated.
packages/sync/.../prepare-generator-file.ts	Updated comments in findPreviousRelativePath to reflect reference to the previous generated codebase; simplified the logic in prepareGeneratorFile using the nullish coalescing operator to determine the previous generated buffer.
packages/sync/.../prepare-generator-file.unit.test.ts	Added a new test case verifying that the generator does not re-write a file marked as deleted when its content remains unchanged.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant Generator as prepareGeneratorFile
    participant FS as FileSystem

    Caller ->>+ Generator: Invoke prepareGeneratorFile(relativePath, content, context)
    Generator ->> Generator: Determine previousRelativePath
    alt previousRelativePath exists
        Generator ->>+ FS: Read file at previousRelativePath
        FS -->>- Generator: Return previousGeneratedBuffer
    else
        Generator ->>+ FS: Read file at relativePath
        FS -->>- Generator: Return previousGeneratedBuffer
    end
    Generator ->> Caller: Return { relativePath, generatedContents, previousRelativePath (if any) }

Loading

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Lite

📥 Commits

Reviewing files that changed from the base of the PR and between c683d88 and 5375bf7.

📒 Files selected for processing (3)

• .changeset/two-garlics-try.md (1 hunks)
• packages/sync/src/output/prepare-generator-files/prepare-generator-file.ts (2 hunks)
• packages/sync/src/output/prepare-generator-files/prepare-generator-file.unit.test.ts (1 hunks)

🔇 Additional comments (4)

.changeset/two-garlics-try.md (1)

1-5: LGTM!

The changeset clearly describes the purpose of this patch: preventing regeneration of files that have been deleted and remain unmodified. This aligns with the code changes in the PR.

packages/sync/src/output/prepare-generator-files/prepare-generator-file.ts (2)

213-218: Documentation update looks good.

The terminology change from "previous working codebase" to "previous generated codebase" is more accurate and consistent with the function's purpose.

---

319-322: Good code simplification.

Using the nullish coalescing operator (??) simplifies the code while maintaining the same functionality - reading from previousRelativePath if it exists, otherwise falling back to relativePath.

packages/sync/src/output/prepare-generator-files/prepare-generator-file.unit.test.ts (1)

184-214: Great test addition.

This test case properly verifies the core functionality of the PR: ensuring that deleted files with unchanged content are not regenerated. The test simulates a scenario where:

1. A file has been deleted (empty workingFiles map)
2. The previous generated content exists
3. The new generated content is identical to the previous one

The expected result correctly asserts that mergedContents is undefined, which means no file write operation will occur.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.