js-client icon indicating copy to clipboard operation
js-client copied to clipboard

Feature: re-publish this package as @netlify/js-client

Open erezrokah opened this issue 4 years ago • 5 comments

This package is currently published as netlify: https://www.npmjs.com/package/netlify

This is very confusing and doesn't match our naming convention of scoped packages.

We should deprecate the old package and publish it under @netlify/js-client

erezrokah avatar Oct 07 '20 09:10 erezrokah

We could use https://docs.npmjs.com/cli/deprecate

erezrokah avatar Oct 07 '20 12:10 erezrokah

This is a much better name. Using npm deprecate, users would get notified to update the package name. However, some users will skip this warning and get stuck on an old version of this library. This might be the biggest downside. That being said, I still think this is a good idea :+1:

ehmicky avatar Oct 07 '20 12:10 ehmicky

I think this is a good idea. Also if people choose to ignore warnings then it's on them. Anyone using the js-client is a developer and is expected to manage the versions of their dependencies and when to upgrade, and will know how to get to our docs to see that the package name changed.

futuregerald avatar Oct 07 '20 14:10 futuregerald

We should coordinate with the documentation team @rstavchansky to check if anything should be changed there.

ehmicky avatar Oct 07 '20 14:10 ehmicky

Thanks for the ping @ehmicky. The only mention of this that I can find is in our API Getting Started page. It's a direct link to the netlify/js-client GitHub repo, though, so I don't think the docs repo itself will require any changes.

rstavchansky avatar Oct 07 '20 15:10 rstavchansky