Update README #5214

hsubox76 · 2021-07-29T21:27:25Z

Added products that didn't exist at the time.
Put individual product imports as the main method and all-in-one imports as the alternative.
Added require('firebase/app').default per our ESM module changes in 8.0.0
Commented out build badge since we don't use Travis anymore. Reminder to replace later with a new service if possible.

changeset-bot · 2021-07-29T21:27:27Z

⚠️ No Changeset found

Latest commit: ef4e0c9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

github-actions · 2021-07-29T21:30:41Z

Changeset File Check ✅

No modified packages are missing from the changeset file.
No changeset formatting errors detected.

packages/firebase/README.md

Co-authored-by: Feiyang <[email protected]>

hsubox76 · 2021-07-30T16:28:17Z

packages/firebase/README.md

@@ -177,7 +169,9 @@ $ npm install --save firebase
 In your code, you can access Firebase using:

 ```js
-var firebase = require('firebase');
+var firebase = require('firebase/app').default;


I wanted to double check that Node needs the .default too? I vaguely remember maybe not?

yes, if you want to get typings. Can you also update vars to consts?

google-oss-bot · 2021-07-30T16:49:05Z

Binary Size Report

Affected SDKs

@firebase/analytics

Type Base (a075b5f) Head (60e9ef4) Diff

esm2017 ? 18.7 kB ? (?)

main ? 24.2 kB ? (?)

module ? 23.4 kB ? (?)
@firebase/api-documenter

Type Base (a075b5f) Head (60e9ef4) Diff

main ? 3.72 kB ? (?)

`@firebase/app`

Type	Base (`a075b5f`)	Head (`60e9ef4`)	Diff
browser	?	11.0 kB	? (?)
esm2017	?	9.80 kB	? (?)
lite	?	8.93 kB	? (?)
lite-esm2017	?	7.93 kB	? (?)
main	?	10.1 kB	? (?)
module	?	11.0 kB	? (?)
react-native	?	9.86 kB	? (?)

@firebase/app-check

Type Base (a075b5f) Head (60e9ef4) Diff

browser ? 24.4 kB ? (?)

esm2017 ? 20.0 kB ? (?)

main ? 24.4 kB ? (?)

module ? 23.9 kB ? (?)
@firebase/auth

Type Base (a075b5f) Head (60e9ef4) Diff

browser ? 181 kB ? (?)

main ? 181 kB ? (?)

module ? 181 kB ? (?)
@firebase/component

Type Base (a075b5f) Head (60e9ef4) Diff

browser ? 8.33 kB ? (?)

esm2017 ? 6.32 kB ? (?)

main ? 8.67 kB ? (?)

module ? 8.33 kB ? (?)
@firebase/database

Type Base (a075b5f) Head (60e9ef4) Diff

browser ? 296 kB ? (?)

esm2017 ? 265 kB ? (?)

main ? 299 kB ? (?)

module ? 296 kB ? (?)
@firebase/database-compat

Type Base (a075b5f) Head (60e9ef4) Diff

browser ? 86.6 kB ? (?)

main ? 103 kB ? (?)

module ? 86.6 kB ? (?)
@firebase/database-exp

Type Base (a075b5f) Head (60e9ef4) Diff

browser ? 246 kB ? (?)

main ? 278 kB ? (?)

module ? 246 kB ? (?)
@firebase/firestore

Type Base (a075b5f) Head (60e9ef4) Diff

browser ? 285 kB ? (?)

esm2017 ? 227 kB ? (?)

main ? 531 kB ? (?)

module ? 285 kB ? (?)

react-native ? 227 kB ? (?)
@firebase/firestore-compat

Type Base (a075b5f) Head (60e9ef4) Diff

browser ? 29.0 kB ? (?)

main ? 38.1 kB ? (?)

module ? 29.0 kB ? (?)

react-native ? 28.7 kB ? (?)
@firebase/firestore-exp

Type Base (a075b5f) Head (60e9ef4) Diff

browser ? 224 kB ? (?)

main ? 510 kB ? (?)

module ? 224 kB ? (?)

react-native ? 224 kB ? (?)
@firebase/firestore-lite

Type Base (a075b5f) Head (60e9ef4) Diff

browser ? 72.7 kB ? (?)

main ? 149 kB ? (?)

module ? 72.7 kB ? (?)

react-native ? 72.9 kB ? (?)
@firebase/firestore/bundle

Type Base (a075b5f) Head (60e9ef4) Diff

browser ? 291 kB ? (?)

esm2017 ? 177 kB ? (?)

main ? 527 kB ? (?)

module ? 291 kB ? (?)

react-native ? 177 kB ? (?)
@firebase/firestore/memory

Type Base (a075b5f) Head (60e9ef4) Diff

browser ? 217 kB ? (?)

esm2017 ? 172 kB ? (?)

main ? 325 kB ? (?)

module ? 217 kB ? (?)

react-native ? 172 kB ? (?)
@firebase/firestore/memory-bundle

Type Base (a075b5f) Head (60e9ef4) Diff

browser ? 225 kB ? (?)

esm2017 ? 177 kB ? (?)

main ? 322 kB ? (?)

module ? 225 kB ? (?)

react-native ? 177 kB ? (?)
@firebase/functions

Type Base (a075b5f) Head (60e9ef4) Diff

browser ? 10.7 kB ? (?)

esm2017 ? 8.21 kB ? (?)

main ? 11.1 kB ? (?)

module ? 10.7 kB ? (?)
@firebase/installations

Type Base (a075b5f) Head (60e9ef4) Diff

esm2017 ? 16.6 kB ? (?)

main ? 22.2 kB ? (?)

module ? 21.6 kB ? (?)
@firebase/logger

Type Base (a075b5f) Head (60e9ef4) Diff

esm2017 ? 3.25 kB ? (?)

main ? 5.40 kB ? (?)

module ? 4.65 kB ? (?)
@firebase/messaging

Type Base (a075b5f) Head (60e9ef4) Diff

esm2017 ? 26.2 kB ? (?)

main ? 34.9 kB ? (?)

module ? 34.4 kB ? (?)
@firebase/performance

Type Base (a075b5f) Head (60e9ef4) Diff

browser ? 27.7 kB ? (?)

esm2017 ? 25.9 kB ? (?)

main ? 28.0 kB ? (?)

module ? 27.7 kB ? (?)
@firebase/polyfill

Type Base (a075b5f) Head (60e9ef4) Diff

main ? 747 B ? (?)

module ? 705 B ? (?)
@firebase/remote-config

Type Base (a075b5f) Head (60e9ef4) Diff

browser ? 22.4 kB ? (?)

esm2017 ? 17.4 kB ? (?)

main ? 23.0 kB ? (?)

module ? 22.4 kB ? (?)
@firebase/rules-unit-testing

Type Base (a075b5f) Head (60e9ef4) Diff

main ? 15.3 kB ? (?)
@firebase/storage

Type Base (a075b5f) Head (60e9ef4) Diff

browser ? 63.8 kB ? (?)

esm2017 ? 55.0 kB ? (?)

main ? 55.5 kB ? (?)

module ? 63.8 kB ? (?)
@firebase/storage-compat

Type Base (a075b5f) Head (60e9ef4) Diff

browser ? 10.2 kB ? (?)

main ? 29.2 kB ? (?)

module ? 10.2 kB ? (?)
@firebase/storage-exp

Type Base (a075b5f) Head (60e9ef4) Diff

browser ? 51.7 kB ? (?)

main ? 53.0 kB ? (?)

module ? 51.7 kB ? (?)
@firebase/util

Type Base (a075b5f) Head (60e9ef4) Diff

browser ? 21.7 kB ? (?)

esm2017 ? 20.4 kB ? (?)

main ? 26.4 kB ? (?)

module ? 21.7 kB ? (?)
@firebase/webchannel-wrapper

Type Base (a075b5f) Head (60e9ef4) Diff

esm2017 ? 43.2 kB ? (?)

main ? 50.7 kB ? (?)

module ? 44.8 kB ? (?)

`firebase`

Click to show 16 binary size changes.

Type	Base (`a075b5f`)	Head (`60e9ef4`)	Diff
firebase-analytics.js	?	35.7 kB	? (?)
firebase-app-check.js	?	23.9 kB	? (?)
firebase-app.js	?	21.9 kB	? (?)
firebase-auth.js	?	177 kB	? (?)
firebase-database.js	?	187 kB	? (?)
firebase-firestore.js	?	336 kB	? (?)
firebase-firestore.memory.js	?	271 kB	? (?)
firebase-functions.js	?	10.9 kB	? (?)
firebase-installations.js	?	19.3 kB	? (?)
firebase-messaging.js	?	40.9 kB	? (?)
firebase-performance-standalone.es2017.js	?	73.4 kB	? (?)
firebase-performance-standalone.js	?	49.8 kB	? (?)
firebase-performance.js	?	38.3 kB	? (?)
firebase-remote-config.js	?	36.9 kB	? (?)
firebase-storage.js	?	41.5 kB	? (?)
firebase.js	?	895 kB	? (?)

Test Logs

Head (60e9ef4f): https://github.com/firebase/firebase-js-sdk/actions/runs/1091016330

google-oss-bot · 2021-07-30T16:54:45Z

Size Analysis Report

Affected Products

Diffs between base commit (a075b5f) and head commit (60e9ef4) are too large (521,811 characters) to display.

Please check below links to see details from the original test log.

Test Logs

Head (60e9ef4): https://github.com/firebase/firebase-js-sdk/actions/runs/1091016330

… into ch-readme

Feiyang1 · 2021-07-31T01:10:44Z

packages/firebase/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/firebase/firebase-js-sdk.svg?branch=master)](https://travis-ci.org/firebase/firebase-js-sdk)
+<!-- [![Build Status](https://travis-ci.org/firebase/firebase-js-sdk.svg?branch=master)](https://travis-ci.org/firebase/firebase-js-sdk) -->


Should it be deleted?

I thought that leaving the comment would be a good reminder to put a new badge there if we go through the README in the future and we have a new service by then. I guess it's better to explicitly put a TODO instead.

hsubox76 added 2 commits July 29, 2021 14:21

Update README

2615fcf

Add alternatives

df4078c

hsubox76 requested review from Feiyang1 and hiranya911 as code owners July 29, 2021 21:27

hsubox76 assigned Feiyang1 Jul 29, 2021

Feiyang1 reviewed Jul 29, 2021

View reviewed changes

packages/firebase/README.md Show resolved Hide resolved

packages/firebase/README.md Outdated Show resolved Hide resolved

Feiyang1 assigned hsubox76 and unassigned Feiyang1 Jul 29, 2021

Update packages/firebase/README.md

f330845

Co-authored-by: Feiyang <[email protected]>

hsubox76 commented Jul 30, 2021

View reviewed changes

Address PR comments, tinker with script includes

a587498

hsubox76 assigned Feiyang1 and unassigned hsubox76 Jul 30, 2021

Feiyang1 assigned hsubox76 and unassigned Feiyang1 Jul 30, 2021

hsubox76 added 2 commits July 30, 2021 15:20

Merge branch 'ch-readme' of https://github.com/firebase/firebase-js-sdk…

f2869dd

… into ch-readme

Update var to const

caef9d5

hsubox76 assigned Feiyang1 and unassigned hsubox76 Jul 30, 2021

Feiyang1 reviewed Jul 31, 2021

View reviewed changes

Feiyang1 approved these changes Jul 31, 2021

View reviewed changes

Feiyang1 assigned hsubox76 and unassigned Feiyang1 Jul 31, 2021

Add TODO

ef4e0c9

hsubox76 merged commit c493d92 into master Aug 2, 2021

hsubox76 deleted the ch-readme branch August 2, 2021 17:33

firebase locked and limited conversation to collaborators Sep 2, 2021

		@@ -1,4 +1,4 @@
		[![Build Status](https://travis-ci.org/firebase/firebase-js-sdk.svg?branch=master)](https://travis-ci.org/firebase/firebase-js-sdk)
		<!-- [![Build Status](https://travis-ci.org/firebase/firebase-js-sdk.svg?branch=master)](https://travis-ci.org/firebase/firebase-js-sdk) -->

Update README #5214

Update README #5214

Uh oh!

Conversation

hsubox76 commented Jul 29, 2021

Uh oh!

changeset-bot bot commented Jul 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

github-actions bot commented Jul 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changeset File Check ✅

Uh oh!

Uh oh!

Uh oh!

hsubox76 Jul 30, 2021

Choose a reason for hiding this comment

Uh oh!

Feiyang1 Jul 30, 2021

Choose a reason for hiding this comment

Uh oh!

hsubox76 Jul 30, 2021

Choose a reason for hiding this comment

Uh oh!

google-oss-bot commented Jul 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Binary Size Report

Affected SDKs

@firebase/analytics

@firebase/api-documenter

@firebase/app

@firebase/app-check

@firebase/auth

@firebase/component

@firebase/database

@firebase/database-compat

@firebase/database-exp

@firebase/firestore

@firebase/firestore-compat

@firebase/firestore-exp

@firebase/firestore-lite

@firebase/firestore/bundle

@firebase/firestore/memory

@firebase/firestore/memory-bundle

@firebase/functions

@firebase/installations

@firebase/logger

@firebase/messaging

@firebase/performance

@firebase/polyfill

@firebase/remote-config

@firebase/rules-unit-testing

@firebase/storage

@firebase/storage-compat

@firebase/storage-exp

@firebase/util

@firebase/webchannel-wrapper

firebase

Test Logs

Uh oh!

google-oss-bot commented Jul 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Size Analysis Report

Affected Products

Test Logs

Uh oh!

Feiyang1 Jul 31, 2021

Choose a reason for hiding this comment

Uh oh!

hsubox76 Aug 2, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

changeset-bot bot commented Jul 29, 2021 •

edited

Loading

github-actions bot commented Jul 29, 2021 •

edited

Loading

google-oss-bot commented Jul 30, 2021 •

edited

Loading

`@firebase/analytics`

`@firebase/api-documenter`

`@firebase/app`

`@firebase/app-check`

`@firebase/auth`

`@firebase/component`

`@firebase/database`

`@firebase/database-compat`

`@firebase/database-exp`

`@firebase/firestore`

`@firebase/firestore-compat`

`@firebase/firestore-exp`

`@firebase/firestore-lite`

`@firebase/firestore/bundle`

`@firebase/firestore/memory`

`@firebase/firestore/memory-bundle`

`@firebase/functions`

`@firebase/installations`

`@firebase/logger`

`@firebase/messaging`

`@firebase/performance`

`@firebase/polyfill`

`@firebase/remote-config`

`@firebase/rules-unit-testing`

`@firebase/storage`

`@firebase/storage-compat`

`@firebase/storage-exp`

`@firebase/util`

`@firebase/webchannel-wrapper`

`firebase`

google-oss-bot commented Jul 30, 2021 •

edited

Loading