chore: generate readme options (#411)

utils/update-readme.js

@@ -36,8 +36,8 @@ import screenshotTools from '../lib/tools/screenshot.js';
 import testTools from '../lib/tools/testing.js';
 import visionTools from '../lib/tools/vision.js';
 import waitTools from '../lib/tools/wait.js';
+import { execSync } from 'node:child_process';
 
-// Category definitions for tools
 const categories = {
   'Interactions': [
     ...snapshotTools,
@@ -77,24 +77,22 @@ const categories = {
 // NOTE: Can be removed when we drop Node.js 18 support and changed to import.meta.filename.
 const __filename = url.fileURLToPath(import.meta.url);
 
-const kStartMarker = `<!--- Generated by ${path.basename(__filename)} -->`;
-const kEndMarker = `<!--- End of generated section -->`;
-
 /**
  * @param {import('../src/tools/tool.js').ToolSchema<any>} tool 
- * @returns {string}
+ * @returns {string[]}
  */
 function formatToolForReadme(tool) {
   const lines = /** @type {string[]} */ ([]);
-  lines.push(`<!-- NOTE: This has been generated via ${path.basename(__filename)} -->\n\n`);
-  lines.push(`- **${tool.name}**\n`);
-  lines.push(`  - Title: ${tool.title}\n`);
-  lines.push(`  - Description: ${tool.description}\n`);
+  lines.push(`<!-- NOTE: This has been generated via ${path.basename(__filename)} -->`);
+  lines.push(``);
+  lines.push(`- **${tool.name}**`);
+  lines.push(`  - Title: ${tool.title}`);
+  lines.push(`  - Description: ${tool.description}`);
 
   const inputSchema = /** @type {any} */ (zodToJsonSchema(tool.inputSchema || {}));
   const requiredParams = inputSchema.required || [];
   if (inputSchema.properties && Object.keys(inputSchema.properties).length) {
-    lines.push(`  - Parameters:\n`);
+    lines.push(`  - Parameters:`);
     Object.entries(inputSchema.properties).forEach(([name, param]) => {
       const optional = !requiredParams.includes(name);
       const meta = /** @type {string[]} */ ([]);
@@ -102,55 +100,94 @@ function formatToolForReadme(tool) {
         meta.push(param.type);
       if (optional)
         meta.push('optional');
-      lines.push(`    - \`${name}\` ${meta.length ? `(${meta.join(', ')})` : ''}: ${param.description}\n`);
+      lines.push(`    - \`${name}\` ${meta.length ? `(${meta.join(', ')})` : ''}: ${param.description}`);
     });
   } else {
-    lines.push(`  - Parameters: None\n`);
+    lines.push(`  - Parameters: None`);
   }
-  lines.push(`  - Read-only: **${tool.type === 'readOnly'}**\n`);
-  lines.push('\n');
-  return lines.join('');
+  lines.push(`  - Read-only: **${tool.type === 'readOnly'}**`);
+  lines.push('');
+  return lines;
 }
 
-async function updateReadme() {
+/**
+ * @param {string} content
+ * @param {string} startMarker
+ * @param {string} endMarker
+ * @param {string[]} generatedLines
+ * @returns {Promise<string>}
+ */
+async function updateSection(content, startMarker, endMarker, generatedLines) {
+  const startMarkerIndex = content.indexOf(startMarker);
+  const endMarkerIndex = content.indexOf(endMarker);
+  if (startMarkerIndex === -1 || endMarkerIndex === -1)
+    throw new Error('Markers for generated section not found in README');
+
+  return [
+    content.slice(0, startMarkerIndex + startMarker.length),
+    '',
+    generatedLines.join('\n'),
+    '',
+    content.slice(endMarkerIndex),
+  ].join('\n');
+}
+
+/**
+ * @param {string} content
+ * @returns {Promise<string>}
+ */
+async function updateTools(content) {
   console.log('Loading tool information from compiled modules...');
 
-  // Count the tools processed
   const totalTools = Object.values(categories).flat().length;
   console.log(`Found ${totalTools} tools`);
 
   const generatedLines = /** @type {string[]} */ ([]);
-
   for (const [category, categoryTools] of Object.entries(categories)) {
-    generatedLines.push(`<details>\n<summary><b>${category}</b></summary>\n\n`);
-
+    generatedLines.push(`<details>\n<summary><b>${category}</b></summary>`);
+    generatedLines.push('');
     for (const tool of categoryTools)
-      generatedLines.push(formatToolForReadme(tool.schema));
-
-    generatedLines.push(`</details>\n\n`);
+      generatedLines.push(...formatToolForReadme(tool.schema));
+    generatedLines.push(`</details>`);
+    generatedLines.push('');
   }
 
+  const startMarker = `<!--- Tools generated by ${path.basename(__filename)} -->`;
+  const endMarker = `<!--- End of tools generated section -->`;
+  return updateSection(content, startMarker, endMarker, generatedLines);
+}
+
+/**
+ * @param {string} content
+ * @returns {Promise<string>}
+ */
+async function updateOptions(content) {
+  console.log('Listing options...');
+  const output = execSync('node cli.js --help');
+  const lines = output.toString().split('\n');
+  const firstLine = lines.findIndex(line => line.includes('--version'));
+  lines.splice(0, firstLine + 1);
+  const lastLine = lines.findIndex(line => line.includes('--help'));
+  lines.splice(lastLine);
+  const startMarker = `<!--- Options generated by ${path.basename(__filename)} -->`;
+  const endMarker = `<!--- End of options generated section -->`;
+  return updateSection(content, startMarker, endMarker, [
+    '```',
+    '> npx @playwright/mcp@latest --help',
+    ...lines,
+    '```',
+  ]);
+}
+
+async function updateReadme() {
   const readmePath = path.join(path.dirname(__filename), '..', 'README.md');
   const readmeContent = await fs.promises.readFile(readmePath, 'utf-8');
-  const startMarker = readmeContent.indexOf(kStartMarker);
-  const endMarker = readmeContent.indexOf(kEndMarker);
-  if (startMarker === -1 || endMarker === -1)
-    throw new Error('Markers for generated section not found in README');
-
-  const newReadmeContent = [
-    readmeContent.slice(0, startMarker),
-    kStartMarker + '\n\n',
-    generatedLines.join(''),
-    kEndMarker,
-    readmeContent.slice(endMarker + kEndMarker.length),
-  ].join('');
-
-  // Write updated README
-  await fs.promises.writeFile(readmePath, newReadmeContent, 'utf-8');
+  const withTools = await updateTools(readmeContent);
+  const withOptions = await updateOptions(withTools);
+  await fs.promises.writeFile(readmePath, withOptions, 'utf-8');
   console.log('README updated successfully');
 }
 
-// Run the update
 updateReadme().catch(err => {
   console.error('Error updating README:', err);
   process.exit(1);