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/rrweb-player to packages/rrweb-playback-ui #661

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

eoghanmurray
Copy link
Contributor

@eoghanmurray eoghanmurray commented Aug 10, 2021

  • avoid confusion with packages/rrweb/src/replayer which is the generic player

I don't know what further work would be needed on the publishing side of things to get e.g. new url after this change https://cdn.jsdelivr.net/npm/rrweb-playback-ui@latest/dist/index.js working?

@eoghanmurray eoghanmurray changed the title Rename packages/rrweb-player to packages/rrweb-svelte-ui Rename packages/rrweb-player to packages/rrweb-playback-ui Aug 10, 2021
@Yuyz0112
Copy link
Member

quote from the core team discussion, so others can get more information:

I agree with the naming of rrweb/src/replayer and rrweb-player is confusing sometimes.

From the use case, I think:

  • rrweb/src/replayer is the minimum core with most of the replay features.
  • rrweb-player is the player with a user-friendly UI. So maybe rrweb-ui is a better name?

And I think rrweb-player will be the only UI package maintained by us, this means:

  • we may have UI packages with frameworks like React, Vue, Angular, but is a wrapper of rrweb-player, like this
  • community can maintain UI packages implemented on top of rrweb/src/replayer instead of rrweb-player, like this
  • the way of customizing UI can be various.
  • the tech stack of rrweb-player is under the water, so maybe we can switch to other frameworks in the future version of rrweb-player, without breaking changes in naming and version.

And we choose svelte because it has a slim runtime which reduces the overhead when using in other frameworks. Users can just use rrweb-player as a vanilla JS UI without caring it's implemented in svelte or plain JS.

The reason we are not using plain JS is that we need a reactive data model and component system.

 - avoid confusion with `packages/rrweb/src/replayer` which is the generic player
@eoghanmurray
Copy link
Contributor Author

@Yuyz0112 wondering if you prefer rrweb-ui over rrweb-playback-ui as I don't think I had updated this change to the latter when you made your comment above?

@eoghanmurray
Copy link
Contributor Author

Parking this as we are going to tie the rename of this package with a new release with improve features and greater ability to customize.

@eoghanmurray
Copy link
Contributor Author

@Juice10 adding a 2.0 label for your consideration if you are moving around things, but otherwise I'm happy to let this one slide

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

Successfully merging this pull request may close these issues.

2 participants