chore: turn on padding-line-between-statements (#1691)

Author: Shinigami92

.eslintrc.js

@@ -34,6 +34,15 @@ module.exports = defineConfig({
     '@typescript-eslint/ban-ts-comment': 'warn',
     '@typescript-eslint/consistent-type-imports': 'error',
     '@typescript-eslint/explicit-module-boundary-types': 'error',
+    '@typescript-eslint/naming-convention': [
+      'error',
+      {
+        format: ['PascalCase'],
+        selector: ['class', 'interface', 'typeAlias', 'enumMember'],
+        leadingUnderscore: 'forbid',
+        trailingUnderscore: 'forbid',
+      },
+    ],
     '@typescript-eslint/no-inferrable-types': [
       'error',
       { ignoreParameters: true },
@@ -43,23 +52,15 @@ module.exports = defineConfig({
     '@typescript-eslint/no-unsafe-call': 'off',
     '@typescript-eslint/no-unsafe-member-access': 'off',
     '@typescript-eslint/no-unsafe-return': 'warn',
-    '@typescript-eslint/restrict-template-expressions': [
+    '@typescript-eslint/padding-line-between-statements': [
       'error',
-      {
-        allowNumber: true,
-        allowBoolean: true,
-      },
+      { blankLine: 'always', prev: 'block-like', next: '*' },
     ],
-    '@typescript-eslint/unbound-method': 'off',
-    '@typescript-eslint/naming-convention': [
+    '@typescript-eslint/restrict-template-expressions': [
       'error',
-      {
-        format: ['PascalCase'],
-        selector: ['class', 'interface', 'typeAlias', 'enumMember'],
-        leadingUnderscore: 'forbid',
-        trailingUnderscore: 'forbid',
-      },
+      { allowNumber: true, allowBoolean: true },
     ],
+    '@typescript-eslint/unbound-method': 'off',
   },
   overrides: [
     {

scripts/apidoc/apiDocsWriter.ts

@@ -161,6 +161,7 @@ export function writeApiSearchIndex(project: ProjectReflection): void {
           },
         ];
       }
+
       return apiSection;
     })
     .sort((a, b) => a.text.localeCompare(b.text));

scripts/apidoc/moduleMethods.ts

@@ -46,6 +46,7 @@ export function extractModuleName(module: DeclarationReflection): string {
   } else if (name === 'NameModule') {
     return 'Person';
   }
+
   return name.replace(/Module$/, '');
 }
 

scripts/apidoc/parameterDefaults.ts

@@ -52,6 +52,7 @@ function cleanParameterDefault(value?: string): string | undefined {
   if (value == null) {
     return undefined;
   }
+
   // Strip type casts: "'foobar' as unknown as T" => "'foobar'"
   return value.replace(/ as unknown as [A-Za-z<>]+/, '');
 }
@@ -124,6 +125,7 @@ function patchSignatureParameterDefaults(
   if (signatureParameters.length !== parameterDefaults.length) {
     throw new Error('Unexpected parameter length mismatch');
   }
+
   signatureParameters.forEach(
     (param, index) =>
       (param.defaultValue = parameterDefaults[index] || param.defaultValue)

scripts/apidoc/signature.ts

@@ -142,6 +142,7 @@ export function analyzeSignature(
   if (signatureTypeParameters.length !== 0) {
     signatureTypeParametersString = `<${signatureTypeParameters.join(', ')}>`;
   }
+
   const signatureParametersString = signatureParameters.join(', ');
 
   let examples: string;
@@ -150,6 +151,7 @@ export function analyzeSignature(
   } else {
     examples = `faker.${methodName}${signatureTypeParametersString}(${signatureParametersString}): ${signature.type?.toString()}\n`;
   }
+
   faker.seed(0);
   if (moduleName) {
     try {
@@ -230,6 +232,7 @@ function analyzeParameterOptions(
   if (!parameterType) {
     return [];
   }
+
   if (parameterType.type === 'union') {
     return parameterType.types.flatMap((type) =>
       analyzeParameterOptions(name, type)
@@ -261,6 +264,7 @@ function typeToText(type_?: Type, short = false): string {
   if (!type_) {
     return '?';
   }
+
   const type = type_ as SomeType;
   switch (type.type) {
     case 'array':
@@ -283,6 +287,7 @@ function typeToText(type_?: Type, short = false): string {
           .map((t) => typeToText(t, short))
           .join(', ')}>`;
       }
+
     case 'reflection':
       return declarationTypeToText(type.declaration, short);
     case 'indexedAccess':
@@ -335,6 +340,7 @@ function signatureTypeToText(signature?: SignatureReflection): string {
   if (!signature) {
     return '(???) => ?';
   }
+
   return `(${signature.parameters
     ?.map((p) => `${p.name}: ${typeToText(p.type)}`)
     .join(', ')}) => ${typeToText(signature.type)}`;
@@ -350,18 +356,22 @@ function extractDefaultFromComment(comment?: Comment): string | undefined {
   if (!comment) {
     return;
   }
+
   const summary = comment.summary;
   const text = joinTagParts(summary).trim();
   if (!text) {
     return;
   }
+
   const result = /^(.*)[ \n]Defaults to `([^`]+)`\.(.*)$/s.exec(text);
   if (!result) {
     return;
   }
+
   if (result[3].trim()) {
     throw new Error(`Found description text after the default value:\n${text}`);
   }
+
   summary.splice(summary.length - 2, 2);
   const lastSummaryPart = summary[summary.length - 1];
   lastSummaryPart.text = lastSummaryPart.text.replace(/[ \n]Defaults to $/, '');

scripts/apidoc/utils.ts

@@ -122,6 +122,7 @@ export function extractSeeAlsos(signature?: SignatureReflection): string[] {
         if (link.startsWith('-')) {
           link = link.slice(1).trim();
         }
+
         return link;
       })
       .filter((link) => link)

scripts/bundle.ts

@@ -12,6 +12,7 @@ const target = ['ES2019', 'node14.17'];
 if (existsSync(localeDir)) {
   rmSync(localeDir, { recursive: true, force: true });
 }
+
 mkdirSync(localeDir);
 for (const locale of Object.keys(locales)) {
   writeFileSync(

scripts/generateLocales.ts

@@ -82,6 +82,7 @@ function removeIndexTs(files: string[]): string[] {
   if (index !== -1) {
     files.splice(index, 1);
   }
+
   return files;
 }
 
@@ -152,6 +153,7 @@ function tryLoadLocalesMainIndexFile(pathModules: string): LocaleDefinition {
       console.error(`Failed to load ${pathModules} or manually parse it.`, e);
     }
   }
+
   return localeDef;
 }
 
@@ -177,6 +179,7 @@ function generateLocalesIndexFile(
       )}';`
     );
   }
+
   content.push(
     ...modules.map((m) => `import ${escapeImport(m)} from './${m}';`)
   );

src/faker.ts

@@ -62,6 +62,7 @@ export class Faker {
         `Locale ${locale} is not supported. You might want to add the requested locale first to \`faker.locales\`.`
       );
     }
+
     this._locale = locale;
   }
 
@@ -75,6 +76,7 @@ export class Faker {
         `Locale ${localeFallback} is not supported. You might want to add the requested locale first to \`faker.locales\`.`
       );
     }
+
     this._localeFallback = localeFallback;
   }
 

src/internal/mersenne/twister.ts

@@ -129,6 +129,7 @@ export default class MersenneTwister19937 {
         sum = this.addition32(sum, this.unsigned32(n2 << i));
       }
     }
+
     return sum;
   }
 
@@ -194,10 +195,12 @@ export default class MersenneTwister19937 {
         this.mt[0] = this.mt[this.N - 1];
         i = 1;
       }
+
       if (j >= keyLength) {
         j = 0;
       }
     }
+
     for (k = this.N - 1; k; k--) {
       // mt[i] = (mt[i] ^ ((mt[i-1] ^ (mt[i-1] >> 30)) * 1566083941)) - i
       this.mt[i] = this.subtraction32(
@@ -218,6 +221,7 @@ export default class MersenneTwister19937 {
         i = 1;
       }
     }
+
     this.mt[0] = 0x80000000; // MSB is 1; assuring non-zero initial array
   }
 

src/modules/animal/index.ts

@@ -10,6 +10,7 @@ export class AnimalModule {
       if (name === 'constructor' || typeof this[name] !== 'function') {
         continue;
       }
+
       this[name] = this[name].bind(this);
     }
   }

src/modules/color/index.ts

@@ -58,9 +58,11 @@ function formatHexColor(
       hexColor = hexColor.toLowerCase();
       break;
   }
+
   if (options?.prefix) {
     hexColor = options.prefix + hexColor;
   }
+
   return hexColor;
 }
 
@@ -78,6 +80,7 @@ function toBinary(values: number[]): string {
       const bytes = new Uint8Array(buffer);
       return toBinary(Array.from(bytes)).split(' ').join('');
     }
+
     return (value >>> 0).toString(2).padStart(8, '0');
   });
   return binary.join(' ');
@@ -161,6 +164,7 @@ export class ColorModule {
       if (name === 'constructor' || typeof this[name] !== 'function') {
         continue;
       }
+
       this[name] = this[name].bind(this);
     }
   }
