From af321464cf8fccfcd5b45d9528d806141e45ed1f Mon Sep 17 00:00:00 2001 From: Matt Galligan Date: Mon, 1 Sep 2025 16:37:20 -0400 Subject: [PATCH] feat: replace console usage with pino logger and add tightly scoped ignores --- biome.json | 25 +- bun.lock | 81 ++++- packages/core/package.json | 6 +- .../src/interfaces/__tests__/logger.spec.ts | 294 ++++++++++++++++++ packages/core/src/interfaces/logger.ts | 180 ++++++++++- 5 files changed, 563 insertions(+), 23 deletions(-) create mode 100644 packages/core/src/interfaces/__tests__/logger.spec.ts diff --git a/biome.json b/biome.json index 04672bd..442c0bf 100644 --- a/biome.json +++ b/biome.json @@ -32,7 +32,8 @@ "suspicious": { "noExplicitAny": "off", "noArrayIndexKey": "off", - "noEmptyBlockStatements": "off" + "noEmptyBlockStatements": "off", + "noConsole": "error" }, "performance": { "noBarrelFile": "off" @@ -42,6 +43,28 @@ } } }, + "overrides": [ + { + "includes": ["packages/core/src/interfaces/logger.ts"], + "linter": { + "rules": { + "suspicious": { + "noConsole": "off" + } + } + } + }, + { + "includes": ["**/__tests__/**", "**/*.spec.ts", "**/*.test.ts"], + "linter": { + "rules": { + "suspicious": { + "noConsole": "off" + } + } + } + } + ], "formatter": { "indentStyle": "space", "indentWidth": 2, diff --git a/bun.lock b/bun.lock index cdabe27..e892c73 100644 --- a/bun.lock +++ b/bun.lock @@ -21,11 +21,14 @@ "version": "0.1.0", "dependencies": { "js-yaml": "^4.1.0", + "pino": "^9.9.0", }, "devDependencies": { "@types/js-yaml": "^4.0.9", "@types/json-schema": "^7.0.15", "@types/node": "^18.19.31", + "pino-pretty": "^13.1.1", + "rimraf": "^6.0.1", "tsup": "^8.0.2", "typescript": "^5.4.5", "vitest": "^1.6.0", @@ -145,6 +148,10 @@ "@inquirer/external-editor": ["@inquirer/external-editor@1.0.1", "", { "dependencies": { "chardet": "^2.1.0", "iconv-lite": "^0.6.3" }, "peerDependencies": { "@types/node": ">=18" }, "optionalPeers": ["@types/node"] }, "sha512-Oau4yL24d2B5IL4ma4UpbQigkVhzPDXLoqy1ggK4gnHg/stmkffJE4oOXHXF3uz0UEpywG68KcyXsyYpA1Re/Q=="], + "@isaacs/balanced-match": ["@isaacs/balanced-match@4.0.1", "", {}, "sha512-yzMTt9lEb8Gv7zRioUilSglI0c0smZ9k5D65677DLWLtWJaXIS3CqcGyUFByYKlnUj6TkjLVs54fBl6+TiGQDQ=="], + + "@isaacs/brace-expansion": ["@isaacs/brace-expansion@5.0.0", "", { "dependencies": { "@isaacs/balanced-match": "^4.0.1" } }, "sha512-ZT55BDLV0yv0RBm2czMiZ+SqCGO7AvmOM3G/w2xhVPH+te0aKgFjmBvGlL1dH+ql2tgGO3MVrbb3jCKyvpgnxA=="], + "@isaacs/cliui": ["@isaacs/cliui@8.0.2", "", { "dependencies": { "string-width": "^5.1.2", "string-width-cjs": "npm:string-width@^4.2.0", "strip-ansi": "^7.0.1", "strip-ansi-cjs": "npm:strip-ansi@^6.0.1", "wrap-ansi": "^8.1.0", "wrap-ansi-cjs": "npm:wrap-ansi@^7.0.0" } }, "sha512-O8jcjabXaleOG9DQ0+ARXWZBTfnP4WNAqzuiJK7ll44AmxGKv/J2M4TPjxjY3znBCfvBXFzucm1twdyFybFqEA=="], "@jest/schemas": ["@jest/schemas@29.6.3", "", { "dependencies": { "@sinclair/typebox": "^0.27.8" } }, "sha512-mo5j5X+jIZmJQveBKeS/clAueipV7KgiX1vMgCxam1RNYiqE1w62n0/tJJnHtjW8ZHcQco5gY85jA3mi0L+nSA=="], @@ -277,6 +284,8 @@ "assertion-error": ["assertion-error@1.1.0", "", {}, "sha512-jgsaNduz+ndvGyFt3uSuWqvy4lCnIJiovtouQN5JZHOKCS2QuhEdbcQHFhVksz2N2U9hXJo8odG7ETyWlEeuDw=="], + "atomic-sleep": ["atomic-sleep@1.0.0", "", {}, "sha512-kNOjDqAh7px0XWNI+4QbzoiR/nTkHAWNud2uvnJquD1/x5a7EQZMJT0AczqK0Qn67oY/TTQ1LbUKajZpp3I9tQ=="], + "balanced-match": ["balanced-match@1.0.2", "", {}, "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw=="], "better-path-resolve": ["better-path-resolve@1.0.0", "", { "dependencies": { "is-windows": "^1.0.0" } }, "sha512-pbnl5XzGBdrFU/wT4jqmJVPn2B6UHPBOhzMQkY/SPUPB6QtUXtmBHBIwCbXJol93mOpGMnQyP/+BB19q04xj7g=="], @@ -313,6 +322,8 @@ "color-name": ["color-name@1.1.4", "", {}, "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA=="], + "colorette": ["colorette@2.0.20", "", {}, "sha512-IfEDxwoWIjkeXL1eXcDiow4UbKjhLdq6/EuSVR9GMN7KVH3r9gQ83e73hsz1Nd1T3ijd5xv1wcWRYO+D6kCI2w=="], + "commander": ["commander@14.0.0", "", {}, "sha512-2uM9rYjPvyq39NwLRqaiLtWHyDC1FvryJDa2ATTVims5YAS4PupsEQsDvP14FqhFr0P49CYDugi59xaxJlTXRA=="], "confbox": ["confbox@0.2.2", "", {}, "sha512-1NB+BKqhtNipMsov4xI/NnhCKp9XG9NamYp5PVm9klAT0fsrNPjaFICsCFhNhwZJKNh7zB/3q8qXz0E9oaMNtQ=="], @@ -323,6 +334,8 @@ "csstype": ["csstype@3.1.3", "", {}, "sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw=="], + "dateformat": ["dateformat@4.6.3", "", {}, "sha512-2P0p0pFGzHS5EMnhdxQi7aJN+iMheud0UhG4dlE1DLAlvL8JHjJJTX/CSm4JXwV0Ka5nGk3zC5mcb5bUQUxxMA=="], + "debug": ["debug@4.4.1", "", { "dependencies": { "ms": "^2.1.3" } }, "sha512-KcKCqiftBJcZr++7ykoDIEwSa3XWowTfNPo92BYxjXiyYEVrUQh2aLyhxBCwww+heortUFxEJYcRzosstTEBYQ=="], "decode-named-character-reference": ["decode-named-character-reference@1.2.0", "", { "dependencies": { "character-entities": "^2.0.0" } }, "sha512-c6fcElNV6ShtZXmsgNgFFV5tVX2PaV4g+MOAkb8eXHvn6sryJBrZa9r0zV6+dtTyoCKxtDy5tyQ5ZwQuidtd+Q=="], @@ -345,6 +358,8 @@ "emoji-regex": ["emoji-regex@9.2.2", "", {}, "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg=="], + "end-of-stream": ["end-of-stream@1.4.5", "", { "dependencies": { "once": "^1.4.0" } }, "sha512-ooEGc6HP26xXq/N+GCGOT0JKCLDGrq2bQUZrQ7gyrJiZANJ/8YDTxTpQBXGMn+WbIQXNVpyWymm7KYVICQnyOg=="], + "enquirer": ["enquirer@2.4.1", "", { "dependencies": { "ansi-colors": "^4.1.1", "strip-ansi": "^6.0.1" } }, "sha512-rRqJg/6gd538VHvR3PSrdRBb/1Vy2YfzHqzvbhGIQpDRKIa4FgV/54b5Q1xYSxOOwKvjXweS26E0Q+nAMwp2pQ=="], "entities": ["entities@4.5.0", "", {}, "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw=="], @@ -365,8 +380,14 @@ "extendable-error": ["extendable-error@0.1.7", "", {}, "sha512-UOiS2in6/Q0FK0R0q6UY9vYpQ21mr/Qn1KOnte7vsACuNJf514WvCCUHSRCPcgjPT2bAhNIJdlE6bVap1GKmeg=="], + "fast-copy": ["fast-copy@3.0.2", "", {}, "sha512-dl0O9Vhju8IrcLndv2eU4ldt1ftXMqqfgN4H1cpmGV7P6jeB9FwpN9a2c8DPGE1Ys88rNUJVYDHq73CGAGOPfQ=="], + "fast-glob": ["fast-glob@3.3.3", "", { "dependencies": { "@nodelib/fs.stat": "^2.0.2", "@nodelib/fs.walk": "^1.2.3", "glob-parent": "^5.1.2", "merge2": "^1.3.0", "micromatch": "^4.0.8" } }, "sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg=="], + "fast-redact": ["fast-redact@3.5.0", "", {}, "sha512-dwsoQlS7h9hMeYUq1W++23NDcBLV4KqONnITDV9DjfS3q1SgDGVrBdvvTLUotWtPSD7asWDV9/CmsZPy8Hf70A=="], + + "fast-safe-stringify": ["fast-safe-stringify@2.1.1", "", {}, "sha512-W+KJc2dmILlPplD/H4K9l9LcAHAfPtP6BY84uVLXQ6Evcz9Lcg33Y2z1IVblT6xdY54PXYVHEv+0Wpq8Io6zkA=="], + "fastq": ["fastq@1.19.1", "", { "dependencies": { "reusify": "^1.0.4" } }, "sha512-GwLTyxkCXjXbxqIhTsMI2Nui8huMPtnxg7krajPJAjnEG/iiOS7i+zCtWGZR9G0NBKbXKh6X9m9UIsYX/N6vvQ=="], "fdir": ["fdir@6.5.0", "", { "peerDependencies": { "picomatch": "^3 || ^4" }, "optionalPeers": ["picomatch"] }, "sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg=="], @@ -387,7 +408,7 @@ "get-stream": ["get-stream@8.0.1", "", {}, "sha512-VaUJspBffn/LMCJVoMvSAdmscJyS1auj5Zulnn5UoYcY531UWmdwhRWkcGKnGU93m5HSXP9LP2usOryrBtQowA=="], - "glob": ["glob@10.4.5", "", { "dependencies": { "foreground-child": "^3.1.0", "jackspeak": "^3.1.2", "minimatch": "^9.0.4", "minipass": "^7.1.2", "package-json-from-dist": "^1.0.0", "path-scurry": "^1.11.1" }, "bin": { "glob": "dist/esm/bin.mjs" } }, "sha512-7Bv8RF0k6xjo7d4A/PxYLbUCfb6c+Vpd2/mB2yRDlew7Jb5hEXiCD9ibfO7wpk8i4sevK6DFny9h7EYbM3/sHg=="], + "glob": ["glob@11.0.3", "", { "dependencies": { "foreground-child": "^3.3.1", "jackspeak": "^4.1.1", "minimatch": "^10.0.3", "minipass": "^7.1.2", "package-json-from-dist": "^1.0.0", "path-scurry": "^2.0.0" }, "bin": { "glob": "dist/esm/bin.mjs" } }, "sha512-2Nim7dha1KVkaiF4q6Dj+ngPPMdfvLJEOpZk/jKiUAkqKebpGAWQXAq9z1xu9HKu5lWfqw/FASuccEjyznjPaA=="], "glob-parent": ["glob-parent@5.1.2", "", { "dependencies": { "is-glob": "^4.0.1" } }, "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow=="], @@ -395,6 +416,8 @@ "graceful-fs": ["graceful-fs@4.2.11", "", {}, "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ=="], + "help-me": ["help-me@5.0.0", "", {}, "sha512-7xgomUX6ADmcYzFik0HzAxh/73YlKR9bmFzf51CZwR+b6YtzU2m0u49hQCqV6SvlqIqsaxovfwdvbnsw3b/zpg=="], + "human-id": ["human-id@4.1.1", "", { "bin": { "human-id": "dist/cli.js" } }, "sha512-3gKm/gCSUipeLsRYZbbdA1BD83lBoWUkZ7G9VFrhWPAU76KwYo5KR8V28bpoPm/ygy0x5/GCbpRQdY7VLYCoIg=="], "human-signals": ["human-signals@5.0.0", "", {}, "sha512-AXcZb6vzzrFAUE61HnN4mpLqd/cSIwNQjtNWR0euPm6y0iqx3G4gOXaIDdtdDwZmhwe82LA6+zinmW4UBWVePQ=="], @@ -427,7 +450,7 @@ "isexe": ["isexe@2.0.0", "", {}, "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw=="], - "jackspeak": ["jackspeak@3.4.3", "", { "dependencies": { "@isaacs/cliui": "^8.0.2" }, "optionalDependencies": { "@pkgjs/parseargs": "^0.11.0" } }, "sha512-OGlZQpz2yfahA/Rd1Y8Cd9SIEsqvXkLVoSw/cgwhnhFMDbsQFeZYoJJ7bIZBS9BcamUW96asq/npPWugM+RQBw=="], + "jackspeak": ["jackspeak@4.1.1", "", { "dependencies": { "@isaacs/cliui": "^8.0.2" } }, "sha512-zptv57P3GpL+O0I7VdMJNBZCu+BPHVQUk55Ft8/QCJjTVxrnJHuVuX/0Bl2A6/+2oyR/ZMEuFKwmzqqZ/U5nPQ=="], "joycon": ["joycon@3.1.1", "", {}, "sha512-34wB/Y7MW7bzjKRjUKTa46I2Z7eV62Rkhva+KkopW7Qvv/OSWBqvkSY7vusOPrNuZcUG3tApvdVgNB8POj3SPw=="], @@ -481,7 +504,7 @@ "loupe": ["loupe@2.3.7", "", { "dependencies": { "get-func-name": "^2.0.1" } }, "sha512-zSMINGVYkdpYSOBmLi0D1Uo7JU9nVdQKrHxC8eYlV+9YKK9WePqAlL7lSlorG/U2Fw1w0hTBmaa/jrQ3UbPHtA=="], - "lru-cache": ["lru-cache@10.4.3", "", {}, "sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ=="], + "lru-cache": ["lru-cache@11.1.0", "", {}, "sha512-QIXZUBJUx+2zHUdQujWejBkcD9+cs94tLn0+YL8UrCh+D5sCXZ4c7LaEH48pNwRY3MLDgqUFyhlCyjJPf1WP0A=="], "magic-string": ["magic-string@0.30.18", "", { "dependencies": { "@jridgewell/sourcemap-codec": "^1.5.5" } }, "sha512-yi8swmWbO17qHhwIBNeeZxTceJMeBvWJaId6dyvTSOwTipqeHhMhOrz6513r1sOKnpvQ7zkhlG8tPrpilwTxHQ=="], @@ -553,7 +576,9 @@ "mimic-fn": ["mimic-fn@4.0.0", "", {}, "sha512-vqiC06CuhBTUdZH+RYl8sFrL096vA45Ok5ISO6sE/Mr1jRbGH4Csnhi8f3wKVl7x8mO4Au7Ir9D3Oyv1VYMFJw=="], - "minimatch": ["minimatch@9.0.5", "", { "dependencies": { "brace-expansion": "^2.0.1" } }, "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow=="], + "minimatch": ["minimatch@10.0.3", "", { "dependencies": { "@isaacs/brace-expansion": "^5.0.0" } }, "sha512-IPZ167aShDZZUMdRk66cyQAW3qr0WzbHkPdMYa8bzZhlHhO3jALbKdxcaak7W9FfT2rZNpQuUu4Od7ILEpXSaw=="], + + "minimist": ["minimist@1.2.8", "", {}, "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA=="], "minipass": ["minipass@7.1.2", "", {}, "sha512-qOOzS1cBTWYF4BH8fVePDBOO9iptMnGUEZwNc/cMWnTV2nVLZ7VoNWEPHkYczZA0pdoA7dl6e7FL659nX9S2aw=="], @@ -573,6 +598,10 @@ "object-assign": ["object-assign@4.1.1", "", {}, "sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg=="], + "on-exit-leak-free": ["on-exit-leak-free@2.1.2", "", {}, "sha512-0eJJY6hXLGf1udHwfNftBqH+g73EU4B504nZeKpz1sYRKafAghwxEJunB2O7rDZkL4PGfsMVnTXZ2EjibbqcsA=="], + + "once": ["once@1.4.0", "", { "dependencies": { "wrappy": "1" } }, "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w=="], + "onetime": ["onetime@6.0.0", "", { "dependencies": { "mimic-fn": "^4.0.0" } }, "sha512-1FlR+gjXK7X+AsAHso35MnyN5KqGwJRi/31ft6x0M194ht7S+rWAvd7PHss9xSKMzE0asv1pyIHaJYq+BbacAQ=="], "outdent": ["outdent@0.5.0", "", {}, "sha512-/jHxFIzoMXdqPzTaCpFzAAWhpkSjZPF4Vsn6jAfNpmbH/ymsmd7Qc6VE9BGn0L6YMj6uwpQLxCECpus4ukKS9Q=="], @@ -597,7 +626,7 @@ "path-key": ["path-key@3.1.1", "", {}, "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q=="], - "path-scurry": ["path-scurry@1.11.1", "", { "dependencies": { "lru-cache": "^10.2.0", "minipass": "^5.0.0 || ^6.0.2 || ^7.0.0" } }, "sha512-Xa4Nw17FS9ApQFJ9umLiJS4orGjm7ZzwUrwamcGQuHSzDyth9boKDaycYdDcZDuqYATXw4HFXgaqWTctW/v1HA=="], + "path-scurry": ["path-scurry@2.0.0", "", { "dependencies": { "lru-cache": "^11.0.0", "minipass": "^7.1.2" } }, "sha512-ypGJsmGtdXUOeM5u93TyeIEfEhM6s+ljAhrk5vAvSx8uyY/02OvrZnA0YNGUrPXfpJMgI1ODd3nwz8Npx4O4cg=="], "path-type": ["path-type@6.0.0", "", {}, "sha512-Vj7sf++t5pBD637NSfkxpHSMfWaeig5+DKWLhcqIYx6mWQz5hdJTGDVMQiJcw1ZYkhs7AazKDGpRVji1LJCZUQ=="], @@ -611,6 +640,14 @@ "pify": ["pify@4.0.1", "", {}, "sha512-uB80kBFb/tfd68bVleG9T5GGsGPjJrLAUpR5PZIrhBnIaRTQRjqdJSsIKkOP6OAIFbj7GOrcudc5pNjZ+geV2g=="], + "pino": ["pino@9.9.0", "", { "dependencies": { "atomic-sleep": "^1.0.0", "fast-redact": "^3.1.1", "on-exit-leak-free": "^2.1.0", "pino-abstract-transport": "^2.0.0", "pino-std-serializers": "^7.0.0", "process-warning": "^5.0.0", "quick-format-unescaped": "^4.0.3", "real-require": "^0.2.0", "safe-stable-stringify": "^2.3.1", "sonic-boom": "^4.0.1", "thread-stream": "^3.0.0" }, "bin": { "pino": "bin.js" } }, "sha512-zxsRIQG9HzG+jEljmvmZupOMDUQ0Jpj0yAgE28jQvvrdYTlEaiGwelJpdndMl/MBuRr70heIj83QyqJUWaU8mQ=="], + + "pino-abstract-transport": ["pino-abstract-transport@2.0.0", "", { "dependencies": { "split2": "^4.0.0" } }, "sha512-F63x5tizV6WCh4R6RHyi2Ml+M70DNRXt/+HANowMflpgGFMAym/VKm6G7ZOQRjqN7XbGxK1Lg9t6ZrtzOaivMw=="], + + "pino-pretty": ["pino-pretty@13.1.1", "", { "dependencies": { "colorette": "^2.0.7", "dateformat": "^4.6.3", "fast-copy": "^3.0.2", "fast-safe-stringify": "^2.1.1", "help-me": "^5.0.0", "joycon": "^3.1.1", "minimist": "^1.2.6", "on-exit-leak-free": "^2.1.0", "pino-abstract-transport": "^2.0.0", "pump": "^3.0.0", "secure-json-parse": "^4.0.0", "sonic-boom": "^4.0.1", "strip-json-comments": "^5.0.2" }, "bin": { "pino-pretty": "bin.js" } }, "sha512-TNNEOg0eA0u+/WuqH0MH0Xui7uqVk9D74ESOpjtebSQYbNWJk/dIxCXIxFsNfeN53JmtWqYHP2OrIZjT/CBEnA=="], + + "pino-std-serializers": ["pino-std-serializers@7.0.0", "", {}, "sha512-e906FRY0+tV27iq4juKzSYPbUj2do2X2JX4EzSca1631EB2QJQUqGbDuERal7LCtOpxl6x3+nvo9NPZcmjkiFA=="], + "pirates": ["pirates@4.0.7", "", {}, "sha512-TfySrs/5nm8fQJDcBDuUng3VOUKsd7S+zqvbOTiGXHfxX4wK31ard+hoNuvkicM/2YFzlpDgABOevKSsB4G/FA=="], "pkg-types": ["pkg-types@2.3.0", "", { "dependencies": { "confbox": "^0.2.2", "exsolve": "^1.0.7", "pathe": "^2.0.3" } }, "sha512-SIqCzDRg0s9npO5XQ3tNZioRY1uK06lA41ynBC1YmFTmnY6FjUjVt6s4LoADmwoig1qqD0oK8h1p/8mlMx8Oig=="], @@ -623,6 +660,10 @@ "pretty-format": ["pretty-format@29.7.0", "", { "dependencies": { "@jest/schemas": "^29.6.3", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" } }, "sha512-Pdlw/oPxN+aXdmM9R00JVC9WVFoCLTKJvDVLgmJ+qAffBMxsV85l/Lu7sNx4zSzPyoL2euImuEwHhOXdEgNFZQ=="], + "process-warning": ["process-warning@5.0.0", "", {}, "sha512-a39t9ApHNx2L4+HBnQKqxxHNs1r7KF+Intd8Q/g1bUh6q0WIp9voPXJ/x0j+ZL45KF1pJd9+q2jLIRMfvEshkA=="], + + "pump": ["pump@3.0.3", "", { "dependencies": { "end-of-stream": "^1.1.0", "once": "^1.3.1" } }, "sha512-todwxLMY7/heScKmntwQG8CXVkWUOdYxIvY2s0VWAAMh/nd8SoYiRaKjlr7+iCs984f2P8zvrfWcDDYVb73NfA=="], + "punycode": ["punycode@2.3.1", "", {}, "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg=="], "punycode.js": ["punycode.js@2.3.1", "", {}, "sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA=="], @@ -631,22 +672,32 @@ "queue-microtask": ["queue-microtask@1.2.3", "", {}, "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A=="], + "quick-format-unescaped": ["quick-format-unescaped@4.0.4", "", {}, "sha512-tYC1Q1hgyRuHgloV/YXs2w15unPVh8qfu/qCTfhTYamaw7fyhumKa2yGpdSo87vY32rIclj+4fWYQXUMs9EHvg=="], + "react-is": ["react-is@18.3.1", "", {}, "sha512-/LLMVyas0ljjAtoYiPqYiL8VWXzUUdThrmU5+n20DZv+a+ClRoevUzw5JxU+Ieh5/c87ytoTBV9G1FiKfNJdmg=="], "read-yaml-file": ["read-yaml-file@1.1.0", "", { "dependencies": { "graceful-fs": "^4.1.5", "js-yaml": "^3.6.1", "pify": "^4.0.1", "strip-bom": "^3.0.0" } }, "sha512-VIMnQi/Z4HT2Fxuwg5KrY174U1VdUIASQVWXXyqtNRtxSr9IYkn1rsI6Tb6HsrHCmB7gVpNwX6JxPTHcH6IoTA=="], "readdirp": ["readdirp@4.1.2", "", {}, "sha512-GDhwkLfywWL2s6vEjyhri+eXmfH6j1L7JE27WhqLeYzoh/A3DBaYGEj2H/HFZCn/kMfim73FXxEJTw06WtxQwg=="], + "real-require": ["real-require@0.2.0", "", {}, "sha512-57frrGM/OCTLqLOAh0mhVA9VBMHd+9U7Zb2THMGdBUoZVOtGbJzjxsYGDJ3A9AYYCP4hn6y1TVbaOfzWtm5GFg=="], + "resolve-from": ["resolve-from@5.0.0", "", {}, "sha512-qYg9KP24dD5qka9J47d0aVky0N+b4fTU89LN9iDnjB5waksiC49rvMB0PrUJQGoTmH50XPiqOvAjDfaijGxYZw=="], "reusify": ["reusify@1.1.0", "", {}, "sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw=="], + "rimraf": ["rimraf@6.0.1", "", { "dependencies": { "glob": "^11.0.0", "package-json-from-dist": "^1.0.0" }, "bin": { "rimraf": "dist/esm/bin.mjs" } }, "sha512-9dkvaxAsk/xNXSJzMgFqqMCuFgt2+KsOFek3TMLfo8NCPfWpBmqwyNn5Y+NX56QUYfCtsyhF3ayiboEoUmJk/A=="], + "rollup": ["rollup@4.50.0", "", { "dependencies": { "@types/estree": "1.0.8" }, "optionalDependencies": { "@rollup/rollup-android-arm-eabi": "4.50.0", "@rollup/rollup-android-arm64": "4.50.0", "@rollup/rollup-darwin-arm64": "4.50.0", "@rollup/rollup-darwin-x64": "4.50.0", "@rollup/rollup-freebsd-arm64": "4.50.0", "@rollup/rollup-freebsd-x64": "4.50.0", "@rollup/rollup-linux-arm-gnueabihf": "4.50.0", "@rollup/rollup-linux-arm-musleabihf": "4.50.0", "@rollup/rollup-linux-arm64-gnu": "4.50.0", "@rollup/rollup-linux-arm64-musl": "4.50.0", "@rollup/rollup-linux-loongarch64-gnu": "4.50.0", "@rollup/rollup-linux-ppc64-gnu": "4.50.0", "@rollup/rollup-linux-riscv64-gnu": "4.50.0", "@rollup/rollup-linux-riscv64-musl": "4.50.0", "@rollup/rollup-linux-s390x-gnu": "4.50.0", "@rollup/rollup-linux-x64-gnu": "4.50.0", "@rollup/rollup-linux-x64-musl": "4.50.0", "@rollup/rollup-openharmony-arm64": "4.50.0", "@rollup/rollup-win32-arm64-msvc": "4.50.0", "@rollup/rollup-win32-ia32-msvc": "4.50.0", "@rollup/rollup-win32-x64-msvc": "4.50.0", "fsevents": "~2.3.2" }, "bin": { "rollup": "dist/bin/rollup" } }, "sha512-/Zl4D8zPifNmyGzJS+3kVoyXeDeT/GrsJM94sACNg9RtUE0hrHa1bNPtRSrfHTMH5HjRzce6K7rlTh3Khiw+pw=="], "run-parallel": ["run-parallel@1.2.0", "", { "dependencies": { "queue-microtask": "^1.2.2" } }, "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA=="], + "safe-stable-stringify": ["safe-stable-stringify@2.5.0", "", {}, "sha512-b3rppTKm9T+PsVCBEOUR46GWI7fdOs00VKZ1+9c1EWDaDMvjQc6tUwuFyIprgGgTcWoVHSKrU8H31ZHA2e0RHA=="], + "safer-buffer": ["safer-buffer@2.1.2", "", {}, "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg=="], + "secure-json-parse": ["secure-json-parse@4.0.0", "", {}, "sha512-dxtLJO6sc35jWidmLxo7ij+Eg48PM/kleBsxpC8QJE0qJICe+KawkDQmvCMZUr9u7WKVHgMW6vy3fQ7zMiFZMA=="], + "semver": ["semver@7.7.2", "", { "bin": { "semver": "bin/semver.js" } }, "sha512-RF0Fw+rO5AMf9MAyaRXI4AV0Ulj5lMHqVxxdSgiVbixSCXoEmmX/jk0CuJw4+3SqroYO9VoUh+HcuJivvtJemA=="], "shebang-command": ["shebang-command@2.0.0", "", { "dependencies": { "shebang-regex": "^3.0.0" } }, "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA=="], @@ -661,12 +712,16 @@ "slash": ["slash@5.1.0", "", {}, "sha512-ZA6oR3T/pEyuqwMgAKT0/hAv8oAXckzbkmR0UkUosQ+Mc4RxGoJkRmwHgHufaenlyAgE1Mxgpdcrf75y6XcnDg=="], + "sonic-boom": ["sonic-boom@4.2.0", "", { "dependencies": { "atomic-sleep": "^1.0.0" } }, "sha512-INb7TM37/mAcsGmc9hyyI6+QR3rR1zVRu36B0NeGXKnOOLiZOfER5SA+N7X7k3yUYRzLWafduTDvJAfDswwEww=="], + "source-map": ["source-map@0.8.0-beta.0", "", { "dependencies": { "whatwg-url": "^7.0.0" } }, "sha512-2ymg6oRBpebeZi9UUNsgQ89bhx01TcTkmNTGnNO88imTmbSgy4nfujrgVEFKWpMTEGA11EDkTt7mqObTPdigIA=="], "source-map-js": ["source-map-js@1.2.1", "", {}, "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA=="], "spawndamnit": ["spawndamnit@3.0.1", "", { "dependencies": { "cross-spawn": "^7.0.5", "signal-exit": "^4.0.1" } }, "sha512-MmnduQUuHCoFckZoWnXsTg7JaiLBJrKFj9UI2MbRPGaJeVpsLcVBu6P/IGZovziM/YBsellCmsprgNA+w0CzVg=="], + "split2": ["split2@4.2.0", "", {}, "sha512-UcjcJOWknrNkF6PLX83qcHM6KHgVKNkV62Y8a5uYDVv9ydGQVwAHMKqHdJje1VTWpljG0WYpCDhrCdAOYH4TWg=="], + "sprintf-js": ["sprintf-js@1.0.3", "", {}, "sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g=="], "stackback": ["stackback@0.0.2", "", {}, "sha512-1XMJE5fQo1jGH6Y/7ebnwPOBEkIEnT4QF32d5R1+VXdXveM0IBMJt8zfaxX1P3QhVwrYe+576+jkANtSS2mBbw=="], @@ -685,6 +740,8 @@ "strip-final-newline": ["strip-final-newline@3.0.0", "", {}, "sha512-dOESqjYr96iWYylGObzd39EuNTa5VJxyvVAEm5Jnh7KGo75V43Hk1odPQkNDyXNmUR6k+gEiDVXnjB8HJ3crXw=="], + "strip-json-comments": ["strip-json-comments@5.0.3", "", {}, "sha512-1tB5mhVo7U+ETBKNf92xT4hrQa3pm0MZ0PQvuDnWgAAGHDsfp4lPSpiS6psrSiet87wyGPh9ft6wmhOMQ0hDiw=="], + "strip-literal": ["strip-literal@2.1.1", "", { "dependencies": { "js-tokens": "^9.0.1" } }, "sha512-631UJ6O00eNGfMiWG78ck80dfBab8X6IVFB51jZK5Icd7XAs60Z5y7QdSd/wGIklnWvRbUNloVzhOKKmutxQ6Q=="], "sucrase": ["sucrase@3.35.0", "", { "dependencies": { "@jridgewell/gen-mapping": "^0.3.2", "commander": "^4.0.0", "glob": "^10.3.10", "lines-and-columns": "^1.1.6", "mz": "^2.7.0", "pirates": "^4.0.1", "ts-interface-checker": "^0.1.9" }, "bin": { "sucrase": "bin/sucrase", "sucrase-node": "bin/sucrase-node" } }, "sha512-8EbVDiu9iN/nESwxeSxDKe0dunta1GOlHufmSSXxMD2z2/tMZpDMpvXQGsc+ajGo8y2uYUmixaSRUc/QPoQ0GA=="], @@ -695,6 +752,8 @@ "thenify-all": ["thenify-all@1.6.0", "", { "dependencies": { "thenify": ">= 3.1.0 < 4" } }, "sha512-RNxQH/qI8/t3thXJDwcstUO4zeqo64+Uy/+sNVRBx4Xn2OX+OZ9oP+iJnNFqplFra2ZUVeKCSa2oVWi3T4uVmA=="], + "thread-stream": ["thread-stream@3.1.0", "", { "dependencies": { "real-require": "^0.2.0" } }, "sha512-OqyPZ9u96VohAyMfJykzmivOrY2wfMSf3C5TtFJVgN+Hm6aj+voFhlK+kZEIv2FBh1X6Xp3DlnCOfEQ3B2J86A=="], + "tinybench": ["tinybench@2.9.0", "", {}, "sha512-0+DUvqWMValLmha6lr4kD8iAMK1HzV0/aKnCtWb9v9641TnP/MFb7Pc2bxoxQjTXAErryXVgUOfv2YqNllqGeg=="], "tinyexec": ["tinyexec@0.3.2", "", {}, "sha512-KQQR9yN7R5+OSwaK0XQoj22pwHoTlgYqmUscPYoknOoWCWfj/5/ABTMRi69FrKU5ffPVh5QcFikpWJI/P1ocHA=="], @@ -767,6 +826,8 @@ "wrap-ansi-cjs": ["wrap-ansi@7.0.0", "", { "dependencies": { "ansi-styles": "^4.0.0", "string-width": "^4.1.0", "strip-ansi": "^6.0.0" } }, "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q=="], + "wrappy": ["wrappy@1.0.2", "", {}, "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ=="], + "yocto-queue": ["yocto-queue@1.2.1", "", {}, "sha512-AyeEbWOu/TAXdxlV9wmGcR0+yh2j3vYPGOECcIj2S7MkrLyC7ne+oye2BKTItt0ii2PHk4cDy+95+LshzbXnGg=="], "zod": ["zod@4.1.5", "", {}, "sha512-rcUUZqlLJgBC33IT3PNMgsCq6TzLQEG/Ei/KTCU0PedSWRMAXoOUN+4t/0H+Q8bdnLPdqUYnvboJT0bn/229qg=="], @@ -825,6 +886,8 @@ "sucrase/commander": ["commander@4.1.1", "", {}, "sha512-NOKm8xhkzAjzFx8B2v5OAHT+u5pRQc2UCa2Vq9jYL/31o2wi9mxBA7LIFs3sV5VSC49z6pEhfbMULvShKj26WA=="], + "sucrase/glob": ["glob@10.4.5", "", { "dependencies": { "foreground-child": "^3.1.0", "jackspeak": "^3.1.2", "minimatch": "^9.0.4", "minipass": "^7.1.2", "package-json-from-dist": "^1.0.0", "path-scurry": "^1.11.1" }, "bin": { "glob": "dist/esm/bin.mjs" } }, "sha512-7Bv8RF0k6xjo7d4A/PxYLbUCfb6c+Vpd2/mB2yRDlew7Jb5hEXiCD9ibfO7wpk8i4sevK6DFny9h7EYbM3/sHg=="], + "tinyglobby/picomatch": ["picomatch@4.0.3", "", {}, "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q=="], "trpc-cli/zod": ["zod@3.25.76", "", {}, "sha512-gzUt/qt81nXsFGKIFcC3YnfEAx5NkunCfnDlvuBSSFS02bcXu4Lmea0AFIUwbLWxWPx3d9p8S5QoaujKcNQxcQ=="], @@ -865,6 +928,12 @@ "string-width/strip-ansi/ansi-regex": ["ansi-regex@6.2.0", "", {}, "sha512-TKY5pyBkHyADOPYlRT9Lx6F544mPl0vS5Ew7BJ45hA08Q+t3GjbueLliBWN3sMICk6+y7HdyxSzC4bWS8baBdg=="], + "sucrase/glob/jackspeak": ["jackspeak@3.4.3", "", { "dependencies": { "@isaacs/cliui": "^8.0.2" }, "optionalDependencies": { "@pkgjs/parseargs": "^0.11.0" } }, "sha512-OGlZQpz2yfahA/Rd1Y8Cd9SIEsqvXkLVoSw/cgwhnhFMDbsQFeZYoJJ7bIZBS9BcamUW96asq/npPWugM+RQBw=="], + + "sucrase/glob/minimatch": ["minimatch@9.0.5", "", { "dependencies": { "brace-expansion": "^2.0.1" } }, "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow=="], + + "sucrase/glob/path-scurry": ["path-scurry@1.11.1", "", { "dependencies": { "lru-cache": "^10.2.0", "minipass": "^5.0.0 || ^6.0.2 || ^7.0.0" } }, "sha512-Xa4Nw17FS9ApQFJ9umLiJS4orGjm7ZzwUrwamcGQuHSzDyth9boKDaycYdDcZDuqYATXw4HFXgaqWTctW/v1HA=="], + "ultracite/vitest/@vitest/expect": ["@vitest/expect@3.2.4", "", { "dependencies": { "@types/chai": "^5.2.2", "@vitest/spy": "3.2.4", "@vitest/utils": "3.2.4", "chai": "^5.2.0", "tinyrainbow": "^2.0.0" } }, "sha512-Io0yyORnB6sikFlt8QW5K7slY4OjqNX9jmJQ02QDda8lyM6B5oNgVWoSoKPac8/kgnCUzuHQKrSLtu/uOqqrig=="], "ultracite/vitest/@vitest/runner": ["@vitest/runner@3.2.4", "", { "dependencies": { "@vitest/utils": "3.2.4", "pathe": "^2.0.3", "strip-literal": "^3.0.0" } }, "sha512-oukfKT9Mk41LreEW09vt45f8wx7DordoWUZMYdY/cyAk7w5TWkTRCNZYF7sX7n2wB7jyGAl74OxgwhPgKaqDMQ=="], @@ -935,6 +1004,8 @@ "wrap-ansi/strip-ansi/ansi-regex": ["ansi-regex@6.2.0", "", {}, "sha512-TKY5pyBkHyADOPYlRT9Lx6F544mPl0vS5Ew7BJ45hA08Q+t3GjbueLliBWN3sMICk6+y7HdyxSzC4bWS8baBdg=="], + "sucrase/glob/path-scurry/lru-cache": ["lru-cache@10.4.3", "", {}, "sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ=="], + "ultracite/vitest/@vitest/runner/strip-literal": ["strip-literal@3.0.0", "", { "dependencies": { "js-tokens": "^9.0.1" } }, "sha512-TcccoMhJOM3OebGhSBEmp3UZ2SfDMZUEBdRA/9ynfLi8yYajyWX3JiXArcJt4Umh4vISpspkQIY8ZZoCqjbviA=="], "ultracite/vitest/@vitest/spy/tinyspy": ["tinyspy@4.0.3", "", {}, "sha512-t2T/WLB2WRgZ9EpE4jgPJ9w+i66UZfDc8wHh0xrwiRNN+UwH98GIJkTeZqX9rg0i0ptwzqW+uYeIF0T4F8LR7A=="], diff --git a/packages/core/package.json b/packages/core/package.json index 983f756..f78908c 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -26,7 +26,11 @@ "typecheck": "tsc --noEmit" }, "dependencies": { - "js-yaml": "^4.1.0" + "js-yaml": "^4.1.0", + "pino": "^9.9.0" + }, + "optionalDependencies": { + "pino-pretty": "^13.1.1" }, "devDependencies": { "@types/js-yaml": "^4.0.9", diff --git a/packages/core/src/interfaces/__tests__/logger.spec.ts b/packages/core/src/interfaces/__tests__/logger.spec.ts new file mode 100644 index 0000000..02ada53 --- /dev/null +++ b/packages/core/src/interfaces/__tests__/logger.spec.ts @@ -0,0 +1,294 @@ +// :M: tldr: Tests for Logger interface implementations +// :M: v0.2.0: Tests for both ConsoleLogger and PinoLogger implementations + +import { afterEach, beforeEach, describe, expect, test, vi } from "vitest"; +import type { Logger } from "../logger"; +import { ConsoleLogger, PinoLogger } from "../logger"; + +// Mock console for testing ConsoleLogger +const mockConsoleDebug = vi.fn(); +const mockConsoleInfo = vi.fn(); +const mockConsoleWarn = vi.fn(); +const mockConsoleError = vi.fn(); +const originalConsoleDebug = console.debug; +const originalConsoleInfo = console.info; +const originalConsoleWarn = console.warn; +const originalConsoleError = console.error; + +describe("Logger implementations", () => { + describe("ConsoleLogger", () => { + let logger: Logger; + + beforeEach(() => { + console.debug = mockConsoleDebug; + console.info = mockConsoleInfo; + console.warn = mockConsoleWarn; + console.error = mockConsoleError; + mockConsoleDebug.mockClear(); + mockConsoleInfo.mockClear(); + mockConsoleWarn.mockClear(); + mockConsoleError.mockClear(); + logger = new ConsoleLogger(); + }); + + afterEach(() => { + console.debug = originalConsoleDebug; + console.info = originalConsoleInfo; + console.warn = originalConsoleWarn; + console.error = originalConsoleError; + process.env.RULESETS_LOG_LEVEL = undefined; + }); + + test("should implement Logger interface", () => { + expect(logger).toHaveProperty("debug"); + expect(logger).toHaveProperty("info"); + expect(logger).toHaveProperty("warn"); + expect(logger).toHaveProperty("error"); + }); + + test("debug should not output by default", () => { + logger.debug("test debug message"); + expect(mockConsoleDebug).not.toHaveBeenCalled(); + }); + + test("debug should output when RULESETS_LOG_LEVEL is debug", () => { + process.env.RULESETS_LOG_LEVEL = "debug"; + const debugLogger = new ConsoleLogger(); + debugLogger.debug("test debug message"); + expect(mockConsoleDebug).toHaveBeenCalledWith("[DEBUG] test debug message"); + }); + + test("debug should handle additional arguments", () => { + process.env.RULESETS_LOG_LEVEL = "debug"; + const debugLogger = new ConsoleLogger(); + // biome-ignore lint/style/noMagicNumbers: test data for verifying arguments handling + debugLogger.debug("test debug", { extra: "data" }, 123); + // biome-ignore lint/style/noMagicNumbers: test data for verifying arguments handling + expect(mockConsoleDebug).toHaveBeenCalledWith("[DEBUG] test debug", { extra: "data" }, 123); + }); + + test("info should output with formatted message", () => { + logger.info("test info message"); + expect(mockConsoleInfo).toHaveBeenCalledWith("[INFO] test info message"); + }); + + test("info should handle additional arguments", () => { + logger.info("test info", { context: "test" }, "extra"); + expect(mockConsoleInfo).toHaveBeenCalledWith( + "[INFO] test info", + { context: "test" }, + "extra" + ); + }); + + test("warn should output with formatted message", () => { + logger.warn("test warn message"); + expect(mockConsoleWarn).toHaveBeenCalledWith("[WARN] test warn message"); + }); + + test("warn should handle additional arguments", () => { + // biome-ignore lint/style/noMagicNumbers: test array for verifying arguments handling + logger.warn("test warning", [1, 2, 3]); + // biome-ignore lint/style/noMagicNumbers: test array for verifying arguments handling + expect(mockConsoleWarn).toHaveBeenCalledWith("[WARN] test warning", [1, 2, 3]); + }); + + test("error should output string messages with prefix", () => { + logger.error("test error message"); + expect(mockConsoleError).toHaveBeenCalledWith("[ERROR] test error message"); + }); + + test("error should output Error objects with message and stack", () => { + const testError = new Error("test error"); + testError.stack = "Error: test error\n at test.js:1:1"; + + logger.error(testError); + expect(mockConsoleError).toHaveBeenCalledWith( + "[ERROR] test error", + expect.stringContaining("Error: test error") + ); + }); + + test("error should handle Error objects with additional arguments", () => { + const testError = new Error("test error"); + testError.stack = "Error: test error\n at test.js:1:1"; + + logger.error(testError, { context: "additional" }); + expect(mockConsoleError).toHaveBeenCalledWith( + "[ERROR] test error", + expect.stringContaining("Error: test error"), + { context: "additional" } + ); + }); + + test("error should handle string messages with additional arguments", () => { + logger.error("test error", { extra: "data" }, "more args"); + expect(mockConsoleError).toHaveBeenCalledWith( + "[ERROR] test error", + { extra: "data" }, + "more args" + ); + }); + + test("should respect log level filtering for info messages", () => { + process.env.RULESETS_LOG_LEVEL = "warn"; + const warnLogger = new ConsoleLogger(); + warnLogger.info("test info message"); + expect(mockConsoleInfo).not.toHaveBeenCalled(); + }); + + test("should validate invalid log levels and default to info", () => { + process.env.RULESETS_LOG_LEVEL = "invalid"; + const invalidLogger = new ConsoleLogger(); + invalidLogger.info("test info message"); + expect(mockConsoleInfo).toHaveBeenCalledWith("[INFO] test info message"); + }); + }); + + describe("PinoLogger", () => { + let logger: PinoLogger; + + beforeEach(() => { + // Create logger with minimal config to avoid transport issues in tests + logger = new PinoLogger({ + level: "silent", // Silent during tests + transport: undefined, // No transport during tests + }); + }); + + test("should implement Logger interface", () => { + expect(logger).toHaveProperty("debug"); + expect(logger).toHaveProperty("info"); + expect(logger).toHaveProperty("warn"); + expect(logger).toHaveProperty("error"); + expect(logger).toHaveProperty("getPinoLogger"); + }); + + test("should create logger instance successfully", () => { + expect(logger).toBeInstanceOf(PinoLogger); + }); + + test("should not throw when calling debug method", () => { + expect(() => logger.debug("test debug message")).not.toThrow(); + }); + + test("should not throw when calling debug method with extra args", () => { + expect(() => logger.debug("test debug message", { extra: "data" }, "more")).not.toThrow(); + }); + + test("should not throw when calling info method", () => { + expect(() => logger.info("test info message")).not.toThrow(); + }); + + test("should not throw when calling info method with extra args", () => { + expect(() => logger.info("test info message", { extra: "data" })).not.toThrow(); + }); + + test("should not throw when calling warn method", () => { + expect(() => logger.warn("test warn message")).not.toThrow(); + }); + + test("should not throw when calling warn method with extra args", () => { + expect(() => logger.warn("test warn message", "extra")).not.toThrow(); + }); + + test("should not throw when calling error method with string", () => { + expect(() => logger.error("test error message")).not.toThrow(); + }); + + test("should not throw when calling error method with Error object", () => { + const testError = new Error("test error"); + expect(() => logger.error(testError)).not.toThrow(); + }); + + test("should not throw when calling error method with Error object and extra args", () => { + const testError = new Error("test error"); + expect(() => logger.error(testError, { context: "test" }, "more")).not.toThrow(); + }); + + test("should not throw when calling error method with string and extra args", () => { + expect(() => logger.error("test error message", { context: "test" })).not.toThrow(); + }); + + test("getPinoLogger should return underlying pino instance", () => { + const pinoInstance = logger.getPinoLogger(); + expect(pinoInstance).toBeDefined(); + expect(typeof pinoInstance.debug).toBe("function"); + expect(typeof pinoInstance.info).toBe("function"); + expect(typeof pinoInstance.warn).toBe("function"); + expect(typeof pinoInstance.error).toBe("function"); + }); + + test("should accept custom options", () => { + const customLogger = new PinoLogger({ + level: "warn", + name: "custom-logger", + transport: undefined, + }); + expect(customLogger).toBeInstanceOf(PinoLogger); + }); + + test("should respect RULESETS_LOG_LEVEL environment variable", () => { + const originalLogLevel = process.env.RULESETS_LOG_LEVEL; + process.env.RULESETS_LOG_LEVEL = "debug"; + + const envLogger = new PinoLogger({ transport: undefined }); + expect(envLogger).toBeInstanceOf(PinoLogger); + + const p = envLogger.getPinoLogger(); + expect(p.level).toBe("debug"); + + if (originalLogLevel === undefined) { + process.env.RULESETS_LOG_LEVEL = undefined; + } else { + process.env.RULESETS_LOG_LEVEL = originalLogLevel; + } + }); + + test("should handle RULESETS_LOG_PRETTY environment variable", () => { + const originalPretty = process.env.RULESETS_LOG_PRETTY; + process.env.RULESETS_LOG_PRETTY = "true"; + + // Should not throw even if pino-pretty is not available + expect(() => new PinoLogger()).not.toThrow(); + + if (originalPretty === undefined) { + process.env.RULESETS_LOG_PRETTY = undefined; + } else { + process.env.RULESETS_LOG_PRETTY = originalPretty; + } + }); + + test("should validate invalid RULESETS_LOG_LEVEL and default to info", () => { + const originalLogLevel = process.env.RULESETS_LOG_LEVEL; + process.env.RULESETS_LOG_LEVEL = "invalid"; + + const envLogger = new PinoLogger({ transport: undefined }); + const p = envLogger.getPinoLogger(); + expect(p.level).toBe("info"); + + if (originalLogLevel === undefined) { + process.env.RULESETS_LOG_LEVEL = undefined; + } else { + process.env.RULESETS_LOG_LEVEL = originalLogLevel; + } + }); + }); + + describe("Logger compatibility", () => { + test("both loggers should implement the same interface", () => { + const consoleLogger = new ConsoleLogger(); + const pinoLogger = new PinoLogger({ level: "silent", transport: undefined }); + + const testLoggerInterface = (logger: Logger) => { + expect(typeof logger.debug).toBe("function"); + expect(typeof logger.info).toBe("function"); + expect(typeof logger.warn).toBe("function"); + expect(typeof logger.error).toBe("function"); + }; + + testLoggerInterface(consoleLogger); + testLoggerInterface(pinoLogger); + }); + }); +}); diff --git a/packages/core/src/interfaces/logger.ts b/packages/core/src/interfaces/logger.ts index 9d15794..9ae0593 100644 --- a/packages/core/src/interfaces/logger.ts +++ b/packages/core/src/interfaces/logger.ts @@ -1,5 +1,9 @@ // :M: tldr: Defines the Logger interface for Rulesets // :M: v0.1.0: Simple logging contract with four standard levels +import pino from "pino"; + +export type LogLevel = "debug" | "info" | "warn" | "error"; + export type Logger = { // :M: tldr: Logs a debug message // :M: v0.1.0: For detailed debugging information @@ -15,34 +19,178 @@ export type Logger = { error(message: string | Error, ...args: unknown[]): void; }; +// :M: tldr: Helper to validate and normalize log levels +// :M: v0.2.0: Ensures only valid log levels are used +function getValidLogLevel(level: string | undefined): LogLevel { + const validLevels: LogLevel[] = ["debug", "info", "warn", "error"]; + return validLevels.includes(level as LogLevel) ? (level as LogLevel) : "info"; +} + +// :M: tldr: Helper to check if logging is enabled for a level +// :M: v0.2.0: Consistent level checking across logger implementations +function shouldLog(currentLevel: LogLevel, targetLevel: LogLevel): boolean { + const levels: LogLevel[] = ["debug", "info", "warn", "error"]; + const currentIndex = levels.indexOf(currentLevel); + const targetIndex = levels.indexOf(targetLevel); + return targetIndex >= currentIndex; +} + // Basic console logger implementation for v0 export class ConsoleLogger implements Logger { + private readonly level: LogLevel; + + constructor() { + this.level = getValidLogLevel(process.env.RULESETS_LOG_LEVEL); + } + // :M: tldr: Logs a debug message to the console - // :M: v0.1.0: Console implementation of debug logging - debug(_message: string, ..._args: unknown[]): void { - if (process.env.RULESETS_LOG_LEVEL === "debug") { - // Debug logging disabled in v0.1.0 + // :M: v0.2.0: Console implementation with consistent level filtering + debug(message: string, ...args: unknown[]): void { + if (shouldLog(this.level, "debug")) { + console.debug(`[DEBUG] ${message}`, ...args); } } + // :M: tldr: Logs an informational message to the console - // :M: v0.1.0: Console implementation of info logging - info(_message: string, ..._args: unknown[]): void { - // Info logging disabled in v0.1.0 + // :M: v0.2.0: Console implementation with consistent level filtering + info(message: string, ...args: unknown[]): void { + if (shouldLog(this.level, "info")) { + console.info(`[INFO] ${message}`, ...args); + } } + // :M: tldr: Logs a warning message to the console - // :M: v0.1.0: Console implementation of warning logging - warn(_message: string, ..._args: unknown[]): void { - // Warning logging disabled in v0.1.0 + // :M: v0.2.0: Console implementation with consistent level filtering + warn(message: string, ...args: unknown[]): void { + if (shouldLog(this.level, "warn")) { + console.warn(`[WARN] ${message}`, ...args); + } } + // :M: tldr: Logs an error message to the console - // :M: v0.1.0: Console implementation with stack trace support - error(message: string | Error, ..._args: unknown[]): void { + // :M: v0.2.0: Console implementation with consistent level filtering and stack trace support + error(message: string | Error, ...args: unknown[]): void { + if (shouldLog(this.level, "error")) { + if (message instanceof Error) { + console.error(`[ERROR] ${message.message}`, message.stack, ...args); + } else { + console.error(`[ERROR] ${message}`, ...args); + } + } + } +} + +// Pino-based logger implementation for production use +// :M: tldr: Production logger implementation using pino +// :M: v0.2.0: Structured logging with configurable levels and formatting +export class PinoLogger implements Logger { + private readonly logger: pino.Logger; + + constructor(options: pino.LoggerOptions = {}) { + // :M: tldr: Initialize pino logger with sensible defaults + // :M: v0.2.0: Support custom configuration while maintaining backward compatibility + const defaultOptions: pino.LoggerOptions = { + level: getValidLogLevel(process.env.RULESETS_LOG_LEVEL), + transport: this.createTransport(), + formatters: { + level: (label) => ({ level: label.toUpperCase() }), + bindings: () => ({}), + }, + }; + + this.logger = pino({ + ...defaultOptions, + ...options, + }); + } + + // :M: tldr: Creates transport configuration with graceful pino-pretty fallback + // :M: v0.2.0: Only enables pretty transport when explicitly requested and available + private createTransport(): pino.TransportTargetOptions | undefined { + if (process.env.RULESETS_LOG_PRETTY !== "true") { + return; + } + + try { + // Check if pino-pretty is available + require.resolve("pino-pretty"); + return { + target: "pino-pretty", + options: { + colorize: true, + ignore: "pid,hostname", + translateTime: "SYS:standard", + }, + }; + } catch { + // pino-pretty not available, fall back to default transport + return; + } + } + + // :M: tldr: Logs a debug message using pino + // :M: v0.2.0: Structured debug logging with direct object merging + debug(message: string, ...args: unknown[]): void { + if (args.length === 1 && typeof args[0] === "object" && args[0] !== null) { + this.logger.debug(args[0] as Record, message); + } else if (args.length > 0) { + this.logger.debug({ args }, message); + } else { + this.logger.debug(message); + } + } + + // :M: tldr: Logs an informational message using pino + // :M: v0.2.0: Structured info logging with direct object merging + info(message: string, ...args: unknown[]): void { + if (args.length === 1 && typeof args[0] === "object" && args[0] !== null) { + this.logger.info(args[0] as Record, message); + } else if (args.length > 0) { + this.logger.info({ args }, message); + } else { + this.logger.info(message); + } + } + + // :M: tldr: Logs a warning message using pino + // :M: v0.2.0: Structured warning logging with direct object merging + warn(message: string, ...args: unknown[]): void { + if (args.length === 1 && typeof args[0] === "object" && args[0] !== null) { + this.logger.warn(args[0] as Record, message); + } else if (args.length > 0) { + this.logger.warn({ args }, message); + } else { + this.logger.warn(message); + } + } + + // :M: tldr: Logs an error message using pino + // :M: v0.2.0: Structured error logging with native pino error conventions + error(message: string | Error, ...args: unknown[]): void { if (message instanceof Error) { - // biome-ignore lint/suspicious/noConsole: Logger needs to output errors - console.error(message.stack ?? message.message); + if (args.length === 1 && typeof args[0] === "object" && args[0] !== null) { + this.logger.error( + { err: message, ...(args[0] as Record) }, + message.message + ); + } else if (args.length > 0) { + this.logger.error({ err: message, args }, message.message); + } else { + this.logger.error({ err: message }, message.message); + } + } else if (args.length === 1 && typeof args[0] === "object" && args[0] !== null) { + this.logger.error(args[0] as Record, message); + } else if (args.length > 0) { + this.logger.error({ args }, message); } else { - // biome-ignore lint/suspicious/noConsole: Logger needs to output errors - console.error(message); + this.logger.error(message); } } + + // :M: tldr: Provides access to underlying pino logger for advanced use cases + // :M: v0.2.0: Allows direct access to pino features like child loggers + // :M: Note: This method exposes implementation details and may be removed in future versions + getPinoLogger(): pino.Logger { + return this.logger; + } }