Use eol.lf with jsdoc-to-markdown

Make sure the output of jsdoc-to-markdown always produces Unix line
endings (LF and not CRLF or CR).

Author: spl

docs/createDocs.js

@@ -1,11 +1,16 @@
 /* eslint-disable no-use-before-define */
+
+// This file is used only for development, so we disable the following check.
+/* eslint import/no-extraneous-dependencies: ["error", {"devDependencies": true}] */
+
 // https://auth0.com/docs/api/management/v2#!/Clients/post_clients
 // https://terminusdb.eu.auth0.com/api/v2/
 
-// eslint-disable-next-line import/no-extraneous-dependencies
 const jsdoc2md = require('jsdoc-to-markdown');
 const fs = require('fs');
 const path = require('path');
+const eol = require('eol');
+
 const { woqlClientMenu } = require('./navigationModel');
 
 /* input and output paths */
@@ -69,7 +74,10 @@ function createFile(filePath, options, outputDir) {
   // const template = `{{#class name="${className}"}}{{>docs}}{{/class}}`
   // eslint-disable-next-line no-console
   console.log(`rendering ${filePath}`);
-  const output = jsdoc2md.renderSync(options);
+  // Use `eol.lf` to guarantee the string always has Unix (LF) line endings,
+  // `jsdoc-to-markdown` may use different line endings depending on the OS, and
+  // this can cause problems with rendering the Markdown.
+  const output = eol.lf(jsdoc2md.renderSync(options));
   fs.writeFileSync(path.resolve(outputDir, `${fileName}.md`), setHeadings(fileName, output));
 }
 /// /([\w-]+)(.js)/

package.json

@@ -20,13 +20,13 @@
   "author": "[email protected]",
   "license": "Apache-2.0",
   "dependencies": {
-    "pathval":">=1.1.1",
-    "ajv":">=6.12.3",
-    "follow-redirects":">=1.14.8",
+    "ajv": ">=6.12.3",
     "axios": ">=0.25.0",
-    "form-data": "^4.0.0",
     "babel-polyfill": "^6.26.0",
+    "follow-redirects": ">=1.14.8",
+    "form-data": "^4.0.0",
     "node-forge": ">=1.0.0",
+    "pathval": ">=1.1.1",
     "underscore": ">=1.13.2"
   },
   "devDependencies": {
@@ -40,6 +40,7 @@
     "chai": "^4.3.4",
     "coveralls": "^3.1.1",
     "docsify-cli": "^4.4.2",
+    "eol": "^0.9.1",
     "eslint": "^8.6.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-prettier": "6.11.0",