@prairielearn/logger 3.0.0 → 3.1.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @prairielearn/logger
 
+## 3.1.0
+
+### Minor Changes
+
+- 35ca957: Add `withoutLogging` utility to `@prairielearn/logger` for temporarily silencing logger output during test execution.
+
+## 3.0.1
+
+### Patch Changes
+
+- 8bdf6ea: Upgrade all JavaScript dependencies
+
 ## 3.0.0
 
 ### Major Changes

package/dist/index.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Temporarily silence all logger output while executing the provided function.
+ *
+ * @param fn - The function to run with the logger silenced.
+ * @returns The result of the function.
+ */
+export declare function withoutLogging<T>(fn: () => T | Promise<T>): Promise<T>;
 export declare const logger: import("winston").Logger;
 interface AddFileLoggingOptions {
     filename: string;

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,MAAM,0BAOjB,CAAC;AAEH,UAAU,qBAAqB;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,wBAAgB,cAAc,CAAC,OAAO,EAAE,qBAAqB,QAQ5D","sourcesContent":["import { format } from 'logform';\nimport { createLogger, transports } from 'winston';\n\nexport const logger = createLogger({\n  transports: [\n    new transports.Console({\n      level: 'info',\n      format: format.combine(format.colorize(), format.simple()),\n    }),\n  ],\n});\n\ninterface AddFileLoggingOptions {\n  filename: string;\n  level?: string;\n}\n\nexport function addFileLogging(options: AddFileLoggingOptions) {\n  logger.add(\n    new transports.File({\n      filename: options.filename,\n      level: options.level ?? 'debug',\n      format: format.combine(format.timestamp(), format.json()),\n    }),\n  );\n}\n"]}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,wBAAsB,cAAc,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAQ5E;AAED,eAAO,MAAM,MAAM,0BAOjB,CAAC;AAEH,UAAU,qBAAqB;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,wBAAgB,cAAc,CAAC,OAAO,EAAE,qBAAqB,QAQ5D","sourcesContent":["import { format } from 'logform';\nimport { createLogger, transports } from 'winston';\n\n/**\n * Temporarily silence all logger output while executing the provided function.\n *\n * @param fn - The function to run with the logger silenced.\n * @returns The result of the function.\n */\nexport async function withoutLogging<T>(fn: () => T | Promise<T>): Promise<T> {\n  const originalSilent = logger.silent;\n  logger.silent = true;\n  try {\n    return await fn();\n  } finally {\n    logger.silent = originalSilent;\n  }\n}\n\nexport const logger = createLogger({\n  transports: [\n    new transports.Console({\n      level: 'info',\n      format: format.combine(format.colorize(), format.simple()),\n    }),\n  ],\n});\n\ninterface AddFileLoggingOptions {\n  filename: string;\n  level?: string;\n}\n\nexport function addFileLogging(options: AddFileLoggingOptions) {\n  logger.add(\n    new transports.File({\n      filename: options.filename,\n      level: options.level ?? 'debug',\n      format: format.combine(format.timestamp(), format.json()),\n    }),\n  );\n}\n"]}

package/dist/index.js

@@ -1,5 +1,21 @@
 import { format } from 'logform';
 import { createLogger, transports } from 'winston';
