updates

Author: runspired

docs-viewer/src/preview-docs.ts

@@ -5,65 +5,22 @@
 import chalk from 'chalk';
 import path from 'path';
 import fs from 'fs';
-import { findWorkspaceDir } from '@pnpm/find-workspace-dir';
+import {
+  determinePackageManager,
+  docsViewerRoot,
+  generateDocs,
+  getCurrentVersion,
+  log,
+  maybeMakePNPMInstallable,
+  projectRoot,
+  repoDetails,
+  workspaceRoot,
+} from './-utils';
 
 const EMBER_API_DOCS_REPO = `git@github.com:ember-learn/ember-api-docs.git`;
 const EMBER_JSONAPI_DOCS_REPO = `git@github.com:ember-learn/ember-jsonapi-docs.git`;
 const EMBER_API_DOCS_DATA_REPO = `git@github.com:ember-learn/ember-api-docs-data.git`;
 
-const workspaceRoot = (await findWorkspaceDir(process.cwd())) as string;
-
-if (!workspaceRoot) {
-  throw new Error('Could not find workspace root');
-}
-
-const docsViewerRoot = path.join(workspaceRoot, 'docs-viewer');
-
-function log(message: string) {
-  console.log(chalk.grey(`[docs-viewer]\t${message}`));
-}
-
-function repoDetails(gitUrl: string) {
-  const repoPath = gitUrl.replace('.git', '').replace('git@github.com:', '');
-  const [org, name] = repoPath.split('/');
-  const installPathFromRoot = path.join('./projects', name);
-  const location = path.join(docsViewerRoot, installPathFromRoot);
-
-  return {
-    org,
-    name,
-    repoPath,
-    gitUrl,
-    installPathFromRoot,
-    location,
-    relativePath: path.relative(__dirname, path.join(docsViewerRoot, installPathFromRoot)),
-  };
-}
-
-async function getCurrentVersion(tool: string) {
-  const proc = Bun.spawn([tool, '--version'], {
-    env: process.env,
-    stdio: ['inherit', 'pipe', 'inherit'],
-  });
-  await proc.exited;
-  const version = await new Response(proc.stdout).text();
-  return version.trim().replace('v', '');
-}
-
-function determinePackageManager(dir: string) {
-  if (fs.existsSync(path.join(dir, 'pnpm-lock.yaml'))) {
-    return 'pnpm';
-  }
-  if (fs.existsSync(path.join(dir, 'package-lock.json'))) {
-    return 'npm';
-  }
-  if (fs.existsSync(path.join(dir, 'yarn.lock'))) {
-    return 'yarn';
-  }
-
-  return 'npm';
-}
-
 async function getOrUpdateRepo(gitUrl: string) {
   const details = repoDetails(gitUrl);
 
@@ -75,42 +32,11 @@ async function getOrUpdateRepo(gitUrl: string) {
 
   // install dependencies
   const packageManager = determinePackageManager(details.location);
-
   if (packageManager === 'pnpm') {
-    // get the version to use from package.json
-    const packageJson = require(path.join(details.location, 'package.json'));
-
-    let nodeVersion = await getCurrentVersion('node');
-    const pnpmVersion = await getCurrentVersion('pnpm');
-
-    // ember-api-docs requires an older node due to node-sass
-    if (packageJson.name === 'ember-api-docs') {
-      nodeVersion = '20.19.0';
-    }
-
-    if (
-      !packageJson.volta ||
-      packageJson.volta.node !== nodeVersion ||
-      packageJson.volta.pnpm !== pnpmVersion ||
-      packageJson.packageManager ||
-      packageJson.engines?.node !== nodeVersion
-    ) {
-      delete packageJson.packageManager;
-      packageJson.volta = {
-        node: nodeVersion,
-        pnpm: pnpmVersion,
-      };
-      packageJson.engines = packageJson.engines || {};
-      packageJson.engines.node = nodeVersion;
-
-      fs.writeFileSync(path.join(details.location, 'package.json'), JSON.stringify(packageJson, null, 2));
-      const proc = Bun.spawn(['git', 'commit', '-am', '"ensure volta works as expected"'], {
-        cwd: details.location,
-        env: process.env,
-        stdio: ['inherit', 'inherit', 'inherit'],
-      });
-      await proc.exited;
-    }
+    // some of the repositories use pnpm but do not have volta configured
+    // and have not had their engines/packageManager field updated in a while.
+    // this lets us still install them with pnpm if that is the case
+    await maybeMakePNPMInstallable(details);
   }
 
   log(`Installing dependencies in ${chalk.green(details.installPathFromRoot)} using ${chalk.yellow(packageManager)}`);
@@ -125,6 +51,10 @@ async function getOrUpdateRepo(gitUrl: string) {
   await proc.exited;
 }
 
+/**
+ * Updates the repo by fetching only the latest commit on the main branch
+ * and resetting the local repo to that commit
+ */
 async function getLatest(details: ReturnType<typeof repoDetails>) {
   log(`Updating ${chalk.green(details.repoPath)} in ${chalk.green(details.installPathFromRoot)} to latest`);
   const mainBranch = details.name === 'ember-jsonapi-docs' ? 'master' : 'main';
@@ -138,6 +68,9 @@ async function getLatest(details: ReturnType<typeof repoDetails>) {
   await proc2.exited;
 }
 
+/**
+ * Clones the repo, fetching only the latest commit
+ */
 async function cloneRepo(details: ReturnType<typeof repoDetails>) {
   const relativePath = path.join('./projects', details.name);
   log(`Cloning ${chalk.green(details.repoPath)} to ${chalk.green(relativePath)}`);
@@ -152,44 +85,45 @@ async function main() {
   log(`\tCurrent working directory: ${chalk.green(process.cwd())}`);
 
   // clone repos
+  //////////////
+  //
   await getOrUpdateRepo(EMBER_API_DOCS_DATA_REPO);
   await getOrUpdateRepo(EMBER_JSONAPI_DOCS_REPO);
   await getOrUpdateRepo(EMBER_API_DOCS_REPO);
 
   // symlink our own project root into projects as 'ember-data'
-  const emberDataLocation = path.join(docsViewerRoot, './projects/ember-data');
+  /////////////////////////////////////////////////////////////
+  //
+  const emberDataLocation = path.join(projectRoot, 'ember-data');
   if (!fs.existsSync(emberDataLocation)) {
     log(`Symlinking ${chalk.green('ember-data')} to ${chalk.green('./projects/ember-data')}`);
     fs.symlinkSync(workspaceRoot, emberDataLocation);
   }
 
-  // symlink `ember-api-docs-data` to `ember-api-docs`
-  const projectRoot = path.join(docsViewerRoot, './projects');
+  // symlink `ember-api-docs-data` into `ember-api-docs`
+  ////////////////////////////////////////////////////
+  //
   const emberApiDocsData = path.join(projectRoot, 'ember-api-docs-data');
   const symLinkLocation = path.join(projectRoot, 'ember-api-docs/ember-api-docs-data');
-
   if (!fs.existsSync(symLinkLocation)) {
     log(`Symlinking ${chalk.green('ember-api-docs-data')} to ${chalk.green('ember-api-docs')}`);
     fs.symlinkSync(emberApiDocsData, symLinkLocation);
   }
 
   log('Docs viewer setup complete');
-
   log('Generating the current docs in ember-jsonapi-docs (these will be inserted into ember-api-docs-data)');
-  const currentVersion = require(path.join(workspaceRoot, 'package.json')).version;
-  const absoluteVersion = currentVersion.split('-')[0];
-  const command = ['bun', 'gen', '--project', 'ember-data', '--version', absoluteVersion];
 
-  const proc = Bun.spawn(command, {
-    cwd: path.join(projectRoot, 'ember-jsonapi-docs'),
-    env: process.env,
-    stdio: ['inherit', 'inherit', 'inherit'],
-  });
-  await proc.exited;
+  // generate the docs
+  ////////////////////
+  //
+  await generateDocs();
 
   log('Docs generated. Run `bun regenerate-docs` to update the docs with any changes');
   log('Starting the docs viewer');
 
+  // start the docs viewer
+  ////////////////////////
+  //
   const proc2 = Bun.spawn(['pnpm', 'start'], {
     cwd: path.join(projectRoot, 'ember-api-docs'),
     env: process.env,

docs-viewer/src/rebuild-docs.ts

@@ -4,6 +4,10 @@
  * Rebuilds the data used by the docs viewer app
  */
 
-async function main();
+import { generateDocs } from './-utils';
+
+async function main() {
+  await generateDocs();
+}
 
 main();