Enable ts strict mode in core-logger

unchainedshop · Oct 28, 2023 · b70bd52 · b70bd52
1 parent 3b37da9
commit b70bd52
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 5 deletions.
diff --git a/packages/logger/src/createLogger.ts b/packages/logger/src/createLogger.ts
@@ -6,10 +6,23 @@ import { LogLevel } from './logger.types.js';
 const require = createRequire(import.meta.url);
 const { stringify } = require('safe-stable-stringify');
 
-const { DEBUG = '', LOG_LEVEL = LogLevel.Info, UNCHAINED_LOG_FORMAT = 'unchained' } = process.env;
+enum SupportedLogFormats {
+  'unchained',
+  'json',
+}
 
-const { combine, colorize, json } = format;
+const {
+  DEBUG = '',
+  LOG_LEVEL = LogLevel.Info,
+  UNCHAINED_LOG_FORMAT = 'unchained',
+} = process.env as unknown as {
+  DEBUG?: string;
+  LOG_LEVEL: LogLevel;
+  UNCHAINED_LOG_FORMAT: SupportedLogFormats;
+};
 
+const { combine, colorize, json } = format;
+const logFormat = (UNCHAINED_LOG_FORMAT as string).toLowerCase();
 const debugStringContainsModule = (debugString: string, moduleName: string) => {
   if (!debugString) return false;
   const loggingMatched = debugString.split(',').reduce((accumulator: any, name: string) => {
@@ -40,12 +53,12 @@ const myFormat = format.printf(({ level, message, label, timestamp, stack, ...re
     .join(' ');
 });
 
-const UnchainedLogFormats = {
+const UnchainedLogFormats: { [key: string]: ReturnType<typeof json | typeof combine> } = {
   unchained: combine(colorize(), myFormat),
   json: json(),
 };
 
-if (!UnchainedLogFormats[UNCHAINED_LOG_FORMAT.toLowerCase()]) {
+if (!UnchainedLogFormats[logFormat]) {
   throw new Error(
     `UNCHAINED_LOG_FORMAT is invalid, use one of ${Object.keys(UnchainedLogFormats).join(',')}`,
   );
@@ -63,7 +76,7 @@ export const createLogger = (moduleName: string, moreTransports: Array<Transport
     ),
     transports: [
       new transports.Console({
-        format: UnchainedLogFormats[UNCHAINED_LOG_FORMAT],
+        format: UnchainedLogFormats[logFormat],
         stderrLevels: [LogLevel.Error],
         consoleWarnLevels: [LogLevel.Warning],
         level: loggingMatched ? LogLevel.Debug : LOG_LEVEL,

diff --git a/packages/logger/tsconfig.json b/packages/logger/tsconfig.json
@@ -1,6 +1,7 @@
 {
   "extends": "../shared/base.tsconfig.json",
   "compilerOptions": {
+    "strict": true,
     "rootDir": "src",
     "outDir": "lib",
   },