@@ -320,11 +324,13 @@ export class ColorModule {
       color = formatHexColor(color, options);
       return color;
     }
+
     color = Array.from({ length: 3 }, () => this.faker.number.int(255));
     if (includeAlpha) {
       color.push(this.faker.number.float());
       cssFunction = 'rgba';
     }
+
     return toColorFormat(color, format, cssFunction);
   }
 
@@ -460,6 +466,7 @@ export class ColorModule {
     for (let i = 0; i < (options?.includeAlpha ? 3 : 2); i++) {
       hsl.push(this.faker.number.float());
     }
+
     return toColorFormat(
       hsl,
       options?.format || 'decimal',
@@ -537,6 +544,7 @@ export class ColorModule {
     for (let i = 0; i < 2; i++) {
       hsl.push(this.faker.number.float());
     }
+
     return toColorFormat(hsl, options?.format || 'decimal', 'hwb');
   }
 
@@ -598,6 +606,7 @@ export class ColorModule {
         this.faker.number.float({ min: -100, max: 100, precision: 0.0001 })
       );
     }
+
     return toColorFormat(lab, options?.format || 'decimal', 'lab');
   }
 
@@ -669,6 +678,7 @@ export class ColorModule {
     for (let i = 0; i < 2; i++) {
       lch.push(this.faker.number.float({ max: 230, precision: 0.1 }));
     }
+
     return toColorFormat(lch, options?.format || 'decimal', 'lch');
   }
 
