Skip to content
This repository has been archived by the owner on Oct 10, 2022. It is now read-only.

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

Open
erezrokah opened this issue Oct 7, 2020 · 5 comments
Open

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

erezrokah opened this issue Oct 7, 2020 · 5 comments
Labels
type: feature code contributing to the implementation of a feature and/or user facing functionality

Comments

@erezrokah
Copy link
Contributor

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 erezrokah changed the title Feat: re-publish this package a @netlify/js-client Feature: re-publish this package a @netlify/js-client Oct 7, 2020
@erezrokah erezrokah changed the title Feature: re-publish this package a @netlify/js-client Feature: re-publish this package as @netlify/js-client Oct 7, 2020
@erezrokah erezrokah added the type: feature code contributing to the implementation of a feature and/or user facing functionality label Oct 7, 2020
@erezrokah
Copy link
Contributor Author

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

@ehmicky
Copy link
Contributor

ehmicky commented Oct 7, 2020

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 👍

@futuregerald
Copy link

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.

@ehmicky
Copy link
Contributor

ehmicky commented Oct 7, 2020

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

@rstavchansky
Copy link

rstavchansky commented Oct 7, 2020

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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type: feature code contributing to the implementation of a feature and/or user facing functionality
Projects
None yet
Development

No branches or pull requests

4 participants