Normalise line-endings in the test suite to enable cross-platform testing

Author: 75lb

.github/workflows/node.js.yml

@@ -4,7 +4,7 @@ name: Node.js CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [ master, next ]
   pull_request:
     branches: [ master ]
 
@@ -15,7 +15,7 @@ jobs:
 
     strategy:
       matrix:
-        os: [ubuntu-latest] # Remove windows as tests fail on `\r\n` style newlines
+        os: [ubuntu-latest, windows-latest] # Remove windows as tests fail on `\r\n` style newlines
         node-version: [12, 14, 16, 18, 20, 22, 23]
 
     steps:
@@ -28,3 +28,4 @@ jobs:
     - run: npm install
     - run: npm i -g @75lb/nature
     - run: npm run test:ci
+

package-lock.json

@@ -11,7 +11,8 @@ test.set('.explain({ files, cache: true  })', async function () {
   const f = new Fixture('class-all')
   jsdoc.cache.dir = 'tmp/test/cache1'
   await jsdoc.cache.clear()
-  const output = await jsdoc.explain({ files: f.sourcePath, cache: true })
+  let output = await jsdoc.explain({ files: f.sourcePath, cache: true })
+  output = Fixture.normaliseNewLines(output)
   const cachedFiles = readdirSync(jsdoc.cache.dir)
     .map(file => path.resolve(jsdoc.cache.dir, file))
   a.equal(cachedFiles.length, 1)

test/caching.js

@@ -7,13 +7,15 @@ const [test, only, skip] = [new Map(), new Map(), new Map()]
 
 test.set('.explain({ files })', async function () {
   const f = new Fixture('class-all')
-  const output = await jsdoc.explain({ files: f.sourcePath })
+  let output = await jsdoc.explain({ files: f.sourcePath })
+  output = Fixture.normaliseNewLines(output)
   a.deepEqual(output, f.getExpectedOutput(output))
 })
 
 test.set('.explain({ source })', async function () {
   const f = new Fixture('class-all')
-  const output = await jsdoc.explain({ source: f.getSource() })
+  let output = await jsdoc.explain({ source: f.getSource() })
+  output = Fixture.normaliseNewLines(output)
   a.deepEqual(output, f.getExpectedOutput(output))
 })
 

test/explain.js

@@ -0,0 +1 @@
+../../../node_modules/.bin/jsdoc

test/fixture/folder with spaces/jsdoc

@@ -44,6 +44,16 @@ class Fixture {
       }
     })
   }
+
+  static normaliseNewLines (doclets) {
+    const input = JSON.stringify(doclets)
+    /* Normalise all newlines to posix style to avoid differences while testing on Windows */
+    let result = input.replace(/\r?\n/gm, '\n')
+    /* Additional check for naked \r characters created by jsdoc */
+    /* See: https://github.com/jsdoc2md/dmd/issues/102 */
+    result = result.replace(/\r(?!\n)/g, '\n')
+    return JSON.parse(result)
+  }
 }
 
 export default Fixture