infra(typescript-eslint): strict-type-checked (#2467)

faker-js · Nov 4, 2023 · 358572d · 358572d
1 parent 22003bb
commit 358572d
Show file tree

Hide file tree

Showing 7 changed files with 21 additions and 12 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -15,7 +15,7 @@ module.exports = defineConfig({
   reportUnusedDisableDirectives: true,
   extends: [
     'eslint:recommended',
-    'plugin:@typescript-eslint/recommended-type-checked',
+    'plugin:@typescript-eslint/strict-type-checked',
     'plugin:prettier/recommended',
     'plugin:deprecation/recommended',
     'plugin:jsdoc/recommended-typescript-error',
@@ -91,6 +91,7 @@ module.exports = defineConfig({
       'error',
       { ignoreParameters: true },
     ],
+    '@typescript-eslint/no-unnecessary-condition': 'off', // requires `strictNullChecks` to be enabled
     '@typescript-eslint/no-unsafe-assignment': 'off',
     '@typescript-eslint/no-unsafe-call': 'off',
     '@typescript-eslint/no-unsafe-member-access': 'off',
@@ -104,6 +105,11 @@ module.exports = defineConfig({
       { allowNumber: true, allowBoolean: true },
     ],
     '@typescript-eslint/unbound-method': 'off',
+    '@typescript-eslint/unified-signatures': 'off', // incompatible with our api docs generation
+
+    // TODO @ST-DDT 2023-10-10: The following rules currently conflict with our code.
+    // Each rule should be checked whether it should be enabled/configured and the problems fixed, or stay disabled permanently.
+    '@typescript-eslint/no-confusing-void-expression': 'off',
 
     'jsdoc/require-jsdoc': 'off', // Enabled only for src/**/*.ts
     'jsdoc/require-returns': 'off',

diff --git a/src/modules/finance/index.ts b/src/modules/finance/index.ts
@@ -815,7 +815,7 @@ export class FinanceModule {
     const normalizedIssuer = issuer.toLowerCase();
     if (normalizedIssuer in localeFormat) {
       format = this.faker.helpers.arrayElement(localeFormat[normalizedIssuer]);
-    } else if (/#/.test(issuer)) {
+    } else if (issuer.includes('#')) {
       // The user chose an optional scheme
       format = issuer;
     } else {

diff --git a/src/modules/image/index.ts b/src/modules/image/index.ts
@@ -232,17 +232,16 @@ export class ImageModule {
       length: { min: 5, max: 10 },
     })}/${width}/${height}`;
 
-    const hasValidGrayscale = grayscale === true;
     const hasValidBlur = typeof blur === 'number' && blur >= 1 && blur <= 10;
 
-    if (hasValidGrayscale || hasValidBlur) {
+    if (grayscale || hasValidBlur) {
       url += '?';
 
-      if (hasValidGrayscale) {
+      if (grayscale) {
         url += `grayscale`;
       }
 
-      if (hasValidGrayscale && hasValidBlur) {
+      if (grayscale && hasValidBlur) {
         url += '&';
       }
 

diff --git a/src/modules/word/filter-word-list-by-length.ts b/src/modules/word/filter-word-list-by-length.ts
@@ -13,12 +13,12 @@ const STRATEGIES = {
     wordList: ReadonlyArray<string>,
     length: { min: number; max: number }
   ): string[] => {
-    const wordsByLength = wordList.reduce(
+    const wordsByLength = wordList.reduce<Record<number, string[]>>(
       (data, word) => {
         (data[word.length] = data[word.length] ?? []).push(word);
         return data;
       },
-      {} as Record<number, string[]>
+      {}
     );
 
     const lengths = Object.keys(wordsByLength).map(Number);

diff --git a/test/modules/helpers.spec.ts b/test/modules/helpers.spec.ts
@@ -95,6 +95,7 @@ describe('helpers', () => {
       enum MixedFoo {
         Foo = 0,
         Bar = 1,
+        // eslint-disable-next-line @typescript-eslint/no-mixed-enums
         FooName = 'Foo',
         BarName = 'Bar',
       }
@@ -256,6 +257,7 @@ describe('helpers', () => {
         enum FooMixedEnum {
           Foo = 0,
           Bar = 1,
+          // eslint-disable-next-line @typescript-eslint/no-mixed-enums
           StrFoo = 'FOO',
           StrBar = 'BAR',
         }

diff --git a/test/scripts/apidoc/module.example.ts b/test/scripts/apidoc/module.example.ts
@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/no-extraneous-class -- required for tests */
+
 /**
  * A simple module without anything special.
  */

diff --git a/test/scripts/apidoc/verify-jsdoc-tags.spec.ts b/test/scripts/apidoc/verify-jsdoc-tags.spec.ts
@@ -47,18 +47,18 @@ describe('verify JSDoc tags', () => {
   }
 
   const allowedReferences = new Set(
-    Object.values(modules).reduce((acc, [module, methods]) => {
+    Object.values(modules).reduce<string[]>((acc, [module, methods]) => {
       const moduleFieldName = extractModuleFieldName(module);
       return [
         ...acc,
         ...Object.keys(methods).map(
           (methodName) => `faker.${moduleFieldName}.${methodName}`
         ),
       ];
-    }, [] as string[])
+    }, [])
   );
   const allowedLinks = new Set(
-    Object.values(modules).reduce((acc, [module, methods]) => {
+    Object.values(modules).reduce<string[]>((acc, [module, methods]) => {
       const moduleFieldName = extractModuleFieldName(module);
       return [
         ...acc,
@@ -68,7 +68,7 @@ describe('verify JSDoc tags', () => {
             `/api/${moduleFieldName}.html#${methodName.toLowerCase()}`
         ),
       ];
-    }, [] as string[])
+    }, [])
   );
 
   function assertDescription(description: string, isHtml: boolean): void {