Skip to content

Warn before starting experimental two-way sync - #61

Merged
elemdos merged 1 commit into
masterfrom
fix/experimental-sync-warning
Oct 10, 2026
Merged

elemdos merged 1 commit into
masterfrom
fix/experimental-sync-warning

Conversation

@elemdos

@elemdos elemdos commented Oct 10, 2026 •

Copy link
Copy Markdown
Contributor

Starting primo dev --author both now prints a warning before workspace setup or synchronization: conflicting edits can overwrite local files or CMS changes. The warning recommends committing or backing up the workspace and choosing one authoring mode at a time. Help and README describe the same risk.

Validation: TypeScript build and built CLI dev --help passed with Node 22.22.3; git diff --check passed. Sync behavior and the default files-author mode are unchanged.

Summary by CodeRabbit

  • Documentation
    • Clarified that bidirectional sync is experimental and that conflicting edits may overwrite local or CMS changes.
    • Added guidance to back up the workspace and use a single authoring mode where possible.
  • Developer Experience
    • The development server now displays a warning when bidirectional sync is selected.

@coderabbitai

coderabbitai Bot commented Oct 10, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: a7741fc7-4a54-4109-a06f-29dd1fadb9a9

📥 Commits

Reviewing files that changed from the base of the PR and between 34deb1d and 1b871e0.


📒 Files selected for processing (3)
  • README.md
  • src/commands/dev.ts
  • src/index.ts

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.



📝 Walkthrough

Walkthrough

The --author both mode is now labeled experimental. Its runtime warning and documentation describe possible overwrites and recommend backing up the workspace and using one authoring mode at a time.

Changes

Author Mode Warning

Layer / File(s) Summary
Both-mode warning and guidance
src/index.ts, src/commands/dev.ts, README.md
The option description and runtime warning identify --author both as experimental and warn that conflicting edits can overwrite local files or CMS changes. The README recommends backing up the workspace and using one authoring mode at a time. In CMS mode, it recommends making file edits in files mode.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Feature


Merge Risk: ⚪ Minimal · up to 1b871

The change adds an early warning for experimental two-way sync and matching backup guidance. No actionable merge risk is identified.

Pre-merge checks | Passed 4 | Failed 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 2 files. (1 skipped: 1 … Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main change: adding a warning before experimental two-way sync starts.
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.

Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 2 files. (1 skipped: 1 unsupported.)



  • Fix all pre-merge checks with AI
✨ Finishing Touches 💡 1
📝 Generate docstrings 💡
  • Commit to this branch
  • Create a new PR

🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR


  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@elemdos
elemdos merged commit 2ba99c9 into master Oct 10, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant