remote/test/puppeteer/Herebyfile.mjs

   1 /**
   2  * @license
   3  * Copyright 2024 Google Inc.
   4  * SPDX-License-Identifier: Apache-2.0
   5  */
   6
   7 /* eslint-disable import/order */
   8
   9 import {copyFile, readFile, writeFile} from 'fs/promises';
  10
  11 import {docgen, spliceIntoSection} from '@puppeteer/docgen';
  12 import {execa} from 'execa';
  13 import {task} from 'hereby';
  14 import semver from 'semver';
  15
  16 export const docsNgSchematicsTask = task({
  17   name: 'docs:ng-schematics',
  18   run: async () => {
  19     const readme = await readFile('packages/ng-schematics/README.md', 'utf-8');
  20     await writeFile('docs/integrations/ng-schematics.md', readme);
  21   },
  22 });
  23
  24 /**
  25  * This logic should match the one in `website/docusaurus.config.js`.
  26  */
  27 function getApiUrl(version) {
  28   if (semver.gte(version, '19.3.0')) {
  29     return `https://github.com/puppeteer/puppeteer/blob/puppeteer-${version}/docs/api/index.md`;
  30   } else if (semver.gte(version, '15.3.0')) {
  31     return `https://github.com/puppeteer/puppeteer/blob/${version}/docs/api/index.md`;
  32   } else {
  33     return `https://github.com/puppeteer/puppeteer/blob/${version}/docs/api.md`;
  34   }
  35 }
  36
  37 export const docsChromiumSupportTask = task({
  38   name: 'docs:chromium-support',
  39   run: async () => {
  40     const content = await readFile('docs/chromium-support.md', {
  41       encoding: 'utf8',
  42     });
  43     const {versionsPerRelease} = await import('./versions.js');
  44     const buffer = [];
  45     for (const [chromiumVersion, puppeteerVersion] of versionsPerRelease) {
  46       if (puppeteerVersion === 'NEXT') {
  47         continue;
  48       }
  49       if (semver.gte(puppeteerVersion, '20.0.0')) {
  50         buffer.push(
  51           `  * [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) ${chromiumVersion} - [Puppeteer ${puppeteerVersion}](${getApiUrl(
  52             puppeteerVersion
  53           )})`
  54         );
  55       } else {
  56         buffer.push(
  57           `  * Chromium ${chromiumVersion} - [Puppeteer ${puppeteerVersion}](${getApiUrl(
  58             puppeteerVersion
  59           )})`
  60         );
  61       }
  62     }
  63     await writeFile(
  64       'docs/chromium-support.md',
  65       spliceIntoSection('version', content, buffer.join('\n'))
  66     );
  67   },
  68 });
  69
  70 export const docsTask = task({
  71   name: 'docs',
  72   dependencies: [docsNgSchematicsTask, docsChromiumSupportTask],
  73   run: async () => {
  74     // Copy main page.
  75     await copyFile('README.md', 'docs/index.md');
  76
  77     // Generate documentation
  78     for (const [name, folder] of [
  79       ['browsers', 'browsers-api'],
  80       ['puppeteer', 'api'],
  81     ]) {
  82       docgen(`docs/${name}.api.json`, `docs/${folder}`);
  83     }
  84
  85     // Update main @puppeteer/browsers page.
  86     const readme = await readFile('packages/browsers/README.md', 'utf-8');
  87     const index = await readFile('docs/browsers-api/index.md', 'utf-8');
  88     await writeFile(
  89       'docs/browsers-api/index.md',
  90       index.replace('# API Reference', readme)
  91     );
  92
  93     // Format everything.
  94     await execa('prettier', ['--ignore-path', 'none', '--write', 'docs']);
  95   },
  96 });