feat: add log when directory does not exists (#273)

* feat: add log when directory does not exists

Signed-off-by: n4n5 <[email protected]>

* fmt

* lint

* add a comment for disabling the lint

---------

Signed-off-by: n4n5 <[email protected]>

Author: Its-Just-Nans

src/serve-static.ts

@@ -1,7 +1,7 @@
 import type { Context, Env, MiddlewareHandler } from 'hono'
 import { getMimeType } from 'hono/utils/mime'
 import type { ReadStream, Stats } from 'node:fs'
-import { createReadStream, lstatSync } from 'node:fs'
+import { createReadStream, lstatSync, existsSync } from 'node:fs'
 import { join } from 'node:path'
 
 export type ServeStaticOptions<E extends Env = Env> = {
@@ -59,6 +59,10 @@ export const serveStatic = <E extends Env = any>(
   const root = options.root || ''
   const optionPath = options.path
 
+  if (root !== '' && !existsSync(root)) {
+    console.error(`serveStatic: root path '${root}' is not found, are you sure it's correct?`)
+  }
+
   return async (c, next) => {
     // Do nothing if Response is already set
     if (c.finalized) {

test/serve-static.test.ts

@@ -325,3 +325,27 @@ describe('Serve Static Middleware', () => {
     })
   })
 })
+
+describe('Serve Static Middleware with wrong path', () => {
+  it('Should show an error when the path is wrong', async () => {
+    const logSpy = jest.spyOn(console, 'error')
+
+    const app = new Hono<{
+      Variables: {
+        path: string
+      }
+    }>()
+
+    app.use(
+      '*',
+      serveStatic({
+        root: './public',
+      })
+    )
+
+    expect(logSpy).toHaveBeenCalledWith(
+      // eslint-disable-next-line quotes
+      "serveStatic: root path './public' is not found, are you sure it's correct?"
+    )
+  })
+})