Skip to content

Commit 5636d1e

Browse files
committed
chore: wrap long lines
1 parent a56fe5c commit 5636d1e

File tree

3 files changed

+35
-12
lines changed

3 files changed

+35
-12
lines changed

.prettierrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"semi": false,
33
"trailingComma": "es5",
4+
"printWidth": 100,
45
"singleQuote": true
56
}

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,21 @@
66

77
## Introduction
88

9-
Firebase provides two solutions to handle real-time databases: Realtime Database and Cloud Store (which is also a realtime database).
10-
In order to keep all clients data in-sync with its cloud database, their [js SDK](https://firebase.google.com/docs/firestore/quickstart) provides the tools to do so. However, it quickly becomes bothersome to _bind_ multiple documents or collections to your application, keep them synchronized as well as handling [references](https://firebase.google.com/docs/firestore/manage-data/data-types) to other documents or collections, which can contain references themselves and must also be kept up to date.
11-
The goal of vuefire and vuexfire is to make this as simple as a function call that returns a promise so it is also easy to setup SSR and allows you to focus on developing your application.
12-
13-
To better understand why Vuefire will make it so much easier to develop Vue apps with firebase, please, check [this link in the documentation](https://vuefire.vuejs.org/vuefire/#why)
9+
Firebase provides two solutions to handle real-time databases: Realtime Database
10+
and Cloud Store (which is also a realtime database). In order to keep all
11+
clients data in-sync with its cloud database, their [js
12+
SDK](https://firebase.google.com/docs/firestore/quickstart) provides the tools
13+
to do so. However, it quickly becomes bothersome to _bind_ multiple documents or
14+
collections to your application, keep them synchronized as well as handling
15+
[references](https://firebase.google.com/docs/firestore/manage-data/data-types)
16+
to other documents or collections, which can contain references themselves and
17+
must also be kept up to date. The goal of vuefire and vuexfire is to make this
18+
as simple as a function call that returns a promise so it is also easy to setup
19+
SSR and allows you to focus on developing your application.
20+
21+
To better understand why Vuefire will make it so much easier to develop Vue apps
22+
with firebase, please, check [this link in the
23+
documentation](https://vuefire.vuejs.org/vuefire/#why)
1424

1525
Note: _This repository contains the code for `vuefire` and `vuexfire` packages:_
1626

packages/documentation/docs/vuexfire/upgrading-from-v2.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
11
# Upgrading from Vuexfire v2.x to v3.0
22

3-
The v2 of Vuexfire removed support of the _RTDB_ and added _Firestore_ support instead. In v3, you can use both. Because of that there were some breaking changes during alpha releases and some of the names of the exports have changed.
3+
The v2 of Vuexfire removed support of the _RTDB_ and added _Firestore_ support
4+
instead. In v3, you can use both. Because of that there were some breaking
5+
changes during alpha releases and some of the names of the exports have changed.
46

5-
If you partially followed, the best place to check for the few breaking changes is [the changelog](https://github.com/vuejs/vuefire/blob/master/CHANGELOG.md)
7+
If you partially followed, the best place to check for the few breaking changes
8+
is [the changelog](https://github.com/vuejs/vuefire/blob/master/CHANGELOG.md)
69

7-
If you didn't follow during the alpha releases, **no worries**, you can easily catch up and use the latest version of Vuexfire. Follow ahead!
10+
If you didn't follow during the alpha releases, **no worries**, you can easily
11+
catch up and use the latest version of Vuexfire. Follow ahead!
812

913
## Renamed imports
1014

11-
To reflect better that mutations are the same for both _RTDB_ and _Firestore_, they have been renamed to `vuexfireMutations`:
15+
To reflect better that mutations are the same for both _RTDB_ and _Firestore_,
16+
they have been renamed to `vuexfireMutations`:
1217

1318
```diff
1419
import Vuex from 'vuex'
@@ -24,7 +29,11 @@ const store = new Vuex.Store({
2429
})
2530
```
2631

27-
`firebaseAction` as well as the injected functions `bindFirebaseRef`/`unbindFirebaseRef` have also been renamed! But because we also support `RTDB`, `firebaseAction` still exists but is meant to be used with _RTDB_ references. If you are migrating from v2, you were likely using _Firestore_, so you should apply these modifications:
32+
`firebaseAction` as well as the injected functions
33+
`bindFirebaseRef`/`unbindFirebaseRef` have also been renamed! But because we
34+
also support `RTDB`, `firebaseAction` still exists but is meant to be used with
35+
_RTDB_ references. If you are migrating from v2, you were likely using
36+
_Firestore_, so you should apply these modifications:
2837

2938
```diff
3039
- import { firebaseAction } from 'vuexfire'
@@ -41,6 +50,9 @@ const store = new Vuex.Store({
4150
})
4251
```
4352

44-
🎉 That's it! Your app should be running again! If you found things missing in this small guide, feel free to open an Issue or a Pull Request [on Github](https://github.com/vuejs/vuefire)
53+
🎉 That's it! Your app should be running again! If you found things missing in
54+
this small guide, feel free to open an Issue or a Pull Request [on
55+
Github](https://github.com/vuejs/vuefire)
4556

46-
You should checkout [the guide](./), there are a few code snippets that may come in handy! You can also use the _RTDB_ alongside _Firestore_ now.
57+
You should checkout [the guide](./), there are a few code snippets that may come
58+
in handy! You can also use the _RTDB_ alongside _Firestore_ now.

0 commit comments

Comments
 (0)