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

Use mdast-util-newline-to-break #10

Merged
merged 4 commits into from
May 9, 2023
Merged

Conversation

remcohaszing
Copy link
Member

@remcohaszing remcohaszing commented May 4, 2023

Initial checklist

  • I read the support docs
  • I read the contributing guide
  • I agree to follow the code of conduct
  • I searched issues and couldn’t find anything (or linked relevant results below)
  • If applicable, I’ve added docs and tests

Description of changes

Replace the transformer with mdast-util-newline-to-break.

Closes #9

@github-actions github-actions bot added 👋 phase/new Post is being triaged automatically 🤞 phase/open Post is being triaged manually and removed 👋 phase/new Post is being triaged automatically labels May 4, 2023
Copy link
Member

@ChristianMurphy ChristianMurphy left a comment

Choose a reason for hiding this comment

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

Thanks @remcohaszing!
Remind me did the upstream package make any changes to the API?
I'm specifically asking to better understand the semver implications of this change.

@remcohaszing
Copy link
Member Author

The upstream API should be the same, but the implementation is based on #9 (comment).

Note that it’s a drop-in replacement. No tests were modified.

@ChristianMurphy ChristianMurphy added the 🧒 semver/minor This is backwards-compatible change label May 5, 2023
package.json Outdated Show resolved Hide resolved
@codecov-commenter
Copy link

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (a343c6c) 100.00% compared to head (74db9b1) 100.00%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #10   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines           49        15   -34     
=========================================
- Hits            49        15   -34     
Impacted Files Coverage Δ
index.js 100.00% <100.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@wooorm wooorm merged commit c608c41 into main May 9, 2023
@wooorm wooorm deleted the mdast-util-newline-to-break branch May 9, 2023 12:28
@wooorm wooorm changed the title Use mdast-util-newline-to-break Use mdast-util-newline-to-break May 9, 2023
@wooorm wooorm added the 💪 phase/solved Post is done label May 9, 2023
@wooorm
Copy link
Member

wooorm commented May 9, 2023

Released in 3.0.3!

@wooorm wooorm removed the 🤞 phase/open Post is being triaged manually label May 9, 2023
@github-actions

This comment was marked as resolved.

@absoludity
Copy link

Thanks @remcohaszing! Remind me did the upstream package make any changes to the API? I'm specifically asking to better understand the semver implications of this change.

AFAICT, the use of mdast-util-newline-to-break, which is ESM only, forces Typescript projects that import the module to update to ESM output, so not sure it should have been a patch release in retrospect?

@wooorm
Copy link
Member

wooorm commented Jul 4, 2023

All our packages are esm for years already. So no.

Where did this comment come from? Did something break? How did you find this somewhat old issue?

@absoludity
Copy link

Sorry - I'd simply failed to include the new dep (mdast-util-newline-to-break) in our transformIgnorePatterns. Sorry for the noise.

@wooorm
Copy link
Member

wooorm commented Jul 5, 2023

Oh is this remix still being broken 😬😬

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💪 phase/solved Post is done 🧒 semver/minor This is backwards-compatible change
Development

Successfully merging this pull request may close these issues.

Move transformer into mdast-util-breaks
5 participants