@prairielearn/formatter 1.0.0

package/.mocharc.cjs

@@ -0,0 +1,3 @@
+module.exports = {
+  require: ['tsx'],
+};

package/dist/date.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Format a date to a human-readable string like '2020-03-27T12:34:56 (CDT)'.
+ *
+ * @param date The date to format.
+ * @param timeZone The time zone to use for formatting.
+ * @param param2.includeTz Whether to include the time zone in the output (default true).
+ * @param param2.longTz Whether to use the long time zone name (default false).
+ * @returns Human-readable string representing the date.
+ */
+export declare function formatDate(date: Date, timeZone: string, { includeTz, longTz }?: {
+    includeTz?: boolean;
+    longTz?: boolean;
+}): string;

package/dist/date.js

@@ -0,0 +1,30 @@
+import keyBy from 'lodash/keyBy.js';
+/**
+ * Format a date to a human-readable string like '2020-03-27T12:34:56 (CDT)'.
+ *
+ * @param date The date to format.
+ * @param timeZone The time zone to use for formatting.
+ * @param param2.includeTz Whether to include the time zone in the output (default true).
+ * @param param2.longTz Whether to use the long time zone name (default false).
+ * @returns Human-readable string representing the date.
+ */
+export function formatDate(date, timeZone, { includeTz = true, longTz = false } = {}) {
+    const options = {
+        timeZone,
+        hourCycle: 'h23',
+        year: 'numeric',
+        month: '2-digit',
+        day: '2-digit',
+        hour: '2-digit',
+        minute: '2-digit',
+        second: '2-digit',
+        timeZoneName: longTz ? 'long' : 'short',
+    };
+    const parts = keyBy(new Intl.DateTimeFormat('en-US', options).formatToParts(date), (x) => x.type);
+    let dateFormatted = `${parts.year.value}-${parts.month.value}-${parts.day.value} ${parts.hour.value}:${parts.minute.value}:${parts.second.value}`;
+    if (includeTz) {
+        dateFormatted = `${dateFormatted} (${parts.timeZoneName.value})`;
+    }
+    return dateFormatted;
+}
+//# sourceMappingURL=date.js.map

package/dist/date.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"date.js","sourceRoot":"","sources":["../src/date.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,iBAAiB,CAAC;AAEpC;;;;;;;;GAQG;AACH,MAAM,UAAU,UAAU,CACxB,IAAU,EACV,QAAgB,EAChB,EAAE,SAAS,GAAG,IAAI,EAAE,MAAM,GAAG,KAAK,KAAgD,EAAE;IAEpF,MAAM,OAAO,GAA+B;QAC1C,QAAQ;QACR,SAAS,EAAE,KAAK;QAChB,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,SAAS;QAChB,GAAG,EAAE,SAAS;QACd,IAAI,EAAE,SAAS;QACf,MAAM,EAAE,SAAS;QACjB,MAAM,EAAE,SAAS;QACjB,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO;KACxC,CAAC;IACF,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAClG,IAAI,aAAa,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IAClJ,IAAI,SAAS,EAAE,CAAC;QACd,aAAa,GAAG,GAAG,aAAa,KAAK,KAAK,CAAC,YAAY,CAAC,KAAK,GAAG,CAAC;IACnE,CAAC;IACD,OAAO,aAAa,CAAC;AACvB,CAAC","sourcesContent":["import keyBy from 'lodash/keyBy.js';\n\n/**\n * Format a date to a human-readable string like '2020-03-27T12:34:56 (CDT)'.\n *\n * @param date The date to format.\n * @param timeZone The time zone to use for formatting.\n * @param param2.includeTz Whether to include the time zone in the output (default true).\n * @param param2.longTz Whether to use the long time zone name (default false).\n * @returns Human-readable string representing the date.\n */\nexport function formatDate(\n  date: Date,\n  timeZone: string,\n  { includeTz = true, longTz = false }: { includeTz?: boolean; longTz?: boolean } = {},\n): string {\n  const options: Intl.DateTimeFormatOptions = {\n    timeZone,\n    hourCycle: 'h23',\n    year: 'numeric',\n    month: '2-digit',\n    day: '2-digit',\n    hour: '2-digit',\n    minute: '2-digit',\n    second: '2-digit',\n    timeZoneName: longTz ? 'long' : 'short',\n  };\n  const parts = keyBy(new Intl.DateTimeFormat('en-US', options).formatToParts(date), (x) => x.type);\n  let dateFormatted = `${parts.year.value}-${parts.month.value}-${parts.day.value} ${parts.hour.value}:${parts.minute.value}:${parts.second.value}`;\n  if (includeTz) {\n    dateFormatted = `${dateFormatted} (${parts.timeZoneName.value})`;\n  }\n  return dateFormatted;\n}\n"]}

