replace some tslint rules with eslint rules (#2161)

* use eslint no-floating-promise

* replace tslint ban with eslint rules

* [AUTOMATED]: Prettier Code Styling

* eslint disable

* fix lint

* revert previous changes

* fix lint for firestore

* [AUTOMATED]: Prettier Code Styling

Author: Feiyang1

config/.eslintrc.json

@@ -82,6 +82,37 @@
             "boolean"
         ],
         "constructor-super": "error",
+        "no-restricted-properties": [
+            "error",
+            { 
+                "object": "it",
+                "property": "skip"
+            }
+            ,
+            { 
+                "object": "it",
+                "property": "only"
+            },
+            { 
+                "object": "describe",
+                "property": "skip"
+            },
+            { 
+                "object": "describe",
+                "property": "only"
+            },
+            { 
+                "object": "xit"
+            }
+        ],
+        "no-restricted-globals": [
+            "error",
+            {"name": "xit"},
+            {"name": "xdescribe"},
+            {"name": "parseInt", "message": "tsstyle#type-coercion"},
+            {"name": "parseFloat", "message": "tsstyle#type-coercion"}
+        ],
+        "no-array-constructor": "error",
         "import/no-default-export": "error",
         "import/no-duplicates": "error",
         "import/no-extraneous-dependencies": [
@@ -166,23 +197,12 @@
                 "argsIgnorePattern": "^_"
             }
         ],
+        "@typescript-eslint/no-floating-promises": "error",
         "@typescript-eslint/tslint/config": [
             "error",
             {
-                "rules": {    
-                    "ban": [true,
-                        {"name": ["it", "skip"]},
-                        {"name": ["it", "only"]},
-                        {"name": ["describe", "skip"]},
-                        {"name": ["describe", "only"]},
-                        {"name": ["xit"]},
-                        {"name": ["xdescribe"]},
-                        {"name": "parseInt", "message": "tsstyle#type-coercion"},
-                        {"name": "parseFloat", "message": "tsstyle#type-coercion"},
-                        {"name": "Array", "message": "tsstyle#array-constructor"}
-                    ],
+                "rules": {
                     "jsdoc-format": true,
-                    "no-floating-promises": true,
                     "arrow-return-shorthand": true
                 }
             }

packages/app/.eslintrc.js

@@ -0,0 +1,9 @@
+module.exports = {
+  extends: '../../config/.eslintrc.json',
+  parserOptions: {
+    project: 'tsconfig.json',
+    // to make vscode-eslint work with monorepo
+    // https://github.com/typescript-eslint/typescript-eslint/issues/251#issuecomment-463943250
+    tsconfigRootDir: __dirname
+  }
+};

packages/app/.eslintrc.json

@@ -14,8 +14,8 @@
     "dist"
   ],
   "scripts": {
-    "lint": "eslint -c .eslintrc.json '**/*.ts' --ignore-path '../../.gitignore'",
-    "lint:fix": "eslint --fix -c .eslintrc.json '**/*.ts'  --ignore-path '../../.gitignore'",
+    "lint": "eslint -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
+    "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts'  --ignore-path '../../.gitignore'",
     "build": "rollup -c",
     "dev": "rollup -c -w",
     "test": "run-p lint test:browser test:node",

packages/app/package.json

@@ -58,7 +58,7 @@ function executeFirebaseTests(): void {
       const app = firebase.initializeApp({});
       // Ensure the hook is called synchronously
       assert.equal(hookEvents, 1);
-      // tslint:disable-next-line:no-floating-promises
+      // eslint-disable-next-line @typescript-eslint/no-floating-promises
       app.delete();
     });
 
@@ -173,7 +173,7 @@ function executeFirebaseTests(): void {
       );
       // Ensure the hook is called synchronously
       assert.equal(hookEvents, 1);
-      // tslint:disable-next-line:no-floating-promises
+      // eslint-disable-next-line @typescript-eslint/no-floating-promises
       app.delete();
     });
 

packages/app/test/firebaseApp.test.ts

