@prairielearn/formatter 1.1.0 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @prairielearn/formatter
 
+## 1.2.0
+
+### Minor Changes
+
+- d3336c2: Add `formatInterval` function
+
 ## 1.1.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -1 +1,2 @@
 export { formatDate, formatDateYMD, formatDateYMDHM } from './date.js';
+export { formatInterval } from './interval.js';

package/dist/index.js

@@ -1,2 +1,3 @@
 export { formatDate, formatDateYMD, formatDateYMDHM } from './date.js';
+export { formatInterval } from './interval.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC","sourcesContent":["export { formatDate, formatDateYMD, formatDateYMDHM } from './date.js';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AACvE,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC","sourcesContent":["export { formatDate, formatDateYMD, formatDateYMDHM } from './date.js';\nexport { formatInterval } from './interval.js';\n"]}

package/dist/interval.d.ts

@@ -0,0 +1,11 @@
+export declare const SECOND_IN_MILLISECONDS = 1000;
+export declare const MINUTE_IN_MILLISECONDS: number;
+export declare const HOUR_IN_MILLISECONDS: number;
+export declare const DAY_IN_MILLISECONDS: number;
+/**
+ * Format an interval (in milliseconds) to a human-readable string like '3 h 40 m'.
+ *
+ * @param interval Time interval in milliseconds.
+ * @returns Human-readable string representing the interval.
+ */
+export declare function formatInterval(interval: number): string;

package/dist/interval.js

@@ -0,0 +1,35 @@
+export const SECOND_IN_MILLISECONDS = 1000;
+export const MINUTE_IN_MILLISECONDS = 60 * SECOND_IN_MILLISECONDS;
+export const HOUR_IN_MILLISECONDS = 60 * MINUTE_IN_MILLISECONDS;
+export const DAY_IN_MILLISECONDS = 24 * HOUR_IN_MILLISECONDS;
+/**
+ * Format an interval (in milliseconds) to a human-readable string like '3 h 40 m'.
+ *
+ * @param interval Time interval in milliseconds.
+ * @returns Human-readable string representing the interval.
+ */
+export function formatInterval(interval) {
+    const sign = interval < 0 ? '-' : '';
+    const days = Math.floor(Math.abs(interval) / DAY_IN_MILLISECONDS);
+    const hours = Math.floor(Math.abs(interval) / HOUR_IN_MILLISECONDS) % 24;
+    const mins = Math.floor(Math.abs(interval) / MINUTE_IN_MILLISECONDS) % 60;
+    const secs = Math.floor(Math.abs(interval) / SECOND_IN_MILLISECONDS) % 60;
+    const parts = [];
+    if (days > 0) {
+        parts.push(`${sign}${days} d`);
+    }
+    if (hours > 0) {
+        parts.push(`${sign}${hours} h`);
+    }
+    if (mins > 0) {
+        parts.push(`${sign}${mins} min`);
+    }
+    if (secs > 0) {
+        parts.push(`${sign}${secs} s`);
+    }
+    if (parts.length === 0) {
+        parts.push('0 s');
+    }
+    return parts.join(' ');
+}
+//# sourceMappingURL=interval.js.map

