@book000/node-utils 1.2.28 → 1.2.29

package/src/examples/main.ts

@@ -0,0 +1,38 @@
+import { Logger } from '@/logger'
+import { Configuration, exampleConfiguration } from './example-configuration'
+import { exampleLogger } from './example-logger'
+import { exampleDiscord } from './example-discord'
+import fs from 'node:fs'
+import os from 'node:os'
+
+async function main() {
+  const logger = Logger.configure('main')
+  logger.info('Running main()')
+
+  logger.info('Calling exampleLogger()')
+  exampleLogger()
+
+  logger.info('Create dummy configuration file')
+  const config: Configuration = {
+    foo: 'foo',
+    bar: 123,
+  }
+  const temporaryConfigPath = `${os.tmpdir()}/config.json`
+  fs.writeFileSync(temporaryConfigPath, JSON.stringify(config))
+
+  logger.info('Set environment variable')
+  process.env.CONFIG_PATH = temporaryConfigPath
+
+  logger.info('Calling exampleConfiguration()')
+  exampleConfiguration()
+
+  logger.info('Remove dummy configuration file')
+  fs.unlinkSync(temporaryConfigPath)
+
+  logger.info('Calling exampleDiscord()')
+  await exampleDiscord()
+}
+
+;(async () => {
+  await main()
+})()

package/src/index.ts

@@ -0,0 +1,6 @@
+export * from './examples/example-configuration'
+export * from './examples/example-discord'
+export * from './examples/example-logger'
+export * from './configuration'
+export * from './discord'
+export * from './logger'

package/src/logger.ts

