chore: generate cli help in-build

.gitignore

@@ -19,6 +19,7 @@ drivers/
 nohup.out
 .trace
 .tmp
+.playwright-cli
 allure*
 blob-report
 playwright-report

package.json

@@ -43,7 +43,10 @@
     "roll": "node utils/roll_browser.js",
     "check-deps": "node utils/check_deps.js",
     "build-android-driver": "./utils/build_android_driver.sh",
-    "innerloop": "playwright run-server --reuse-browser"
+    "innerloop": "playwright run-server --reuse-browser",
+    "playwright-cli": "node packages/playwright/lib/mcp/terminal/cli.js",
+    "test-playwright-cli": "playwright test --config=tests/mcp/playwright.config.ts --project=chrome cli.spec.ts",
+    "playwright-cli-readme": "node utils/generate_cli_help.js --readme"
   },
   "workspaces": [
     "packages/*"

packages/playwright/src/mcp/terminal/helpGenerator.ts

@@ -14,8 +14,6 @@
  * limitations under the License.
  */
 
-import fs from 'fs';
-import path from 'path';
 import { commands } from './commands';
 
 import type zodType from 'zod';
@@ -77,7 +75,7 @@ const categories: { name: Category, title: string }[] = [
   { name: 'session', title: 'Sessions' },
 ] as const;
 
-function generateHelp() {
+export function generateHelp() {
   const lines: string[] = [];
   lines.push('Usage: playwright-cli <command> [args] [options]');
 
@@ -99,7 +97,7 @@ function generateHelp() {
 }
 
 
-function generateReadme() {
+export function generateReadme() {
   const lines: string[] = [];
   lines.push('\n## Commands');
 
@@ -136,27 +134,17 @@ function generateReadmeEntry(command: AnyCommandSchema): string {
   return formatWithGap(prefix, suffix, 40);
 }
 
-async function main() {
+export function generateHelpJSON() {
   const help = {
     global: generateHelp(),
     commands: Object.fromEntries(
         Object.entries(commands).map(([name, command]) => [name, generateCommandHelp(command)])
     ),
   };
-  const readme = generateReadme();
-  const fileName = path.resolve(__dirname, 'help.json').replace('lib', 'src');
-  // eslint-disable-next-line no-console
-  console.log('Writing ', path.relative(process.cwd(), fileName));
-  await fs.promises.writeFile(fileName, JSON.stringify(help, null, 2));
-  // eslint-disable-next-line no-console
-  console.log(help.global);
-  // eslint-disable-next-line no-console
-  console.log(readme);
+  return help;
 }
 
 function formatWithGap(prefix: string, text: string, threshold: number = 30) {
   const indent = Math.max(1, threshold - prefix.length);
   return prefix + ' '.repeat(indent) + text;
 }
-
-void main();

utils/build/build.js

@@ -551,6 +551,15 @@ for (const webPackage of ['html-reporter', 'recorder', 'trace-viewer']) {
   }));
 }
 
+// Generate CLI help.
+onChanges.push({
+  inputs: [
+    'packages/playwright/src/mcp/terminal/commands.ts',
+    'utils/generate_cli_help.js',
+  ],
+  script: 'utils/generate_cli_help.js',
+});
+
 // Generate injected.
 onChanges.push({
   inputs: [
@@ -636,12 +645,6 @@ copyFiles.push({
   to: 'packages/playwright/lib',
 });
 
-copyFiles.push({
-  files: 'packages/playwright/src/mcp/terminal/*.json',
-  from: 'packages/playwright/src',
-  to: 'packages/playwright/lib',
-});
-
 copyFiles.push({
   files: 'packages/playwright/src/mcp/terminal/*.md',
   from: 'packages/playwright/src',

utils/generate_cli_help.js

@@ -0,0 +1,36 @@
+#!/usr/bin/env node
+/**
+ * Copyright (c) Microsoft Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+// @ts-check
+
+const fs = require('fs')
+const path = require('path')
+
+const { generateHelp, generateReadme, generateHelpJSON } = require('../packages/playwright/lib/mcp/terminal/helpGenerator.js');
+
+if (process.argv[2] === '--readme') {
+  console.log(generateReadme());
+  process.exit(0);
+}
+
+if (process.argv[2] === '--print') {
+  console.log(generateHelp());
+  process.exit(0);
+}
+
+const fileName = path.resolve(__dirname, '../packages/playwright/lib/mcp/terminal/help.json');
+console.log('Writing ', path.relative(process.cwd(), fileName));
+fs.writeFileSync(fileName, JSON.stringify(generateHelpJSON(), null, 2));