Skip to content

docs: add v1 to v2 migration guide #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: 08-29-refactor_migrate_to_esm_use_pkg-utils_for_build_switch_tests_to_vitest
Choose a base branch
from
Open

docs: add v1 to v2 migration guide #86

wants to merge 1 commit into from

Conversation

rdunk
Copy link
Member

@rdunk rdunk commented Sep 23, 2025 •
edited
Loading

Adds a migration guide for v1 to v2 and links to it from the README.

  • The migration guide covers:
    • Replacing default export with named export
    • Fixing type imports to use the main package entry point
    • Moving from CommonJS to ESM
    • Updated Node.js minimum version requirement

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Sep 23, 2025 •
edited
Loading

⚠️ No Changeset found

Latest commit: 13f9122

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@rdunk rdunk mentioned this pull request Sep 23, 2025
Open
@rdunk Graphite App
Copy link
Member Author

rdunk commented Sep 23, 2025

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

@rdunk rdunk mentioned this pull request Sep 23, 2025
Open
@rdunk rdunk marked this pull request as ready for review September 23, 2025 12:26
@rdunk rdunk force-pushed the 09-23-docs_add_v1_to_v2_migration_guide branch from 0271865 to 36058ae Compare September 23, 2025 12:42
@rdunk rdunk force-pushed the 08-29-refactor_migrate_to_esm_use_pkg-utils_for_build_switch_tests_to_vitest branch from f80b5ba to 826e441 Compare September 23, 2025 13:11
@rdunk rdunk force-pushed the 09-23-docs_add_v1_to_v2_migration_guide branch from 36058ae to 00af0ca Compare September 23, 2025 13:11
@rdunk rdunk force-pushed the 09-23-docs_add_v1_to_v2_migration_guide branch from 00af0ca to 13f9122 Compare September 23, 2025 13:18
@rdunk rdunk requested a review from a team September 30, 2025 10:49
markmichon
markmichon approved these changes Sep 30, 2025
View reviewed changes
Copy link

@markmichon markmichon left a comment

Choose a reason for hiding this comment

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

lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@markmichon markmichon markmichon approved these changes

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
@rdunk @markmichon