-
Notifications
You must be signed in to change notification settings - Fork 928
Usage instructions are inconsistent/conflicting/confusing #3514
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
Comments
I found a few problems with this issue:
|
Thanks Google OSS Bot, but when I spend time creating an issue, I sorta expect a human to look at it... |
The first link seems to be the README for the individual @firebase/firestore package which, as it says on the page, shouldn't be directly installed by itself (it will come in as part of As for I'll look into if we can settle on one of these as the "official" default suggested format and we can change either the README or the docs site so they're consistent. (I think it'll probably |
In one place it says:
Note the use of the namespace
@firebase
.In another place it says:
Note how this basically all uses the same package
firebase
, without a namespace.I think the first form, with
@firebase
is the new/preferred form or not?Looking at the first example, it uses @firebase/app. If we open that up, we see that it points us to firebase
...and then we come to the second example. This is confusing. Which form should I use on my new project?
All packages point to this Github Repo, which is why I am making this issue here.
EDIT
I read more docs and now I'm more confused...
It seems the docs on GCP use yet another form:
I don't see the namespace used here. So in that sense it looks like the second example. But this one uses
import * as firebase from
instead ofimport firebase from
.I know many big projects (e.g. Babel, Webpack) have been moving over to using namespaces/scopes. So they have been introducing the
@
symbol in their package names and have been recommending their users to use the new form. Is the same true for Firebase? Is the first form actually the recommended form? And so are the second example and the docs on GCP outdated? Or is the opposite true and is the example on the Firestore package the one that is outdated? And if we need to use the non-scoped package, do we use it likeimport firebase from
or likeimport * as firebase from
? Please advice.The text was updated successfully, but these errors were encountered: