Fix some eslint checks present in mozilla-central (#2051)

* Enable no-else-return * Enable object-shorthand * Fix mozilla/prefer-boolean-length-check * Enable dot-notation * Enable consistent-return * Fix prettier * Disable dot-notation on test files
Kinto · Jun 20, 2023 · 49c5885 · 49c5885
1 parent 3cc62df
commit 49c5885
Show file tree

Hide file tree

Showing 18 changed files with 54 additions and 41 deletions.
diff --git a/.eslintrc b/.eslintrc
@@ -20,7 +20,11 @@
     ],
     "no-var": 2,
     "prefer-const": 1,
-    "semi": [2, "always"]
+    "semi": [2, "always"],
+    "no-else-return": "error",
+    "object-shorthand": ["error", "always"],
+    "dot-notation": "error",
+    "consistent-return": "error"
   },
   "env": {
     "es6": true,

diff --git a/src/KintoBase.ts b/src/KintoBase.ts
@@ -47,7 +47,7 @@ export default class KintoBase<
    */
   static get adapters() {
     return {
-      BaseAdapter: BaseAdapter,
+      BaseAdapter,
     };
   }
 

diff --git a/src/adapters/IDB.ts b/src/adapters/IDB.ts
@@ -529,7 +529,8 @@ export default class IDB<
 
         // No option to preload records, go straight to `callback`.
         if (!options.preload) {
-          return runCallback();
+          runCallback();
+          return;
         }
 
         // Preload specified records using a list request.
@@ -538,7 +539,7 @@ export default class IDB<
           // Store obtained records by id.
           const preloaded: { [key: string]: KintoObject } = {};
           for (const record of records) {
-            delete record["_cid"];
+            delete record._cid;
             preloaded[record.id] = record;
           }
           runCallback(preloaded);
@@ -556,7 +557,7 @@ export default class IDB<
    * @param  {String} id The record id.
    * @return {Promise}
    */
-  async get(id: string): Promise<B | undefined> {
+  async get(id: string): Promise<B | null> {
     try {
       let record: B;
       await this.prepare("records", (store) => {
@@ -567,6 +568,7 @@ export default class IDB<
     } catch (e: any) {
       this._handleError("get", e);
     }
+    return null;
   }
 
   /**
@@ -589,7 +591,7 @@ export default class IDB<
           // we have received all requested records that match the filters,
           // we now park them within current scope and hide the `_cid` attribute.
           for (const result of _results) {
-            delete result["_cid"];
+            delete result._cid;
           }
           results = _results;
         });
@@ -722,6 +724,7 @@ export default class IDB<
       return metadata;
     } catch (e: any) {
       this._handleError("saveMetadata", e);
+      return null;
     }
   }
 
@@ -735,6 +738,7 @@ export default class IDB<
       return entry ? (entry as { metadata: any }).metadata : null;
     } catch (e: any) {
       this._handleError("getMetadata", e);
+      return null;
     }
   }
 }

diff --git a/src/collection.ts b/src/collection.ts
@@ -110,11 +110,11 @@ export class SyncResultObject {
   }
 
   get errors() {
-    return this._lists["errors"];
+    return this._lists.errors;
   }
 
   get conflicts() {
-    return this._lists["conflicts"];
+    return this._lists.conflicts;
   }
 
   get skipped() {
@@ -328,7 +328,7 @@ function importChange<
     }
     return {
       type: "conflicts",
-      data: { type: "incoming", local: local, remote: remote },
+      data: { type: "incoming", local, remote },
     };
   }
   // Local record was synced.

diff --git a/src/http/base.ts b/src/http/base.ts
@@ -442,7 +442,7 @@ export default class KintoClientBase {
     const serverSettings = await this.fetchServerSettings({
       retry: this._getRetry(options),
     });
-    const maxRequests = serverSettings["batch_max_requests"];
+    const maxRequests = serverSettings.batch_max_requests;
     if (maxRequests && requests.length > maxRequests) {
       const chunks = partition(requests, maxRequests);
       const results = [];
@@ -515,9 +515,8 @@ export default class KintoClientBase {
     const responses = await this._batchRequests(rootBatch._requests, options);
     if (options.aggregate) {
       return aggregate(responses, rootBatch._requests);
-    } else {
-      return responses;
     }
+    return responses;
   }
 
   /**

diff --git a/src/http/collection.ts b/src/http/collection.ts
@@ -737,12 +737,11 @@ export default class Collection {
     const path = this._endpoints.record(this.bucket.name, this.name);
     if (options.at) {
       return this.getSnapshot<T>(options.at);
-    } else {
-      return this.client.paginatedList<T>(path, options, {
-        headers: this._getHeaders(options),
-        retry: this._getRetry(options),
-      });
     }
+    return this.client.paginatedList<T>(path, options, {
+      headers: this._getHeaders(options),
+      retry: this._getRetry(options),
+    });
   }
 
   /**

diff --git a/src/http/http.ts b/src/http/http.ts
@@ -209,9 +209,8 @@ export default class HTTP {
     // If number of allowed of retries is not exhausted, retry the same request.
     if (retryAfter && options.retry > 0) {
       return this.retry<T>(url, retryAfter, request, options);
-    } else {
-      return this.processResponse<T>(response);
     }
+    return this.processResponse<T>(response);
   }
 
   _checkForDeprecationHeader(headers: FetchHeaders): void {
@@ -246,10 +245,10 @@ export default class HTTP {
     }
   }
 
-  _checkForRetryAfterHeader(headers: FetchHeaders): number | undefined {
+  _checkForRetryAfterHeader(headers: FetchHeaders): number | null {
     const retryAfter = headers.get("Retry-After");
     if (!retryAfter) {
-      return;
+      return null;
     }
     const delay = parseInt(retryAfter, 10) * 1000;
     const tryAgainAfter = new Date().getTime() + delay;

diff --git a/src/utils.ts b/src/utils.ts
@@ -168,9 +168,8 @@ function makeNestedObjectFromArr(
       return (acc[cv] = val);
     } else if (Object.prototype.hasOwnProperty.call(acc, cv)) {
       return acc[cv];
-    } else {
-      return (acc[cv] = {});
     }
+    return (acc[cv] = {});
   }, nestedFiltersObj);
 }
 
@@ -266,9 +265,8 @@ export function qsify(obj: { [key: string]: any }): string {
       const ks = encode(k) + "=";
       if (Array.isArray(stripped[k])) {
         return ks + stripped[k].map((v: any) => encode(v)).join(",");
-      } else {
-        return ks + encode(stripped[k]);
       }
+      return ks + encode(stripped[k]);
     })
     .join("&");
 }
@@ -376,7 +374,7 @@ export function capable(capabilities: string[]): DecoratorReturn {
             .fetchServerCapabilities()
             .then((available: string[]) => {
               const missing = capabilities.filter((c) => !(c in available));
-              if (missing.length > 0) {
+              if (missing.length) {
                 const missingStr = missing.join(", ");
                 throw new Error(
                   `Required capabilities ${missingStr} not present on server`

diff --git a/test/adapters/IDB_test.ts b/test/adapters/IDB_test.ts
@@ -1,3 +1,4 @@
+/* eslint dot-notation: off */
 import sinon from "sinon";
 
 import IDB, { open, execute } from "../../src/adapters/IDB";

diff --git a/test/collection_test.ts b/test/collection_test.ts
@@ -1,3 +1,4 @@
+/* eslint dot-notation: off */
 import sinon from "sinon";
 import { EventEmitter } from "events";
 import { v4 as uuid4 } from "uuid";
@@ -197,7 +198,7 @@ describe("Collection", () => {
               TEST_COLLECTION_NAME,
               { api } as unknown as KintoBase<any>,
               {
-                adapter: function () {},
+                adapter() {},
               } as any
             );
           }).to.Throw(Error, /Unsupported adapter/);
@@ -344,7 +345,7 @@ describe("Collection", () => {
               TEST_COLLECTION_NAME,
               { api } as unknown as KintoBase<any>,
               {
-                idSchema: idSchema,
+                idSchema,
               }
             );
           }
@@ -1056,8 +1057,8 @@ describe("Collection", () => {
           };
           conflict = {
             type: "incoming",
-            local: local,
-            remote: remote,
+            local,
+            remote,
           };
         });
 
@@ -1144,7 +1145,7 @@ describe("Collection", () => {
           const res_1 = await articles.get(id, { includeDeleted: true });
           res_1.data.should.deep.equal({
             _status: "deleted",
-            id: id,
+            id,
             title: "foo",
             url: "http://foo",
           });
@@ -1176,7 +1177,7 @@ describe("Collection", () => {
           const res_1 = await articles.getAny(id);
           res_1.data.should.deep.equal({
             _status: "deleted",
-            id: id,
+            id,
             title: "foo",
             url: "http://foo",
           });
@@ -1740,7 +1741,7 @@ describe("Collection", () => {
             });
             const id = uuid4();
             await articles.create(
-              { id: id, title: "some title" },
+              { id, title: "some title" },
               { synced: true }
             );
             await articles.delete(id);
@@ -2173,7 +2174,7 @@ describe("Collection", () => {
               const id = uuid4();
               listRecords.returns(
                 Promise.resolve({
-                  data: [{ id: id, deleted: true }],
+                  data: [{ id, deleted: true }],
                   next: () => {},
                   last_modified: "42",
                 })
@@ -2264,8 +2265,8 @@ describe("Collection", () => {
             const remote = { ...local, title: "blah", last_modified: 42 };
             const conflict = {
               type: "incoming" as const,
-              local: local,
-              remote: remote,
+              local,
+              remote,
             };
             const resolution = { ...local, title: "resolved" };
             sandbox
@@ -2588,9 +2589,9 @@ describe("Collection", () => {
             updateRecord: sinon.SinonExpectation;
           beforeEach(() => {
             batch = {
-              deleteRecord: function () {},
-              createRecord: function () {},
-              updateRecord: function () {},
+              deleteRecord() {},
+              createRecord() {},
+              updateRecord() {},
             };
             batchSpy = sandbox.mock(batch);
             deleteRecord = batchSpy.expects("deleteRecord");

diff --git a/test/http/api_test.ts b/test/http/api_test.ts
@@ -1,3 +1,4 @@
+/* eslint dot-notation: off */
 import sinon from "sinon";
 import { EventEmitter } from "events";
 import { fakeServerResponse, Stub, expectAsyncError } from "../test_utils";
@@ -743,6 +744,7 @@ describe("KintoClient", () => {
                 if (name === "ETag") {
                   return ETag;
                 }
+                return "";
               },
             },
           })

diff --git a/test/http/bucket_test.ts b/test/http/bucket_test.ts
@@ -1,3 +1,4 @@
+/* eslint dot-notation: off */
 import sinon from "sinon";
 import KintoClient from "../../src/http";
 import Bucket, { BucketOptions } from "../../src/http/bucket";

diff --git a/test/http/collection_test.ts b/test/http/collection_test.ts
@@ -1,3 +1,4 @@
+/* eslint dot-notation: off */
 import sinon from "sinon";
 import KintoClient from "../../src/http";
 import Bucket from "../../src/http/bucket";

diff --git a/test/http/http_test.ts b/test/http/http_test.ts
@@ -191,6 +191,7 @@ describe("HTTP class", () => {
                     if (name !== "Alert") {
                       return "fake";
                     }
+                    return "";
                   },
                 },
                 text() {
@@ -267,6 +268,7 @@ describe("HTTP class", () => {
                   if (name === "Content-Length") {
                     return 0;
                   }
+                  return "";
                 },
               },
               text() {

diff --git a/test/http/integration_test.ts b/test/http/integration_test.ts
@@ -69,7 +69,7 @@ describe("HTTP Integration tests", function (__test) {
 
   after(() => {
     if (skipLocalServer) {
-      return;
+      return Promise.resolve();
     }
     const logLines = server.logs.toString().split("\n");
     const serverDidCrash = logLines.some((l) => l.startsWith("Traceback"));

diff --git a/test/index_test.ts b/test/index_test.ts
@@ -1,3 +1,4 @@
+/* eslint dot-notation: off */
 import sinon from "sinon";
 import { EventEmitter } from "events";
 import { SUPPORTED_PROTOCOL_VERSION as SPV } from "../src/http";

diff --git a/test/integration_test.ts b/test/integration_test.ts
@@ -1,3 +1,4 @@
+/* eslint dot-notation: off */
 import { v4 as uuid4 } from "uuid";
 import sinon from "sinon";
 import KintoServer from "kinto-node-test-server";

diff --git a/test/test_utils.ts b/test/test_utils.ts
@@ -52,7 +52,7 @@ export function fakeServerResponse(
     respHeaders.set("Content-Length", JSON.stringify(json).length.toString());
   }
   return Promise.resolve({
-    status: status,
+    status,
     statusText: status === 200 ? "OK" : "Error",
     headers: respHeaders,
     text() {