@@ -0,0 +1,29 @@
+module.exports = {
+  extends: '../../config/.eslintrc.json',
+  parserOptions: {
+    project: 'tsconfig.json',
+    // to make vscode-eslint work with monorepo
+    // https://github.com/typescript-eslint/typescript-eslint/issues/251#issuecomment-463943250
+    tsconfigRootDir: __dirname
+  },
+  plugins: ['import'],
+  rules: {
+    'no-console': ['error', { allow: ['warn', 'error'] }],
+    'import/no-default-export': 'error',
+    '@typescript-eslint/no-unused-vars': [
+      'error',
+      {
+        varsIgnorePattern: '^_',
+        args: 'none'
+      }
+    ]
+  },
+  overrides: [
+    {
+      files: ['**/*.test.ts', '**/test/**/*.ts'],
+      rules: {
+        '@typescript-eslint/no-explicit-any': 'error'
+      }
+    }
+  ]
+};

packages/firestore/.eslintrc.js

@@ -7,8 +7,8 @@
     "build": "rollup -c",
     "build:console": "node tools/console.build.js",
     "dev": "rollup -c -w",
-    "lint": "eslint -c .eslintrc.json '**/*.ts' --ignore-path '../../.gitignore'",
-    "lint:fix": "eslint --fix -c .eslintrc.json '**/*.ts' --ignore-path '../../.gitignore'",
+    "lint": "eslint -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
+    "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
     "prettier": "prettier --write 'src/**/*.js' 'test/**/*.js' 'src/**/*.ts' 'test/**/*.ts'",
     "test": "run-s lint test:all",
     "test:all": "run-p test:browser test:travis",

packages/firestore/.eslintrc.json

