Feature/check ordering js should succeed

.gitattributes

@@ -0,0 +1 @@
+* text=auto

.github/workflows/check-csv-ordering.yaml

@@ -12,11 +12,10 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Generate header-free version
-        run: tail -n +2 fate-product-list.csv > headerless.csv
-
-      - name: Generate sorted version
-        run: LC_ALL=en_US.UTF-8 sort headerless.csv | head -c -1 > sorted.csv
-
-      - name: Compare sorted and actual list
-        run: diff --color=always -u headerless.csv sorted.csv
+      - name: Setup nodejs
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+      - run: npm ci
+      - name: Check ordering
+        run: npm test

package.json

@@ -4,7 +4,7 @@
   "description": "A list of Fate RPG products.",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "node scripts/check-csv-order.js"
   },
   "repository": {
     "type": "git",
@@ -15,5 +15,8 @@
   "bugs": {
     "url": "https://github.com/fate-srd/fate-product-list/issues"
   },
-  "homepage": "https://github.com/fate-srd/fate-product-list#readme"
-}
+  "homepage": "https://github.com/fate-srd/fate-product-list#readme",
+  "devDependencies": {
+    "csv-parse": "^5.5.6"
+  }
+}

readme.md

@@ -16,6 +16,43 @@ The submission will be reviewed and added to the Fate SRD. This usually happens
 
 If you are comfortable with editing files and git/Github, you may [create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request). It will be reviewed and added to the site.
 
+There is a Github check configured to ensure the CSV file is in the expected order. This check is implemented a small
+Javascript script that runs under [Nodejs](https://nodejs.org/) version 20.x. (The code ill probably run under older versions, too.)
+
+To check the CSV file order locally, before you push your changes to Github, you must have a current version of Nodejs 
+installed, then run the following commands.
+
+```bash
+npm install
+npm test
+```
+
+Example output of successful test:
+```
+% npm test
+
+> [email protected] test
+> node scripts/check-csv-order.js
+
+check-csv-order: started.
+check-csv-order: finished, fate-product-list.csv is correctly ordered.
+%
+```
+
+Example output of unsuccessful test:
+```
+% npm test
+
+> [email protected] test
+> node scripts/check-csv-order.js
+
+check-csv-order: started.
+Mismatch on record 222:
+ input: "Publisher Name: Modiphius, Product title: Mindjammer: The Mindjammer Companion"
+sorted: "Publisher Name: Modiphius, Product title: Mindjammer: The Core Worlds Sourcebook"
+%
+```
+
 ### Submitting an issue
 
 1. Be logged into Github.

scripts/check-csv-order.js

@@ -0,0 +1,65 @@
+
+const process = require('node:process');
+const fs = require('node:fs/promises');
+
+const {parse: csvParse} = require('csv-parse/sync');
+
+const compStrings = new Intl.Collator('en-us', {sensitivity: 'base'}).compare; // , ignorePunctuation: true
+
+/**
+ * Compares 2 product records by publisher then title.
+ *
+ * Used in sort function to sort.
+ *
+ * @param {"Publisher Name": string, "Product title": string} a
+ * @param {"Publisher Name": string, "Product title": string} b
+ * @returns {number}
+ */
+function compRecords(a, b) {
+  const publisherA = a["Publisher Name"];
+  const titleA = a["Product title"];
+
+  const publisherB = b["Publisher Name"];
+  const titleB = b["Product title"];
+
+  const pubCompare = compStrings(publisherA, publisherB);
+  if (pubCompare === 0) {
+    return compStrings(titleA, titleB);
+  }
+  return pubCompare;
+}
+
+/**
+ * Generates a string describing the record.
+ *
+ * @param {"Publisher Name": string, "Product title": string} a
+ * @returns {string}
+ */
+function recordToString(a) {
+  return `Publisher Name: ${a["Publisher Name"]}, Product title: ${a["Product title"]}`
+}
+
+(async (path) => {
+  console.log('check-csv-order: started.');
+
+  const fileContents = await fs.readFile(path, {encoding: 'utf8'});
+
+  // Parse CSV rows into object records.
+  const records = csvParse(fileContents, {columns: true});
+  // console.log('records: ', records);
+
+  // Sort records
+  const recordsSorted = records.toSorted(compRecords);
+  // console.log('recordsSorted: ', recordsSorted);
+
+  // Compare input records to sorted records, exit with process error on first difference.
+  for (let i = 0; i < records.length; i++) {
+    if (compRecords(records[i], recordsSorted[i]) !== 0) {
+      console.log(`Mismatch on record ${i}:\n input: "${recordToString(records[i])}"\nsorted: "${recordToString(recordsSorted[i])}"`)
+      process.exit(1);
+    }
+  }
+  console.log(`check-csv-order: finished, ${path} is correctly ordered.`);
+})('fate-product-list.csv');
+
+