✅ add unit test for checkDelegates()

Author: ctcpip

.github/workflows/check.yml

@@ -13,4 +13,5 @@ jobs:
         name: 'nvm install lts/* && npm ci'
         with:
           node-version: lts/*
+      - run: npm run test
       - run: npm run check

README.md

@@ -1,3 +1,3 @@
-# ECMA, TC39 Meeting Notes
+# TC39 Meeting Notes
 
 See [`meetings/`](https://github.com/tc39/notes/tree/master/meetings).

package.json

@@ -1,7 +1,7 @@
 {
   "private": true,
   "scripts": {
-    "check": "./scripts/check-delegates.js",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "check": "node -e 'import(\"./scripts/check-delegates.mjs\").then(cd => cd.checkDelegates())'",
+    "test": "node ./scripts/check-delegates-test.mjs"
   }
 }

scripts/check-delegates-test.mjs

@@ -0,0 +1,19 @@
+import { strict as assert } from 'node:assert';
+import { checkDelegates } from './check-delegates.mjs';
+
+const lex = `Rob Palmer (RPR)\nUjjwal Sharma (USA)\nChris de Almeida (CDA)`;
+const missing = `Chris de Almeida (CDA)\nRob Palmer\nUjjwal Sharma (USA)`;
+const uppercaseLatin = `Chris de Almeida (CDA)\nRob Palmer (竄)\nUjjwal Sharma (USA)`;
+const twoLetter = `Chris de Almeida (CDA)\nRob Palmer (RP)\nUjjwal Sharma (USA)`;
+const threeLetter = `Chris de Almeida (CDA)\nRob Palmer (ROBPALMER)\nUjjwal Sharma (USA)`;
+const duplicate = `Chris de Almeida (CDA)\nRob Palmer (RPR)\nUjjwal Sharma (USA)\nUjjwal Sharma (USA)`;
+const valid = `Chris de Almeida (CDA)\nRob Palmer (RPR)\nUjjwal Sharma (USA)`;
+
+assert.throws(()=>checkDelegates(lex), { message: /Not in lexicographic order/});
+assert.throws(()=>checkDelegates(missing), { message: /Missing abbreviation for/});
+assert.throws(()=>checkDelegates(uppercaseLatin), { message: /Abbreviations must be all uppercase Latin letters/});
+assert.throws(()=>checkDelegates(twoLetter), { message: /not in allowlist. New delegate abbreviations must be three letters/});
+assert.throws(()=>checkDelegates(threeLetter), { message: /New delegate abbreviations must be three letters/});
+assert.throws(()=>checkDelegates(duplicate), { message: /Conflicting usage on line/});
+
+assert.doesNotThrow(()=>checkDelegates(valid));

scripts/check-delegates.js

@@ -0,0 +1,65 @@
+#!/usr/bin/env node
+
+import fs from 'fs';
+
+export function checkDelegates(contents = fs.readFileSync('./delegates.txt', 'utf8').toString()) {
+
+  console.debug('checking delegates...');
+
+  // List of delegate abbreviations that predate the 3-letter
+  // requirement. Do not change this!
+  const TWO_LETTER_ABBRS = new Set([
+    'AC', 'AH', 'AK', 'AR', 'AS', 'BB', 'BE', 'BG', 'BM', 'BN', 'BS',
+    'BT', 'BZ', 'CF', 'CM', 'CP', 'DC', 'DD', 'DE', 'DH', 'DL', 'DS',
+    'DT', 'EA', 'EF', 'ET', 'EY', 'FN', 'FP', 'GB', 'GI', 'GN', 'GY',
+    'IH', 'IS', 'IT', 'JB', 'JH', 'JK', 'JM', 'JN', 'JP', 'JS', 'JT',
+    'KG', 'KM', 'KR', 'KS', 'LB', 'LH', 'LL', 'LM', 'MB', 'MF', 'MH',
+    'MM', 'MP', 'MS', 'NC', 'NH', 'NL', 'NM', 'OH', 'PJ', 'PL', 'RB',
+    'RH', 'RW', 'RX', 'SC', 'SK', 'SM', 'SP', 'TC', 'TD', 'TS', 'TW',
+    'VM', 'WH', 'YK', 'ZB',
+  ]);
+
+
+  const re = /^(?<name>[^(]+)(?: \((?<abbr>[^)]*)\))?$/;
+  const abbrs = new Map;
+  const lines = contents.split('\n');
+
+  let lineNumber = 1;
+  let previousLine = '';
+
+  for (const line of lines) {
+    if (line.length === 0) continue;
+    const match = re.exec(line);
+    const {name, abbr} = match.groups;
+
+    if (previousLine.localeCompare(line, 'en') > 0) {
+      throw new Error(`Line ${lineNumber}: Not in lexicographic order.`);
+    }
+
+    if (abbr == null) {
+      throw new Error(`Line ${lineNumber}: Missing abbreviation for ${JSON.stringify(line)}.`);
+    }
+
+    if (!/^[A-Z]+$/.test(abbr)) {
+      throw new Error(`Line ${lineNumber}: Abbreviations must be all uppercase Latin letters.`);
+    }
+
+    if (abbr.length === 2) {
+      if (!TWO_LETTER_ABBRS.has(abbr)) {
+        throw new Error(`Line ${lineNumber}: 2-letter abbreviation ${JSON.stringify(abbr)} not in allowlist. New delegate abbreviations must be three letters.`);
+      }
+    } else if (abbr.length !== 3) {
+      throw new Error(`Line ${lineNumber}: Invalid abbreviation ${JSON.stringify(abbr)}. New delegate abbreviations must be three letters.`);
+    }
+
+    if (abbrs.has(abbr)) {
+      throw new Error(`Line ${lineNumber}: Duplicate abbreviation ${JSON.stringify(abbr)}. Conflicting usage on line ${abbrs.get(abbr)}.`);
+    }
+    abbrs.set(abbr, lineNumber);
+
+    previousLine = line;
+    ++lineNumber;
+  }
+
+  console.debug('...delegates are valid\n');
+}