search

stoplightio / json-ref-resolver

[Deprecated] Recursively resolve JSON pointers and remote authorities.
https://github.com/APIDevTools/json-schema-ref-parser
Apache License 2.0
37 stars 9 forks source link

Emphasize deprecation notice #210

Closed pushred closed 4 years ago

pushred commented 4 years ago

Ahhh, my team spent some time going down the path of using this library (and encountering some strange issues) before noticing:

CleanShot 2020-09-14 at 14 24 07

:grimacing:

GitHub's recent design updates that moved the description to a sidebar didn't help but please consider adding a more prominent notice to the README. Also npm deprecate for good measure and further emphasis on npmjs.com

Then again, perhaps nobody else is noticing this library! I think I found it by searching npmjs.com with the terms "json ref resolver" and automatically went to the Stoplight result because I trust Stoplight.

However had I searched just with "json ref" I would have found two results for the successor library, https://www.npmjs.com/package/@apidevtools/json-schema-ref-parser

https://twitter.com/philsturgeon/status/1235849451568152577

philsturgeon commented 4 years ago

@pushred doh! Thanks for pointing this out. We'll pull all the levers we have available to us to make it more clear that this repo is no longer a thing, including NPM deprecation, archiving on GitHub, and anything else we think up. We didn't do that for a while to avoid spamming users of our tools (which had not all moved across) with deprecation warnings, but it's time to get on with it. Going to close this and hit archive now!

bertramakers commented 2 years ago

I also started using this package yesterday and only noticed the deprecation notice by coincidence due to this issue while I was looking at the issues for something else. Archiving the repository and/or a notice in the README would have made it more clear.

Thanks for the link to the successor @pushred!

P0lip commented 2 years ago

Archiving the repository and/or a notice in the README would have made it more clear.

It used to be archived, but I still occasionally push some changes every now and then. Overall though the package is not actively maintained anymore.