Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions packages/playwright-core/src/tools/cli-daemon/program.ts
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ export async function initWorkspace(initSkills: string | undefined, initSkillsGl
const playwrightDir = path.join(cwd, '.playwright');
await fs.promises.mkdir(playwrightDir, { recursive: true });
console.log(`✅ Workspace initialized at \`${cwd}\`.`);
await patchGitIgnore(cwd);
}

const skills = initSkillsGlobal ?? initSkills;
Expand All @@ -111,6 +112,22 @@ export async function initWorkspace(initSkills: string | undefined, initSkillsGl
await ensureConfiguredBrowserInstalled();
}

async function patchGitIgnore(cwd: string) {
if (!fs.existsSync(path.join(cwd, '.git')))
return;
try {
const gitIgnorePath = path.join(cwd, '.gitignore');
const existing = await fs.promises.readFile(gitIgnorePath, 'utf8').catch(() => '');
if (existing.split('\n').some(line => line.trim() === '.playwright-cli/'))
return;
const separator = existing && !existing.endsWith('\n') ? '\n' : '';
await fs.promises.appendFile(gitIgnorePath, separator + '# Playwright CLI output (may contain credentials)\n.playwright-cli/\n');
console.log('✅ Added `.playwright-cli/` to `.gitignore`.');
} catch (error) {
console.log(`⚠️ Failed to update \`.gitignore\`: ${error instanceof Error ? error.message : error}`);
}
}

async function ensureConfiguredBrowserInstalled() {
if (getAsBooleanFromENV('PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD'))
return;
Expand Down
17 changes: 17 additions & 0 deletions tests/mcp/cli-misc.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,23 @@ test('install workspace', async ({ cli }, testInfo) => {
expect(fs.existsSync(playwrightDir)).toBe(true);
});

test('install adds .playwright-cli/ to .gitignore', async ({ cli }, testInfo) => {
const outsideGitRepo = await cli('install');
expect(outsideGitRepo.output).not.toContain('.gitignore');
expect(fs.existsSync(testInfo.outputPath('.gitignore'))).toBe(false);

await fs.promises.mkdir(testInfo.outputPath('.git'), { recursive: true });
await fs.promises.writeFile(testInfo.outputPath('.gitignore'), 'node_modules/');
const insideGitRepo = await cli('install');
expect(insideGitRepo.output).toContain('Added `.playwright-cli/` to `.gitignore`.');
const expectedContent = 'node_modules/\n# Playwright CLI output (may contain credentials)\n.playwright-cli/\n';
expect(await fs.promises.readFile(testInfo.outputPath('.gitignore'), 'utf8')).toBe(expectedContent);

const secondRun = await cli('install');
expect(secondRun.output).not.toContain('.gitignore');
expect(await fs.promises.readFile(testInfo.outputPath('.gitignore'), 'utf8')).toBe(expectedContent);
});

test('install workspace w/skills', async ({ cli }, testInfo) => {
const { output } = await cli('install', '--skills');
expect(output).toContain(`Skill installed to \`.claude${path.sep}skills${path.sep}playwright-cli\`.`);
Expand Down
Loading