feat(3.0): convert src code to ESM

Author: tduyng

src/index.ts

@@ -8,10 +8,9 @@ import type {
     LoggerMethods,
     NameSpaceConfig,
     OutputAdapter,
-} from './definitions'
-
-import * as outputs from './output_adapters'
-import * as outputUtils from './output_utils'
+} from './definitions.js'
+import * as outputs from './output_adapters.js'
+import * as outputUtils from './output_utils.js'
 
 /************* LOCAL STATE *************/
 const defaultConfig: Readonly<LoggerConfig> = {
@@ -23,7 +22,7 @@ const defaultConfig: Readonly<LoggerConfig> = {
     globalContext: {},
 }
 
-const mutableConfig: LoggerConfig = {
+const sharedConfig: LoggerConfig = {
     ...defaultConfig,
 }
 
@@ -92,7 +91,7 @@ const parseNamespace = (namespace: string): NameSpaceConfig | undefined => {
 export const createLogger = (
     namespace = '',
     canForceWrite = false,
-    config = mutableConfig
+    config = sharedConfig
 ): Logger => {
     if (config.loggers[namespace]) return config.loggers[namespace]
 
@@ -158,7 +157,7 @@ export const id = (): string => uuidv4()
 /**
  * Define enabled / disabled namespaces
  */
-export const setNamespaces = (namespaceStr: string, config = mutableConfig): void => {
+export const setNamespaces = (namespaceStr: string, config = sharedConfig): void => {
     config.namespaces = namespaceStr
         .split(',')
         .map(parseNamespace)
@@ -168,7 +167,7 @@ export const setNamespaces = (namespaceStr: string, config = mutableConfig): voi
 /**
  * Change log level
  */
-export const setLevel = (level: LogLevel, config = mutableConfig): void => {
+export const setLevel = (level: LogLevel, config = sharedConfig): void => {
     const levelIndex = config.levels.indexOf(level)
     if (levelIndex === -1) throw new Error(`Invalid log level: ${level}`)
     config.level = levelIndex
@@ -179,7 +178,7 @@ export const setLevel = (level: LogLevel, config = mutableConfig): void => {
  */
 export const setOutput = (
     outputAdapters: OutputAdapter[] | OutputAdapter,
-    config = mutableConfig
+    config = sharedConfig
 ): void => {
     config.outputs = Array.isArray(outputAdapters) ? outputAdapters : [outputAdapters]
 }
@@ -190,10 +189,7 @@ export const setOutput = (
  * Be warned this context will be added to all logs,
  * even those from third party libraries if they use this module.
  */
-export const setGlobalContext = (
-    context: Record<string, unknown>,
-    config = mutableConfig
-): void => {
+export const setGlobalContext = (context: Record<string, unknown>, config = sharedConfig): void => {
     config.globalContext = { ...context }
 }
 
@@ -205,7 +201,7 @@ setNamespaces(namespaces)
 setLevel(logLevel)
 
 /************* EXPORT *************/
-export * from './definitions'
+export * from './definitions.js'
 export { outputUtils, outputs }
 export default {
     createLogger,

src/output_adapters.ts

@@ -1,8 +1,8 @@
-const prettyOutput = require('prettyoutput')
 import { Writable } from 'node:stream'
-import { colors } from './colors'
-import type { Log, LogColor, LogLevel, Output } from './definitions'
-import { stringifyLog } from './output_utils'
+import prettyOutput from 'prettyoutput'
+import { colors } from './colors.js'
+import type { Log, LogColor, LogLevel, Output } from './definitions.js'
+import { stringifyLog } from './output_utils.js'
 
 /**
  * Object mapping log color and log level

src/output_utils.ts

@@ -1,5 +1,5 @@
-import type { ReplacerFunction } from './definitions'
-import { fastStringifyLog } from './json_schema'
+import type { ReplacerFunction } from './definitions.js'
+import { fastStringifyLog } from './json_schema.js'
 
 /**
  * Replace circular reference when used with JSON.stringify
@@ -33,7 +33,8 @@ export const stringifyLog = (log: Record<string, unknown>): string => {
 export const isObject = (val: unknown): val is Record<string, unknown> =>
     !!val && typeof val === 'object' && !Array.isArray(val)
 
-export const memoize = <T extends (...args: unknown[]) => unknown>(fn: T): T => {
+// biome-ignore lint/suspicious/noExplicitAny: <explanation>
+export const memoize = <T extends (...args: any[]) => unknown>(fn: T): T => {
     const cache = new Map<string, ReturnType<T>>()
     return ((...args: unknown[]) => {
         const key = JSON.stringify(args)

src/types/global.d.ts

@@ -0,0 +1,6 @@
+declare namespace NodeJS {
+    interface ProcessEnv {
+        LOGS?: string
+        LOG_LEVEL?: string
+    }
+}

src/types/pretty_output.d.ts

@@ -0,0 +1,5 @@
+declare module 'prettyoutput' {
+    const prettyoutput: (input: unknown, opts: Record<string, unknown>, indent?: number) => string
+
+    export = prettyoutput
+}

tsconfig.json

@@ -1,21 +1,31 @@
 {
     "compilerOptions": {
+        "allowJs": true,
+        "allowSyntheticDefaultImports": true,
+        "allowUnreachableCode": false,
+        "declaration": true,
+        "esModuleInterop": true,
+        "forceConsistentCasingInFileNames": true,
         "incremental": true,
+        "lib": ["ES2023", "DOM"],
+        "module": "NodeNext",
+        "moduleResolution": "NodeNext",
+        "noErrorTruncation": true,
+        "noFallthroughCasesInSwitch": true,
         "noImplicitAny": true,
-        "allowJs": true,
-        "target": "es2019",
-        "module": "commonjs",
-        "lib": ["es2020"],
-        "alwaysStrict": true,
-        "skipLibCheck": true,
-        "noUnusedParameters": false,
-        "noUnusedLocals": false,
-        "strictNullChecks": true,
+        "noImplicitOverride": true,
+        "noImplicitReturns": true,
+        "noPropertyAccessFromIndexSignature": true,
         "noUncheckedIndexedAccess": true,
-        "esModuleInterop": true,
-        "allowSyntheticDefaultImports": true,
-        "forceConsistentCasingInFileNames": true
+        "noUnusedLocals": true,
+        "noUnusedParameters": true,
+        "outDir": "./lib",
+        "skipLibCheck": true,
+        "sourceMap": true,
+        "strict": true,
+        "target": "ES2020",
+        "typeRoots": ["./node_modules/@types", "src/types"]
     },
-    "include": ["src/**/*", "test/**/*.ts"],
+    "include": ["src/**/*", "test/**/*.ts", "examples/**/*.ts"],
     "exclude": []
 }

tsconfig.lib.json

@@ -1,9 +1,7 @@
 {
     "extends": "./tsconfig.json",
     "compilerOptions": {
-        "declaration": true,
-        "outDir": "lib",
-        "sourceMap": true
+        "declaration": true
     },
     "include": ["src/**/*.ts"]
 }