@bbc/morty-docs 3.0.3 → 4.0.2

package/package.json

@@ -1,22 +1,21 @@
 {
   "name": "@bbc/morty-docs",
-  "version": "3.0.3",
+  "version": "4.0.2",
   "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": {
     "access": "public"
   },
   "scripts": {
-    "prebuild": "[ -d node_modules ] || npm install",
-    "preversion": "npm run test",
-    "start": "rm -rf www && npm run build -- --source-maps && node run.js && npx http-server www",
-    "build": "rm -rf build && mkdir build && babel src --out-dir build",
-    "build-watch": "npm run build -- --source-maps --watch",
+    "prepare": "npm run build",
+    "prebuild": "[ -d node_modules ] || npm ci",
+    "start": "rm -rf www && npm run build -- --sourcemap && node run.js && npx http-server www",
+    "build": "rm -rf build && esbuild src/index.js --bundle --minify --platform=node --target=node22 --outfile=build/index.js",
     "test": "jest --runInBand --outputFile test-results.json --json",
     "coverage": "jest --coverage --runInBand && open coverage/lcov-report/index.html",
     "lint": "standard",
     "posttest": "npm run lint",
-    "prepare": "npm run build",
+    "preversion": "npm run test",
     "postversion": "git push origin main && git push --tags origin main"
   },
   "files": [
@@ -41,29 +40,24 @@
   },
   "homepage": "https://github.com/bbc/morty-docs#readme",
   "dependencies": {
-    "asciidoctor": "^2.2.6",
-    "fs-extra": "^7.0.1",
-    "react": "^16.8.6",
-    "react-dom": "^16.8.6",
-    "react-test-renderer": "^16.13.1",
-    "recursive-readdir": "^2.2.2",
-    "showdown": "^1.9.0"
+    "marked": "^15.0.12",
+    "node-emoji": "^2.2.0",
+    "react": "^19.2.1",
+    "react-dom": "^19.2.1"
   },
   "devDependencies": {
-    "@babel/cli": "^7.17.0",
-    "@babel/core": "^7.9.0",
-    "@babel/node": "^7.4.5",
-    "@babel/preset-react": "^7.0.0",
-    "babel-eslint": "^10.0.3",
+    "@babel/core": "^7.28.5",
+    "@babel/preset-react": "^7.28.5",
+    "@happy-dom/jest-environment": "^20.0.11",
+    "@testing-library/react": "^16.3.0",
+    "esbuild": "^0.27.1",
     "http-server": "^14.1.1",
-    "jest": "^29.7.0",
-    "jest-serializer-html": "^7.0.0",
-    "standard": "^12.0.1"
+    "jest": "^30.2.0",
+    "standard": "^17.1.2"
   },
   "standard": {
     "env": [
       "jest"
-    ],
-    "parser": "babel-eslint"
+    ]
   }
 }

package/build/generate-indexes.js

@@ -1,46 +0,0 @@
-const path = require('path');
-const renderIndexPage = require('./page-renderers/IndexPage');
-const getDirectories = require('./helpers/get-directory-paths');
-const filterFilesInDirectory = require('./helpers/filter-files-in-dir');
-const filterDirectoriesInDirectory = require('./helpers/filter-dirs-in-dir');
-const generateIndex = (directory, filePaths, subDirPaths, options) => {
-  const subDirLinks = subDirPaths.filter(dirPath => !dirPath.includes('/')).map(dirPath => ({
-    link: `${dirPath}/index.html`,
-    text: dirPath,
-    iconName: 'folder'
-  }));
-  const fileLinks = filePaths.map(filePath => {
-    const text = path.basename(filePath);
-    return {
-      link: encodeURIComponent(text),
-      text,
-      iconName: 'file'
-    };
-  });
-  return renderIndexPage([...subDirLinks, ...fileLinks], options, directory);
-};
-const generateIndexes = (files, options = {
-  contentTitle: ''
-}) => {
-  const supportedFilePaths = files.map(file => file.relativePath).filter(relativePath => path.extname(relativePath) === '.html' || path.extname(relativePath) === '.pdf');
-  const directories = getDirectories(supportedFilePaths);
-  // If we have not got a 'root' folder, then add one.
-  // TODO: Refactor this so it is not needed (maybe?)
-  if (!directories.includes('')) {
-    directories.push('');
-  }
-  const indexes = directories.flatMap(directory => {
-    const filesInDir = filterFilesInDirectory(supportedFilePaths, directory);
-    const subDirsInDir = filterDirectoriesInDirectory(directories, directory);
-    const indexPath = path.join(directory, 'index.html');
-    if (filesInDir.includes(indexPath)) {
-      return [];
-    }
-    return {
-      relativePath: indexPath,
-      raw: Buffer.from(generateIndex(directory, filesInDir, subDirsInDir, options))
-    };
-  });
-  return indexes;
-};
-module.exports = generateIndexes;

