Skip to content

docs(codemods): mark the platform vs personal codemod boundary - #1063

Merged
kody-bot merged 2 commits into
mainfrom
cursor/user-codemod-docs-86c8
Jul 30, 2026
Merged

kody-bot merged 2 commits into
mainfrom
cursor/user-codemod-docs-86c8

Conversation

@kentcdodds

@kentcdodds kentcdodds commented Jul 30, 2026 •

Copy link
Copy Markdown
Member

Docs-only follow-up to #1049.

Adds one entry to the "codemods are not" list in docs/contributing/package-codemods.md marking 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-runner community 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:check green.

Open in Web Open in Cursor 

Summary by CodeRabbit

  • Documentation
    • Clarified the distinction between personal (user-authored) codemods and built-in platform codemods.
    • Directed readers transforming their own packages to use existing user capabilities and community tooling.
    • Added guidance to review the community package source and fork/pin before running it, and reiterated that built-in engines shouldn’t run user-authored transforms.

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>
@coderabbitai

coderabbitai Bot commented Jul 30, 2026 •

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 86066906-009e-43db-9d9f-af15fcdf571d

📥 Commits

Reviewing files that changed from the base of the PR and between bf519c3 and 6bbf8d1.

📒 Files selected for processing (1)
  • docs/contributing/package-codemods.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/contributing/package-codemods.md

📝 Walkthrough

Walkthrough

The package codemods documentation distinguishes platform-authored built-in migrations from user-authored transforms, directs users to @kentcdodds/codemod-runner, and instructs them to inspect and fork the community package before running it.

Changes

Package codemod documentation

Layer / File(s) Summary
Personal codemod guidance
docs/contributing/package-codemods.md
Clarifies the boundary between built-in and personal codemods, documents the @kentcdodds/codemod-runner workflow, instructs users to inspect and fork the community package, and reiterates that the built-in engine should not execute user-authored transforms.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

  • kentcdodds/kody#1049: Updates the same package codemod documentation and related authoring guidance.
  • kentcdodds/kody#1056: Adds codemod-specific authoring documentation that overlaps with this package codemod guidance.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the docs-only change clarifying the platform vs personal codemod boundary.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch cursor/user-codemod-docs-86c8

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.

@kody-bot
kody-bot marked this pull request as ready for review July 30, 2026 16:12
@github-actions

github-actions Bot commented Jul 30, 2026 •

Copy link
Copy Markdown
Contributor

🔎 Preview deployed: https://kody-pr-1063.kody-a99.workers.dev

Worker: kody-pr-1063
D1: kody-pr-1063-db
KV: kody-pr-1063-oauth-kv

Mocks:

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 44b8647 and bf519c3.

📒 Files selected for processing (1)
  • docs/contributing/package-codemods.md

Comment thread docs/contributing/package-codemods.md Outdated
Co-authored-by: Kent C. Dodds <me+github@kentcdodds.com>
@kody-bot
kody-bot merged commit 56e4851 into main Jul 30, 2026
10 checks passed
@kody-bot
kody-bot deleted the cursor/user-codemod-docs-86c8 branch July 30, 2026 17:09
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.

3 participants