enable eslint in rxfire

Author: Feiyang1

packages/rxfire/.eslintrc.json

@@ -0,0 +1,6 @@
+{
+    "extends": "../../config/.eslintrc.json",
+    "parserOptions": {
+        "project": "tsconfig.json"
+    }
+}

packages/rxfire/database/list/audit-trail.ts

@@ -67,7 +67,7 @@ function waitForLoaded(
     // We can use both datasets to form an array of the latest values.
     map(([loaded, changes]) => {
       // Store the last key in the data set
-      let lastKeyToLoad = loaded.lastKeyToLoad;
+      const lastKeyToLoad = loaded.lastKeyToLoad;
       // Store all child keys loaded at this point
       const loadedKeys = changes.map(change => change.snapshot.key);
       return { changes, lastKeyToLoad, loadedKeys };

packages/rxfire/package.json

@@ -21,10 +21,12 @@
     "url": "https://github.com/firebase/firebase-js-sdk.git"
   },
   "scripts": {
+    "lint": "eslint -c .eslintrc.json '**/*.ts' --ignore-path '../../.gitignore' '.gitignore'",
+    "lint:fix": "eslint --fix -c .eslintrc.json '**/*.ts' --ignore-path '../../.gitignore' '.gitignore'",
     "build": "rollup -c",
     "dev": "rollup -c -w",
     "prepare": "yarn build",
-    "test": "yarn test:browser",
+    "test": "run-p lint test:browser",
     "test:browser": "karma start --single-run",
     "test:browser:debug": "karma start --browsers=Chrome --auto-watch"
   },
@@ -67,7 +69,11 @@
     "ts-node": "8.1.0",
     "tslint": "5.16.0",
     "webpack": "4.30.0",
-    "yargs": "13.2.2"
+    "yargs": "13.2.2",
+    "eslint": "5.16.0",
+    "@typescript-eslint/parser": "1.9.0",
+    "@typescript-eslint/eslint-plugin": "1.9.0",
+    "@typescript-eslint/eslint-plugin-tslint": "1.9.0"
   },
   "typings": "dist/index.d.ts",
   "files": [

packages/rxfire/storage/index.ts

@@ -19,30 +19,32 @@ import { storage } from 'firebase/app';
 import { Observable, from } from 'rxjs';
 import { map } from 'rxjs/operators';
 
-export function fromTask(task: storage.UploadTask) {
+export function fromTask(task: storage.UploadTask): Observable<storage.UploadTaskSnapshot> {
   return new Observable<storage.UploadTaskSnapshot>(subscriber => {
-    const progress = (snap: storage.UploadTaskSnapshot) =>
+    const progress = (snap: storage.UploadTaskSnapshot): void =>
       subscriber.next(snap);
-    const error = (e: Error) => subscriber.error(e);
-    const complete = () => subscriber.complete();
+    const error = (e: Error): void => subscriber.error(e);
+    const complete = (): void => subscriber.complete();
     task.on('state_changed', progress, error, complete);
     return () => task.cancel();
   });
 }
 
-export function getDownloadURL(ref: storage.Reference) {
+export function getDownloadURL(ref: storage.Reference): Observable<string> {
   return from(ref.getDownloadURL());
 }
 
-export function getMetadata(ref: storage.Reference) {
+// TODO: fix storage typing in firebase, then apply the same fix here
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function getMetadata(ref: storage.Reference): Observable<any> {
   return from(ref.getMetadata());
 }
 
 export function put(
   ref: storage.Reference,
-  data: any,
+  data: unknown,
   metadata?: storage.UploadMetadata
-) {
+): Observable<storage.UploadTaskSnapshot> {
   return fromTask(ref.put(data, metadata));
 }
 
@@ -51,11 +53,16 @@ export function putString(
   data: string,
   format?: storage.StringFormat,
   metadata?: storage.UploadMetadata
-) {
+): Observable<storage.UploadTaskSnapshot> {
   return fromTask(ref.putString(data, format, metadata));
 }
 
-export function percentage(task: storage.UploadTask) {
+export function percentage(
+  task: storage.UploadTask
+): Observable<{
+  progress: number;
+  snapshot: storage.UploadTaskSnapshot;
+}> {
   return fromTask(task).pipe(
     map(s => ({
       progress: (s.bytesTransferred / s.totalBytes) * 100,

packages/rxfire/test/database.test.ts

@@ -15,22 +15,27 @@
  * limitations under the License.
  */
 
+// tslint:disable:no-floating-promises
+
 import { expect } from 'chai';
+// app/database is used as namespaces to access types
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
 import { initializeApp, database, app } from 'firebase';
 import { fromRef } from '../database/fromRef';
-import { list, ListenEvent, objectVal, listVal } from '../database';
+import { list, ListenEvent, objectVal, listVal, QueryChange } from '../database';
 import { take, skip, switchMap } from 'rxjs/operators';
-import { BehaviorSubject } from 'rxjs';
+import { BehaviorSubject, Observable } from 'rxjs';
 import { auditTrail } from '../database/list/audit-trail';
 
+// eslint-disable-next-line @typescript-eslint/no-require-imports
 export const TEST_PROJECT = require('../../../config/project.json');
 
-const rando = () =>
+const rando = (): string =>
   Math.random()
     .toString(36)
     .substring(5);
 
-let batch = (items: { name: string; key: string }[]) => {
+let batch = (items: { name: string; key: string }[]): Readonly<{}> => {
   let batch: { [key: string]: unknown } = {};
   items.forEach(item => {
     batch[item.key] = item;
@@ -42,14 +47,17 @@ let batch = (items: { name: string; key: string }[]) => {
 describe('RxFire Database', () => {
   let app: app.App;
   let database: database.Database;
-  let ref = (path: string) => {
+  const ref = (path: string): database.Reference => {
     app!.database().goOffline();
     return app!.database().ref(path);
   };
 
   function prepareList(
     opts: { events?: ListenEvent[]; skipnumber: number } = { skipnumber: 0 }
-  ) {
+  ): {
+    snapChanges: Observable<QueryChange[]>;
+    ref: database.Reference;
+  } {
     const { events, skipnumber } = opts;
     const aref = ref(rando());
     const snapChanges = list(aref, events);
@@ -215,7 +223,7 @@ describe('RxFire Database', () => {
           sub.unsubscribe();
           done();
         });
-        itemRef.child(key).setPriority(-100, () => {});
+        itemRef.child(key).setPriority(-100, () => { });
       });
 
       /**
@@ -385,7 +393,7 @@ describe('RxFire Database', () => {
       it('should process a new child_removed event', done => {
         const aref = ref(rando());
         const obs = list(aref, [ListenEvent.added, ListenEvent.removed]);
-        const sub = obs
+        const _sub = obs
           .pipe(
             skip(1),
             take(1)
@@ -408,7 +416,7 @@ describe('RxFire Database', () => {
       it('should process a new child_changed event', done => {
         const aref = ref(rando());
         const obs = list(aref, [ListenEvent.added, ListenEvent.changed]);
-        const sub = obs
+        const _sub = obs
           .pipe(
             skip(1),
             take(1)
@@ -431,7 +439,7 @@ describe('RxFire Database', () => {
       it('should process a new child_moved event', done => {
         const aref = ref(rando());
         const obs = list(aref, [ListenEvent.added, ListenEvent.moved]);
-        const sub = obs
+        const _sub = obs
           .pipe(
             skip(1),
             take(1)
@@ -445,7 +453,7 @@ describe('RxFire Database', () => {
           .add(done);
         app.database().goOnline();
         aref.set(itemsObj).then(() => {
-          aref.child(items[0].key).setPriority('a', () => {});
+          aref.child(items[0].key).setPriority('a', () => { });
         });
       });
 
@@ -472,7 +480,7 @@ describe('RxFire Database', () => {
        */
       it('should handle multiple subscriptions (hot)', done => {
         const { snapChanges, ref } = prepareList();
-        const sub = snapChanges.subscribe(() => {}).add(done);
+        const sub = snapChanges.subscribe(() => { }).add(done);
         snapChanges
           .pipe(take(1))
           .subscribe(actions => {
@@ -490,7 +498,7 @@ describe('RxFire Database', () => {
         const { snapChanges, ref } = prepareList();
         snapChanges
           .pipe(take(1))
-          .subscribe(() => {})
+          .subscribe(() => { })
           .add(() => {
             snapChanges
               .pipe(take(1))
@@ -567,7 +575,7 @@ describe('RxFire Database', () => {
        */
       it('should handle dynamic queries that return empty sets', done => {
         let count = 0;
-        let namefilter$ = new BehaviorSubject<number | null>(null);
+        const namefilter$ = new BehaviorSubject<number | null>(null);
         const aref = ref(rando());
         aref.set(itemsObj);
         namefilter$
@@ -606,7 +614,10 @@ describe('RxFire Database', () => {
 
     function prepareAuditTrail(
       opts: { events?: ListenEvent[]; skipnumber: number } = { skipnumber: 0 }
-    ) {
+    ): {
+      changes: Observable<QueryChange[]>;
+      ref: database.Reference;
+    } {
       const { events, skipnumber } = opts;
       const aref = ref(rando());
       aref.set(itemsObj);

packages/rxfire/test/firestore.test.ts

@@ -14,7 +14,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
+// tslint:disable:no-floating-promises
+
 import { expect } from 'chai';
+// app is used as namespaces to access types
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
 import { initializeApp, firestore, app } from 'firebase/app';
 import 'firebase/firestore';
 import {
@@ -27,9 +32,10 @@ import {
 } from '../firestore';
 import { map, take, skip } from 'rxjs/operators';
 
+// eslint-disable-next-line @typescript-eslint/no-require-imports
 export const TEST_PROJECT = require('../../../config/project.json');
 
-const createId = () =>
+const createId = (): string =>
   Math.random()
     .toString(36)
     .substring(5);
@@ -38,7 +44,7 @@ const createId = () =>
  * Create a collection with a random name. This helps sandbox offline tests and
  * makes sure tests don't interfere with each other as they run.
  */
-const createRandomCol = (firestore: firestore.Firestore) =>
+const createRandomCol = (firestore: firestore.Firestore): firestore.CollectionReference =>
   firestore.collection(createId());
 
 /**
@@ -52,7 +58,7 @@ const unwrapChange = map((changes: firestore.DocumentChange[]) => {
  * Create an environment for the tests to run in. The information is returned
  * from the function for use within the test.
  */
-const seedTest = (firestore: firestore.Firestore) => {
+const seedTest = (firestore: firestore.Firestore):any => {
   const colRef = createRandomCol(firestore);
   const davidDoc = colRef.doc('david');
   davidDoc.set({ name: 'David' });
@@ -159,7 +165,6 @@ describe('RxFire Firestore', () => {
       );
 
       addedChanges.subscribe(data => {
-        debugger;
         const expectedNames = [
           { name: 'David', type: 'added' },
           { name: 'Shannon', type: 'added' }

packages/rxfire/tsconfig.json

@@ -1,11 +1,9 @@
 {
   "extends": "../../config/tsconfig.base.json",
   "compilerOptions": {
-    "outDir": "dist",
-    "declaration": true
+    "outDir": "dist"
   },
   "exclude": [
-    "dist/**/*",
-    "test/**/*"
+    "dist/**/*"
   ]
 }