package/dist/interval.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interval.js","sourceRoot":"","sources":["../src/interval.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,sBAAsB,GAAG,IAAI,CAAC;AAC3C,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,GAAG,sBAAsB,CAAC;AAClE,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,GAAG,sBAAsB,CAAC;AAChE,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,GAAG,oBAAoB,CAAC;AAE7D;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,QAAgB;IAC7C,MAAM,IAAI,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAErC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,mBAAmB,CAAC,CAAC;IAClE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,oBAAoB,CAAC,GAAG,EAAE,CAAC;IACzE,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,sBAAsB,CAAC,GAAG,EAAE,CAAC;IAC1E,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,sBAAsB,CAAC,GAAG,EAAE,CAAC;IAE1E,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;QACb,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC;IACjC,CAAC;IACD,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QACd,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,KAAK,IAAI,CAAC,CAAC;IAClC,CAAC;IACD,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;QACb,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,IAAI,MAAM,CAAC,CAAC;IACnC,CAAC;IACD,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;QACb,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC;IACjC,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC","sourcesContent":["export const SECOND_IN_MILLISECONDS = 1000;\nexport const MINUTE_IN_MILLISECONDS = 60 * SECOND_IN_MILLISECONDS;\nexport const HOUR_IN_MILLISECONDS = 60 * MINUTE_IN_MILLISECONDS;\nexport const DAY_IN_MILLISECONDS = 24 * HOUR_IN_MILLISECONDS;\n\n/**\n * Format an interval (in milliseconds) to a human-readable string like '3 h 40 m'.\n *\n * @param interval Time interval in milliseconds.\n * @returns Human-readable string representing the interval.\n */\nexport function formatInterval(interval: number): string {\n  const sign = interval < 0 ? '-' : '';\n\n  const days = Math.floor(Math.abs(interval) / DAY_IN_MILLISECONDS);\n  const hours = Math.floor(Math.abs(interval) / HOUR_IN_MILLISECONDS) % 24;\n  const mins = Math.floor(Math.abs(interval) / MINUTE_IN_MILLISECONDS) % 60;\n  const secs = Math.floor(Math.abs(interval) / SECOND_IN_MILLISECONDS) % 60;\n\n  const parts: string[] = [];\n\n  if (days > 0) {\n    parts.push(`${sign}${days} d`);\n  }\n  if (hours > 0) {\n    parts.push(`${sign}${hours} h`);\n  }\n  if (mins > 0) {\n    parts.push(`${sign}${mins} min`);\n  }\n  if (secs > 0) {\n    parts.push(`${sign}${secs} s`);\n  }\n  if (parts.length === 0) {\n    parts.push('0 s');\n  }\n\n  return parts.join(' ');\n}\n"]}

package/dist/interval.test.d.ts

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

package/dist/interval.test.js

@@ -0,0 +1,31 @@
+import { assert } from 'chai';
+import { formatInterval } from './interval.js';
+describe('interval formatting', () => {
+    describe('formatInterval()', () => {
+        it('should handle seconds', () => {
+            assert.equal(formatInterval(7000), '7 s');
+        });
+        it('should handle fractional seconds', () => {
+            assert.equal(formatInterval(7321), '7 s');
+        });
+        it('should handle minutes', () => {
+            assert.equal(formatInterval(2 * 60 * 1000), '2 min');
+        });
+        it('should handle hours', () => {
+            assert.equal(formatInterval(3 * 60 * 60 * 1000), '3 h');
+        });
+        it('should handle hours', () => {
+            assert.equal(formatInterval(4 * 24 * 60 * 60 * 1000), '4 d');
+        });
+        it('should handle complex intervals', () => {
+            assert.equal(formatInterval((((4 * 24 + 3) * 60 + 2) * 60 + 7) * 1000), '4 d 3 h 2 min 7 s');
+        });
+        it('should handle zero', () => {
+            assert.equal(formatInterval(0), '0 s');
+        });
+        it('should handle negative intervals', () => {
+            assert.equal(formatInterval(-(((4 * 24 + 3) * 60 + 2) * 60 + 7) * 1000), '-4 d -3 h -2 min -7 s');
+        });
+    });
+});
+//# sourceMappingURL=interval.test.js.map