package/build/generate-transform-input.js

@@ -1,54 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-const generateTransformInput = dir => {
-  dir = path.format(path.parse(dir));
-  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)
-  };
-};
-module.exports = generateTransformInput;

package/build/helpers/filter-dirs-in-dir.js

@@ -1,21 +0,0 @@
-const {
-  sortArrayByDate
-} = require('./sort-array-by-date');
-const filterDirs = (directoryPaths, directory) => {
-  const directoryArray = [];
-  const nestedDirFolders = directoryPaths.filter(directoryPath => directoryPath.includes(directory) && !directoryPath.startsWith(directory) && directoryPath !== directory);
-  if (nestedDirFolders.length) directoryArray.push(nestedDirFolders);
-  // if directory path includes the config folder then return the full directory path
-
-  const rootDirFolders = directoryPaths.filter(directoryPath => directoryPath.startsWith(directory) && directoryPath !== directory);
-  const rootDir = rootDirFolders.map(directoryPath => directoryPath.startsWith(`${directory}/`) && directory !== '' ? directoryPath.replace(`${directory}/`, '') : directoryPath);
-  if (rootDir.length) directoryArray.push(rootDir);
-  // if directory path starts with the config folder then remove the directory from the path
-  // sort array here
-  let sortedDirectoryArray = directoryArray;
-  if (sortedDirectoryArray.length) {
-    sortedDirectoryArray.map(arr => sortArrayByDate(arr));
-  }
-  return sortedDirectoryArray.flat();
-};
-module.exports = filterDirs;

package/build/helpers/filter-files-in-dir.js

@@ -1,10 +0,0 @@
-const {
-  sortArrayByDate
-} = require('./sort-array-by-date');
-const directoryDepth = path => path.split('/').length;
-const isInRootDirectory = filePath => directoryDepth(filePath) === 1;
-const isIn = directory => filePath => filePath.startsWith(directory) && directoryDepth(filePath) - 1 === directoryDepth(directory);
-module.exports = (filePaths, directory) => {
-  const isInSpecifiedDirectory = directory ? isIn(directory) : isInRootDirectory;
-  return sortArrayByDate(filePaths.filter(isInSpecifiedDirectory));
-};

package/build/helpers/get-directory-paths.js

@@ -1,24 +0,0 @@
-const getDirectoryPaths = filePaths => {
-  const dirPaths = filePaths.map(path => {
-    // file = SomeOtherDir/AnotherDir/AnotherNestedDir/file.html
-    if (!path.includes('/')) return ''; // if file is not in the directory, return '', as this is the root
-
-    const splitPaths = path.split('/'); // => [ 'SomeOtherDir', 'AnotherDir', 'AnotherNestedDir', 'File1.html' ]
-    splitPaths.pop(); // remove file.html
-
-    const allDirs = splitPaths.map((splitPath, index) => {
-      const newPath = joinPathParts(splitPaths, index);
-      return newPath;
-    });
-    return allDirs;
-  });
-  return [...new Set(dirPaths.flat())];
-};
-const joinPathParts = (pathsArray, end) => {
-  if (end === 0) {
-    return pathsArray[0];
-  }
-  end++;
-  return pathsArray.slice(0, end).join('/');
-};
-module.exports = getDirectoryPaths;

package/build/helpers/get-header-paths.js

@@ -1,14 +0,0 @@
-const getHeaderLinks = (basePath, relPath = '') => {
-  const combinedParts = [...basePath.split('/'), ...relPath.split('/')];
-  const paths = combinedParts.filter(part => part && !part.endsWith('.html') && !part.endsWith('.md'));
-  return paths.reduce((acc, item, index) => {
-    const prevPart = acc[index - 1];
-    const path = prevPart ? `${prevPart.path}/${item}` : `/${item}`;
-    acc.push({
-      text: item,
-      path
-    });
-    return acc;
-  }, []);
-};
-module.exports = getHeaderLinks;

