Port tests from JS to TS, replacing Ava with Jest

Author: mjradwin

jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+export default {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};

package-lock.json

@@ -12,6 +12,7 @@
     "type": "git",
     "url": "git+https://github.com/hebcal/hdate-js.git"
   },
+  "type": "module",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "typings": "dist/index.d.ts",
@@ -25,9 +26,9 @@
     "dist/*"
   ],
   "scripts": {
-    "test": "ava",
+    "test": "jest",
     "build": "npm run po2json && npm run build:es6 && npm run build:cjs && npm run build:types",
-    "build:cjs": "tsc",
+    "build:cjs": "tsc -p ./tsconfig-cjs.json",
     "build:es6": "tsc -p ./tsconfig-es6.json",
     "build:types": "tsc -p ./tsconfig-types.json",
     "po2json": "node ./po2json.cjs po/*.po",
@@ -39,10 +40,11 @@
     "lint": "gts lint"
   },
   "devDependencies": {
-    "@ava/typescript": "^5.0.0",
+    "@types/jest": "^29.5.12",
     "@types/node": "20.12.12",
-    "ava": "^6.1.3",
     "gts": "^5.3.0",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.4",
     "ttag-cli": "^1.10.12",
     "typescript": "^5.4.5"
   }

package.json

@@ -86,7 +86,7 @@ export class HDate {
    * @param {number|string} [month] - Hebrew month of year (1=NISAN, 7=TISHREI)
    * @param {number} [year] - Hebrew year
    */
-  constructor(day: number|Date|HDate|SimpleHebrewDate|undefined, month?: number|string, year?: number) {
+  constructor(day?: number|Date|HDate|SimpleHebrewDate|undefined, month?: number|string, year?: number) {
     if (arguments.length === 2 || arguments.length > 3) {
       throw new TypeError('HDate constructor requires 0, 1 or 3 arguments');
     }

src/hdate.ts

@@ -96,9 +96,9 @@ export class Locale {
    * Adds a translation to `locale`, replacing any previous translation.
    * @param {string} locale Locale name (i.e: `'he'`, `'fr'`).
    * @param {string} id Message ID to translate
-   * @param {string} translation Translation text
+   * @param {string | string[]} translation Translation text
    */
-  static addTranslation(locale: string, id: string, translation: string): void {
+  static addTranslation(locale: string, id: string, translation: string | string[]): void {
     if (typeof locale !== 'string') {
       throw new TypeError(`Invalid locale name: ${locale}`);
     }

src/locale.ts

@@ -119,7 +119,7 @@ export class Sedra {
    * @param {string} [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale
    * @return {string}
    */
-  getString(hd: HDate | number, locale: string): string {
+  getString(hd: HDate | number, locale?: string): string {
     const parsha = this.get(hd);
     const locale0 = locale || Locale.getLocaleName();
     let name = Locale.gettext(parsha[0], locale0);

src/sedra.ts

@@ -1,12 +1,13 @@
 /* eslint-disable max-len */
-const test = require('ava');
-const {months} = require('../dist/cjs/hdate-base');
-const {getYahrzeit, getBirthdayOrAnniversary,
-  getYahrzeitHD, getBirthdayHD} = require('../dist/cjs/anniversary');
+import {months} from '../src/hdate-base';
+import {
+  getYahrzeit, getBirthdayOrAnniversary,
+  getYahrzeitHD, getBirthdayHD
+} from '../src/anniversary';
 
-test('yahrzeit', (t) => {
+test('yahrzeit', () => {
   // Gregorian YYYY, MM, DD
-  const items = [
+  const items: [number, number, number, string, string][] = [
     [2017, 1, 13, 'General',
       '1/2/2018 12/23/2018 1/12/2020 12/30/2020 12/19/2021 1/8/2023 12/27/2023 1/15/2025 1/4/2026 12/25/2026 1/14/2028 1/2/2029 12/21/2029 1/10/2031 12/30/2031 12/17/2032 1/6/2034 12/27/2034 1/15/2036 1/2/2037 12/23/2037 1/11/2039 1/1/2040 12/19/2040 1/7/2042 12/28/2042',
     ],
@@ -36,14 +37,15 @@ test('yahrzeit', (t) => {
     for (let i = 0; i < 25; i++) {
       const hyear = i + 5778;
       const yahrzeit = getYahrzeit(hyear, gd);
-      const dateStr = yahrzeit.toLocaleDateString('en-US');
-      t.is(dateStr, expected[i], `${name} ${i} ${hyear}`);
+      expect(yahrzeit).toBeDefined();
+      const dateStr = (yahrzeit as Date).toLocaleDateString('en-US');
+      expect(dateStr).toBe(expected[i]);
     }
   }
 });
 
-test('birthday', (t) => {
-  const items = [
+test('birthday', () => {
+  const items: [number, number, number, string, string][] = [
     [1948, 3, 11, 'Adar1-30',
       '3/23/1993 3/13/1994 3/2/1995 3/21/1996 3/9/1997 3/28/1998 3/18/1999 3/7/2000 3/25/2001 3/14/2002 3/4/2003 3/23/2004 3/11/2005 3/30/2006 3/20/2007 3/7/2008 3/26/2009 3/16/2010 3/6/2011 3/24/2012 3/12/2013',
     ],
@@ -70,32 +72,37 @@ test('birthday', (t) => {
     for (let i = 0; i < 21; i++) {
       const hyear = i + 5753;
       const birthday = getBirthdayOrAnniversary(hyear, gd);
-      const dateStr = birthday.toLocaleDateString('en-US');
-      t.is(dateStr, expected[i], `${name} ${i} ${hyear}`);
+      expect(birthday).toBeDefined();
+      const dateStr = (birthday as Date).toLocaleDateString('en-US');
+      expect(dateStr).toBe(expected[i]);
     }
   }
 });
 
-test('before-original', (t) => {
+test('before-original', () => {
   let dt = getYahrzeit(5769, new Date(2008, 10, 13));
-  t.is(dt, undefined, 'Hebrew year 5769 occurs on or before original date in 5769');
+  expect(dt).toBe(undefined); // 'Hebrew year 5769 occurs on or before original date in 5769');
 
   dt = getYahrzeit(5770, new Date(2008, 10, 13));
-  t.is(dt.getFullYear(), 2009);
+  expect(dt).toBeDefined();
+  expect((dt as Date).getFullYear()).toBe(2009);
 
   dt = getBirthdayOrAnniversary(5778, new Date(2018, 11, 13));
-  t.is(dt, undefined, 'Hebrew year 5778 occurs before original date in 5779');
+  expect(dt).toBe(undefined); // 'Hebrew year 5778 occurs before original date in 5779');
 
   dt = getBirthdayOrAnniversary(5780, new Date(2018, 11, 13));
-  t.is(dt.getFullYear(), 2020);
+  expect(dt).toBeDefined();
+  expect((dt as Date).getFullYear()).toBe(2020);
 });
 
-test('ctor-hdate', (t) => {
+test('ctor-hdate', () => {
   const niftar = {dd: 15, mm: months.CHESHVAN, yy: 5769};
   const yahrzeit = getYahrzeitHD(5782, niftar);
-  t.deepEqual(yahrzeit, {dd: 15, mm: 8, yy: 5782}, '15 Cheshvan 5782');
+  expect(yahrzeit).toBeDefined();
+  expect(yahrzeit).toEqual({dd: 15, mm: 8, yy: 5782});
 
   const birth = {dd: 23, mm: months.SIVAN, yy: 5735};
   const anniversary = getBirthdayHD(5782, birth);
-  t.deepEqual(anniversary, {dd: 23, mm: 3, yy: 5782}, '23 Sivan 5782');
+  expect(anniversary).toBeDefined();
+  expect(anniversary).toEqual({dd: 23, mm: 3, yy: 5782});
 });

test/anniversary.spec.js test/anniversary.spec.ts

@@ -0,0 +1,51 @@
+import {gematriya, gematriyaStrToNum} from '../src/gematriya';
+
+test('gematriya', () => {
+  expect(gematriya(5749)).toBe('תשמ״ט');
+  expect(gematriya(5774)).toBe('תשע״ד');
+  expect(gematriya(5780)).toBe('תש״פ');
+  expect(gematriya(3)).toBe('ג׳');
+  expect(gematriya(14)).toBe('י״ד');
+  expect(gematriya(15)).toBe('ט״ו');
+  expect(gematriya(16)).toBe('ט״ז');
+  expect(gematriya(17)).toBe('י״ז');
+  expect(gematriya(20)).toBe('כ׳');
+  expect(gematriya(25)).toBe('כ״ה');
+  expect(gematriya(60)).toBe('ס׳');
+  expect(gematriya(123)).toBe('קכ״ג');
+  expect(gematriya(613)).toBe('תרי״ג');
+  expect(gematriya(3761)).toBe('ג׳תשס״א');
+  expect(gematriya(6749)).toBe('ו׳תשמ״ט');
+  expect(gematriya(8765)).toBe('ח׳תשס״ה');
+  expect(gematriya(22700)).toBe('כב׳ת״ש');
+  expect(gematriya(16123)).toBe('טז׳קכ״ג');
+  expect(gematriya(1123)).toBe('א׳קכ״ג');
+  expect(gematriya(6000)).toBe('ו׳');
+  expect(gematriya(7007)).toBe('ז׳ז׳');
+});
+
+test('gematriyaStrToNum', () => {
+  expect(gematriyaStrToNum('תשמ״ט')).toBe(749);
+  expect(gematriyaStrToNum('תשע״ד')).toBe(774);
+  expect(gematriyaStrToNum('תש״פ')).toBe(780);
+  expect(gematriyaStrToNum('ג׳')).toBe(3);
+  expect(gematriyaStrToNum('י״ד')).toBe(14);
+  expect(gematriyaStrToNum('ט״ו')).toBe(15);
+  expect(gematriyaStrToNum('ט״ז')).toBe(16);
+  expect(gematriyaStrToNum('י״ז')).toBe(17);
+  expect(gematriyaStrToNum('כ׳')).toBe(20);
+  expect(gematriyaStrToNum('כ״ה')).toBe(25);
+  expect(gematriyaStrToNum('ס׳')).toBe(60);
+  expect(gematriyaStrToNum('קכ״ג')).toBe(123);
+  expect(gematriyaStrToNum('תרי״ג')).toBe(613);
+});
+
+test('gematriyaStrToNum-thousands', () => {
+  expect(gematriyaStrToNum('ג׳תשס״א')).toBe(3761);
+  expect(gematriyaStrToNum('ו׳תשמ״ט')).toBe(6749);
+  expect(gematriyaStrToNum('ח׳תשס״ה')).toBe(8765);
+  expect(gematriyaStrToNum('כב׳ת״ש')).toBe(22700);
+  expect(gematriyaStrToNum('טז׳קכ״ג')).toBe(16123);
+  expect(gematriyaStrToNum('א׳קכ״ג')).toBe(1123);
+  expect(gematriyaStrToNum('ז׳ז׳')).toBe(7007);
+});