chore: use jobs for document generation

.github/workflows/pre-release.yml

@@ -20,7 +20,7 @@ jobs:
         run: npm install
       - name: Build
         run: |
-          ts-node utils/generate_sources.ts
+          npm run generate:sources
           npm run docs
       - name: Version docs
         working-directory: ./website

docs/index.md

@@ -1,7 +1,5 @@
 ---
-
 sidebar_position: 1
-
 ---
 
 # Puppeteer

package.json

@@ -41,9 +41,9 @@
     "lint:prettier": "prettier --check .",
     "lint:eslint": "([ \"$CI\" = true ] && eslint --ext js --ext ts --quiet -f codeframe . || eslint --ext js --ext ts .)",
     "install": "node install.js",
-    "generate:sources": "ts-node utils/generate_sources.ts",
+    "generate:sources": "tsx utils/generate_sources.ts",
     "generate:types": "node utils/export_all.js && api-extractor run --local --verbose && eslint --ext ts --no-ignore --no-eslintrc -c .eslintrc.types.cjs --fix lib/types.d.ts",
-    "generate:markdown": "ts-node utils/generate_docs.ts && prettier --ignore-path none --write docs",
+    "generate:markdown": "tsx utils/generate_docs.ts && prettier --ignore-path none --write docs",
     "generate:esm-package-json": "echo '{\"type\": \"module\"}' > lib/esm/package.json",
     "format": "run-s format:*",
     "format:prettier": "prettier --write .",
@@ -53,8 +53,8 @@
     "commitlint": "commitlint --from=HEAD~1",
     "clean": "rimraf lib && rimraf test/build",
     "check": "run-p check:*",
-    "check:protocol-revision": "ts-node -s scripts/ensure-correct-devtools-protocol-package",
-    "check:pinned-deps": "ts-node -s scripts/ensure-pinned-deps",
+    "check:protocol-revision": "tsx scripts/ensure-correct-devtools-protocol-package",
+    "check:pinned-deps": "tsx scripts/ensure-pinned-deps",
     "build": "run-s generate:sources build:tsc generate:types generate:esm-package-json",
     "build:tsc": "tsc --version && run-p build:tsc:*",
     "build:tsc:esm": "tsc -b src/tsconfig.esm.json",
@@ -138,6 +138,7 @@
     "source-map-support": "0.5.21",
     "text-diff": "1.0.1",
     "tsd": "0.22.0",
+    "tsx": "3.8.2",
     "typescript": "4.7.4"
   }
 }

utils/generate_docs.ts

@@ -15,12 +15,11 @@
  */
 
 import {readFileSync, writeFileSync} from 'fs';
-import {join} from 'path';
-import {chdir} from 'process';
+import {readFile, writeFile} from 'fs/promises';
+import rimraf from 'rimraf';
 import semver from 'semver';
-import {versionsPerRelease} from '../versions.js';
-import versionsArchived from '../website/versionsArchived.json';
 import {generateDocs} from './internal/custom_markdown_action';
