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

Refactor to remove buffer import in types #82

Merged
merged 2 commits into from Sep 8, 2022
Merged

Refactor to remove buffer import in types #82

merged 2 commits into from Sep 8, 2022

Conversation

remcohaszing
Copy link
Member

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

This can be problematic is the buffer package is installed. A practical example is that types published in DefinitelyTyped can’t depend on vfile or unified.

Checking the global Buffer works fine too.

This can be problematic is the `buffer` package is installed. A
practical example is that types published in DefinitelyTyped can’t
depend on `vfile` or `unified`.

Checking the global `Buffer` works fine too.
@remcohaszing remcohaszing added the ☂️ area/types This affects typings label Sep 8, 2022
@remcohaszing remcohaszing requested a review from a team September 8, 2022 08:34
@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 Sep 8, 2022
@wooorm wooorm changed the title Remove the buffer import Refactor to remove buffer import in types Sep 8, 2022
@wooorm wooorm merged commit 6c5a2f7 into vfile:main Sep 8, 2022
@wooorm wooorm added the 💪 phase/solved Post is done label Sep 8, 2022
@github-actions

This comment has been minimized.

@github-actions github-actions bot removed the 🤞 phase/open Post is being triaged manually label Sep 8, 2022
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.

Just to confirm, this was tested in a non-node environment to ensure that it doesn't error when Buffer isn't a global?

@remcohaszing
Copy link
Member Author

Yes, by removing @types/node_modules/node and inspecting in VSCode.

@wooorm
Copy link
Member

wooorm commented Sep 8, 2022

released! https://github.com/vfile/vfile/releases/tag/5.3.5

fuxingloh pushed a commit to fuxingloh/contented that referenced this pull request Sep 9, 2022
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [vfile](https://togithub.com/vfile/vfile) | [`^5.3.4` ->
`^5.3.5`](https://renovatebot.com/diffs/npm/vfile/5.3.4/5.3.5) |
[![age](https://badges.renovateapi.com/packages/npm/vfile/5.3.5/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/vfile/5.3.5/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/vfile/5.3.5/compatibility-slim/5.3.4)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/vfile/5.3.5/confidence-slim/5.3.4)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>vfile/vfile</summary>

### [`v5.3.5`](https://togithub.com/vfile/vfile/releases/tag/5.3.5)

[Compare Source](https://togithub.com/vfile/vfile/compare/5.3.4...5.3.5)

- [`6c5a2f7`](https://togithub.com/vfile/vfile/commit/6c5a2f7) Refactor
to remove buffer import in types
by [@&#8203;remcohaszing](https://togithub.com/remcohaszing) in
[vfile/vfile#82

**Full Changelog**: vfile/vfile@5.3.4...5.3.5

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click
this checkbox.

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://app.renovatebot.com/dashboard#github/BirthdayResearch/contented).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzMi4xOTQuMiIsInVwZGF0ZWRJblZlciI6IjMyLjE5NC4yIn0=-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
☂️ area/types This affects typings 💪 phase/solved Post is done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants