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

[core] Rename npm org name from @base_ui to @base-ui #488

Open
oliviertassinari opened this issue Jul 24, 2024 · 2 comments
Open

[core] Rename npm org name from @base_ui to @base-ui #488

oliviertassinari opened this issue Jul 24, 2024 · 2 comments
Labels
breaking change core Infrastructure work going on behind the scenes on hold There is a blocker, we need to wait

Comments

@oliviertassinari
Copy link
Member

oliviertassinari commented Jul 24, 2024

Summary

The npm package convention is to use a dash to separate words, not an underscore. We used the underscore @base_ui because we didn't find a better option.

See mui/material-ui#43002 as an example of surprise:

Any reason why @base_ui scope is with an underscore? Feels a bit unusual for npm package naming and different to what we've been doing before with no obvious benefit. I personally find it to work particularly badly with underlines in urls (github, npm, docs,...)

I have flagged it as a breaking change as it's kind of one, but also doesn't have to be truly one.

Benchmark

npm packages with an underscore are not common: https://github.com/evanwashere/top-npm-packages

Options

We are working on gaining access to the @base-ui npm org name. Once we get it. We should be able to migrate to it. https://www.notion.so/mui-org/ops-Trademark-Base-UI-88f653d8a8b64cac96fa7546638ecc3d?d=24e76446683d430381fdd0a65c03e3d5

@oliviertassinari oliviertassinari added status: waiting for maintainer These issues haven't been looked at yet by a maintainer core Infrastructure work going on behind the scenes breaking change labels Jul 24, 2024
@michaldudak
Copy link
Member

What's the point of having this as a GitHub issue? It's not actionable, as we've already contacted npm and can only wait until they resolve this. I can see a GH issue only when we actually own the org, to update the code.

@oliviertassinari
Copy link
Member Author

oliviertassinari commented Jul 25, 2024

What's the point of having this as a GitHub issue?

@michaldudak

  1. There will be a pull request, which will close this issue.
  2. As a developer, I might want to leave this feedback as it confuses me. Now, I can find more information about this frustration.
  3. If this gets enough upvotes, I could see us prioritizing this change earlier than we would have had otherwise (same on the opposite side).

@michaldudak michaldudak added on hold There is a blocker, we need to wait and removed status: waiting for maintainer These issues haven't been looked at yet by a maintainer labels Jul 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change core Infrastructure work going on behind the scenes on hold There is a blocker, we need to wait
Projects
None yet
Development

No branches or pull requests

2 participants