') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); })(); codemod iterations by KKonstantinov · Pull Request #2386 · modelcontextprotocol/typescript-sdk · GitHub
Skip to content

codemod iterations - #2386

Merged
KKonstantinov merged 7 commits into
mainfrom
feature/codemod-iterations-4
Jun 29, 2026
Merged

codemod iterations#2386
KKonstantinov merged 7 commits into
mainfrom
feature/codemod-iterations-4

Conversation

@KKonstantinov

@KKonstantinovKKonstantinov commented Jun 29, 2026•
edited
Loading

Copy link
Copy Markdown
Contributor

feat(codemod): test the batch harness against the published codemod + SDK, and preserve shebangs

Extends the codemod batch-test harness so it can validate the published@modelcontextprotocol/codemod and the published v2 SDK packages from npm — not just the local working copy — and fixes a codemod bug that dropped a file's leading #! shebang during migration.

Motivation and Context

The batch-test harness runs the v1→v2 codemod against real-world repos to catch regressions, missing transforms, and gaps. Until now it could only exercise the local working-copy codemod against locally-packed SDK tarballs. That validates the branch under development, but never the artifacts users actually npm install — so a bug present only in a published build, or an incompatibility with a published SDK alpha, would slip through.

This PR adds independent source selection for the codemod and the SDK, each local or published, plus version pinning:

FlagValuesDefaultEffect
--codemodlocal | publishedlocallocal: run the working-copy codemod in-process. published: npx the published CLI.
--sdklocal | publishedlocallocal: pack local packages, rewrite deps to file: tarballs. published: install v2 deps from npm.
--codemod-version <spec>npm version/tag/rangelatestOnly with --codemod=published.
--sdk-version <spec>npm version/tag/range(unset)Only with --sdk=published. Pins each v2 dep to its own resolved version; unset = whatever the codemod writes.

So the same harness can now answer "does the published codemod + published SDK still migrate these repos cleanly?", with results written to per-run directories keyed on the resolved versions.

Separately, several transforms consumed a file's leading #! shebang (it is leading trivia of the first import they rewrite), silently breaking CLI packages whose bin points at the migrated entry. The runner now captures the shebang before transforms and restores it before saving.

How Has This Been Tested?

  • New unit suitetest/batchTest.test.ts — arg parsing (--flag value and --flag=value, -- separator, invalid/unknown flags, ignored version overrides), parseNpmViewVersion, parseCodemodCliOutput, computeResultsDirName across all modes, rewriteToPublishedVersion (per-package independent versions, formatting/trailing-newline preserved), cleanSubprocessEnv, and local runCodemod.
  • Shebang regression tests — test/integration.test.ts verifies a migrated CLI file keeps #!/usr/bin/env node (plus its following blank line); test/commentInsertion.test.ts verifies a comment-bearing diagnostic's reported file:line points at the actual line in the saved (shebang-restored) file.
  • End-to-end — ran the harness against the repos in repos.json (punkpeye/fastmcp, upstash/context7, firebase/firebase-tools) in both local and published modes.
  • pnpm check:all is green (typecheck + lint + docs:check); the full codemod suite passes (411 tests).

Breaking Changes

None. The batch-test harness is dev-only tooling. The shebang fix is a user-facing codemod bugfix (output is now more correct) shipped as a patch changeset for @modelcontextprotocol/codemod; no consumer action required.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have read the MCP Documentation
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have added or updated documentation as needed

Additional context

Results layout. Each run writes to batch-test/results/codemod-…__sdk-…/, keyed on the resolved versions, with a top-level summary.json (per-repo pass/fail, error counts, run config, and the resolved per-package sdkVersions) and a report.json per repo (baseline vs post-codemod check results, diagnostics, change counts). In published-codemod mode the CLI emits text rather than structured diagnostics, so codemod.diagnostics is empty and the raw CLI output is captured under codemod.cli.

Subprocess env hygiene. The harness is invoked via pnpm, which exports its own config as npm_config_* / PNPM_* vars; those leak into every subprocess and break things (minimum-release-age blocks installs, workspace-cwd npx mis-resolves). cleanSubprocessEnv strips them so installs, npx, and npm view see a clean package-manager env (npmrc files still honored).

Security. The npx / npm view / git shell-outs interpolate only operator-controlled inputs — CLI flags, the committed repos.json, and Anthropic-published npm versions. JSON.stringify quoting does not neutralize $(…)/backticks under sh -c, so the harness must never be pointed at an untrusted manifest. This is called out at each call site.

