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

[FEAT] Scoped NPM packages #190

Closed
paescuj opened this issue Aug 24, 2022 · 3 comments
Closed

[FEAT] Scoped NPM packages #190

paescuj opened this issue Aug 24, 2022 · 3 comments
Labels
enhancement New feature or request

Comments

@paescuj
Copy link
Collaborator

paescuj commented Aug 24, 2022

As a big overhaul is coming anyway (#185) I'd like to discuss how you, @lucaburgio & @sammarks, feel about switching to scoped NPM packages.
For example:

  • iconoir-react -> @iconoir/react
  • iconoir-react-native -> @iconoir/react-native
  • iconoir -> @iconoir/core (not sure if we should switch this as well or leave it)

The main reason for my suggestion is that this way it would be clearly visible that the packages are official "iconoir" packages and there would be no risk of conflicts with "community" packages (for example, iconoir-vue).

Ref #56.

@paescuj paescuj added the enhancement New feature or request label Aug 24, 2022
@lucaburgio
Copy link
Collaborator

I like the proposal. It looks cleaner and more scalable.
But can this change be applied without disrupting the experience of those who are already using the packages?

@paescuj
Copy link
Collaborator Author

paescuj commented Aug 25, 2022

I like the proposal. It looks cleaner and more scalable.

Great to hear that you like it!

But can this change be applied without disrupting the experience of those who are already using the packages?

Yes, those who are already using the packages must manually switch to the new names.
However, this requires no more than:

npm uninstall iconoir-react
npm install @iconoir/react

In addition, we can deprecate the old packages with a reference to the new names so users will see that they should use the new packages instead.

@sammarks
Copy link
Collaborator

We agreed on Discord (for now at least) that we will leave the existing package names as they are, but will use scoped packages for any new libraries (like we did with the VueJS library).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants