chore: Updated dependencies and linted code.

Author: ShogunPanda

package.json

@@ -45,10 +45,10 @@
     "swagger-ui-dist": "^4.0.0-beta.4"
   },
   "devDependencies": {
-    "@cowtech/eslint-config": "^7.14.5",
-    "@cowtech/esm-package-utils": "^0.9.1",
+    "@cowtech/eslint-config": "^8.0.1",
+    "@cowtech/esm-package-utils": "^0.9.3",
     "@types/js-yaml": "^4.0.2",
-    "@types/node": "^16.6.1",
+    "@types/node": "^17.0.2",
     "@types/swagger-ui-dist": "^3.30.1",
     "@types/tap": "^15.0.5",
     "c8": "^7.8.0",

src/index.ts

@@ -47,12 +47,12 @@ export const plugin = fastifyPlugin(
     })
 
     // Utility to track all the RouteOptions we add
-    instance.addHook('onRoute', (route: RouteOptions) => {
+    instance.addHook('onRoute', route => {
       routes.push(route)
     })
 
     // When the server starts, add all schemas and routes to the spec
-    instance.addHook('onReady', (done: () => void) => {
+    instance.addHook('onReady', done => {
       spec = buildSpec(instance, spec, instance.getSchemas() as { [key: string]: Schema }, routes)
       done()
     })

src/spec.ts

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-floating-promises */
 import { FastifyInstance, FastifySchema, RouteOptions } from 'fastify'
 
 interface RouteConfig {
@@ -118,14 +117,14 @@ function cleanSpec(object: Schema): Schema {
 
       // Check if there is a multiple type defined - Replace with anyOf since OpenAPI does not support type arrays
       if (Array.isArray(cleanedValue.type)) {
-        cleanedValue.anyOf = cleanedValue.type.map((t: string) => ({ type: t }))
+        cleanedValue.anyOf = cleanedValue.type.map(t => ({ type: t }))
         delete cleanedValue.type
       }
 
       cleaned[key] = cleanedValue
     } else if (Array.isArray(value)) {
       // Recurse into array
-      cleaned[key] = value.map((item: Schema) => (typeof item === 'object' ? cleanSpec(item) : item))
+      cleaned[key] = value.map(item => (typeof item === 'object' ? cleanSpec(item) : item))
     } else {
       // Return other properties unchanged
       cleaned[key] = value
@@ -160,9 +159,7 @@ export function buildSpec(
   }
 
   // Get the visible routes and sort them
-  const apiRoutes = routes
-    .filter((r: RouteOptions) => getRouteConfig(r).hide !== true)
-    .sort((a: RouteOptions, b: RouteOptions) => a.url.localeCompare(b.url))
+  const apiRoutes = routes.filter(r => getRouteConfig(r).hide !== true).sort((a, b) => a.url.localeCompare(b.url))
 
   // For each route
   for (const route of apiRoutes) {
@@ -176,7 +173,7 @@ export function buildSpec(
 
     // Sort available methods
     const methods = (Array.isArray(route.method) ? route.method : [route.method]).sort(
-      (a: string, b: string) => methodsOrder.indexOf(a) - methodsOrder.indexOf(b)
+      (a, b) => methodsOrder.indexOf(a) - methodsOrder.indexOf(b)
     )
 
     // Get OpenAPI supported tags

src/ui.ts

@@ -33,7 +33,7 @@ export function addUI(instance: FastifyInstance, prefix: string): void {
   // This hook is required because we have to serve the patched index file in order to point to the local documentation
   // eslint-disable-next-line no-useless-escape
   const indexUrl = new RegExp(`^(?:${prefix.replace(/\//g, '\\/')}\/(?:index\.html)?)$`)
-  instance.addHook('preHandler', (request: FastifyRequest, reply: FastifyReply, done: () => void) => {
+  instance.addHook('preHandler', (request, reply, done) => {
     if (request.raw.url!.match(indexUrl)) {
       reply.header('Content-Type', 'text/html; charset=UTF-8')
       reply.send(swaggerUIRootIndex)

test/spec.test.ts

@@ -1,12 +1,9 @@
-/* eslint-disable no-useless-escape */
 /* eslint-disable @typescript-eslint/no-floating-promises */
 
 import fastify, { FastifyReply, FastifyRequest } from 'fastify'
 import t from 'tap'
 import { plugin as fastifyOpenApiDocs } from '../src'
 
-type Test = typeof t
-
 const openapi = {
   // All these fields are optional, but they should be provided to satisfy OpenAPI specification.
   openapi: '3.0.3',
@@ -40,8 +37,8 @@ const openapi = {
   }
 }
 
-t.test('Spec generation', (t: Test) => {
-  t.test('should correctly generate a OpenAPI spec in JSON and YAML format', async (t: Test) => {
+t.test('Spec generation', t => {
+  t.test('should correctly generate a OpenAPI spec in JSON and YAML format', async t => {
     const server = fastify()
 
     server.register(fastifyOpenApiDocs, { openapi })
@@ -274,7 +271,7 @@ paths:
     })
   })
 
-  t.test('should accept routes with no OpenAPI annotations and hide routes', async (t: Test) => {
+  t.test('should accept routes with no OpenAPI annotations and hide routes', async t => {
     const server = fastify()
 
     server.register(fastifyOpenApiDocs, {
@@ -442,7 +439,7 @@ paths:
     })
   })
 
-  t.test('should accept routes with no schema', async (t: Test) => {
+  t.test('should accept routes with no schema', async t => {
     const server = fastify()
 
     server.register(fastifyOpenApiDocs, {})
@@ -479,7 +476,7 @@ paths:
     })
   })
 
-  t.test('should resolve $ref in params', async (t: Test) => {
+  t.test('should resolve $ref in params', async t => {
     const server = fastify()
 
     server.register(fastifyOpenApiDocs, {})
@@ -520,7 +517,7 @@ paths:
     })
   })
 
-  t.test('should recognized $raw and $empty', async (t: Test) => {
+  t.test('should recognized $raw and $empty', async t => {
     const server = fastify()
 
     server.register(fastifyOpenApiDocs, {})
@@ -569,7 +566,7 @@ paths:
     })
   })
 
-  t.test('should replace multiple types with anyOf', async (t: Test) => {
+  t.test('should replace multiple types with anyOf', async t => {
     const server = fastify()
 
     server.register(fastifyOpenApiDocs, {})

test/ui.test.ts

@@ -1,14 +1,11 @@
-/* eslint-disable no-useless-escape */
 /* eslint-disable @typescript-eslint/no-floating-promises */
 
 import fastify from 'fastify'
 import t from 'tap'
 import { plugin as fastifyOpenApiDocs } from '../src'
 
-type Test = typeof t
-
-t.test('UI serving', (t: Test) => {
-  t.test('should serve the UI by default', async (t: Test) => {
+t.test('UI serving', t => {
+  t.test('should serve the UI by default', async t => {
     const server = fastify()
 
     server.register(fastifyOpenApiDocs, {})
@@ -24,7 +21,7 @@ t.test('UI serving', (t: Test) => {
     t.equal(defaultBody, indexBody)
   })
 
-  t.test('should not serve the UI if requested to', async (t: Test) => {
+  t.test('should not serve the UI if requested to', async t => {
     const server = fastify()
 
     server.register(fastifyOpenApiDocs, { skipUI: true })
@@ -41,7 +38,7 @@ t.test('UI serving', (t: Test) => {
     t.equal(indexBody, '{"message":"Route GET:/docs/index.html not found","error":"Not Found","statusCode":404}')
   })
 
-  t.test('should respect the right prefix', async (t: Test) => {
+  t.test('should respect the right prefix', async t => {
     const server = fastify()
 
     server.register(fastifyOpenApiDocs, { prefix: 'another' })
@@ -57,7 +54,7 @@ t.test('UI serving', (t: Test) => {
     t.equal(defaultBody, indexBody)
   })
 
-  t.test('should allow multiple instances', async (t: Test) => {
+  t.test('should allow multiple instances', async t => {
     const server = fastify()
 
     server.register(fastifyOpenApiDocs, { prefix: 'v1' })