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

Rename packages #2446

Open
ckniffen opened this issue Aug 24, 2023 · 4 comments
Open

Rename packages #2446

ckniffen opened this issue Aug 24, 2023 · 4 comments

Comments

@ckniffen
Copy link
Collaborator

ckniffen commented Aug 24, 2023

I propose we scope all packages in this monorepo to @xrplf. This will have the benefit of grouping the packages in node_modules in one place and remove the name "ripple". It also shows shared set of maintainers between the packages as anyone can create a package named xrpl-*.

Suggested package renames:

  • @xrplf/address-codec <- ripple-address-codec
  • @xrplf/binary-codec <-ripple-binary-codec
  • @xrplf/keypairs <- ripple-keypairs
  • xrpl <- xrpl
  • @xrplf/isomorphic - new in 3.0
  • @xrplf/secret-numbers - new in 3.0

This work can be done in either xrpl.js 3.0 or 4.0. I would prefer 4.0 as it may break xrpl into smaller packages such as suggested in #2307

@ckniffen
Copy link
Collaborator Author

ckniffen commented Aug 24, 2023

There are also 2 packages already under the @xrplf npm organization, @xrplf/prettier-config and @xrplf/eslint-config.

@tequdev
Copy link
Contributor

tequdev commented Aug 25, 2023

For me personally, I like "xrpl" as it is.

@intelliot
Copy link
Collaborator

I think it's worth considering keeping xrpl as-is to avoid churn and keep the name short, while still renaming/moving the other packages to be under @xrplf.

@ckniffen
Copy link
Collaborator Author

ckniffen commented Sep 1, 2023

For me personally, I like "xrpl" as it is.

I think it's worth considering keeping xrpl as-is to avoid churn and keep the name short, while still renaming/moving the other packages to be under @xrplf.

I will keep that one the same.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants