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

Toolkit UMD naming #15

Open
rjimenezda opened this issue Sep 30, 2019 · 6 comments
Open

Toolkit UMD naming #15

rjimenezda opened this issue Sep 30, 2019 · 6 comments

Comments

@rjimenezda
Copy link
Contributor

The UMD module names are a bit of a mess right now. They are long, verbose, and not namespaced.

We should try to come up with a relatively short way of naming packages, maybe even namespacing?

IDEA: We could have different entry points for the UMDs, so they build a namespace. We shouldn't use carto. because I think VL and carto.js will not play nice.

@VictorVelarde
Copy link
Contributor

At this point in time, I think we should go for a new namespace, starting from 'carto' root.

Something in the line of:

  • carto.vis: new viz classes to come
  • carto.data (<-- sql): SQL API and more to come
  • carto.auth: Auth / OAuth stuff
  • carto.maps: Maps API
  • carto.customStorrage (maybe just rename it to carto.kepler package?)

Opening the discussion with you @jesusbotella, @neokore and @elenatorro

@rjimenezda
Copy link
Contributor Author

As long as it doesn't clash with VL and carto.js, which also live under 'carto'

@VictorVelarde
Copy link
Contributor

or even if it does... 😄 (more to come soon...)

@neokore
Copy link
Contributor

neokore commented Feb 17, 2020

Taking carto as root is great, it makes easy to remember and sticks the library with the brand, but depending on how it will be distributed, we may need to add some "legacy users" checks.
E.g. in case of reusing a CARTO package (let's say carto.js) and any user just upgrade it, it will be useful to detect legacy library calls (maybe the initialize methods) and throw an exception to alert that this library is not backwards compatible.

@jesusbotella
Copy link
Contributor

I think we should use carto namespace no matter what.
The library/module is not intended to work alongside CARTO-VL or CARTO.js, they have their own modules starting from carto namespace. So no need to be backwards compatible with our own libraries.

@VictorVelarde
Copy link
Contributor

We'll make the move just after merging metrics-event PR #56 , starting a new base 'viz', isolated from the current -rc.013 line

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

4 participants