Merge branch 'master' into v2.3.0

Author: Scott Prue

.eslintrc

@@ -0,0 +1,35 @@
+module.exports = {
+  root: true,
+
+  parser: 'babel-eslint',
+
+  extends: ['standard', 'standard-react', 'prettier', 'prettier/react'],
+  plugins: ['babel', 'react', 'prettier'],
+
+  settings: {
+    react: {
+      version: 'detect'
+    }
+  },
+
+  env: {
+    browser: true,
+    es6: true
+  },
+
+  rules: {
+    semi: [2, 'never'],
+    'no-console': 'error',
+    'prettier/prettier': ['error', {
+      singleQuote: true,
+      trailingComma: 'none',
+      semi: false,
+      bracketSpacing: true,
+      jsxBracketSameLine: true,
+      printWidth: 80,
+      tabWidth: 2,
+      useTabs: false
+    }]
+  }
+};
+

.eslintrc.js

@@ -9,7 +9,7 @@ We welcome any type of contribution, not only code. You can help with
 - **Marketing**: writing blog posts, howto's, printing stickers, ...
 - **Community**: presenting the project at meetups, organizing a dedicated meetup for the local community, ...
 - **Code**: take a look at the [open issues](issues). Even if you can't write code, commenting on them, showing that you care about a given issue matters. It helps us triage them.