package/build/helpers/sort-array-by-date.js

@@ -1,11 +0,0 @@
-const dateRegex = /\d{4}-\d{2}-\d{2}/; // i.e. 2019-10-29
-
-function sortByDate(a, b) {
-  return a.match(dateRegex) && b.match(dateRegex) ? b.localeCompare(a) : a.localeCompare(b);
-}
-const sortArrayByDate = arr => {
-  return arr.sort(sortByDate);
-};
-module.exports = {
-  sortArrayByDate
-};

package/build/markdown-to-html-parser.js

@@ -1,64 +0,0 @@
-const showdown = require('showdown');
-
-// there may be an option to enable this, but since we haven't found it here is a reg-ex
-// to convert links within a file from *.md to *.html
-const convertMdLinksToHtmlLinks = {
-  type: 'output',
-  regex: /<a href="([^:\n]*?).md">/g,
-  // exclude colon, so external links aren't converted
-  replace: '<a href="$1.html">'
-};
-
-// Replace hash links with .html e.g. page.md#Title becomes page.html#Title.
-const convertMdHashLinksToHtmlLinks = {
-  type: 'output',
-  regex: /<a href="([^:\n]*?).md#(.*?)">/g,
-  // exclude colon, so external links aren't converted
-  replace: '<a href="$1.html#$2">'
-};
-const headingExtension = {
-  type: 'output',
-  regex: /<(h[123456]) id="([^"]+)">(.*)<\/\1>/g,
-  replace: '<$1 id="$2"><a href="#$2">$3</a></$1>'
-};
-const classMap = {
-  img: 'img-responsive',
-  table: 'table'
-};
-const bindings = Object.keys(classMap).map(key => ({
-  type: 'output',
-  regex: new RegExp(`<${key}(.*)>`, 'g'),
-  replace: `<${key} class="${classMap[key]}" $1>`
-}));
-const normaliseBasePath = basePath => {
-  const pathElements = (basePath || '').split('/').filter(entry => Boolean(entry));
-  if (pathElements.length === 0) {
-    return '';
-  }
-  return '/' + pathElements.join('/');
-};
-const createParser = options => {
-  const basePath = normaliseBasePath(options.basePath);
-  const addBasePathToRootLinks = {
-    type: 'output',
-    regex: /<a href="\/([^:\n]*)">/g,
-    // exclude colon, so external links aren't converted
-    replace: `<a href="${basePath}/$1">`
-  };
-  const addBasePathToLinkHrefs = {
-    type: 'output',
-    regex: /<link(.+)href="\/([^:\n]*)"(.*)\/>/g,
-    // exclude colon, so external links aren't converted
-    replace: `<link$1href="${basePath}/$2"$3/>`
-  };
-  const parser = new showdown.Converter({
-    extensions: [convertMdLinksToHtmlLinks, convertMdHashLinksToHtmlLinks, addBasePathToRootLinks, addBasePathToLinkHrefs, headingExtension, ...bindings]
-  });
-  parser.setFlavor('github');
-  return parser;
-};
-const parseToHTML = (markdown, options = {}) => {
-  const parser = createParser(options);
-  return parser.makeHtml(markdown);
-};
-module.exports = parseToHTML;

package/build/page-renderers/Components/Footer.js

@@ -1,29 +0,0 @@
-const React = require('react');
-const {
-  prettyDate
-} = require('./PrettyDate');
-const Styles = {
-  footer: {
-    bottom: '0',
-    width: '100%',
-    backgroundColor: '#f5f5f5',
-    boxSizing: 'border-box',
-    minHeight: '25vh',
-    position: 'relative',
-    textAlign: 'center',
-    padding: '1em 0 2em 0',
-    lineHeight: '1.5rem'
-  },
-  footerLink: {
-    color: '#337ab7'
-  }
-};
-const Footer = () => {
-  return React.createElement("footer", {
-    style: Styles.footer
-  }, React.createElement("a", {
-    href: "https://github.com/bbc/morty-docs",
-    style: Styles.footerLink
-  }, "Morty-Docs on github"), React.createElement("br", null), "Page generated on ", prettyDate(new Date()));
-};
-module.exports = Footer;

package/build/page-renderers/Components/Header.js

