Repository navigation
docs(codemods): mark the platform vs personal codemod boundary - #1063
Conversation
Platform-authored migrations stay in the built-in engine; user-authored transforms over a user's own packages are the userland pattern, packaged as the @kentcdodds/codemod-runner community package. Co-authored-by: Kent C. Dodds <me+github@kentcdodds.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe package codemods documentation distinguishes platform-authored built-in migrations from user-authored transforms, directs users to ChangesPackage codemod documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
🔎 Preview deployed: https://kody-pr-1063.kody-a99.workers.dev Worker: Mocks:
|
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/contributing/package-codemods.md`:
- Around line 47-51: Update the guidance around the `@kentcdodds/codemod-runner`
reference to disclose that the community package is unreviewed. Instruct readers
to inspect and pin the package or its source before installation, or replace the
reference with a reviewed canonical implementation.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 261cf105-49b7-4e2b-a3f4-34b5316f344b
📒 Files selected for processing (1)
docs/contributing/package-codemods.md
Co-authored-by: Kent C. Dodds <me+github@kentcdodds.com>
Docs-only follow-up to #1049.
Adds one entry to the "codemods are not" list in
docs/contributing/package-codemods.mdmarking the scope boundary of the built-in engine: platform-authored migrations live in-repo (version-coupled, CI-tested, fleet-reaching), while user-authored transforms over a user's own packages are a userland pattern — now packaged as the@kentcdodds/codemod-runnercommunity package (same contract vocabulary:detect/transform, dry-run-before-apply, drift skips, idempotency verification, revert snapshots). The dividing line documented: who authored the transform.No code changes;
format:checkgreen.Summary by CodeRabbit