+import {job} from './internal/job';
 
 function getOffsetAndLimit(
   sectionName: string,
@@ -47,56 +46,66 @@ function spliceIntoSection(
   return lines.join('\n');
 }
 
-// Change to root directory
-chdir(join(__dirname, '..'));
+(async () => {
+  job('', async ({inputs, outputs}) => {
+    const content = await readFile(inputs[0]!, 'utf-8');
+    const sectionContent = `
+---
+sidebar_position: 1
+---
+`;
+    await writeFile(outputs[0]!, sectionContent + content);
+  })
+    .inputs(['README.md'])
+    .outputs(['docs/index.md'])
+    .build();
 
-// README
-{
-  const content = readFileSync('README.md', 'utf-8');
-  const sectionContent = `
- ---
- sidebar_position: 1
- ---
+  // Chrome Versions
+  job('', async ({inputs, outputs}) => {
+    let content = readFileSync(outputs[0]!, {encoding: 'utf8'});
+    const {versionsPerRelease} = await import(inputs[0]!);
+    const versionsArchived = await import(inputs[1]!);
 
- `;
-  writeFileSync('docs/index.md', sectionContent + content);
-}
-
-// Chrome Versions
-{
-  const filename = 'docs/chromium-support.md';
-  let content = readFileSync(filename, {encoding: 'utf8'});
-
-  // Generate versions
-  const buffer: string[] = [];
-  for (const [chromiumVersion, puppeteerVersion] of versionsPerRelease) {
-    if (puppeteerVersion === 'NEXT') {
-      continue;
+    // Generate versions
+    const buffer: string[] = [];
+    for (const [chromiumVersion, puppeteerVersion] of versionsPerRelease) {
+      if (puppeteerVersion === 'NEXT') {
+        continue;
+      }
+      if (versionsArchived.includes(puppeteerVersion.substring(1))) {
+        buffer.push(
+          `  * Chromium ${chromiumVersion} - [Puppeteer ${puppeteerVersion}](https://github.com/puppeteer/puppeteer/blob/${puppeteerVersion}/docs/api/index.md)`
+        );
+      } else if (semver.lt(puppeteerVersion, '15.0.0')) {
+        buffer.push(
+          `  * Chromium ${chromiumVersion} - [Puppeteer ${puppeteerVersion}](https://github.com/puppeteer/puppeteer/blob/${puppeteerVersion}/docs/api.md)`
+        );
+      } else if (semver.gte(puppeteerVersion, '15.3.0')) {
+        buffer.push(
+          `  * Chromium ${chromiumVersion} - [Puppeteer ${puppeteerVersion}](https://pptr.dev/${puppeteerVersion.slice(
+            1
+          )})`
+        );
+      } else {
+        buffer.push(
+          `  * Chromium ${chromiumVersion} - Puppeteer ${puppeteerVersion}`
+        );
+      }
     }
-    if (versionsArchived.includes(puppeteerVersion.substring(1))) {
-      buffer.push(
-        `  * Chromium ${chromiumVersion} - [Puppeteer ${puppeteerVersion}](https://github.com/puppeteer/puppeteer/blob/${puppeteerVersion}/docs/api/index.md)`
-      );
-    } else if (semver.lt(puppeteerVersion, '15.0.0')) {
-      buffer.push(
-        `  * Chromium ${chromiumVersion} - [Puppeteer ${puppeteerVersion}](https://github.com/puppeteer/puppeteer/blob/${puppeteerVersion}/docs/api.md)`
-      );
-    } else if (semver.gte(puppeteerVersion, '15.3.0')) {
-      buffer.push(
-        `  * Chromium ${chromiumVersion} - [Puppeteer ${puppeteerVersion}](https://pptr.dev/${puppeteerVersion.slice(
-          1
-        )})`
-      );
-    } else {
-      buffer.push(
-        `  * Chromium ${chromiumVersion} - Puppeteer ${puppeteerVersion}`
-      );
-    }
-  }
-  content = spliceIntoSection('version', content, buffer.join('\n'));
+    content = spliceIntoSection('version', content, buffer.join('\n'));
 
-  writeFileSync(filename, content);
-}
+    writeFileSync(outputs[0]!, content);
+  })
+    .inputs(['versions.js', 'website/versionsArchived.json'])
+    .outputs(['docs/chromium-support.md'])
+    .build();
 
-// Generate documentation
-generateDocs('docs/puppeteer.api.json', 'docs/api');
+  // Generate documentation
+  job('', async ({inputs, outputs}) => {
+    rimraf.sync(outputs[0]!);
+    generateDocs(inputs[0]!, outputs[0]!);
+  })
+    .inputs(['docs/puppeteer.api.json'])
+    .outputs(['docs/api'])
+    .build();
+})();