-- **Money**: we welcome financial contributions in full transparency on our [open collective](https://opencollective.com/react-redux-firebase).
+- **Money**: we welcome financial contributions as detailed in the [financial contributions section](#financial-contributions).
 
 ## Your First Contribution
 
@@ -26,8 +26,7 @@ It is also always helpful to have some context for your pull request. What was t
 
 ## Financial contributions
 
-We also welcome financial contributions in full transparency on our [open collective](https://opencollective.com/react-redux-firebase).
-Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.
+Financial contributions are welcomed through either [patreon](https://www.patreon.com/prescottprue) or [open collective](https://opencollective.com/react-redux-firebase).
 
 ## Questions
 
@@ -48,20 +47,3 @@ Thank you to all our backers! [[Become a backer](https://opencollective.com/reac
 
 <a href="https://opencollective.com/react-redux-firebase#backers" target="_blank"><img src="https://opencollective.com/react-redux-firebase/backers.svg?width=890"></a>
 
-
-### Sponsors
-
-Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/react-redux-firebase#sponsor))
-
-<a href="https://opencollective.com/react-redux-firebase/sponsor/0/website" target="_blank"><img src="https://opencollective.com/react-redux-firebase/sponsor/0/avatar.svg"></a>
-<a href="https://opencollective.com/react-redux-firebase/sponsor/1/website" target="_blank"><img src="https://opencollective.com/react-redux-firebase/sponsor/1/avatar.svg"></a>
-<a href="https://opencollective.com/react-redux-firebase/sponsor/2/website" target="_blank"><img src="https://opencollective.com/react-redux-firebase/sponsor/2/avatar.svg"></a>
-<a href="https://opencollective.com/react-redux-firebase/sponsor/3/website" target="_blank"><img src="https://opencollective.com/react-redux-firebase/sponsor/3/avatar.svg"></a>
-<a href="https://opencollective.com/react-redux-firebase/sponsor/4/website" target="_blank"><img src="https://opencollective.com/react-redux-firebase/sponsor/4/avatar.svg"></a>
-<a href="https://opencollective.com/react-redux-firebase/sponsor/5/website" target="_blank"><img src="https://opencollective.com/react-redux-firebase/sponsor/5/avatar.svg"></a>
-<a href="https://opencollective.com/react-redux-firebase/sponsor/6/website" target="_blank"><img src="https://opencollective.com/react-redux-firebase/sponsor/6/avatar.svg"></a>
-<a href="https://opencollective.com/react-redux-firebase/sponsor/7/website" target="_blank"><img src="https://opencollective.com/react-redux-firebase/sponsor/7/avatar.svg"></a>
-<a href="https://opencollective.com/react-redux-firebase/sponsor/8/website" target="_blank"><img src="https://opencollective.com/react-redux-firebase/sponsor/8/avatar.svg"></a>
-<a href="https://opencollective.com/react-redux-firebase/sponsor/9/website" target="_blank"><img src="https://opencollective.com/react-redux-firebase/sponsor/9/avatar.svg"></a>
-
-<!-- This `CONTRIBUTING.md` is based on @nayafia's template https://github.com/nayafia/contributing-template -->

CONTRIBUTING.md

@@ -19,15 +19,15 @@ The [Material Example](https://github.com/prescottprue/react-redux-firebase/tree
 
 ## Features
 
-- Out of the box support for authentication (with auto load user profile)
-- Full Firebase Platform Support Including Real Time Database, Firestore, and Storage
-- Automatic binding/unbinding of listeners through React Higher Order Components (`firebaseConnect`  and `firestoreConnect`)
-- [Population capability](http://react-redux-firebase.com/docs/populate) (similar to mongoose's `populate` or SQL's `JOIN`)
-- Support small data ( using `value` ) or large datasets ( using `child_added`, `child_removed`, `child_changed` )
-- Multiple queries types supported including `orderByChild`, `orderByKey`, `orderByValue`, `orderByPriority`, `limitToLast`, `limitToFirst`, `startAt`, `endAt`, `equalTo`
-- Tons of examples of integrations including [`redux-thunk`](https://github.com/gaearon/redux-thunk) and [`redux-observable`](https://redux-observable.js.org/)
-- Server Side Rendering Support
-- [`react-native` support](http://react-redux-firebase.com/docs/integrations/react-native.html) using [native modules](http://react-redux-firebase.com/docs/integrations/react-native.html#native-modules) or [web sdk](http://react-redux-firebase.com/docs/integrations/react-native.html#jsweb)
+* Out of the box support for authentication (with auto load user profile)
+* Full Firebase Platform Support Including Real Time Database, Firestore, and Storage
+* Automatic binding/unbinding of listeners through React Higher Order Components (`firebaseConnect` and `firestoreConnect`)
+* [Population capability](http://react-redux-firebase.com/docs/populate) (similar to mongoose's `populate` or SQL's `JOIN`)
+* Support small data ( using `value` ) or large datasets ( using `child_added`, `child_removed`, `child_changed` )
+* Multiple queries types supported including `orderByChild`, `orderByKey`, `orderByValue`, `orderByPriority`, `limitToLast`, `limitToFirst`, `startAt`, `endAt`, `equalTo`
+* Tons of examples of integrations including [`redux-thunk`](https://github.com/gaearon/redux-thunk) and [`redux-observable`](https://redux-observable.js.org/)
+* Server Side Rendering Support
+* [`react-native` support](http://react-redux-firebase.com/docs/integrations/react-native.html) using [native modules](http://react-redux-firebase.com/docs/integrations/react-native.html#native-modules) or [web sdk](http://react-redux-firebase.com/docs/integrations/react-native.html#jsweb)
 
 ## Installation
 
@@ -43,24 +43,27 @@ If you're not, you can access the library on [unpkg](https://unpkg.com/redux-fir
 
 ## Use
 
-Include `reactReduxFirebase` (store enhancer) and  `firebaseReducer` (reducer) while creating your redux store:
+Include `reactReduxFirebase` (store enhancer) and `firebaseReducer` (reducer) while creating your redux store:
 
 ```javascript
 import React from 'react'
 import { render } from 'react-dom'
 import { Provider } from 'react-redux'
 import { createStore, combineReducers, compose } from 'redux'
 import { reactReduxFirebase, firebaseReducer } from 'react-redux-firebase'
-import firebase from 'firebase'
-// import { reduxFirestore, firestoreReducer } from 'redux-firestore' // <- needed if using firestore
+import firebase from 'firebase/app'
+import 'firebase/auth'
+import 'firebase/database'
+// import 'firebase/storage' // <- needed if using storage
 // import 'firebase/firestore' // <- needed if using firestore
 // import 'firebase/functions' // <- needed if using httpsCallable
+// import { reduxFirestore, firestoreReducer } from 'redux-firestore' // <- needed if using firestore
 
 const firebaseConfig = {}
 
 // react-redux-firebase config
 const rrfConfig = {
-  userProfile: 'users',
+  userProfile: 'users'
   // useFirestoreForProfile: true // Firestore for Profile instead of Realtime DB
 }
 
@@ -73,13 +76,13 @@ firebase.initializeApp(firebaseConfig)
 
 // Add reactReduxFirebase enhancer when making store creator
 const createStoreWithFirebase = compose(
-  reactReduxFirebase(firebase, rrfConfig), // firebase instance as first argument
+  reactReduxFirebase(firebase, rrfConfig) // firebase instance as first argument
   // reduxFirestore(firebase) // <- needed if using firestore
 )(createStore)
 
 // Add firebase to reducers
 const rootReducer = combineReducers({
-  firebase: firebaseReducer,
+  firebase: firebaseReducer
   // firestore: firestoreReducer // <- needed if using firestore
 })
 
@@ -92,9 +95,9 @@ const App = () => (
   <Provider store={store}>
     <Todos />
   </Provider>
-);
+)
 
-render(<App/>, document.getElementById('root'));
+render(<App />, document.getElementById('root'))
 ```
 
 The Firebase instance can then be grabbed from context within your components (`withFirebase` and `firebaseConnect` Higher Order Components provided to help):
@@ -112,13 +115,9 @@ const Todos = ({ firebase }) => {
   return (
     <div>
       <h1>Todos</h1>
-      <ul>
-        {todosList}
-      </ul>
+      <ul>{todosList}</ul>
       <input type="text" ref="newTodo" />
-      <button onClick={pushSample}>
-        Add
-      </button>
+      <button onClick={pushSample}>Add</button>
     </div>
   )
 }
@@ -142,21 +141,15 @@ const Todos = ({ todos, firebase }) => {
     ? 'Loading'
     : isEmpty(todos)
       ? 'Todo list is empty'
-      : Object.keys(todos).map(
-          (key, id) => (
-            <TodoItem key={key} id={id} todo={todos[key]}/>
-          )
-        )
+      : Object.keys(todos).map((key, id) => (
+          <TodoItem key={key} id={id} todo={todos[key]} />
+        ))
   return (
     <div>
       <h1>Todos</h1>
-      <ul>
-        {todosList}
-      </ul>
+      <ul>{todosList}</ul>
       <input type="text" ref="newTodo" />
-      <button onClick={this.handleAdd}>
-        Add
-      </button>
+      <button onClick={this.handleAdd}>Add</button>
     </div>
   )
 }
@@ -165,8 +158,8 @@ export default compose(
   firebaseConnect([
     'todos' // { path: '/todos' } // object notation
   ]),
-  connect((state) => ({
-    todos: state.firebase.data.todos,
+  connect(state => ({
+    todos: state.firebase.data.todos
     // profile: state.firebase.profile // load profile
   }))
 )(Todos)
@@ -185,19 +178,19 @@ import { firebaseConnect, getVal } from 'react-redux-firebase'
 
 // Component enhancer that loads todo into redux then into the todo prop
 const enhance = compose(
-  firebaseConnect((props) => {
+  firebaseConnect(props => {
     // Set listeners based on props (prop is route parameter from react-router in this case)
     return [
-      { path: `todos/${props.params.todoId}` }, // create todo listener
+      { path: `todos/${props.params.todoId}` } // create todo listener
       // `todos/${props.params.todoId}` // equivalent string notation
     ]
   }),
   connect(({ firebase }, props) => ({
-    todo: getVal(firebase, `data/todos/${props.params.todoId}`), // lodash's get can also be used
+    todo: getVal(firebase, `data/todos/${props.params.todoId}`) // lodash's get can also be used
   }))
 )
 
-const Todo = ({ todo, firebase, params }) =>
+const Todo = ({ todo, firebase, params }) => (
   <div>
     <input
       name="isDone"
@@ -209,12 +202,12 @@ const Todo = ({ todo, firebase, params }) =>
     />
     <span>{todo.label}</span>
   </div>
+)
 
 // Export enhanced component
 export default enhance(Todo)
 ```
 
-
 **Load Data On Click**
 
 ```jsx
@@ -230,15 +223,13 @@ const Todos = ({ firebase }) => {
     ? 'Loading'
     : isEmpty(todos)
       ? 'Todo list is empty'
-      : Object.keys(todos).map(
-          (key, id) => <TodoItem key={key} id={id} todo={todos[key]}/>
-        )
+      : Object.keys(todos).map((key, id) => (
+          <TodoItem key={key} id={id} todo={todos[key]} />
+        ))
   return (
     <div>
       <h1>Todos</h1>
-      <ul>
-        {todosList}
-      </ul>
+      <ul>{todosList}</ul>
       <button onClick={() => firebase.watchEvent('value', 'todos')}>
         Load Todos
       </button>
@@ -249,8 +240,8 @@ const Todos = ({ firebase }) => {
 // Export enhanced component
 export default compose(
   withFirebase, // or firebaseConnect()
-  connect((state) => ({
-    todos: state.firebase.data.todos,
+  connect(state => ({
+    todos: state.firebase.data.todos
     // profile: state.firebase.profile // load profile
   }))
 )(Todos)
@@ -265,6 +256,7 @@ If you plan to use Firestore, you should checkout [`redux-firestore`][redux-fire
 Currently `react-redux-firebase` still handles auth when using [`redux-firestore`][redux-firestore] - The future plan is to also have auth standalone auth library that will allow the developer to choose which pieces they do/do not want.
 
 ## [Docs](http://react-redux-firebase.com)
+
 See full documentation at [react-redux-firebase.com](http://react-redux-firebase.com)
 
 * [Getting Started](http://react-redux-firebase.com/docs/getting_started)
@@ -277,6 +269,7 @@ See full documentation at [react-redux-firebase.com](http://react-redux-firebase
 ## [Examples](examples)
 
 ### Real World Applications
+
 * [fireadmin.io](http://fireadmin.io) - Firebase Instance Management Tool (source [available here](https://github.com/prescottprue/fireadmin))
 
 If you would like a project added to this section please reach out [over gitter][gitter-url]
@@ -299,7 +292,7 @@ A simple example that was created using [create-react-app](https://github.com/fa
 
 #### [Material App Example](examples/complete/material)
 
-An example that user Material UI built on top of the output of [create-react-app](https://github.com/facebookincubator/create-react-app)'s eject command.  Shows a list of todo items and allows you to add to them. This is what is deployed to [redux-firebasev3.firebaseapp.com](https://redux-firebasev3.firebaseapp.com/).
+An example that user Material UI built on top of the output of [create-react-app](https://github.com/facebookincubator/create-react-app)'s eject command. Shows a list of todo items and allows you to add to them. This is what is deployed to [redux-firebasev3.firebaseapp.com](https://redux-firebasev3.firebaseapp.com/).
 
 ## Discussion
 
@@ -359,15 +352,15 @@ This project exists thanks to all the people who contribute.
 
 Thank you to all our backers! 🙏
 
-* [Reside Network Inc.](https://github.com/reside-eng)
+* [Side Inc.](https://github.com/reside-eng)
 
 [npm-image]: https://img.shields.io/npm/v/react-redux-firebase.svg?style=flat-square
 [npm-url]: https://npmjs.org/package/react-redux-firebase
 [npm-downloads-image]: https://img.shields.io/npm/dm/react-redux-firebase.svg?style=flat-square
 [quality-image]: http://npm.packagequality.com/shield/react-redux-firebase.svg?style=flat-square
 [quality-url]: https://packagequality.com/#?package=react-redux-firebase
-[backers]:https://opencollective.com/react-redux-firebase/backers/badge.svg?style=flat-square&color=blue
-[become-a-backer]:https://opencollective.com/react-redux-firebase#backer
+[backers]: https://opencollective.com/react-redux-firebase/backers/badge.svg?style=flat-square&color=blue
+[become-a-backer]: https://opencollective.com/react-redux-firebase#backer
 [travis-image]: https://img.shields.io/travis/prescottprue/react-redux-firebase/master.svg?style=flat-square
 [travis-url]: https://travis-ci.org/prescottprue/react-redux-firebase
 [daviddm-image]: https://img.shields.io/david/prescottprue/react-redux-firebase.svg?style=flat-square

README.md

@@ -60,16 +60,17 @@ function generateDocForFile(file) {
     })
 }
 
-;(async function() {
+;(function() {
   console.log(
     'Generating API documentation (docs/api) from JSDoc comments within src...\n'
   )
-  try {
-    await Promise.all(files.map(generateDocForFile))
-    console.log('\nAPI documentation generated successfully!')
-    process.exit(0)
-  } catch (err) {
-    console.log('Error generating API documentation: ', err.message || err)
-    process.exit(1)
-  }
+  Promise.all(files.map(generateDocForFile))
+    .then(() => {
+      console.log('\nAPI documentation generated successfully!')
+      process.exit(0)
+    })
+    .catch(err => {
+      console.log('Error generating API documentation: ', err.message || err)
+      process.exit(1)
+    })
 })()