package/dist/interval.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interval.test.js","sourceRoot":"","sources":["../src/interval.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAE9B,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAE/C,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;IACnC,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;YAC/B,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;YAC1C,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;YAC/B,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,qBAAqB,EAAE,GAAG,EAAE;YAC7B,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,qBAAqB,EAAE,GAAG,EAAE;YAC7B,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;QAC/D,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;YACzC,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,EAAE,mBAAmB,CAAC,CAAC;QAC/F,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,oBAAoB,EAAE,GAAG,EAAE;YAC5B,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;YAC1C,MAAM,CAAC,KAAK,CACV,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,EAC1D,uBAAuB,CACxB,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { assert } from 'chai';\n\nimport { formatInterval } from './interval.js';\n\ndescribe('interval formatting', () => {\n  describe('formatInterval()', () => {\n    it('should handle seconds', () => {\n      assert.equal(formatInterval(7000), '7 s');\n    });\n    it('should handle fractional seconds', () => {\n      assert.equal(formatInterval(7321), '7 s');\n    });\n    it('should handle minutes', () => {\n      assert.equal(formatInterval(2 * 60 * 1000), '2 min');\n    });\n    it('should handle hours', () => {\n      assert.equal(formatInterval(3 * 60 * 60 * 1000), '3 h');\n    });\n    it('should handle hours', () => {\n      assert.equal(formatInterval(4 * 24 * 60 * 60 * 1000), '4 d');\n    });\n    it('should handle complex intervals', () => {\n      assert.equal(formatInterval((((4 * 24 + 3) * 60 + 2) * 60 + 7) * 1000), '4 d 3 h 2 min 7 s');\n    });\n    it('should handle zero', () => {\n      assert.equal(formatInterval(0), '0 s');\n    });\n    it('should handle negative intervals', () => {\n      assert.equal(\n        formatInterval(-(((4 * 24 + 3) * 60 + 2) * 60 + 7) * 1000),\n        '-4 d -3 h -2 min -7 s',\n      );\n    });\n  });\n});\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prairielearn/formatter",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "type": "module",
   "main": "dist/index.js",
   "repository": {

package/src/index.ts

@@ -1 +1,2 @@
 export { formatDate, formatDateYMD, formatDateYMDHM } from './date.js';
+export { formatInterval } from './interval.js';

package/src/interval.test.ts

@@ -0,0 +1,35 @@
+import { assert } from 'chai';
+
+import { formatInterval } from './interval.js';
+
+describe('interval formatting', () => {
+  describe('formatInterval()', () => {
+    it('should handle seconds', () => {
+      assert.equal(formatInterval(7000), '7 s');
+    });
+    it('should handle fractional seconds', () => {
+      assert.equal(formatInterval(7321), '7 s');
+    });
+    it('should handle minutes', () => {
+      assert.equal(formatInterval(2 * 60 * 1000), '2 min');
+    });
+    it('should handle hours', () => {
+      assert.equal(formatInterval(3 * 60 * 60 * 1000), '3 h');
+    });
+    it('should handle hours', () => {
+      assert.equal(formatInterval(4 * 24 * 60 * 60 * 1000), '4 d');
+    });
+    it('should handle complex intervals', () => {
+      assert.equal(formatInterval((((4 * 24 + 3) * 60 + 2) * 60 + 7) * 1000), '4 d 3 h 2 min 7 s');
+    });
+    it('should handle zero', () => {
+      assert.equal(formatInterval(0), '0 s');
+    });
+    it('should handle negative intervals', () => {
+      assert.equal(
+        formatInterval(-(((4 * 24 + 3) * 60 + 2) * 60 + 7) * 1000),
+        '-4 d -3 h -2 min -7 s',
+      );
+    });
+  });
+});

package/src/interval.ts

@@ -0,0 +1,39 @@
+export const SECOND_IN_MILLISECONDS = 1000;
+export const MINUTE_IN_MILLISECONDS = 60 * SECOND_IN_MILLISECONDS;
+export const HOUR_IN_MILLISECONDS = 60 * MINUTE_IN_MILLISECONDS;
+export const DAY_IN_MILLISECONDS = 24 * HOUR_IN_MILLISECONDS;
+
+/**
+ * Format an interval (in milliseconds) to a human-readable string like '3 h 40 m'.
+ *
+ * @param interval Time interval in milliseconds.
+ * @returns Human-readable string representing the interval.
+ */
+export function formatInterval(interval: number): string {
+  const sign = interval < 0 ? '-' : '';
+
+  const days = Math.floor(Math.abs(interval) / DAY_IN_MILLISECONDS);
+  const hours = Math.floor(Math.abs(interval) / HOUR_IN_MILLISECONDS) % 24;
+  const mins = Math.floor(Math.abs(interval) / MINUTE_IN_MILLISECONDS) % 60;
+  const secs = Math.floor(Math.abs(interval) / SECOND_IN_MILLISECONDS) % 60;
+
+  const parts: string[] = [];
+
+  if (days > 0) {
+    parts.push(`${sign}${days} d`);
+  }
+  if (hours > 0) {
+    parts.push(`${sign}${hours} h`);
+  }
+  if (mins > 0) {
+    parts.push(`${sign}${mins} min`);
+  }
+  if (secs > 0) {
+    parts.push(`${sign}${secs} s`);
+  }
+  if (parts.length === 0) {
+    parts.push('0 s');
+  }
+
+  return parts.join(' ');
+}