@@ -1,59 +0,0 @@
-const React = require('react');
-const getHeaderPaths = require('../../helpers/get-header-paths');
-const Styles = {
-  navbar: {
-    border: 'none',
-    borderRadius: '0',
-    backgroundColor: '#000',
-    marginBottom: '0',
-    width: '100%'
-  },
-  headerNav: {},
-  headerLinks: {
-    padding: '1rem',
-    listStyle: 'none',
-    display: 'flex',
-    alignItems: 'center'
-  },
-  headerLink: {
-    textAlign: 'left',
-    color: 'lightblue',
-    fontSize: '1.5rem',
-    textDecoration: 'none'
-  },
-  separator: {
-    margin: '0 0.28rem',
-    color: '#ebebeb'
-  }
-};
-const HeaderLinks = ({
-  paths
-}) => paths.map(({
-  text,
-  path
-}, index) => {
-  return React.createElement("li", {
-    key: index
-  }, index !== paths.length ? React.createElement("span", {
-    "aria-hidden": true,
-    style: Styles.separator
-  }, "/") : undefined, React.createElement("a", {
-    style: Styles.headerLink,
-    href: path
-  }, text));
-});
-const Header = ({
-  relPath,
-  basePath
-}) => {
-  return React.createElement("div", {
-    style: Styles.navbar
-  }, React.createElement("nav", {
-    style: Styles.headerNav
-  }, React.createElement("ol", {
-    style: Styles.headerLinks
-  }, React.createElement(HeaderLinks, {
-    paths: getHeaderPaths(basePath, relPath)
-  }))));
-};
-module.exports = Header;

package/build/page-renderers/Components/IndexListItem.js

@@ -1,58 +0,0 @@
-const React = require('react');
-const IconFileLines = require('./icons/IconFileLines');
-const IconFolderOpen = require('./icons/IconFolderOpen');
-const Styles = {
-  indexListItem: {
-    fontSize: '1.5rem',
-    borderBottom: 'solid black 1px',
-    marginBottom: '1rem',
-    paddingBottom: '0.5rem'
-  },
-  linkText: {
-    marginLeft: '1rem'
-  },
-  linkAnchor: {
-    textDecoration: 'none',
-    color: '#337ab7'
-  },
-  icon: {
-    fill: '#337ab7',
-    height: '1em',
-    verticalAlign: 'middle'
-  },
-  iconWrap: {
-    display: 'inline-block',
-    width: '1em'
-  }
-};
-const Icon = ({
-  iconName
-}) => {
-  if (iconName === 'folder') {
-    return React.createElement(IconFolderOpen, {
-      style: Styles.icon
-    });
-  }
-  return React.createElement(IconFileLines, {
-    style: Styles.icon
-  });
-};
-const IndexListItem = ({
-  link,
-  text,
-  iconName
-}) => {
-  return React.createElement("li", {
-    style: Styles.indexListItem
-  }, React.createElement("a", {
-    href: link,
-    style: Styles.linkAnchor
-  }, React.createElement("span", {
-    style: Styles.iconWrap
-  }, React.createElement(Icon, {
-    iconName: iconName
-  })), React.createElement("span", {
-    style: Styles.linkText
-  }, text)));
-};
-module.exports = IndexListItem;

package/build/page-renderers/Components/PrettyDate.js

@@ -1,23 +0,0 @@
-const React = require('react');
-const nth = function (d) {
-  if (d > 3 && d < 21) return 'th';
-  switch (d % 10) {
-    case 1:
-      return 'st';
-    case 2:
-      return 'nd';
-    case 3:
-      return 'rd';
-    default:
-      return 'th';
-  }
-};
-const month = ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'];
-const prettyDate = dateObj => {
-  const day = dateObj.getDate();
-  const year = dateObj.getFullYear();
-  return React.createElement(React.Fragment, null, day, React.createElement("sup", null, nth(day)), " ", month[dateObj.getMonth()], " ", year);
-};
-module.exports = {
-  prettyDate
-};

package/build/page-renderers/Components/Reset.js

