chore: add eslint rule to harmonize rules

Author: Tchoupinax

eslint.config.mjs

@@ -76,7 +76,13 @@ export default tseslint.config(
          Existing rule you had
          =========================== */
 
-      '@typescript-eslint/no-explicit-any': 'off'
+      '@typescript-eslint/no-explicit-any': 'off',
+
+      'padding-line-between-statements': [
+        'error',
+        { blankLine: 'never', prev: 'if', next: '*' },
+        { blankLine: 'never', prev: '*', next: 'if' }
+      ]
     }
   }
 )

example/middleware.ts

@@ -27,7 +27,6 @@ export function rateLimitMiddleware(
     const ip = req.ip
     const now = Date.now()
     const record = requestCounts.get(ip!)
-
     if (!record || now > record.resetTime) {
       requestCounts.set(ip!, {
         count: 1,
@@ -36,15 +35,13 @@ export function rateLimitMiddleware(
       next()
       return
     }
-
     if (record.count >= maxRequests) {
       res.status(429).json({
         error: 'Too Many Requests',
         retryAfter: Math.ceil((record.resetTime - now) / 1_000)
       })
       return
     }
-
     record.count++
     next()
   }

src/controller.ts

@@ -104,7 +104,6 @@ export function addController(
       )
       continue // skip
     }
-
     let hasSuccessResponse = false
     const returnType = method.getReturnType()
 
@@ -168,7 +167,6 @@ export function addController(
         }
       }
     }
-
     // Add default success response
     if (!hasSuccessResponse) {
       if (
@@ -190,7 +188,6 @@ export function addController(
         }
       }
     }
-
     // We use another array for codegen parameters instead of operation.parameters
     // because we want to have Request() and Body() in the codegen one
     // to send it to the method at runtime