package/dist/date.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/date.test.js

@@ -0,0 +1,31 @@
+import { assert } from 'chai';
+import { formatDate } from './date.js';
+describe('date formatting', () => {
+    describe('formatDate', () => {
+        it('formats a UTC date', () => {
+            const date = new Date(Date.UTC(2018, 0, 1, 12, 0, 0));
+            assert.equal(formatDate(date, 'UTC'), '2018-01-01 12:00:00 (UTC)');
+        });
+        it('formats a CST date', () => {
+            const date = new Date(Date.UTC(2018, 0, 1, 12, 0, 0));
+            assert.equal(formatDate(date, 'America/Chicago'), '2018-01-01 06:00:00 (CST)');
+        });
+        it('formats a CDT date', () => {
+            const date = new Date(Date.UTC(2018, 6, 1, 12, 0, 0));
+            assert.equal(formatDate(date, 'America/Chicago'), '2018-07-01 07:00:00 (CDT)');
+        });
+        it('formats dates with zero hours', () => {
+            const date = new Date(Date.UTC(2018, 0, 1, 0, 1, 0));
+            assert.equal(formatDate(date, 'UTC'), '2018-01-01 00:01:00 (UTC)');
+        });
+        it('formats dates without the timezone', () => {
+            const date = new Date(Date.UTC(2018, 0, 1, 12, 0, 0));
+            assert.equal(formatDate(date, 'UTC', { includeTz: false }), '2018-01-01 12:00:00');
+        });
+        it('formats dates with the long timezone name', () => {
+            const date = new Date(Date.UTC(2018, 0, 1, 12, 0, 0));
+            assert.equal(formatDate(date, 'America/Chicago', { longTz: true }), '2018-01-01 06:00:00 (Central Standard Time)');
+        });
+    });
+});
+//# sourceMappingURL=date.test.js.map

package/dist/date.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"date.test.js","sourceRoot":"","sources":["../src/date.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAE9B,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAEvC,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAC1B,EAAE,CAAC,oBAAoB,EAAE,GAAG,EAAE;YAC5B,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YACtD,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,2BAA2B,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,oBAAoB,EAAE,GAAG,EAAE;YAC5B,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YACtD,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,iBAAiB,CAAC,EAAE,2BAA2B,CAAC,CAAC;QACjF,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,oBAAoB,EAAE,GAAG,EAAE;YAC5B,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YACtD,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,iBAAiB,CAAC,EAAE,2BAA2B,CAAC,CAAC;QACjF,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;YACvC,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YACrD,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,2BAA2B,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;YAC5C,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YACtD,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,EAAE,qBAAqB,CAAC,CAAC;QACrF,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;YACnD,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YACtD,MAAM,CAAC,KAAK,CACV,UAAU,CAAC,IAAI,EAAE,iBAAiB,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EACrD,6CAA6C,CAC9C,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { assert } from 'chai';\n\nimport { formatDate } from './date.js';\n\ndescribe('date formatting', () => {\n  describe('formatDate', () => {\n    it('formats a UTC date', () => {\n      const date = new Date(Date.UTC(2018, 0, 1, 12, 0, 0));\n      assert.equal(formatDate(date, 'UTC'), '2018-01-01 12:00:00 (UTC)');\n    });\n    it('formats a CST date', () => {\n      const date = new Date(Date.UTC(2018, 0, 1, 12, 0, 0));\n      assert.equal(formatDate(date, 'America/Chicago'), '2018-01-01 06:00:00 (CST)');\n    });\n    it('formats a CDT date', () => {\n      const date = new Date(Date.UTC(2018, 6, 1, 12, 0, 0));\n      assert.equal(formatDate(date, 'America/Chicago'), '2018-07-01 07:00:00 (CDT)');\n    });\n    it('formats dates with zero hours', () => {\n      const date = new Date(Date.UTC(2018, 0, 1, 0, 1, 0));\n      assert.equal(formatDate(date, 'UTC'), '2018-01-01 00:01:00 (UTC)');\n    });\n    it('formats dates without the timezone', () => {\n      const date = new Date(Date.UTC(2018, 0, 1, 12, 0, 0));\n      assert.equal(formatDate(date, 'UTC', { includeTz: false }), '2018-01-01 12:00:00');\n    });\n    it('formats dates with the long timezone name', () => {\n      const date = new Date(Date.UTC(2018, 0, 1, 12, 0, 0));\n      assert.equal(\n        formatDate(date, 'America/Chicago', { longTz: true }),\n        '2018-01-01 06:00:00 (Central Standard Time)',\n      );\n    });\n  });\n});\n"]}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { formatDate } from './date.js';

