Skip to content
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.

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

feat: remove *AsRichText helpers #347

Merged
merged 2 commits into from
Aug 1, 2024
Merged

Conversation

lihbr
Copy link
Member

@lihbr lihbr commented Jul 29, 2024

Resolves: #345

This is another option to #346. Only one of the two PR should be merged.

Description

This PR removes unstable_htmlAsRichText and unstable_markdownAsRichText helpers from @prismicio/client.

These migration-related helpers will be made available through a dedicated package to limit their impact on this core Prismic SDK: https://github.com/prismicio/prismic-migrate (to be made public)

This is not considered a breaking change because the helpers were considered unstable and not following SemVer. In the event you were (already) using them, migrate to @prismicio/migrate.

Checklist

  • If my changes require tests, I added them.
  • If my changes affect backward compatibility, it has been discussed.
  • If my changes require an update to the CONTRIBUTING.md guide, I updated it.

How to QA 1

Double-check for any remaining of the previous helpers. Some fixes on types and alike were made when adding them so I didn't simply revert to a previous commit (and we should own our mistakes)

Footnotes

  1. Please use these labels when submitting a review:
    ❓ #ask: Ask a question.
    💡 #idea: Suggest an idea.
    ⚠️ #issue: Strongly suggest a change.
    🎉 #nice: Share a compliment.

The migration-related helpers will be made available through a dedicated package to limit their impact on this core Prismic SDK.
@lihbr lihbr requested a review from angeloashmore July 29, 2024 13:42
@lihbr lihbr mentioned this pull request Jul 29, 2024
3 tasks
Copy link
Member

@angeloashmore angeloashmore left a comment

Choose a reason for hiding this comment

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

LGTM!

@lihbr lihbr merged commit cbd234b into master Aug 1, 2024
13 checks passed
@lihbr lihbr deleted the lh/extract-html-as-rich-text-helpers branch August 1, 2024 09: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.

2 participants