Skip to content

fix: use e18e docs for replacements#1231

Merged
ghostdevv merged 1 commit intomainfrom
jg/e18e-link
Feb 8, 2026
Merged

fix: use e18e docs for replacements#1231
ghostdevv merged 1 commit intomainfrom
jg/e18e-link

Conversation

@43081j
Copy link
Contributor

@43081j 43081j commented Feb 8, 2026

We recently changed the replacement notice to link to e18e, this is just
one we missed.

We recently changed the replacement notice to link to e18e, this is just
one we missed.
@vercel
Copy link

vercel bot commented Feb 8, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
npmx.dev Ready Ready Preview, Comment Feb 8, 2026 6:56pm
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
docs.npmx.dev Ignored Ignored Preview Feb 8, 2026 6:56pm
npmx-lunaria Ignored Ignored Feb 8, 2026 6:56pm

Request Review

@codecov
Copy link

codecov bot commented Feb 8, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

@ghostdevv ghostdevv enabled auto-merge February 8, 2026 18:57
@ghostdevv ghostdevv added this pull request to the merge queue Feb 8, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 8, 2026

📝 Walkthrough

Walkthrough

The pull request updates the documentation URL resolution for documented replacements across two Vue components. In ReplacementSuggestion.vue and Replacement.vue, the docUrl computation is modified to point to a new domain at https://e18e.dev/docs/replacements/{docPath}.html instead of the previous GitHub docs reference. The changes maintain existing null-check logic and guard clauses whilst appending .html to the docPath parameter.

Possibly related PRs

Suggested reviewers

  • danielroe
🚥 Pre-merge checks | ✅ 1
✅ Passed checks (1 passed)
Check name Status Explanation
Description check ✅ Passed The pull request description accurately describes the changeset, explaining that a missed replacement notice link needed updating to reference e18e documentation.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch jg/e18e-link

No actionable comments were generated in the recent review. 🎉

🧹 Recent nitpick comments
app/components/Compare/ReplacementSuggestion.vue (1)

17-19: Consider defensive normalisation if docPath format becomes inconsistent.

Current test data shows docPath values as simple identifiers ('moment', 'lodash-underscore') without extensions. However, to guard against future data contract changes or upstream package updates, defensive normalisation would safely handle cases where docPath might already include the .html extension.

💡 Optional defensive normalisation
-  return `https://e18e.dev/docs/replacements/${props.replacement.docPath}.html`
+  const path = props.replacement.docPath
+  const normalised = path.endsWith('.html') ? path : `${path}.html`
+  return `https://e18e.dev/docs/replacements/${normalised}`
app/components/Package/Replacement.vue (1)

13-15: Defensive normalisation is optional; docPath values currently follow slug format without extension.

Testing shows all docPath values in the codebase are bare slugs (e.g., moment, lodash-underscore) without file extensions. The .html suffix is correctly appended in Replacement.vue and ReplacementSuggestion.vue. If defensive normalisation is preferred for future robustness, the suggested approach is reasonable, but this is not a critical issue based on current usage patterns.


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

Merged via the queue into main with commit b5eb232 Feb 8, 2026
20 checks passed
@ghostdevv ghostdevv deleted the jg/e18e-link branch February 8, 2026 19:03
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.

2 participants