@@ -0,0 +1,168 @@
+import winston, { format } from 'winston'
+import WinstonDailyRotateFile from 'winston-daily-rotate-file'
+import { Format } from 'logform'
+import cycle from 'cycle'
+
+/**
+ * ロガーラッパークラス
+ */
+export class Logger {
+  private readonly logger: winston.Logger
+
+  private constructor(logger: winston.Logger) {
+    this.logger = logger
+  }
+
+  /**
+   * デバッグログを出力する
+   *
+   * @param message メッセージ
+   * @param metadata メタデータ
+   */
+  public debug(message: string, metadata?: Record<string, unknown>): void {
+    this.logger.debug(message, metadata || {})
+  }
+
+  /**
+   * 情報ログを出力する
+   *
+   * @param message メッセージ
+   * @param metadata メタデータ
+   */
+  public info(message: string, metadata?: Record<string, unknown>): void {
+    this.logger.info(message, metadata || {})
+  }
+
+  /**
+   * 警告ログを出力する
+   *
+   * @param message メッセージ
+   * @param error エラー
+   */
+  public warn(message: string, error?: Error): void {
+    this.logger.warn(message, error)
+  }
+
+  /**
+   * エラーログを出力する
+   *
+   * @param message メッセージ
+   * @param error エラー
+   */
+  public error(message: string, error?: Error): void {
+    this.logger.error(message, error)
+  }
+
+  /**
+   * ロガーを初期化・設定する
+   *
+   * 環境変数で以下の設定が可能
+   * - LOG_LEVEL: ログレベル (デフォルト info)
+   * - LOG_FILE_LEVEL: ファイル出力のログレベル (デフォルト info)
+   * - LOG_DIR: ログ出力先 (デフォルト logs)
+   * - LOG_FILE_MAX_AGE: ログファイルの最大保存期間 (デフォルト 30d)
+   * - LOG_FILE_FORMAT: ログファイルのフォーマット (デフォルト text)
+   *
+   * @param category カテゴリ
+   * @returns ロガー
+   */
+  public static configure(category: string): Logger {
+    const logLevel = process.env.LOG_LEVEL || 'info'
+    const logFileLevel = process.env.LOG_FILE_LEVEL || 'info'
+    const logDirectory = process.env.LOG_DIR || 'logs'
+    const logFileMaxAge = process.env.LOG_FILE_MAX_AGE || '30d'
+    const selectLogFileFormat = process.env.LOG_FILE_FORMAT || 'text'
+
+    const textFormat = format.printf((info) => {
+      const { timestamp, level, message, ...rest } = info
+      // eslint-disable-next-line unicorn/no-array-reduce
+      const filteredRest = Object.keys(rest).reduce((accumulator, key) => {
+        if (key === 'stack') {
+          return accumulator
+        }
+        return {
+          ...accumulator,
+          [key]: rest[key],
+        }
+      }, {})
+      const standardLine = [
+        '[',
+        timestamp,
+        '] [',
+        category ?? '',
+        category ? '/' : '',
+        level.toLocaleUpperCase(),
+        ']: ',
+        message,
+        Object.keys(filteredRest).length > 0
+          ? ` (${JSON.stringify(filteredRest)})`
+          : '',
+      ].join('')
+      const errorLine = info.stack
+        ? info.stack.split('\n').slice(1).join('\n')
+        : undefined
+
+      return [standardLine, errorLine].filter((l) => l !== undefined).join('\n')
+    })
+    const logFileFormat =
+      selectLogFileFormat === 'ndjson' ? format.json() : textFormat
+    const decycleFormat = format((info) => cycle.decycle(info))
+    const fileFormat = format.combine(
+      ...([
+        format.errors({ stack: true }),
+        selectLogFileFormat === 'ndjson'
+          ? format.colorize({
+              message: true,
+            })
+          : format.uncolorize(),
+        decycleFormat(),
+        format.timestamp({
+          format: 'YYYY-MM-DD hh:mm:ss.SSS',
+        }),
+        logFileFormat,
+      ].filter((f) => f !== undefined) as Format[])
+    )
+    const consoleFormat = format.combine(
+      ...([
+        format.colorize({
+          message: true,
+        }),
+        decycleFormat(),
+        format.timestamp({
+          format: 'YYYY-MM-DD hh:mm:ss.SSS',
+        }),
+        textFormat,
+      ].filter((f) => f !== undefined) as Format[])
+    )
+    const extension = selectLogFileFormat === 'ndjson' ? 'ndjson' : 'log'
+    const transportRotateFile = new WinstonDailyRotateFile({
+      level: logFileLevel,
+      dirname: logDirectory,
+      filename: `%DATE%.` + extension,
+      datePattern: 'YYYY-MM-DD',
+      maxFiles: logFileMaxAge,
+      format: fileFormat,
+      auditFile: `${logDirectory}/audit.json`,
+    })
+
+    const logger = winston.createLogger({
+      transports: [
+        new winston.transports.Console({
+          level: logLevel,
+          format: consoleFormat,
+        }),
+        transportRotateFile,
+      ],
+    })
+    return new Logger(logger)
+  }
+}
+
+process.on('unhandledRejection', (reason) => {
+  const logger = Logger.configure('main')
+  logger.error('unhandledRejection', reason as Error)
+})
+process.on('uncaughtException', (error) => {
+  const logger = Logger.configure('main')
+  logger.error('uncaughtException', error)
+})

package/tsconfig.json

@@ -0,0 +1,32 @@
+{
+  "ts-node": { "files": true },
+  "compilerOptions": {
+    "target": "es2020",
+    "module": "commonjs",
+    "moduleResolution": "Node",
+    "lib": ["ESNext", "esnext.AsyncIterable"],
+    "outDir": "./dist",
+    "removeComments": true,
+    "esModuleInterop": true,
+    "allowJs": true,
+    "checkJs": true,
+    "incremental": true,
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+    "strict": true,
+    "noImplicitAny": true,
+    "strictBindCallApply": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "experimentalDecorators": true,
+    "baseUrl": ".",
+    "newLine": "LF",
+    "paths": {
+      "@/*": ["src/*"]
+    }
+  },
+  "include": ["src/**/*"]
+}