@prairielearn/logger 1.0.0

package/README.md

@@ -0,0 +1,28 @@
+# `@prairielearn/logger`
+
+Provides a shared [Winston](https://github.com/winstonjs/winston) instance for all logging.
+
+## Usage
+
+```ts
+import { logger, addFileLogging } from '@prairielearn/logger';
+
+// Log all messages to a file.
+addFileLogging({ filename: '/path/to/file.log' });
+
+// Log all errors to another file.
+addFileLogging({ filename: '/path/to/errors.log', level: 'error' });
+
+logger.debug('verbose');
+logger.verbose('verbose');
+logger.info('info');
+logger.warn('warn');
+
+try {
+  await mightError();
+} catch (err) {
+  // When logging an error, ensure that the first argument is a string. You can
+  // pass the error object as the second argument if desired.
+  logger.error('An error occurred', err);
+}
+```

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import winston from 'winston';
+export declare const logger: winston.Logger;
+interface AddFileLoggingOptions {
+    filename: string;
+    level?: string;
+}
+export declare function addFileLogging(options: AddFileLoggingOptions): void;
+export {};

package/dist/index.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addFileLogging = exports.logger = void 0;
+const winston_1 = __importDefault(require("winston"));
+const logform_1 = require("logform");
+exports.logger = winston_1.default.createLogger({
+    transports: [
+        new winston_1.default.transports.Console({
+            level: 'info',
+            format: logform_1.format.combine(logform_1.format.colorize(), logform_1.format.simple()),
+        }),
+    ],
+});
+function addFileLogging(options) {
+    exports.logger.add(new winston_1.default.transports.File({
+        filename: options.filename,
+        level: options.level ?? 'debug',
+        format: logform_1.format.combine(logform_1.format.timestamp(), logform_1.format.json()),
+    }));
+}
+exports.addFileLogging = addFileLogging;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA8B;AAC9B,qCAAiC;AAEpB,QAAA,MAAM,GAAG,iBAAO,CAAC,YAAY,CAAC;IACzC,UAAU,EAAE;QACV,IAAI,iBAAO,CAAC,UAAU,CAAC,OAAO,CAAC;YAC7B,KAAK,EAAE,MAAM;YACb,MAAM,EAAE,gBAAM,CAAC,OAAO,CAAC,gBAAM,CAAC,QAAQ,EAAE,EAAE,gBAAM,CAAC,MAAM,EAAE,CAAC;SAC3D,CAAC;KACH;CACF,CAAC,CAAC;AAOH,SAAgB,cAAc,CAAC,OAA8B;IAC3D,cAAM,CAAC,GAAG,CACR,IAAI,iBAAO,CAAC,UAAU,CAAC,IAAI,CAAC;QAC1B,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,OAAO;QAC/B,MAAM,EAAE,gBAAM,CAAC,OAAO,CAAC,gBAAM,CAAC,SAAS,EAAE,EAAE,gBAAM,CAAC,IAAI,EAAE,CAAC;KAC1D,CAAC,CACH,CAAC;AACJ,CAAC;AARD,wCAQC"}

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@prairielearn/logger",
+  "version": "1.0.0",
+  "main": "./dist/index.js",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch --preserveWatchOutput"
+  },
+  "devDependencies": {
+    "@prairielearn/tsconfig": "*",
+    "@types/node": "^18.11.18",
+    "typescript": "^4.9.4"
+  },
+  "dependencies": {
+    "logform": "^2.5.1",
+    "winston": "^3.8.2",
+    "zod": "^3.20.2"
+  }
+}

package/src/index.ts

@@ -0,0 +1,26 @@
+import winston from 'winston';
+import { format } from 'logform';
+
+export const logger = winston.createLogger({
+  transports: [
+    new winston.transports.Console({
+      level: 'info',
+      format: format.combine(format.colorize(), format.simple()),
+    }),
+  ],
+});
+
+interface AddFileLoggingOptions {
+  filename: string;
+  level?: string;
+}
+
+export function addFileLogging(options: AddFileLoggingOptions) {
+  logger.add(
+    new winston.transports.File({
+      filename: options.filename,
+      level: options.level ?? 'debug',
+      format: format.combine(format.timestamp(), format.json()),
+    })
+  );
+}

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "@prairielearn/tsconfig",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "types": ["node"],
+  }
+}