feat: add pino-logger package (#14)

Author: KagChi

package.json

@@ -63,6 +63,7 @@
     "@sapphire/decorators": "^4.3.4",
     "@sapphire/framework": "next",
     "@sapphire/pieces": "^3.3.1",
-    "discord.js": "^13.6.0"
+    "discord.js": "^13.6.0",
+    "pino-pretty": "^7.6.1"
   }
 }

packages/pino-logger/.npmignore

@@ -0,0 +1,42 @@
+# Ignore a blackhole and the folder for development
+node_modules/
+.vs/
+.idea/
+*.iml
+coverage/
+docs/
+
+# Yarn files
+.yarn/install-state.gz
+.yarn/build-state.yml
+
+
+# Ignore JavaScript files
+**/*.tsbuildinfo
+!jest.config.ts
+
+# Ignore heapsnapshot and log files
+*.heapsnapshot
+*.log
+
+# Ignore package locks
+package-lock.json
+
+# Ignore the GH cli downloaded by workflows
+gh
+
+# Ignore the "wiki" folder so we can checkout the wiki inside the same folder
+wiki/
+
+# Additional ignore
+test.js
+.github
+.gitignore
+tsconfig.json
+src/
+.eslintrc
+.swc
+.gitattributes
+build.config.ts
+tsconfig.eslint.json
+.turbo

packages/pino-logger/LICENSE

@@ -0,0 +1,66 @@
+# @zhycorporg/pino-logger
+> Plugin for @sapphire/framework to have pino logger
+
+# Instalation 
+```
+npm install @sapphire/framework discord.js @zhycorporg/pino-logger
+```
+
+# Example
+```ts
+import { SapphireClient, SapphireClientOptions } from "@sapphire/framework";
+import { Intents } from "discord.js";
+import { join } from "node:path";
+import "@zhycorporg/pino-logger/register";
+
+class TestClient extends SapphireClient {
+    public constructor(clientOptions?: SapphireClientOptions) {
+        super({
+            fetchPrefix: () => "t!",
+            intents: [
+                Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES
+            ],
+            logger: {
+                pino: {
+                    timestamp: true
+                }
+            },
+            loadMessageCommandListeners: true,
+            baseUserDirectory: join(__dirname),
+            ...clientOptions
+        });
+    }
+}
+```
+
+# Example with pino-pretty
+```ts
+import { SapphireClient, SapphireClientOptions } from "@sapphire/framework";
+import { Intents } from "discord.js";
+import { join } from "node:path";
+import "@zhycorporg/pino-logger/register";
+
+class TestClient extends SapphireClient {
+    public constructor(clientOptions?: SapphireClientOptions) {
+        super({
+            fetchPrefix: () => "t!",
+            intents: [
+                Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES
+            ],
+            logger: {
+                pino: {
+                    timestamp: true,
+                    transport: {
+                        targets: [
+                            { target: "pino-pretty", level: "info", options: { translateTime: "SYS:yyyy-mm-dd HH:MM:ss.l o" } }
+                        ]
+                    }
+                }
+            },
+            loadMessageCommandListeners: true,
+            baseUserDirectory: join(__dirname),
+            ...clientOptions
+        });
+    }
+}
+```

packages/pino-logger/README.md

@@ -0,0 +1,14 @@
+import type { Config } from "@jest/types";
+
+export default async (): Promise<Config.InitialOptions> => ({
+	displayName: "unit test",
+	preset: "ts-jest",
+	testEnvironment: "node",
+	testRunner: "jest-circus/runner",
+	testMatch: ["<rootDir>/tests/**/*.test.ts"],
+	globals: {
+		"ts-jest": {
+			tsconfig: "<rootDir>/tests/tsconfig.json"
+		}
+	}
+});

packages/pino-logger/jest.config.ts

