Versions path fix

Author: slowcheetah

website/build.mjs

@@ -1,4 +1,4 @@
-import { getDefaultVersion } from './scripts/helpers.mjs';
+import { expandVersionsConfig, getDefaultVersion } from './scripts/helpers.mjs';
 import fm from 'front-matter';
 import { JSDOM } from 'jsdom';
 import { Marked } from 'marked';
@@ -20,14 +20,6 @@ let docsMenu = '';
 let isBlog = false;
 let isDocs = false;
 
-async function getDefaultVersionTarget(versionFile, defaultTarget = null) {
-  if (defaultTarget) return defaultTarget;
-
-  const versions = await readJson(versionFile);
-  const defaultVersion = versions.find(v => v.default);
-  return defaultVersion?.branch ?? defaultVersion?.tag;
-}
-
 async function getAllMdFiles(dir) {
   const entries = await readdir(dir, { withFileTypes: true });
   const files = [];
@@ -89,12 +81,20 @@ async function buildDocsMenuForVersion(version) {
   return menu;
 }
 
+function getVersionPath(version) {
+  return version.path ?? version.label;
+}
+
+function getBundlesPath(version) {
+  return path.join(config.bundlesPath, version.branch ?? version.tag);
+}
+
 async function buildVersionsMenuList(versions, currentVersion, section) {
   let versionsMenuHtml = '<div class="dropdown-block">';
   for (const v of versions) {
     const activityClass = v.label === currentVersion && !v.default ? ' class="active"' : '';
     const defaultBadge = v.default ? ' (default)' : '';
-    const versionPath = v.default ? '' : `${ v.path ?? v.label }/`;
+    const versionPath = v.default ? '' : `${ getVersionPath(v) }/`;
     versionsMenuHtml += `<a href="./${ versionPath }${ section }"${ activityClass }>${ v.label }${ defaultBadge }</a>`;
   }
   versionsMenuHtml += '</div>';
@@ -227,9 +227,10 @@ async function buildPlaygrounds(template, versions) {
 }
 
 async function buildPlayground(template, version, versions) {
-  const versionPath = version.branch ?? version.tag;
-  const bundleScript = `<script nomodule src="${ config.bundlesPath }/${ versionPath }/${ config.bundleName }"></script>`;
-  const bundleESModulesScript = `<script type="module" src="${ config.bundlesPath }/${ versionPath }/${ config.bundleNameESModules }"></script>`;
+  const versionPath = getVersionPath(version);
+  const bundlesPath = getBundlesPath(version);
+  const bundleScript = `<script nomodule src="${ bundlesPath }/${ config.bundleName }"></script>`;
+  const bundleESModulesScript = `<script type="module" src="${ bundlesPath }/${ config.bundleNameESModules }"></script>`;
   const babelScript = '<script src="./babel.min.js"></script>';
   const playgroundContent = await readFileContent(`${ config.srcDir }playground.html`);
   const versionsMenu = await buildVersionsMenu(versions, version.label, 'playground');
@@ -256,11 +257,11 @@ async function buildPlayground(template, version, versions) {
 }
 
 async function createDocsIndexes(versions) {
-  if (BRANCH) versions = [{ label: '' }];
+  if (BRANCH) versions = [{ path: '' }];
 
   for (const version of versions) {
     if (version.default) continue;
-    const versionPath = version.path ?? version.label;
+    const versionPath = getVersionPath(version);
     const menuItems = await getDocsMenuItems(versionPath);
     const firstDocPath = path.join(config.resultDir,
       `${ menuItems[0].url }.html`.replace(`{docs-version}${ BRANCH ? '/' : '' }`, versionPath));
@@ -273,15 +274,17 @@ async function createDocsIndexes(versions) {
 async function getVersions() {
   if (BRANCH) {
     return [{
-      label: BRANCH,
-      default: true,
       branch: BRANCH,
+      default: true,
+      label: BRANCH,
+      path: BRANCH,
     }];
   }
+
   const versions = await readJson(config.versionsFile);
   echo(chalk.green('Got versions from file'));
 
-  return versions;
+  return expandVersionsConfig(versions);
 }
 
 function getTitle(content) {
@@ -294,7 +297,8 @@ async function build() {
   await buildBlogMenu();
   const mdFiles = await getAllMdFiles(config.docsDir);
   const versions = await getVersions();
-  const bundlesPath = `${ config.bundlesPath }/${ await getDefaultVersionTarget(config.versionsFile, BRANCH) }`;
+  const defaultVersion = versions.find(v => v.default);
+  const bundlesPath = getBundlesPath(defaultVersion);
   const bundleScript = `<script nomodule src="${ bundlesPath }/${ config.bundleName }"></script>`;
   const bundleESModulesScript = `<script type="module" src="${ bundlesPath }/${ config.bundleNameESModules }"></script>`;
 

website/config/versions.json

@@ -4,13 +4,8 @@
     "default": true,
     "branch": "master"
   },
-  {
-    "label": "v3",
-    "branch": "master"
-  },
   {
     "label": "v4 (alpha)",
-    "path": "v4",
     "branch": "v4"
   }
 ]

website/scripts/helpers.mjs

@@ -154,3 +154,23 @@ export async function readJSON(filePath) {
   const buffer = await readFile(filePath);
   return JSON.parse(buffer);
 }
+
+export function expandVersionsConfig(config) {
+  let defaultIndex = null
+  const $config = config.map(({ label, branch, path, default: $default }, index) => {
+    if ($default) {
+      if (defaultIndex !== null) throw new Error('Duplicate default');
+      defaultIndex = index;
+    }
+    return {
+      branch,
+      default: false,
+      label,
+      path: path ?? label,
+    };
+  });
+
+  if (defaultIndex === null) throw new Error('Missed default');
+
+  return [{ ...$config[defaultIndex], default: true }, ...$config];
+}

website/scripts/runner.mjs

@@ -1,7 +1,16 @@
 /* eslint-disable no-console -- needed for logging */
 import {
-  hasDocs, copyBlogPosts, copyBabelStandalone, copyCommonFiles, buildWeb, getDefaultVersion, readJSON, buildAndCopyCoreJS,
+  hasDocs,
+  copyBlogPosts,
+  copyBabelStandalone,
+  copyCommonFiles,
+  buildWeb,
+  getDefaultVersion,
+  readJSON,
+  buildAndCopyCoreJS,
+  expandVersionsConfig,
 } from './helpers.mjs';
+import config from '../config/config.mjs';
 import childProcess from 'node:child_process';
 import { cp, readdir, readlink } from 'node:fs/promises';
 import { promisify } from 'node:util';
@@ -25,8 +34,8 @@ const BUILD_ID = new Date().toISOString().replaceAll(/\D/g, '-') + Math.random()
 const BUILD_DIR = `${ BUILDS_ROOT_DIR }/${ BUILD_ID }/`;
 const BUILD_SRC_DIR = `${ BUILD_DIR }${ SRC_DIR }/`;
 const BUILD_DOCS_DIR = `${ BUILD_DIR }builder/`;
-const SITE_FILES_DIR = `${ BUILD_SRC_DIR }/website/dist/`;
-const VERSIONS_FILE = `${ BUILD_SRC_DIR }website/config/versions.json`;
+const SITE_FILES_DIR = `${ BUILD_SRC_DIR }/${ config.resultDir }`;
+const VERSIONS_FILE = `${ BUILD_SRC_DIR }${ config.versionsFile }`;
 
 async function copyWeb() {
   console.log('Copying web...');
@@ -182,7 +191,7 @@ async function getVersions(targetBranch) {
   const versions = await readJSON(VERSIONS_FILE);
   console.timeEnd('Got versions');
 
-  return versions;
+  return expandVersionsConfig(versions);
 }
 
 try {
@@ -194,6 +203,7 @@ try {
   if (!BRANCH) {
     const versions = await getVersions(targetBranch);
     for (const version of versions) {
+      if (version.default) continue;
       await copyDocsToBuilder(version);
       await buildAndCopyCoreJS(version, BUILD_SRC_DIR, BUNDLES_DIR, true);
     }