@@ -328,7 +325,6 @@ export function addController(
 
     // Security
     operation.security = [...controllerSecurities, ...getSecurities(method)]
-
     // OperationId
     if (method.getDecorator('OperationId')) {
       operation.operationId = extractDecoratorValues(
@@ -338,12 +334,10 @@ export function addController(
       const name = method.getName()
       operation.operationId = name.charAt(0).toUpperCase() + name.slice(1)
     }
-
     // Deprecated
     if (method.getDecorator('Deprecated')) {
       operation.deprecated = true
     }
-
     // Add to spec + codegen
     const isHidden =
       typeof (

src/index.ts

@@ -148,7 +148,6 @@ export async function generate(config: OpenAPIConfiguration) {
   if (typeof config.openapi.securitySchemes !== 'undefined') {
     spec.components!.securitySchemes = config.openapi.securitySchemes
   }
-
   // Codegen object
   const codegenControllers: CodeGenControllers = {}
   const controllersPathByName: Record<string, string> = {}
@@ -215,7 +214,6 @@ export async function generate(config: OpenAPIConfiguration) {
       spec.components!.schemas![name] = resolved
     }
   }
-
   // Export all responses
   if (
     typeof config.openapi.outputErrorsToDescription !== 'undefined' &&
@@ -327,7 +325,6 @@ export async function generate(config: OpenAPIConfiguration) {
       rows.map(row => `| ${row.join(' | ')} |`).join('\n')
     spec.info.description = `# Errors\n${markdown}`
   }
-
   // Write OpenAPI file(s)
   const jsonContent = JSON.stringify(spec, null, '\t')
 
@@ -339,7 +336,6 @@ export async function generate(config: OpenAPIConfiguration) {
   // Process each file path
   for (const filePath of filePaths) {
     const resolvedPath = path.resolve(root, filePath)
-
     // Determine format based on file extension
     if (
       filePath.toLowerCase().endsWith('.yaml') ||

src/resolve.ts

@@ -304,7 +304,6 @@ export function resolve(
       // For other and anonymous types, don't use ref
       return resolveObjectType(type, spec)
     }
-
     // Add to spec components if not already resolved
     // tslint:disable-next-line: strict-type-predicates
     if (typeof spec.components!.schemas![typeName] === 'undefined') {
@@ -451,11 +450,9 @@ function resolveProperties(
     // OpenAPI don't want the required[] prop if it's empty
     delete result.required
   }
-
   // Check for index signatures regardless of whether explicit properties exist
   const stringIndexType = type.getStringIndexType()
   const numberIndexType = type.getNumberIndexType()
-
   // Handle mapped types and objects with index signatures (ex: { [key: string]: any } or Record<string, any>)
   if (
     (typeof stringIndexType !== 'undefined' &&
@@ -474,7 +471,6 @@ function resolveProperties(
     // Check if the type represents a Record-like structure that should have additionalProperties
     const typeSymbol = type.getSymbol()
     const typeText = type.getText()
-
     // Handle cases where the type might be a transformed Record type
     if (typeSymbol?.getName() === '__type' || typeText.includes('Record<')) {
       // For anonymous types that might be transformed Record types,
@@ -485,7 +481,6 @@ function resolveProperties(
       if (apparentType && apparentType !== type) {
         const apparentStringIndexType = apparentType.getStringIndexType()
         const apparentNumberIndexType = apparentType.getNumberIndexType()
-
         if (
           (typeof apparentStringIndexType !== 'undefined' &&
             apparentStringIndexType.getText() !== 'never') ||
@@ -500,7 +495,6 @@ function resolveProperties(
       }
     }
   }
-
   return result
 }
 
@@ -530,7 +524,6 @@ function resolveMappedObjectType(
     const omittedKeys = typeArguments[1].isUnion()
       ? typeArguments[1].getUnionTypes().map(t => String(t.getLiteralValue()))
       : [String(typeArguments[1].getLiteralValue())]
-
     if (helperName === 'Omit' && omittedKeys.includes('toJSON')) {
       // If we're omitting toJSON, don't follow it to avoid infinite loops
       shouldSkipToJSON = true
@@ -539,22 +532,19 @@ function resolveMappedObjectType(
       shouldSkipToJSON = true
     }
   }
-
   // Check if the subject type has a toJSON method
   const toJSONProperty = subjectType.getProperty('toJSON')
   if (toJSONProperty && !shouldSkipToJSON) {
     const node = getDeclarationForProperty(subjectType, toJSONProperty) as
       | MethodDeclaration
       | MethodSignature
     const toJSONReturnType = resolve(node.getReturnType(), spec)
-
     // Apply mapped type transformation to the toJSON return type
     if ('$ref' in toJSONReturnType) {
       // For reference types, we need to create a new schema with the transformation applied
       // This is more complex, so for now we'll fall back to normal resolution
       return resolveObjectType(type, spec)
     }
-
     if (toJSONReturnType.type === 'object' && toJSONReturnType.properties) {
       const transformedSchema = { ...toJSONReturnType }
 
@@ -571,7 +561,6 @@ function resolveMappedObjectType(
       return transformedSchema
     }
   }
-
   // Fall back to normal object resolution if no toJSON or transformation failed
   return resolveObjectType(type, spec)
 }
@@ -582,7 +571,6 @@ function resolveMappedObjectType(
 function hasInterfaceInheritance(type: Type): boolean {
   const symbol = type.getSymbol()
   if (!symbol) return false
-
   const declarations = symbol.getDeclarations()
 
   return declarations.some(
@@ -599,13 +587,11 @@ function getBaseInterfaces(
 ): OpenAPIV3.ReferenceObject[] {
   const symbol = type.getSymbol()
   if (!symbol) return []
-
   const baseRefs: OpenAPIV3.ReferenceObject[] = []
   const declarations = symbol.getDeclarations()
 
   for (const decl of declarations) {
     if (!Node.isInterfaceDeclaration(decl)) continue
-
     const extendsExpressions = decl.getExtends()
     for (const extendsExpr of extendsExpressions) {
       const baseType = extendsExpr.getType()
@@ -631,17 +617,14 @@ function getOwnInterfaceProperties(
     // Fallback to normal property resolution
     return resolveProperties(type, spec)
   }
-
   const declarations = symbol.getDeclarations()
   const interfaceDecl = declarations.find(decl =>
     Node.isInterfaceDeclaration(decl)
   )
-
   if (!interfaceDecl) {
     // Fallback to normal property resolution
     return resolveProperties(type, spec)
   }
-
   const result: ResolvePropertiesReturnType = {
     properties: {},
     required: []
@@ -675,7 +658,6 @@ function getOwnInterfaceProperties(
     // Handle JSDoc tags
     const jsDocTags = propSig.getSymbol()?.compilerSymbol.getJsDocTags() ?? []
     appendJsDocTags(jsDocTags, resolvedType)
-
     // Add to properties
     if (
       !('type' in resolvedType && (resolvedType.type as any) === 'undefined')
@@ -686,14 +668,11 @@ function getOwnInterfaceProperties(
       }
     }
   }
-
   // Handle method signatures (but ignore them like in resolveProperties)
   // Methods are already filtered out by only looking at property signatures
-
   if (result.required!.length === 0) {
     delete result.required
   }
-
   return result
 }
 
@@ -719,31 +698,26 @@ function resolveObjectType(
       | MethodSignature
     return resolve(node.getReturnType(), spec)
   }
-
   // Check for interface inheritance
   if (!hasInterfaceInheritance(type)) {
     return {
       type: 'object',
       ...resolveProperties(type, spec)
     }
   }
-
   const baseRefs = getBaseInterfaces(type, spec)
-
   // If there are no base interfaces, fall back to normal resolution
   if (baseRefs.length === 0) {
     return {
       type: 'object',
       ...resolveProperties(type, spec)
     }
   }
-
   // Shallow copy to avoid mutating the original baseRefs array
   const allOfElements = Array.from<
     OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject
   >(baseRefs)
   const ownProps = getOwnInterfaceProperties(type, spec)
-
   // Add own properties if any exist
   if (
     Object.keys(ownProps.properties).length > 0 ||
@@ -754,7 +728,6 @@ function resolveObjectType(
       ...ownProps
     })
   }
-
   return {
     allOf: allOfElements
   }
@@ -823,7 +796,6 @@ export function appendJsDocTags(
     if (!supportedTags.includes(tag.name) || !tag.text) {
       continue
     }
-
     const textValue = tag.text.map(t => t.text).join('\n')
     const value = numericTags.includes(tag.name)
       ? parseFloat(textValue)
@@ -845,7 +817,6 @@ export function appendInitializer(
   // Default value
   const initializer = node.getInitializer()
   const initializerType = initializer?.getType()
-
   if (initializerType?.isLiteral()) {
     const initializerLiteralType = initializerType.compilerType as
       | ts.StringLiteralType