node: API docs never mention NodeBuffer, remove the definition#25500
node: API docs never mention NodeBuffer, remove the definition#255002 commits merged intoDefinitelyTyped:masterfrom
Conversation
|
@thw0rted Thank you for submitting this PR! 🔔 @midknight41 @jasonswearingen @HiromiShikata @geoffreak @CodeAnimal @swook @Wind-rider @shantanubhadoria @LukeL99 @bioball @keton @thegecko @parambirs @tellnes @WilcoBakker @octo-sniffle @smac89 @Flarna @mwiktorczyk @wwwy3y3 @DeividasBakanas @kjin @alvis @OliverJAsh @eps1lon @Hannes-Magnusson-CK @jkomyno @ajafff @hoo29 @n-e @soywiz @bonnici @Bartvds @joeskeen @ccurrens @lookfirst @mastermatt - please review this PR in the next few days. Be sure to explicitly select If no reviewer appears after a week, a DefinitelyTyped maintainer will review the PR instead. |
|
@thw0rted The Travis CI build failed! Please review the logs for more information. Once you've pushed the fixes, the build will automatically re-run. Thanks! |
|
@thw0rted I can remember that I started typing a response to your question in #25327 but it seems I haven't finished or it got lost by some other reason... Anyhow, I can't tell why this deprecated interface is there and I see also no use for it. It was already there when I started using them ~2 years ago. There are quite some other relics in the typings (search for Similar I fear that removing |
|
This commit fixed the linter for the packages where things broke, so I think Travis will be happy. Of course, other consumers could be referencing the deprecated interface instead for some reason, so they'd break when updating their typings. Is there something I'm supposed to edit to flag this as a potential breaking change? (Hopefully it's not common to reference the typings for v9 / v10 while including an interface that's been deprecated since v0, but I've seen stranger things...) |
|
@thw0rted I don't think there is some mechanism to avoid breaking other modules. Typings here have no semver versioning, they follow the versions of their source. |
|
A definition owner has approved this PR ⭐️. A maintainer will merge this PR shortly. If it shouldn't be merged yet, please leave a comment saying so and we'll wait. Thank you for your contribution to DefinitelyTyped! |
|
How about you guys wait for 10.x instead removing stuff in a bugfix version?? The problem is that I have third-party typescript dependencies that in turn depend on something that uses NodeBuffer. So you guys just broke our builds for no good reason at all and I have to rely on third parties to fix it properly. At least if you did it in 10.x then we'd have a PLANNED moment to fix breaking changes |
|
@rogierschouten Sorry for that. I think there are two options here:
Just for interest: Which module is still using |
|
I always kind of wondered how people kept DT updates from breaking stuff since the versions link to the library being described, rather than a semver scheme describing changes to the typings themselves. It looks like the answer is that updates just break stuff. Maybe they should do something about that, though I'm not sure npm has the vocabulary for it. Anyway, sorry, @rogierschouten , but please be aware that I didn't submit this change in a vacuum. The type your great-grand-dependency referenced has been marked as deprecated for years (!) and should have been removed ages ago. I came across this because I was using I'm not sure how to best resolve this -- I've been using TS for about a year now but my understanding of the DT ecosystem is only so-so. If reverting v9 helps, fine, but I'm not sure I see the benefit since the type that was removed hasn't existed since at least v0 (!!!) and the deprecation warning has been in place for as far back as I can see. I mean, if the "problem" library didn't notice when they went from 7 to 8, or 8 to 9, why would they notice when going from 9 to 10? Maybe the quick fix would be for your problem library to fix the version of |
|
Thank you for your responses guys. By now I got it fixed for my project with a PR and a fork here and there. All I'm saying is that you can delay breaking changes until a major version change happens. Then, people expect them. They will notice when going from 9 to 10 similarly to how I noticed going from 9.6.11 to 9.6.12: the build breaks. But then it's a planned interruption, that's all. Other than that, third-party software will be in constant motion. But let's stick with semver as much as we can, especially for cosmetic changes like this |
|
Hi Guys, I'm the maintainer and sorry I didn't see this mail till now
(need to flag these as "important" in the future....)
As @rogierschouten is asking about,the reason why NodeBuffer was listed in
there is because hapi does reference it even though it's not mentioned in
the docs. It might be deprecated but it's still used by hapi, removal
from the DT definitions doesn't change that. Sorry I'm too late to the
party to impact the merge though :( I would suggest that you point to a
specific version of the definition to preserve the typings, and yes DT
would greatly benefit from semver. dependency hell is hell.
- Jason
…On Tue, May 8, 2018 at 4:59 AM, Rogier Schouten ***@***.***> wrote:
Thank you for your responses guys. By now I got it fixed for my project
with a PR and a fork here and there.
All I'm saying is that you can delay breaking changes until a major
version change happens. Then, people expect them. They will notice when
going from 9 to 10 similarly to how I noticed going from 9.6.11 to 9.6.12:
the build breaks. But then it's a planned interruption, that's all. Other
than that, third-party software will be in constant motion. But let's stick
with semver as much as we can, especially for cosmetic changes like this
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#25500 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAxsNnDTwiHDDJOXfPZG85haEEU8xbvTks5twYi8gaJpZM4TwpOo>
.
|
|
|
|
ok, I stand corrected :)
- Jason
…On Tue, May 8, 2018 at 7:40 AM, Andy ***@***.***> wrote:
is in this repo and doesn't seem to be using NodeBuffer in its latest
version.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#25500 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAxsNtK3D1Q6f_GfzVWTAaDyG3rkS2CKks5twa5sgaJpZM4TwpOo>
.
|
…itelyTyped#25500) * node: API docs never mention NodeBuffer, remove the definition * Remove references to NodeBuffer from outdated packages
Please fill in this template.
npm test.)npm run lint package-name(ortscif notslint.jsonis present).If changing an existing definition:
@types/buffer(I assume)tslint.jsoncontaining{ "extends": "dtslint/dt.json" }. N/AI asked in #25327 if any maintainers thought this was appropriate and didn't hear back, so I'm putting in a PR. If this interface is actually needed, feel free to close it out.