+/**
+ * Temporarily silence all logger output while executing the provided function.
+ *
+ * @param fn - The function to run with the logger silenced.
+ * @returns The result of the function.
+ */
+export async function withoutLogging(fn) {
+    const originalSilent = logger.silent;
+    logger.silent = true;
+    try {
+        return await fn();
+    }
+    finally {
+        logger.silent = originalSilent;
+    }
+}
 export const logger = createLogger({
     transports: [
         new transports.Console({

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAEnD,MAAM,CAAC,MAAM,MAAM,GAAG,YAAY,CAAC;IACjC,UAAU,EAAE;QACV,IAAI,UAAU,CAAC,OAAO,CAAC;YACrB,KAAK,EAAE,MAAM;YACb,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC;SAC3D,CAAC;KACH;CACF,CAAC,CAAC;AAOH,MAAM,UAAU,cAAc,CAAC,OAA8B,EAAE;IAC7D,MAAM,CAAC,GAAG,CACR,IAAI,UAAU,CAAC,IAAI,CAAC;QAClB,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,OAAO;QAC/B,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC;KAC1D,CAAC,CACH,CAAC;AAAA,CACH","sourcesContent":["import { format } from 'logform';\nimport { createLogger, transports } from 'winston';\n\nexport const logger = createLogger({\n  transports: [\n    new transports.Console({\n      level: 'info',\n      format: format.combine(format.colorize(), format.simple()),\n    }),\n  ],\n});\n\ninterface AddFileLoggingOptions {\n  filename: string;\n  level?: string;\n}\n\nexport function addFileLogging(options: AddFileLoggingOptions) {\n  logger.add(\n    new transports.File({\n      filename: options.filename,\n      level: options.level ?? 'debug',\n      format: format.combine(format.timestamp(), format.json()),\n    }),\n  );\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAEnD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAI,EAAwB,EAAc;IAC5E,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC;IACrC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,CAAC;QACH,OAAO,MAAM,EAAE,EAAE,CAAC;IACpB,CAAC;YAAS,CAAC;QACT,MAAM,CAAC,MAAM,GAAG,cAAc,CAAC;IACjC,CAAC;AAAA,CACF;AAED,MAAM,CAAC,MAAM,MAAM,GAAG,YAAY,CAAC;IACjC,UAAU,EAAE;QACV,IAAI,UAAU,CAAC,OAAO,CAAC;YACrB,KAAK,EAAE,MAAM;YACb,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC;SAC3D,CAAC;KACH;CACF,CAAC,CAAC;AAOH,MAAM,UAAU,cAAc,CAAC,OAA8B,EAAE;IAC7D,MAAM,CAAC,GAAG,CACR,IAAI,UAAU,CAAC,IAAI,CAAC;QAClB,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,OAAO;QAC/B,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC;KAC1D,CAAC,CACH,CAAC;AAAA,CACH","sourcesContent":["import { format } from 'logform';\nimport { createLogger, transports } from 'winston';\n\n/**\n * Temporarily silence all logger output while executing the provided function.\n *\n * @param fn - The function to run with the logger silenced.\n * @returns The result of the function.\n */\nexport async function withoutLogging<T>(fn: () => T | Promise<T>): Promise<T> {\n  const originalSilent = logger.silent;\n  logger.silent = true;\n  try {\n    return await fn();\n  } finally {\n    logger.silent = originalSilent;\n  }\n}\n\nexport const logger = createLogger({\n  transports: [\n    new transports.Console({\n      level: 'info',\n      format: format.combine(format.colorize(), format.simple()),\n    }),\n  ],\n});\n\ninterface AddFileLoggingOptions {\n  filename: string;\n  level?: string;\n}\n\nexport function addFileLogging(options: AddFileLoggingOptions) {\n  logger.add(\n    new transports.File({\n      filename: options.filename,\n      level: options.level ?? 'debug',\n      format: format.combine(format.timestamp(), format.json()),\n    }),\n  );\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prairielearn/logger",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "type": "module",
   "repository": {
     "type": "git",
@@ -21,9 +21,9 @@
     "zod": "^3.25.76"
   },
   "devDependencies": {
-    "@prairielearn/tsconfig": "^0.0.0",
+    "@prairielearn/tsconfig": "^2.0.0",
     "@types/node": "^24.10.9",
-    "@typescript/native-preview": "^7.0.0-dev.20260106.1",
+    "@typescript/native-preview": "^7.0.0-dev.20260203.1",
     "typescript": "^5.9.3"
   }
 }

package/src/index.ts

@@ -1,6 +1,22 @@
 import { format } from 'logform';
 import { createLogger, transports } from 'winston';
 
+/**
+ * Temporarily silence all logger output while executing the provided function.
+ *
+ * @param fn - The function to run with the logger silenced.
+ * @returns The result of the function.
+ */
+export async function withoutLogging<T>(fn: () => T | Promise<T>): Promise<T> {
+  const originalSilent = logger.silent;
+  logger.silent = true;
+  try {
+    return await fn();
+  } finally {
+    logger.silent = originalSilent;
+  }
+}
+
 export const logger = createLogger({
   transports: [
     new transports.Console({