Review fixes folded in (latest commit):

  • typedoc.json excludes the dev-only src/bin/** so the harness's exported types stop tripping typedoc's treatWarningsAsErrors (this was failing docs:check, hence check:all).
  • Post-install "actually-installed" versions are recorded into a separate map from the startup-resolved pins, so a package left unpinned at startup isn't retroactively pinned for later repos from an earlier repo's install.
  • Corrected the npm view "aborts the run" wording (a per-package --sdk-version miss only warns) and the parseNpmViewVersion comment (npm lists matches in publish order, not semver order).

@KKonstantinov
KKonstantinov requested a review from a team as a code ownerJune 29, 2026 14:47
@changeset-bot

changeset-botBot commented Jun 29, 2026•
edited
Loading

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 85879d7

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

This PR includes changesets to release 1 package
NameType
@modelcontextprotocol/codemodPatch

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

@pkg-pr-new

pkg-pr-newBot commented Jun 29, 2026•
edited
Loading

Copy link
Copy Markdown

Open in StackBlitz

@modelcontextprotocol/client

npm i https://pkg.pr.new/@modelcontextprotocol/client@2386

@modelcontextprotocol/codemod

npm i https://pkg.pr.new/@modelcontextprotocol/codemod@2386

@modelcontextprotocol/core

npm i https://pkg.pr.new/@modelcontextprotocol/core@2386

@modelcontextprotocol/server

npm i https://pkg.pr.new/@modelcontextprotocol/server@2386

@modelcontextprotocol/server-legacy

npm i https://pkg.pr.new/@modelcontextprotocol/server-legacy@2386

@modelcontextprotocol/express

npm i https://pkg.pr.new/@modelcontextprotocol/express@2386

@modelcontextprotocol/fastify

npm i https://pkg.pr.new/@modelcontextprotocol/fastify@2386

@modelcontextprotocol/hono

npm i https://pkg.pr.new/@modelcontextprotocol/hono@2386

@modelcontextprotocol/node

npm i https://pkg.pr.new/@modelcontextprotocol/node@2386

commit: 85879d7

felixweinberger
felixweinberger requested changes Jun 29, 2026
View reviewed changes

@felixweinbergerfelixweinberger left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Needs a CI check - seems to fail a build

claude[bot]
claudeBot reviewed Jun 29, 2026
View reviewed changes
Comment threadpackages/codemod/batch-test/README.md Outdated
Comment threadpackages/codemod/src/runner.ts
Comment threadpackages/codemod/src/bin/batchTest.ts
claude[bot]
claudeBot reviewed Jun 29, 2026
View reviewed changes
Comment threadpackages/codemod/src/runner.ts
Comment threadpackages/codemod/src/bin/batchTest.ts
Comment threadpackages/codemod/batch-test/README.md Outdated
@KKonstantinov
fix(codemod): unblock docs:check and address batch-test review
7d29061
 - typedoc: exclude src/bin from codemod docs so the batch-test harness's
exported types no longer trip treatWarningsAsErrors (fixes check:all)
- runner: shift diagnostic lines by the restored shebang's line count so
reported file:line matches the saved file
- batchTest: record post-install versions in a separate map so a
startup-unresolved package isn't retroactively pinned for later repos
- batchTest/README: correct npm-view abort wording, the parseNpmViewVersion
'highest match' comment, and 'How it works' step 4
- changeset: patch @modelcontextprotocol/codemod for the shebang fix
@KKonstantinov
Merge branch 'feature/codemod-iterations-4' of github.com:modelcontex…
f2b3bc8
…tprotocol/typescript-sdk into feature/codemod-iterations-4
claude[bot]
claudeBot reviewed Jun 29, 2026
View reviewed changes
Comment threadpackages/codemod/src/runner.ts
felixweinberger
felixweinberger previously approved these changes Jun 29, 2026
View reviewed changes
@KKonstantinov

KKonstantinov commented Jun 29, 2026

Copy link
Copy Markdown
ContributorAuthor

@claude review

claude[bot]
claudeBot reviewed Jun 29, 2026
View reviewed changes
Comment threadpackages/codemod/batch-test/repos.json Outdated
@KKonstantinov
KKonstantinov merged commit 36055d5 into mainJun 29, 2026
18 checks passed
@KKonstantinov
KKonstantinov deleted the feature/codemod-iterations-4 branch June 29, 2026 17:16
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@claudeclaude[bot]claude[bot] left review comments
@felixweinbergerfelixweinbergerfelixweinberger left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@KKonstantinov@felixweinberger