Merge pull request #5622 from mozilla/eslint-increase-coverage

Increase typescript-eslint coverage
mozilla · Feb 24, 2025 · 415e321 · 415e321
2 parents 2b56c1b + 4b175c0
commit 415e321
Show file tree

Hide file tree

Showing 65 changed files with 530 additions and 92 deletions.
diff --git a/eslint.config.js b/eslint.config.js
@@ -169,20 +169,13 @@ const config = [
       "@typescript-eslint/no-unsafe-call": "off",
     },
   },
-  // Ignore the following files for now.
+  // Next is not running ESLint on root files by default. The only way to
+  // include those would be to explicitly add them one by one. Instead, we
+  // run ESLint directly in addition to next lint on just the root files.
+  // For more info see:
+  // https://nextjs.org/docs/app/api-reference/config/eslint#linting-custom-directories-and-files
   {
-    files: [
-      "src/app/global-error.js",
-      "src/db/migrations/*.js",
-      "src/scripts/build/*.js",
-      "src/scripts/loadtest/*.js",
-      // Next is not running ESLint on root files by default. The only way to
-      // include those would be to explicitly add them one by one. Instead, we
-      // run ESLint directly in addition to next lint on just the root files.
-      // For more info see:
-      // https://nextjs.org/docs/app/api-reference/config/eslint#linting-custom-directories-and-files
-      "*.{js,cjs,ts}",
-    ],
+    files: ["*.{js,cjs,ts}"],
     languageOptions: {
       parserOptions: { project: null },
     },

diff --git a/src/app/global-error.js b/src/app/global-error.js
@@ -8,7 +8,12 @@ import * as Sentry from "@sentry/nextjs";
 import NextError from "next/error";
 import { useEffect } from "react";
 
-export default function GlobalError({ error }) {
+/**
+ * @param {Object} props
+ * @param {Error} props.error - The error object
+ * @param {number} props.statusCode - HTTP error status code (default: 500)
+ */
+export default function GlobalError({ error, statusCode = 500 }) {
   useEffect(() => {
     Sentry.captureException(error);
   }, [error]);
@@ -17,7 +22,7 @@ export default function GlobalError({ error }) {
     <html>
       <body>
         {/* This is the default Next.js error component. */}
-        <NextError />
+        <NextError statusCode={statusCode} />
       </body>
     </html>
   );

diff --git a/src/db/migrations/20180418090800_initial_schema.js b/src/db/migrations/20180418090800_initial_schema.js
@@ -2,6 +2,10 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function up(knex) {
   return knex.schema.createTable("subscribers", (table) => {
     table.increments("id").primary();
@@ -12,6 +16,10 @@ export function up(knex) {
   });
 }
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function down(knex) {
   return knex.schema.dropTableIfExists("subscribers");
 }
diff --git a/src/db/migrations/20180826102013_add_timestamps_to_subscribers.js b/src/db/migrations/20180826102013_add_timestamps_to_subscribers.js
@@ -2,12 +2,20 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function up(knex) {
   return knex.schema.table("subscribers", (table) => {
     table.timestamps(false, true);
   });
 }
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function down(knex) {
   return knex.schema.table("subscribers", (table) => {
     table.dropTimestamps();

diff --git a/src/db/migrations/20180829161115_add_fx_newsletter_column.js b/src/db/migrations/20180829161115_add_fx_newsletter_column.js
@@ -2,12 +2,20 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function up(knex) {
   return knex.schema.table("subscribers", (table) => {
     table.boolean("fx_newsletter").defaultTo(false);
   });
 }
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function down(knex) {
   return knex.schema.table("subscribers", (table) => {
     table.dropColumn("fx_newsletter");

diff --git a/src/db/migrations/20180930071926_add_signup_language.js b/src/db/migrations/20180930071926_add_signup_language.js
@@ -2,12 +2,20 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function up(knex) {
   return knex.schema.table("subscribers", (table) => {
     table.string("signup_language");
   });
 }
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function down(knex) {
   return knex.schema.table("subscribers", (table) => {
     table.dropColumn("signup_language");

diff --git a/src/db/migrations/20181007085241_add_sha1_index.js b/src/db/migrations/20181007085241_add_sha1_index.js
@@ -5,12 +5,21 @@
 // Note: this index was created on heroku, stage, and prod by hand
 // Use this statement to "fake" the migration:
 // INSERT INTO knex_migrations (name, batch, migration_time) values ('20181007085241_add_sha1_index.js', 4, '2018-10-07 08:52:42.000-05');
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function up(knex) {
   return knex.schema.table("subscribers", (table) => {
     table.index("sha1", "subscribers_sha1_idx");
   });
 }
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function down(knex) {
   return knex.schema.table("subscribers", (table) => {
     table.dropIndex("sha1", "subscribers_sha1_idx");

diff --git a/src/db/migrations/20181108151941_add_created_at_index.js b/src/db/migrations/20181108151941_add_created_at_index.js
@@ -2,12 +2,20 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function up(knex) {
   return knex.schema.table("subscribers", (table) => {
     table.index("created_at");
   });
 }
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function down(knex) {
   return knex.schema.table("subscribers", (table) => {
     table.dropIndex("created_at");

diff --git a/src/db/migrations/20181129152508_add_email_index.js b/src/db/migrations/20181129152508_add_email_index.js
@@ -2,12 +2,20 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function up(knex) {
   return knex.schema.table("subscribers", (table) => {
     table.index("email", "subscribers_email_idx");
   });
 }
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function down(knex) {
   return knex.schema.table("subscribers", (table) => {
     table.dropIndex("email", "subscribers_email_idx");

diff --git a/src/db/migrations/20181227100332_add_fxa_columns.js b/src/db/migrations/20181227100332_add_fxa_columns.js
@@ -2,13 +2,21 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function up(knex) {
   return knex.schema.table("subscribers", (table) => {
     table.string("fxa_refresh_token");
     table.jsonb("fxa_profile_json");
   });
 }
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function down(knex) {
   return knex.schema.table("subscribers", (table) => {
     table.dropColumn("fxa_refresh_token");

diff --git a/src/db/migrations/20190117150910_add_verified_index.js b/src/db/migrations/20190117150910_add_verified_index.js
@@ -2,12 +2,20 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function up(knex) {
   return knex.schema.table("subscribers", (table) => {
     table.index("verified", "subscribers_verified_idx");
   });
 }
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function down(knex) {
   return knex.schema.table("subscribers", (table) => {
     table.dropIndex("verified", "subscribers_verified_idx");

diff --git a/src/db/migrations/20190219154519_add_fxa_uid_column.js b/src/db/migrations/20190219154519_add_fxa_uid_column.js
@@ -2,12 +2,20 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function up(knex) {
   return knex.schema.table("subscribers", (table) => {
     table.string("fxa_uid");
   });
 }
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function down(knex) {
   return knex.schema.table("subscribers", (table) => {
     table.dropColumn("fxa_uid");

diff --git a/src/db/migrations/20190328111900_add_email_addresses_table.js b/src/db/migrations/20190328111900_add_email_addresses_table.js
@@ -2,6 +2,10 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<[void, void]> }
+ */
 export function up(knex) {
   return Promise.all([
     knex.schema.createTable("email_addresses", (table) => {
@@ -22,6 +26,10 @@ export function up(knex) {
   ]);
 }
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<[void, void]> }
+ */
 export function down(knex) {
   return Promise.all([
     knex.schema.dropTableIfExists("email_addresses"),

diff --git a/src/db/migrations/20190422140308_add_subscriber_breaches_shown.js b/src/db/migrations/20190422140308_add_subscriber_breaches_shown.js
@@ -2,12 +2,20 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function up(knex) {
   return knex.schema.table("subscribers", (table) => {
     table.timestamp("breaches_last_shown");
   });
 }
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function down(knex) {
   return knex.schema.table("subscribers", (table) => {
     table.dropColumn("breaches_last_shown");

diff --git a/src/db/migrations/20190510152733_add_timestamps_to_email_addresses.js b/src/db/migrations/20190510152733_add_timestamps_to_email_addresses.js
@@ -2,12 +2,20 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function up(knex) {
   return knex.schema.table("email_addresses", (table) => {
     table.timestamps(false);
   });
 }
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function down(knex) {
   return knex.schema.table("email_addresses", (table) => {
     table.dropTimestamps();

diff --git a/src/db/migrations/20190512170106_add_all_emails_to_primary_column.js b/src/db/migrations/20190512170106_add_all_emails_to_primary_column.js
@@ -2,12 +2,20 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function up(knex) {
   return knex.schema.table("subscribers", (table) => {
     table.boolean("all_emails_to_primary").defaultTo(false);
   });
 }
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function down(knex) {
   return knex.schema.table("subscribers", (table) => {
     table.dropColumn("all_emails_to_primary");

diff --git a/src/db/migrations/20190523152919_add_fxa_access_token_to_subscribers.js b/src/db/migrations/20190523152919_add_fxa_access_token_to_subscribers.js
@@ -2,12 +2,20 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function up(knex) {
   return knex.schema.table("subscribers", (table) => {
     table.string("fxa_access_token");
   });
 }
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function down(knex) {
   return knex.schema.table("subscribers", (table) => {
     table.dropColumn("fxa_access_token");

diff --git a/src/db/migrations/20190713193852_add_email_sha1_index.js b/src/db/migrations/20190713193852_add_email_sha1_index.js
@@ -5,12 +5,21 @@
 // Note: this index was created on heroku, stage, and prod by hand
 // Use this statement to "fake" the migration:
 // INSERT INTO knex_migrations (name, batch, migration_time) values ('20190713193852_add_email_sha1_index.js', (SELECT max(batch) + 1 FROM knex_migrations), '2019-07-13 19:52:42.000-05');
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function up(knex) {
   return knex.schema.table("email_addresses", (table) => {
     table.index("sha1", "email_addresses_sha1_idx");
   });
 }
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 export function down(knex) {
   return knex.schema.table("email_addresses", (table) => {
     table.dropIndex("sha1", "email_addresses_sha1_idx");