@@ -0,0 +1,67 @@
+{
+    "name": "@zhycorporg/pino-logger",
+    "description": "Plugin for @sapphire/framework to have pino logger",
+    "author": "Zhycorp <[email protected]>",
+    "version": "1.0.0",
+    "main": "dist/index.js",
+    "module": "dist/index.mjs",
+    "exports": {
+        ".": {
+            "import": "./dist/index.mjs",
+            "require": "./dist/index.js"
+        },
+        "./register": {
+			"import": "./dist/register.mjs",
+			"require": "./dist/register.js",
+			"types": "./dist/register.d.ts"
+		}
+    },
+    "files": [
+        "dist/**/*.js*",
+        "dist/**/*.mjs*",
+        "dist/**/*.d*"
+    ],
+    "license": "AGPL-3.0",
+    "homepage": "https://github.com/zhycorp/sapphire-plugins/tree/main/packages/pino-logger",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/zhycorp/sapphire-plugins.git",
+        "directory": "packages/command-context"
+    },
+    "bugs": {
+        "url": "https://github.com/zhycorp/sapphire-plugins/issues"
+    },
+    "readme": "https://github.com/zhycorp/sapphire-plugins/blob/main/README.md",
+    "engines": {
+        "node": ">=16.6.0",
+        "npm": ">=7.0.0"
+    },
+    "eslintConfig": {
+        "extends": "@hazmi35/eslint-config/typescript",
+        "ignorePatterns": [
+            "dist/*",
+            "jest.config.ts",
+            "rollup.bundle.ts"
+        ],
+        "parserOptions": {
+            "project": "./tsconfig.eslint.json"
+        }
+    },
+    "scripts": {
+        "build": "rimraf dist && tsc -b src && rollup -c rollup.bundle.ts && npm run esm:default",
+        "esm:default": "gen-esm-wrapper dist/index.js dist/index.mjs",
+        "lint": "eslint src tests --ext ts",
+        "lint:fix": "eslint src tests --fix --ext ts",
+        "format": "prettier --write {src,tests}/**/*.ts",
+        "prepareForRelease": "npm run build && npm run format && npm run lint && npm run lint:fix",
+        "test": "jest",
+        "release": "npm publish --access public"
+    },
+    "devDependencies": {
+        "gen-esm-wrapper": "^1.1.3",
+        "typescript": "4.6.4"
+    },
+    "dependencies": {
+        "pino": "^7.11.0"
+    }
+}

packages/pino-logger/package.json

@@ -0,0 +1,12 @@
+import versionInjector from "rollup-plugin-version-injector";
+
+export default {
+	input: "dist/index.js",
+	output: [
+		{
+			file: "./dist/index.js",
+			format: "cjs"
+		}
+	],
+	plugins: [versionInjector()]
+};

packages/pino-logger/rollup.bundle.ts

@@ -0,0 +1 @@
+export * from "./lib/PinoLogger";

packages/pino-logger/src/index.ts

@@ -0,0 +1,43 @@
+/* eslint-disable class-methods-use-this */
+/* eslint-disable @typescript-eslint/consistent-type-imports */
+import type { ILogger } from "@sapphire/framework";
+import pino, { LoggerOptions, Logger } from "pino";
+
+export class PinoLogger implements ILogger {
+    protected pino: Logger;
+    public constructor(options: LoggerOptions) {
+        this.pino = pino(options);
+    }
+
+    public trace(...values: readonly [unknown]): void {
+        this.pino.trace(...values);
+    }
+
+    public debug(...values: readonly [unknown]): void {
+        this.pino.debug(...values);
+    }
+
+    public info(...values: readonly [unknown]): void {
+        this.pino.info(...values);
+    }
+
+    public warn(...values: readonly [unknown]): void {
+        this.pino.warn(...values);
+    }
+
+    public error(...values: readonly [unknown]): void {
+        this.pino.error(...values);
+    }
+
+    public fatal(...values: readonly [unknown]): void {
+        this.pino.fatal(...values);
+    }
+
+    public has(): boolean {
+        return true;
+    }
+
+    public write(): void {
+        throw new Error("Method is not implemented.");
+    }
+}

packages/pino-logger/src/lib/PinoLogger.ts

@@ -0,0 +1,22 @@
+/* eslint-disable @typescript-eslint/no-empty-interface */
+/* eslint-disable @typescript-eslint/explicit-function-return-type */
+/* eslint-disable @typescript-eslint/consistent-type-imports */
+import { Plugin, preGenericsInitialization, SapphireClient } from "@sapphire/framework";
+import type { ClientOptions } from "discord.js";
+import type { LoggerOptions } from "pino";
+import { PinoLogger } from "./lib/PinoLogger";
+
+export class PinoLoggerPlugin extends Plugin {
+    public static [preGenericsInitialization](this: SapphireClient, options: ClientOptions) {
+        options.logger ??= { pino: { } };
+        options.logger.instance = new PinoLogger(options.logger.pino);
+    }
+}
+
+declare module "@sapphire/framework" {
+    export interface ClientLoggerOptions {
+        pino: LoggerOptions;
+    }
+}
+
+SapphireClient.plugins.registerPreGenericsInitializationHook(PinoLoggerPlugin[preGenericsInitialization], "PinoLogger-PreGenericsInitialization");