@@ -1,61 +0,0 @@
-const React = require('react');
-const resetStyles = `/* http://meyerweb.com/eric/tools/css/reset/ 
-v2.0 | 20110126
-License: none (public domain)
-*/
-
-html, body, div, span, applet, object, iframe,
-h1, h2, h3, h4, h5, h6, p, blockquote, pre,
-a, abbr, acronym, address, big, cite, code,
-del, dfn, em, img, ins, kbd, q, s, samp,
-small, strike, strong, sub, sup, tt, var,
-b, u, i, center,
-dl, dt, dd, ol, ul, li,
-fieldset, form, label, legend,
-table, caption, tbody, tfoot, thead, tr, th, td,
-article, aside, canvas, details, embed, 
-figure, figcaption, footer, header, hgroup, 
-menu, nav, output, ruby, section, summary,
-time, mark, audio, video {
- margin: 0;
- padding: 0;
- border: 0;
- font-size: 100%;
- font: inherit;
- vertical-align: baseline;
-}
-/* HTML5 display-role reset for older browsers */
-article, aside, details, figcaption, figure, 
-footer, header, hgroup, menu, nav, section {
- display: block;
-}
-body {
- line-height: 1;
-}
-ol, ul {
- list-style: none;
-}
-blockquote, q {
- quotes: none;
-}
-blockquote:before, blockquote:after,
-q:before, q:after {
- content: '';
- content: none;
-}
-table {
- border-collapse: collapse;
- border-spacing: 0;
-}
-sup {
-  vertical-align: super;
-  font-size: smaller;
-  padding-right: 0.2rem;
-}
-`;
-const Reset = () => React.createElement("style", {
-  dangerouslySetInnerHTML: {
-    __html: resetStyles
-  }
-});
-module.exports = Reset;

package/build/page-renderers/Components/Title.js

@@ -1,23 +0,0 @@
-const React = require('react');
-const Styles = {
-  heading: {
-    fontSize: '2rem',
-    fontWeight: '500'
-  }
-};
-const Title = ({
-  contentTitle
-}) => {
-  if (contentTitle) {
-    return React.createElement("div", {
-      style: {
-        textAlign: 'center',
-        marginBottom: '20px',
-        marginTop: '32px'
-      }
-    }, React.createElement("h1", {
-      style: Styles.heading
-    }, contentTitle));
-  } else return null;
-};
-module.exports = Title;

package/build/page-renderers/Components/icons/IconFileLines.js

@@ -1,12 +0,0 @@
-const React = require('react');
-const IconFileLines = ({
-  style
-}) => React.createElement("svg", {
-  "aria-hidden": "true",
-  style: style,
-  xmlns: "http://www.w3.org/2000/svg",
-  viewBox: "0 0 384 512"
-}, '<!--! Font Awesome Free 6.1.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. -->', React.createElement("path", {
-  d: "M256 0v128h128L256 0zM224 128L224 0H48C21.49 0 0 21.49 0 48v416C0 490.5 21.49 512 48 512h288c26.51 0 48-21.49 48-48V160h-127.1C238.3 160 224 145.7 224 128zM272 416h-160C103.2 416 96 408.8 96 400C96 391.2 103.2 384 112 384h160c8.836 0 16 7.162 16 16C288 408.8 280.8 416 272 416zM272 352h-160C103.2 352 96 344.8 96 336C96 327.2 103.2 320 112 320h160c8.836 0 16 7.162 16 16C288 344.8 280.8 352 272 352zM288 272C288 280.8 280.8 288 272 288h-160C103.2 288 96 280.8 96 272C96 263.2 103.2 256 112 256h160C280.8 256 288 263.2 288 272z"
-}));
-module.exports = IconFileLines;

package/build/page-renderers/Components/icons/IconFolderOpen.js

@@ -1,12 +0,0 @@
-const React = require('react');
-const IconFolderOpen = ({
-  style
-}) => React.createElement("svg", {
-  "aria-hidden": "true",
-  style: style,
-  xmlns: "http://www.w3.org/2000/svg",
-  viewBox: "0 0 576 512"
-}, '<!--! Font Awesome Free 6.1.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. -->', React.createElement("path", {
-  d: "M147.8 192H480V144C480 117.5 458.5 96 432 96h-160l-64-64h-160C21.49 32 0 53.49 0 80v328.4l90.54-181.1C101.4 205.6 123.4 192 147.8 192zM543.1 224H147.8C135.7 224 124.6 230.8 119.2 241.7L0 480h447.1c12.12 0 23.2-6.852 28.62-17.69l96-192C583.2 249 567.7 224 543.1 224z"
-}));
-module.exports = IconFolderOpen;