@@ -507,7 +507,7 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
   ensureClientConfigured(): FirestoreClient {
     if (!this._firestoreClient) {
       // Kick off starting the client but don't actually wait for it.
-      // tslint:disable-next-line:no-floating-promises
+      // eslint-disable-next-line @typescript-eslint/no-floating-promises
       this.configureClient(new MemoryPersistenceSettings());
     }
     return this._firestoreClient as FirestoreClient;

packages/firestore/package.json

@@ -223,7 +223,7 @@ export class AsyncQueue {
    * we ignore the Promise result).
    */
   enqueueAndForget<T extends unknown>(op: () => Promise<T>): void {
-    // tslint:disable-next-line:no-floating-promises
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
     this.enqueue(op);
   }
 
@@ -235,7 +235,7 @@ export class AsyncQueue {
     op: () => Promise<T>
   ): void {
     this.verifyNotFailed();
-    // tslint:disable-next-line:no-floating-promises
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
     this.enqueueInternal(op);
   }
 

packages/firestore/src/api/database.ts

@@ -152,6 +152,7 @@ apiDescribe('Array Transforms:', (persistence: boolean) => {
    * an updated document via watch). As such they also rely on persistence
    * being enabled so documents remain in the cache after the write.
    */
+  // eslint-disable-next-line no-restricted-properties
   (persistence ? describe : describe.skip)('Server Application: ', () => {
     it('set() with no cached base doc', async () => {
       await withTestDoc(persistence, async docRef => {

packages/firestore/src/util/async_queue.ts

@@ -163,7 +163,7 @@ apiDescribe('Database batch writes', (persistence: boolean) => {
           .then(initialSnap => {
             expect(initialSnap.docs.length).to.equal(0);
 
-            // Atomically write two documents.
+            // eslint-disable-next-line @typescript-eslint/no-floating-promises, Atomically write two documents.
             collection.firestore
               .batch()
               .set(docA, { a: 1 })
@@ -275,7 +275,7 @@ apiDescribe('Database batch writes', (persistence: boolean) => {
           .then(initialSnap => {
             expect(initialSnap.docs.length).to.equal(0);
 
-            // Atomically write 2 documents with server timestamps.
+            // eslint-disable-next-line @typescript-eslint/no-floating-promises, Atomically write 2 documents with server timestamps.
             collection.firestore
               .batch()
               .set(docA, {
@@ -325,7 +325,7 @@ apiDescribe('Database batch writes', (persistence: boolean) => {
         .awaitEvent()
         .then(initialSnap => {
           expect(initialSnap.exists).to.equal(false);
-
+          // eslint-disable-next-line @typescript-eslint/no-floating-promises
           doc.firestore
             .batch()
             .delete(doc)

packages/firestore/test/integration/api/array_transforms.test.ts

@@ -126,6 +126,7 @@ apiDescribe('Database', (persistence: boolean) => {
     });
   });
 
+  // eslint-disable-next-line no-restricted-properties
   (persistence ? it : it.skip)('can update an unknown document', () => {
     return withTestDbs(persistence, 2, async ([reader, writer]) => {
       const writerRef = writer.collection('collection').doc();
@@ -346,6 +347,7 @@ apiDescribe('Database', (persistence: boolean) => {
   it("can't specify a field mask for a missing field using set", () => {
     return withTestDoc(persistence, async docRef => {
       expect(() => {
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
         docRef.set(
           { desc: 'NewDescription' },
           { mergeFields: ['desc', 'owner'] }
@@ -775,6 +777,7 @@ apiDescribe('Database', (persistence: boolean) => {
       const doc = coll.doc();
       const deferred1 = new Deferred<void>();
       const deferred2 = new Deferred<void>();
+      // eslint-disable-next-line @typescript-eslint/no-floating-promises
       doc.set({ foo: 'bar' }).then(() => {
         doc.onSnapshot(snap => {
           deferred1.resolve();
@@ -802,8 +805,9 @@ apiDescribe('Database', (persistence: boolean) => {
           }
         }
       });
-
+      // eslint-disable-next-line @typescript-eslint/no-floating-promises
       docRef.set({ a: 1 }).then(() => {
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
         docRef.set({ b: 1 });
       });
       return secondUpdateFound.promise.then(() => {
@@ -815,7 +819,7 @@ apiDescribe('Database', (persistence: boolean) => {
   // TODO(mikelehen): We need a way to create a query that will pass
   // client-side validation but fail remotely.  May need to wait until we
   // have security rules support or something?
-  // tslint:disable-next-line:ban
+  // eslint-disable-next-line no-restricted-properties
   describe.skip('Listens are rejected remotely:', () => {
     const queryForRejection = query('foo');
 
@@ -998,12 +1002,14 @@ apiDescribe('Database', (persistence: boolean) => {
     return withTestDb(persistence, db => {
       return db.INTERNAL.delete().then(() => {
         expect(() => {
+          // eslint-disable-next-line @typescript-eslint/no-floating-promises
           db.disableNetwork();
         }).to.throw('The client has already been terminated.');
       });
     });
   });
 
+  // eslint-disable-next-line no-restricted-properties
   (persistence ? it : it.skip)(
     'maintains persistence after restarting app',
     async () => {
@@ -1024,6 +1030,7 @@ apiDescribe('Database', (persistence: boolean) => {
     }
   );
 
+  // eslint-disable-next-line no-restricted-properties
   (persistence ? it : it.skip)(
     'can clear persistence if the client has not been initialized',
     async () => {
@@ -1047,6 +1054,7 @@ apiDescribe('Database', (persistence: boolean) => {
     }
   );
 
+  // eslint-disable-next-line no-restricted-properties
   (persistence ? it : it.skip)(
     'will reject the promise if clear persistence fails',
     async () => {
@@ -1144,6 +1152,7 @@ apiDescribe('Database', (persistence: boolean) => {
       await firestore.terminate();
 
       expect(() => {
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
         firestore.doc(docRef.path).set({ foo: 'bar' });
       }).to.throw('The client has already been terminated.');
     });
@@ -1156,6 +1165,7 @@ apiDescribe('Database', (persistence: boolean) => {
       await firestore.terminate();
 
       expect(() => {
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
         firestore.doc(docRef.path).set({ foo: 'bar' });
       }).to.throw();
     });
@@ -1198,6 +1208,7 @@ apiDescribe('Database', (persistence: boolean) => {
       async (db, mockCredentialsProvider) => {
         // Prevent pending writes receiving acknowledgement.
         await db.disableNetwork();
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
         db.doc('abc/123').set({ foo: 'bar' });
         const awaitPendingWrite = db.waitForPendingWrites();