From 7d4d374ad14c96a1d89935a5b76389dd2d117b8d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E9=AD=94=E7=8E=8B=E5=B0=91=E5=B9=B4?=
 <q267009886.tw@gmail.com>
Date: Fri, 18 Oct 2024 10:46:41 +0800
Subject: [PATCH] Changed the middleware name to pinoLogger

---
 .changeset/five-hairs-reply.md |  5 +++++
 src/index.test.ts              |  6 ++++--
 src/index.ts                   |  2 +-
 src/middleware.test.ts         | 10 +++++-----
 src/middleware.ts              |  8 +++++++-
 5 files changed, 22 insertions(+), 9 deletions(-)
 create mode 100644 .changeset/five-hairs-reply.md

diff --git a/.changeset/five-hairs-reply.md b/.changeset/five-hairs-reply.md
new file mode 100644
index 0000000..9a1d41e
--- /dev/null
+++ b/.changeset/five-hairs-reply.md
@@ -0,0 +1,5 @@
+---
+"hono-pino": patch
+---
+
+Changed the middleware name to `pinoLogger`
diff --git a/src/index.test.ts b/src/index.test.ts
index d5fb643..8bad850 100644
--- a/src/index.test.ts
+++ b/src/index.test.ts
@@ -6,6 +6,8 @@ it("should have exports", () => {
 });
 
 it("should not have undefined exports", () => {
-  for (const k of Object.keys(myPackage))
-    expect(myPackage).not.toHaveProperty(k, undefined);
+  expect(myPackage).toHaveProperty("logger");
+  expect(myPackage).toHaveProperty("pinoLogger");
+  expect(myPackage).toHaveProperty("PinoLogger");
+  expect(myPackage).toHaveProperty("getLogger");
 });
diff --git a/src/index.ts b/src/index.ts
index 14b4838..b86d6c3 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -1,4 +1,4 @@
-export { logger } from "./middleware";
+export { pinoLogger, logger } from "./middleware";
 export { PinoLogger } from "./logger";
 export { getLogger } from "./utils";
 export type { Options, Env } from "./types";
diff --git a/src/middleware.test.ts b/src/middleware.test.ts
index def7b40..09a6326 100644
--- a/src/middleware.test.ts
+++ b/src/middleware.test.ts
@@ -1,6 +1,6 @@
 import { describe, it, expect } from "vitest";
 import { Hono } from "hono";
-import { logger } from "./middleware";
+import { pinoLogger } from "./middleware";
 import type { Options } from "./types";
 import { pino } from "pino";
 import { PinoLogger } from "./logger";
@@ -11,7 +11,7 @@ const createMockApp = (logHttpOpts?: Options["http"]) => {
   const logs: Record<string, any>[] = [];
   const app = new Hono()
     .use(
-      logger({
+      pinoLogger({
         pino: pino(
           { level: "trace", base: null, timestamp: false },
           {
@@ -228,7 +228,7 @@ describe("contextKey option", () => {
 
   it("basic", async () => {
     const app = new Hono()
-      .use(logger())
+      .use(pinoLogger())
       .get("/", async (c) =>
         c.text(c.get("logger") instanceof PinoLogger ? "ok" : "fail", 200),
       );
@@ -240,8 +240,8 @@ describe("contextKey option", () => {
 
   it("multiple logger", async () => {
     const app = new Hono()
-      .use(logger({ contextKey: "logger1" as const, pino: pino1 }))
-      .use(logger({ contextKey: "logger2" as const, pino: pino2 }))
+      .use(pinoLogger({ contextKey: "logger1" as const, pino: pino1 }))
+      .use(pinoLogger({ contextKey: "logger2" as const, pino: pino2 }))
       .get("/", async (c) =>
         c.text(
           c.get("logger1").logger.bindings().name === "pino1" &&
diff --git a/src/middleware.ts b/src/middleware.ts
index d845868..b9b9527 100644
--- a/src/middleware.ts
+++ b/src/middleware.ts
@@ -9,7 +9,7 @@ import type { LiteralString } from "./utils";
 /**
  * Pino logger middleware
  */
-export const logger = <ContextKey extends string = "logger">(
+export const pinoLogger = <ContextKey extends string = "logger">(
   opts?: Options<LiteralString<ContextKey>>,
 ) => {
   const rootLogger = isPino(opts?.pino) ? opts.pino : pino(opts?.pino);
@@ -79,5 +79,11 @@ export const logger = <ContextKey extends string = "logger">(
   });
 };
 
+/**
+ * Pino logger middleware
+ * @deprecated Renamed to pinoLogger
+ */
+export const logger = pinoLogger;
+
 let defaultReqId = 0n;
 const defaultReqIdGenerator = () => (defaultReqId += 1n);