@bbc/morty-docs 2.0.0 → 3.0.1

package/README.md

@@ -197,4 +197,4 @@ We would expect code quality to be at least as good if not better than
 the code quality of the project at the time you make your contribution.
 After all, we all hope to leave things better than we find them!
 
-© BBC 2021
+© BBC 2024

package/build/generate-transform-input.js

@@ -1,15 +1,54 @@
-const readdir = require('recursive-readdir');
 const fs = require('fs');
 const path = require('path');
 const generateTransformInput = dir => {
   dir = path.format(path.parse(dir));
-  return readdir(dir).then(files => {
-    return files.map(file => {
-      return {
-        relativePath: file.toString().replace(`${dir}/`, ''),
-        raw: fs.readFileSync(file)
-      };
-    });
+  let list = [];
+  const files = fs.readdirSync(dir, {
+    recursive: true,
+    withFileTypes: true
   });
+  // recursive option available from node 18+
+  // when options.withFileTypes set to true, the returned array will contain <fs.Dirent> objects.
+  for (const dirent of files) {
+    // Node API for Dirent is unstable
+    const dirPath = dirent.path || dirent.parentPath; // path is DEPRECATED! But parentPath does not work in 18.17
+
+    const fullPath = path.join(dirPath, dirent.name);
+    // console.log('fullPath = ', fullPath)
+
+    if (dirent.isDirectory()) {
+      console.log('directory... continue');
+      continue;
+    }
+    if (dirent.isFile()) {
+      list.push(makeInputObject(fullPath, dir));
+      continue;
+    }
+    if (dirent.isSymbolicLink) {
+      if (fs.existsSync(fullPath)) {
+        // fs.exists() is deprecated, but fs.existsSync() is not.
+        const stats = fs.statSync(fullPath);
+        console.log('Good symlink');
+        if (stats.isFile()) {
+          // get file details
+          list.push(makeInputObject(fullPath, dir)); // symlinks become copies
+        } else {
+          // recursive call to get all files in the symlinked directory
+          const newlist = generateTransformInput(fullPath);
+          list = list.concat(newlist);
+        }
+      } else {
+        console.log(`Broken symlink at: ${fullPath}`);
+      }
+      continue;
+    }
+  }
+  return list;
+};
+const makeInputObject = (fullPath, rootPath) => {
+  return {
+    relativePath: fullPath.replace(`${rootPath}/`, ''),
+    raw: fs.readFileSync(fullPath, 'utf-8')
+  };
 };
 module.exports = generateTransformInput;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bbc/morty-docs",
-  "version": "2.0.0",
+  "version": "3.0.1",
   "description": "To generate a static website from markdown documentation, to allow users to consume content in an easily accessible format",
   "main": "build/index.js",
   "publishConfig": {
@@ -31,7 +31,8 @@
     "markdown"
   ],
   "engines": {
-    "node": ">=12.x"
+    "node": ">=18.x",
+    "npm": ">=8.x"
   },
   "author": "BBC",
   "license": "Apache-2.0",