Skip to content

fix: don't duplicate .gitignore entries #122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mxschmitt merged 8 commits into from
Jul 8, 2024
Merged

fix: don't duplicate .gitignore entries #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
149b4c4
fix: dont duplicate .gitignore entries
DerTimonius Jun 3, 2024
7a3bd98
use regex instead of string.includes
DerTimonius Jun 4, 2024
113797a
fix inconsistencies
DerTimonius Jun 4, 2024
3dc1bf1
start with testing gitignore
DerTimonius Jul 6, 2024
c8dc45b
implement suggestions
DerTimonius Jul 8, 2024
cbcdb92
resolve merge conflicts
DerTimonius Jul 8, 2024
bf7e331
implement suggestions
DerTimonius Jul 8, 2024
83b89d4
Update tests/integration.spec.ts
mxschmitt Jul 8, 2024
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
18 changes: 12 additions & 6 deletions src/generator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,12 +271,18 @@ export class Generator {
let gitIgnore = '';
if (fs.existsSync(gitIgnorePath))
gitIgnore = fs.readFileSync(gitIgnorePath, 'utf-8').trimEnd() + '\n';
if (!gitIgnore.includes('node_modules'))
gitIgnore += 'node_modules/\n';
gitIgnore += '/test-results/\n';
gitIgnore += '/playwright-report/\n';
gitIgnore += '/blob-report/\n';
gitIgnore += '/playwright/.cache/\n';
const valuesToAdd = {
'node_modules/': /^node_modules\/?/m,
'/test-results/': /^\/?test-results\/?$/m,
'/playwright-report/': /^\/playwright-report\/?$/m,
'/blob-report/': /^\/blob-report\/?$/m,
'/playwright/.cache/': /^\/playwright\/\.cache\/?$/m
};
Object.entries(valuesToAdd).forEach(([value, regex]) => {
if (!gitIgnore.match(regex)) {
gitIgnore += `${value}\n`;
}
});
fs.writeFileSync(gitIgnorePath, gitIgnore);
}

Expand Down
16 changes: 16 additions & 0 deletions tests/integration.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,14 @@ import path from 'path';
import fs from 'fs';
import childProcess from 'child_process';

const validGitignore = [
'node_modules/',
'/test-results/',
'/playwright-report/',
'/blob-report/',
'/playwright/.cache/',
].join('\n');

test('should generate a project in the current directory', async ({ run, dir, packageManager }) => {
test.slow();
const { stdout } = await run([], { installGitHubActions: true, testDir: 'tests', language: 'TypeScript', installPlaywrightDependencies: false, installPlaywrightBrowsers: true });
Expand All @@ -29,6 +37,7 @@ test('should generate a project in the current directory', async ({ run, dir, pa
expect(playwrightConfigContent).toContain('tests');
expect(fs.existsSync(path.join(dir, '.github/workflows/playwright.yml'))).toBeTruthy();
expect(fs.existsSync(path.join(dir, '.gitignore'))).toBeTruthy();
expect(fs.readFileSync(path.join(dir, '.gitignore'), { encoding: 'utf8' }).trim()).toBe(validGitignore);
if (packageManager === 'npm') {
expect(stdout).toContain('Initializing NPM project (npm init -y)…');
expect(stdout).toContain('Installing Playwright Test (npm install --save-dev @playwright/test)…');
Expand Down Expand Up @@ -102,6 +111,13 @@ test('should generate in the root of pnpm workspace', async ({ run, packageManag
expect(fs.existsSync(path.join(dir, 'playwright.config.ts'))).toBeTruthy();
});

test('should not duplicate gitignore entries', async ({ run, dir }) => {
fs.writeFileSync(path.join(dir, '.gitignore'), validGitignore);

await run([], { installGitHubActions: false, testDir: 'tests', language: 'TypeScript', installPlaywrightDependencies: false, installPlaywrightBrowsers: false });
expect(fs.readFileSync(path.join(dir, '.gitignore'), { encoding: 'utf8' }).trim()).toBe(validGitignore);
})

test('should install with "npm ci" in GHA when using npm with package-lock enabled', async ({ dir, run, packageManager }) => {
test.skip(packageManager !== 'npm');

Expand Down