docs(website): add the v7 to v8 migration guide - #797
Merged
Merged
Conversation
List every change between type-plus 7.6.2 and 8.0 that breaks a build or changes a result, with the reason and a before and after example for each, and a checklist at the top. The removed names come from diffing the export surface of the published 7.6.2 against the current build, not only from the changesets. The v7 results were read off the 7.6.2 declarations, and every v8 example was compiled against the current source. Link the page from both readmes and the Guides sidebar. Drop a stale claim that NotUnknownOr takes a positional Else, and fix the ObjectPlus.Merge signature in the legacy object readme. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
🦋 Changeset detectedLatest commit: 214a71c The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #797 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 40 40
Lines 173 173
Branches 30 30
=========================================
Hits 173 173 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
guides/migrating-to-v8: every change betweentype-plus@7.6.2and 8.0 that breaks a build or changes a result. Each entry gives the change, the reason, and a before and after example. A checklist sits at the top.How the list was built
.changeset/, and the8.0.0-beta.*entries inCHANGELOG.md.esm/index.d.tsagainst the current build, via the compiler API. This found about 100 removed names, including the wholeXxxType/NotXxxType/IsStrictXxxfamily andPositive/Negative/Integer/IsWhole. No pending changeset covers those.CanAssign<never, number>wasfalsein 7.x, notnever, and v7IsPositivehad noexactoption.testType.equal, which compiled clean on TS 6.0. The spec was deleted before this commit.Findings worth a look
IsString<'a' | 1>wasfalsein 7.x and isbooleanin v8.IsTrue<boolean>went fromfalsetoboolean. No changeset mentions this, and it is the change most likely to catch users silently. The page puts it first under "Changed results", with{ distributive: false }as the fix.Other changes
readme.mdandpackages/type-plus/readme.md, in the v8 beta status section.migrating-then-else-to-options.mdx: removed the claim thatNotUnknownOrkeeps a positionalElse. It takes{ $unknown }since refactor(type-plus)!: one options convention for transforms #721.src/object/readme.md:ObjectPlus.Mergeno longer shows the removedOptionsparameter. The legacy tree already records the other removals.pnpm verifypasses locally, including the website build.🤖 Generated with Claude Code