@@ -742,6 +752,7 @@ export class ColorModule {
     if (options?.format === 'css' && !options?.space) {
       options = { ...options, space: 'sRGB' };
     }
+
     const color = Array.from({ length: 3 }, () =>
       this.faker.number.float({ precision: 0.0001 })
     );

src/modules/commerce/index.ts

@@ -10,6 +10,7 @@ export class CommerceModule {
       if (name === 'constructor' || typeof this[name] !== 'function') {
         continue;
       }
+
       this[name] = this[name].bind(this);
     }
   }

src/modules/company/index.ts

@@ -10,6 +10,7 @@ export class CompanyModule {
       if (name === 'constructor' || typeof this[name] !== 'function') {
         continue;
       }
+
       this[name] = this[name].bind(this);
     }
   }

src/modules/database/index.ts

@@ -10,6 +10,7 @@ export class DatabaseModule {
       if (name === 'constructor' || typeof this[name] !== 'function') {
         continue;
       }
+
       this[name] = this[name].bind(this);
     }
   }

src/modules/datatype/index.ts

@@ -11,6 +11,7 @@ export class DatatypeModule {
       if (name === 'constructor' || typeof this[name] !== 'function') {
         continue;
       }
+
       this[name] = this[name].bind(this);
     }
   }
@@ -211,14 +212,17 @@ export class DatatypeModule {
         probability: options,
       };
     }
+
     const { probability = 0.5 } = options;
     if (probability <= 0) {
       return false;
     }
+
     if (probability >= 1) {
       // This check is required to avoid returning false when float() returns 1
       return true;
     }
+
     return this.faker.number.float() < probability;
   }
 

src/modules/date/index.ts

@@ -28,6 +28,7 @@ export class DateModule {
       if (name === 'constructor' || typeof this[name] !== 'function') {
         continue;
       }
+
       this[name] = this[name].bind(this);
     }
   }

src/modules/finance/iban.ts

@@ -1401,6 +1401,7 @@ const iban: Iban = {
     for (let i = 0; i < digitStr.length; i++) {
       m = (m * 10 + +digitStr[i]) % 97;
     }
+
     return m;
   },
   pattern10: ['01', '02', '03', '04', '05', '06', '07', '08', '09'],