package/dist/index.js

@@ -0,0 +1,2 @@
+export { formatDate } from './date.js';
+//# 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,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC","sourcesContent":["export { formatDate } from './date.js';\n"]}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@prairielearn/formatter",
+  "version": "1.0.0",
+  "type": "module",
+  "main": "dist/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/PrairieLearn/PrairieLearn.git",
+    "directory": "packages/formatter"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch --preserveWatchOutput",
+    "test": "c8 mocha src/**/*.test.ts"
+  },
+  "dependencies": {
+    "lodash": "^4.17.21"
+  },
+  "devDependencies": {
+    "@prairielearn/tsconfig": "^0.0.0",
+    "@types/node": "^20.12.11",
+    "c8": "^9.1.0",
+    "chai": "^5.1.1",
+    "mocha": "^10.4.0",
+    "tsx": "^4.10.4",
+    "typescript": "^5.4.5"
+  },
+  "c8": {
+    "reporter": [
+      "html",
+      "text-summary",
+      "cobertura"
+    ],
+    "all": true,
+    "include": [
+      "src/**"
+    ]
+  }
+}

package/src/date.test.ts

@@ -0,0 +1,35 @@
+import { assert } from 'chai';
+
+import { formatDate } from './date.js';
+
+describe('date formatting', () => {
+  describe('formatDate', () => {
+    it('formats a UTC date', () => {
+      const date = new Date(Date.UTC(2018, 0, 1, 12, 0, 0));
+      assert.equal(formatDate(date, 'UTC'), '2018-01-01 12:00:00 (UTC)');
+    });
+    it('formats a CST date', () => {
+      const date = new Date(Date.UTC(2018, 0, 1, 12, 0, 0));
+      assert.equal(formatDate(date, 'America/Chicago'), '2018-01-01 06:00:00 (CST)');
+    });
+    it('formats a CDT date', () => {
+      const date = new Date(Date.UTC(2018, 6, 1, 12, 0, 0));
+      assert.equal(formatDate(date, 'America/Chicago'), '2018-07-01 07:00:00 (CDT)');
+    });
+    it('formats dates with zero hours', () => {
+      const date = new Date(Date.UTC(2018, 0, 1, 0, 1, 0));
+      assert.equal(formatDate(date, 'UTC'), '2018-01-01 00:01:00 (UTC)');
+    });
+    it('formats dates without the timezone', () => {
+      const date = new Date(Date.UTC(2018, 0, 1, 12, 0, 0));
+      assert.equal(formatDate(date, 'UTC', { includeTz: false }), '2018-01-01 12:00:00');
+    });
+    it('formats dates with the long timezone name', () => {
+      const date = new Date(Date.UTC(2018, 0, 1, 12, 0, 0));
+      assert.equal(
+        formatDate(date, 'America/Chicago', { longTz: true }),
+        '2018-01-01 06:00:00 (Central Standard Time)',
+      );
+    });
+  });
+});

package/src/date.ts

@@ -0,0 +1,34 @@
+import keyBy from 'lodash/keyBy.js';
+
+/**
+ * Format a date to a human-readable string like '2020-03-27T12:34:56 (CDT)'.
+ *
+ * @param date The date to format.
+ * @param timeZone The time zone to use for formatting.
+ * @param param2.includeTz Whether to include the time zone in the output (default true).
+ * @param param2.longTz Whether to use the long time zone name (default false).
+ * @returns Human-readable string representing the date.
+ */
+export function formatDate(
+  date: Date,
+  timeZone: string,
+  { includeTz = true, longTz = false }: { includeTz?: boolean; longTz?: boolean } = {},
+): string {
+  const options: Intl.DateTimeFormatOptions = {
+    timeZone,
+    hourCycle: 'h23',
+    year: 'numeric',
+    month: '2-digit',
+    day: '2-digit',
+    hour: '2-digit',
+    minute: '2-digit',
+    second: '2-digit',
+    timeZoneName: longTz ? 'long' : 'short',
+  };
+  const parts = keyBy(new Intl.DateTimeFormat('en-US', options).formatToParts(date), (x) => x.type);
+  let dateFormatted = `${parts.year.value}-${parts.month.value}-${parts.day.value} ${parts.hour.value}:${parts.minute.value}:${parts.second.value}`;
+  if (includeTz) {
+    dateFormatted = `${dateFormatted} (${parts.timeZoneName.value})`;
+  }
+  return dateFormatted;
+}

package/src/index.ts

@@ -0,0 +1 @@
+export { formatDate } from './date.js';

package/tsconfig.json

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