Reinstate the @typescript-eslint/ban-ts-comment rule + fix issues

eslint.config.js

@@ -110,7 +110,16 @@ module.exports = [
           additionalHooks: "useDeepCompareEffect"
         }
       ],
-      "no-only-tests/no-only-tests": "warn" // Warn on `.only` in tests
+      "no-only-tests/no-only-tests": "warn", // Warn on `.only` in tests
+      "@typescript-eslint/ban-ts-comment": [
+        "error",
+        {
+          "ts-ignore": true, // flag all `@ts-ignore` comments
+          "ts-expect-error": true, // flag all `@ts-expect-error` comments
+          "ts-nocheck": true, // flag all `@ts-nocheck` comments
+          "ts-check": true // flag all `@ts-check` comments
+        }
+      ]
     }
   },
   // JS/JSX-specific rules
@@ -190,7 +199,8 @@ module.exports = [
       "src/core/fbs/fbs.ts",
       "src/core/publizon/publizon.ts",
       "src/**/*.test.ts",
-      "src/**/*.test.tsx"
+      "src/**/*.test.tsx",
+      "eslint.config.js"
     ]
   }
 ];

src/apps/advanced-search/AdvancedSearch.stories.tsx

@@ -13,7 +13,7 @@ import AdvancedSearchEntry from "./AdvancedSearch.entry";
 const meta: Meta<typeof AdvancedSearchEntry> = {
   title: "Apps / Advanced Search",
   component: AdvancedSearchEntry,
-
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore: can't figure out how to type serviceUrlArgTypes and globalTextArgTypes
   argTypes: {
     ...serviceUrlArgTypes,

src/apps/advanced-search/AdvancedSearchRow.tsx

@@ -40,7 +40,7 @@ const AdvancedSearchRow: React.FC<AdvancedSearchRowProps> = ({
     updateData: (data: AdvancedSearchQuery) => void
   ) => {
     const newData = { ...data };
-
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore-next-line I wasn't able to match the update type with the rowAspect type
     // but the values match and it all works.
     newData.rows[rowIndex][rowAspect] = update;

src/apps/advanced-search/types.ts

@@ -34,7 +34,7 @@ export const advancedSearchIndexTranslations = {
   "term.isbn": "advancedSearchIdentifierText"
 } as const;
 
-export type AdvancedSearchIndex = (typeof advancedSearchIndexes)[number];
+export type AdvancedSearchIndex = typeof advancedSearchIndexes[number];
 
 export type AdvancedSearchClause = {
   value: "AND" | "OR" | "NOT";

src/apps/create-patron-user-info/CreatePatron.stories.tsx

@@ -24,6 +24,7 @@ export default meta;
 type Story = StoryObj<typeof CreatePatron>;
 
 export const Primary: Story = {
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore: can't figure out how to type pincodeArgTypes, serviceUrlArgTypes and globalTextArgTypes
   argTypes: {
     ...pincodeArgTypes,

src/apps/dashboard/dashboard.stories.tsx

@@ -40,7 +40,7 @@ import blockedArgs, {
 const meta: Meta<typeof DashBoard> = {
   title: "Apps / Dashboard",
   component: DashBoard,
-
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore: can't figure out how to type this
   argTypes: {
     ...blockedArgTypes,

src/apps/demo-modal/demo-modal.stories.tsx

@@ -12,7 +12,7 @@ const meta: Meta<typeof DemoModal> = {
       modal: "demo-modal-one"
     }
   },
-
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore: can't figure out how to type globalTextArgTypes
   argTypes: {
     ...globalTextArgTypes,

src/apps/favorites-list-material-component/FavoritesListMaterialComponent.stories.tsx

@@ -13,7 +13,7 @@ import globalConfigArgs, {
 const meta: Meta<typeof FavoritesListMaterialComponent> = {
   title: "Apps / Favorites list material component",
   component: FavoritesListMaterialComponent,
-
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore: can't figure out how to type serviceUrlArgTypes and globalTextArgTypes
   argTypes: {
     ...serviceUrlArgTypes,

src/apps/favorites-list/FavoritesList.stories.tsx

@@ -13,7 +13,7 @@ import globalConfigArgs, {
 const meta: Meta<typeof FavoritesListEntry> = {
   title: "Apps / Favorite list",
   component: FavoritesListEntry,
-
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore: can't figure out how to type serviceUrlArgTypes and globalTextArgTypes
   argTypes: {
     ...serviceUrlArgTypes,

src/apps/fee-list/FeeList.stories.tsx

@@ -29,7 +29,7 @@ import renewalArgs, {
 const meta: Meta<typeof FeeList> = {
   title: "Apps / Fee list",
   component: FeeList,
-
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore: can't figure out how to type this
   argTypes: {
     ...serviceUrlArgTypes,

src/apps/loan-list/list/loan-list.stories.tsx

@@ -29,7 +29,7 @@ import blockedArgs, {
 const meta: Meta<typeof LoanList> = {
   title: "Apps / Loan list",
   component: LoanList,
-
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore: can't figure out how to type this
   argTypes: {
     ...serviceUrlArgTypes,

src/apps/material-grid/automatic/MaterialGridAutomatic.stories.tsx

@@ -12,7 +12,7 @@ import MaterialGridSkeleton from "../MaterialGridSkeleton";
 const meta: Meta<typeof MaterialGridAutomatic> = {
   title: "Apps / Material Grid / Automatic",
   component: MaterialGridAutomatic,
-
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore: can't figure out how to type this
   argTypes: {
     ...globalTextArgTypes,

src/apps/material-grid/manual/MaterialGridManual.stories.tsx

@@ -49,7 +49,7 @@ const materials = [
 const meta: Meta<typeof MaterialGridManual> = {
   title: "Apps / Material Grid / Manual",
   component: MaterialGridManual,
-
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore: can't figure out how to type this
   argTypes: {
     ...globalTextArgTypes,

src/apps/material-search/MaterialSearch.stories.tsx

@@ -84,7 +84,7 @@ const MaterialSearchHiddenInputs = ({
 const meta: Meta<typeof MaterialSearchHiddenInputs> = {
   title: "Apps / Material Search",
   component: MaterialSearchHiddenInputs,
-
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore: can't figure out how to type this
   argTypes: {
     ...globalTextArgTypes,

src/apps/material/material.stories.tsx

@@ -13,7 +13,7 @@ import globalConfigArgs, {
 const meta: Meta<typeof MaterialEntry> = {
   title: "Apps / Material",
   component: MaterialEntry,
-
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore: can't figure out how to type serviceUrlArgTypes and globalTextArgTypes
   argTypes: {
     ...serviceUrlArgTypes,

src/apps/menu/menu.stories.tsx

@@ -42,7 +42,7 @@ const WrappedStoryHeader = withText(withUrls(withConfig(StoryHeader)));
 const meta: Meta<typeof WrappedMenu> = {
   title: "Apps / Header",
   component: WrappedMenu,
-
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore: can't figure out how to type this
   argTypes: {
     ...serviceUrlArgTypes,

src/apps/opening-hours-editor/DialogFormEdit.tsx

@@ -76,7 +76,7 @@ const DialogFormEdit: React.FC<DialogFormEditProps> = ({
             ...cmsEvent,
             // Workaround for a bug caused by the orval tool, which incorrectly requires the repetition ID.
             // Ideally, the repetition ID should be optional according to the API specifications.
-
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
             // @ts-ignore: Unreachable code error
             repetition: {
               type: DplOpeningHoursListGET200ItemRepetitionType.weekly,
@@ -92,7 +92,7 @@ const DialogFormEdit: React.FC<DialogFormEditProps> = ({
       } else {
         // Workaround for a bug caused by the orval tool, which incorrectly requires the repetition ID.
         // Ideally, the repetition ID should be optional according to the API specifications.
-
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
         // @ts-ignore: Unreachable code error
         handleEventEditing(formatFullCalendarEventToCmsEventEdit(cmsEvent));
         closeDialog();
@@ -111,7 +111,7 @@ const DialogFormEdit: React.FC<DialogFormEditProps> = ({
     } else {
       // Workaround for a bug caused by the orval tool, which incorrectly requires the repetition ID.
       // Ideally, the repetition ID should be optional according to the API specifications.
-
+      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
       // @ts-ignore: Unreachable code error
       handleEventEditing(formatFullCalendarEventToCmsEventEdit(cmsEvent));
       closeEditDialog();

src/apps/opening-hours/OpeningHours.stories.tsx

@@ -13,7 +13,7 @@ import OpeningHours from "./OpeningHours.entry";
 const meta: Meta<typeof OpeningHours> = {
   title: "Apps / Opening Hours",
   component: OpeningHours,
-
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore: can't figure out how to type globalConfigArgTypes, globalTextArgTypes and serviceUrlArgTypes
   argTypes: {
     ...globalConfigArgTypes,

src/apps/patron-page/PatronPage.stories.tsx

@@ -19,7 +19,7 @@ import globalConfigArgs, {
 const meta: Meta<typeof PatronPage> = {
   title: "Apps / Patron page",
   component: PatronPage,
-
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore: can't figure out how to type globalConfigArgTypes, serviceUrlArgTypes and globalTextArgTypes
   argTypes: {
     ...serviceUrlArgTypes,

src/apps/recommendation/recommendation.stories.tsx

@@ -15,7 +15,7 @@ import { ManifestationMaterialType } from "../../core/utils/types/material-type"
 const meta: Meta<typeof Recommendation> = {
   title: "Apps / Recommendation",
   component: Recommendation,
-
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore: can't figure out how to type globalTextArgTypes and serviceUrlArgTypes
   argTypes: {
     ...globalTextArgTypes,

src/apps/recommended-material/RecommendedMaterial.stories.tsx

@@ -14,7 +14,7 @@ import { ManifestationMaterialType } from "../../core/utils/types/material-type"
 const meta: Meta<typeof RecommendedMaterial> = {
   title: "Apps / Recommended Material",
   component: RecommendedMaterial,
-
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore: can't figure out how to type globalTextArgTypes
   argTypes: {
     ...globalTextArgTypes,

src/apps/recommender/Recommender.stories.tsx

@@ -13,7 +13,7 @@ import globalConfigArgs, {
 const meta: Meta<typeof Recommender> = {
   title: "Apps / Recommender",
   component: Recommender,
-
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore: can't figure out how to type serviceUrlArgTypes and globalTextArgTypes
   argTypes: {
     ...serviceUrlArgTypes,

src/apps/reservation-list/list/reservation-list.stories.tsx

@@ -23,8 +23,8 @@ import globalTextArgs, {
 const meta: Meta<typeof ReservationList> = {
   title: "Apps / Reservation list",
   component: ReservationList,
-
-  // @ts-ignore: can't figure out how to type serviceUrlArgTypes, deleteReservationModalArgTypes, reservationMaterialDetailsPropTypes, blockedArgTypes, reservationListArgTypes, globalTextArgTypes and globalTextArgTypes
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore: can't figure out how to type serviceUrlArgTypes, deleteReservationModalArgTypes, reservationMaterialDetailsPropTypes,blockedArgTypes, reservationListArgTypes, globalTextArgTypes and globalTextArgTypes
   argTypes: {
     // Config
     ...serviceUrlArgTypes,

src/apps/reservation-list/modal/reservation-details/helper.ts

@@ -29,7 +29,7 @@ export const findEreolAccessLinkFromManifestations = (
     (access) => access.__typename === "Ereol"
   );
   // TODO: Find out why TS doesn't understand that ereolAccess will always exist
-
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore-next-line
   return ereolAccess?.url;
 };
@@ -46,7 +46,7 @@ export const getReservationsForSaving = ({
   selectedBranch: string;
 }) => {
   const getSelectedExpiryDate = (value: FormSelectValue) =>
-    typeof value === "number" ? getFutureDateString(value) : (expiryDate ?? "");
+    typeof value === "number" ? getFutureDateString(value) : expiryDate ?? "";
   const getSelectedPickupBranch = (value: FormSelectValue) =>
     typeof value === "string" ? value : selectedBranch;
 

src/apps/search-header/search-header.stories.tsx

@@ -17,7 +17,7 @@ import globalConfigArgs, {
 const meta: Meta<typeof SearchHeaderEntry> = {
   title: "Apps / Header",
   component: SearchHeaderEntry,
-
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore: can't figure out how to type globalConfigArgTypes, serviceUrlArgTypes and globalTextArgTypes
   argTypes: {
     ...serviceUrlArgTypes,

src/apps/search-result/search-result.stories.tsx

@@ -13,7 +13,7 @@ import globalConfigArgs, {
 const meta: Meta<typeof SearchResultEntry> = {
   title: "Apps / Search Result",
   component: SearchResultEntry,
-
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore: can't figure out how to type serviceUrlArgTypes and globalTextArgTypes
   argTypes: {
     ...serviceUrlArgTypes,

src/apps/something-similar/SomethingSimilar.stories.tsx

@@ -13,7 +13,7 @@ import globalConfigArgs, {
 const meta: Meta<typeof SomethingSimilar> = {
   title: "Apps / Something similar",
   component: SomethingSimilar,
-
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore: can't figure out how to type serviceUrlArgTypes and globalTextArgTypes
   argTypes: {
     ...serviceUrlArgTypes,

src/components/facet-line/FacetLineFilters.tsx

@@ -30,7 +30,7 @@ const FacetLineFilters: React.FunctionComponent<FacetLineFiltersProps> = ({
   // summer 2024, a lot of changes has been introduced
   // which implies refactoring of facet types/functionality.
   // Something here needs to be looked at.
-
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore
   const facetMap = createFacetsMap(facets);
 

src/components/guarded-app.tsx

@@ -67,7 +67,7 @@ const GuardedApp = ({ app, children }: GuardedAppProps) => {
 
     // TODO: For some reason the type is not right in the redux type system.
     // It needs to be solved but I do not have the proper solution right now.
-
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
     dispatch(reRunRequest(persistedRequest));
 

src/core/dbc-gateway/helper.ts

@@ -3,7 +3,7 @@ import { beforeAll, vi } from "vitest";
 import { getServiceBaseUrl } from "../utils/reduxMiddleware/extractServiceBaseUrls";
 import queryMap from "./queryMap";
 
-type Baseurl = (typeof queryMap)[keyof typeof queryMap];
+type Baseurl = typeof queryMap[keyof typeof queryMap];
 
 export const resolveBaseUrl = (query?: string) => {
   if (!query) {

src/core/fbs/model/authenticatedPatronV6AuthenticateStatus.ts

@@ -14,7 +14,7 @@
  </ul>
  */
 export type AuthenticatedPatronV6AuthenticateStatus =
-  (typeof AuthenticatedPatronV6AuthenticateStatus)[keyof typeof AuthenticatedPatronV6AuthenticateStatus];
+  typeof AuthenticatedPatronV6AuthenticateStatus[keyof typeof AuthenticatedPatronV6AuthenticateStatus];
 
 export const AuthenticatedPatronV6AuthenticateStatus = {
   VALID: "VALID",

src/core/publizon/model/apiResponseCode.ts

@@ -11,7 +11,7 @@ Orders/loans created in test environment will not be invoiced. Please request a
  * 101 = Success, 105 = InvalidContentIdentifier, 118 = InvalidRequestIdentity, 120 = MaxConcurrentLoansPerBorrowerExceeded, 125 = MaxAmountPerMonthExceeded, 128 = ContentNotFound, 131 = NotLoanable, 134 = CardTemporarilyBlocked, 135 = MaxLoansOnTitleReached, 136 = InsufficientCopiesException, 137 = ReservationLimitReached, 138 = GenericFault, 139 = InvalidAgreement, 140 = AlreadyReserved, 141 = InvalidEmail, 142 = InvalidPhone, 143 = CostFreeLimitReached, 147 = CountryNotFound, 148 = InvalidInstitutionId, 149 = InvalidCardFormat, 150 = InvalidCardByCulr, 151 = CardNotFound, 152 = InvalidClientId, 153 = LoanNotFound
  */
 export type ApiResponseCode =
-  (typeof ApiResponseCode)[keyof typeof ApiResponseCode];
+  typeof ApiResponseCode[keyof typeof ApiResponseCode];
 
 export const ApiResponseCode = {
   NUMBER_101: 101,

src/core/publizon/model/bookTypes.ts

@@ -10,7 +10,7 @@ Orders/loans created in test environment will not be invoiced. Please request a
 /**
  * 0 = Ebook, 1 = Audio
  */
-export type BookTypes = (typeof BookTypes)[keyof typeof BookTypes];
+export type BookTypes = typeof BookTypes[keyof typeof BookTypes];
 
 export const BookTypes = {
   NUMBER_0: 0,

src/core/publizon/model/contentLoanStatusEnum.ts

@@ -8,7 +8,7 @@ Orders/loans created in test environment will not be invoiced. Please request a
  */
 
 export type ContentLoanStatusEnum =
-  (typeof ContentLoanStatusEnum)[keyof typeof ContentLoanStatusEnum];
+  typeof ContentLoanStatusEnum[keyof typeof ContentLoanStatusEnum];
 
 export const ContentLoanStatusEnum = {
   NUMBER_0: 0,

src/core/publizon/model/fileExtensionType.ts

@@ -8,7 +8,7 @@ Orders/loans created in test environment will not be invoiced. Please request a
  */
 
 export type FileExtensionType =
-  (typeof FileExtensionType)[keyof typeof FileExtensionType];
+  typeof FileExtensionType[keyof typeof FileExtensionType];
 
 export const FileExtensionType = {
   NUMBER_1: 1,

src/core/publizon/model/identifierTypeEnum.ts

@@ -8,7 +8,7 @@ Orders/loans created in test environment will not be invoiced. Please request a
  */
 
 export type IdentifierTypeEnum =
-  (typeof IdentifierTypeEnum)[keyof typeof IdentifierTypeEnum];
+  typeof IdentifierTypeEnum[keyof typeof IdentifierTypeEnum];
 
 export const IdentifierTypeEnum = {
   NUMBER_2: 2,

src/core/utils/withFocusTrap.tsx

@@ -5,12 +5,13 @@ export default <P extends object>(
     Component: React.ComponentType<P>
   ): FC<P & { withFocusTrap?: boolean }> =>
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  ({ withFocusTrap, ...props }) => (
-    <FocusTrap
-      focusTrapOptions={{
-        allowOutsideClick: true
-      }}
-    >
-      <Component {...(props as P)} />
-    </FocusTrap>
-  );
+  ({ withFocusTrap, ...props }) =>
+    (
+      <FocusTrap
+        focusTrapOptions={{
+          allowOutsideClick: true
+        }}
+      >
+        <Component {...(props as P)} />
+      </FocusTrap>
+    );