feat: handle disabled lockfile (#107)

Author: PierreDemailly

package-lock.json

@@ -23,10 +23,12 @@
   },
   "devDependencies": {
     "@playwright/test": "^1.44.1",
+    "@types/ini": "^4.1.1",
     "@types/node": "^18.19.33",
     "ansi-colors": "^4.1.1",
     "enquirer": "^2.3.6",
     "esbuild": "^0.14.25",
+    "ini": "^4.1.3",
     "typescript": "^5.4.5"
   }
 }

package.json

@@ -18,6 +18,7 @@ import fs from 'fs';
 
 import { prompt } from 'enquirer';
 import colors from 'ansi-colors';
+import ini from 'ini';
 
 import { executeCommands, createFiles, executeTemplate, Command, languageToFileExtension, getFileExtensionCT } from './utils';
 import { type PackageManager, determinePackageManager } from './packageManager';
@@ -174,8 +175,10 @@ export class Generator {
     }
 
     if (answers.installGitHubActions) {
+      const npmrcExists = fs.existsSync(path.join(this.rootDir, '.npmrc'));
+      const packageLockDisabled = npmrcExists && ini.parse(fs.readFileSync(path.join(this.rootDir, '.npmrc'), 'utf-8'))['package-lock'] === false;
       const githubActionsScript = executeTemplate(this._readAsset('github-actions.yml'), {
-        installDepsCommand: this.packageManager.ci(),
+        installDepsCommand: packageLockDisabled ? this.packageManager.i() : this.packageManager.ci(),
         installPlaywrightCommand: this.packageManager.npx('playwright', 'install --with-deps'),
         runTestsCommand: answers.framework ? this.packageManager.run('test-ct') : this.packageManager.runPlaywrightTest(),
       }, new Map());

src/generator.ts

@@ -7,6 +7,7 @@ export interface PackageManager {
   init(): string
   npx(command: string, args: string): string
   ci(): string
+  i(): string
   installDevDependency(name: string): string
   runPlaywrightTest(args?: string): string
   run(script: string): string
@@ -28,6 +29,10 @@ class NPM implements PackageManager {
     return 'npm ci'
   }
 
+  i(): string {
+    return 'npm i'
+  }
+
   installDevDependency(name: string): string {
     return `npm install --save-dev ${name}`
   }
@@ -57,6 +62,10 @@ class Yarn implements PackageManager {
     return 'npm install -g yarn && yarn'
   }
 
+  i(): string {
+    return this.ci()
+  }
+
   installDevDependency(name: string): string {
     return `yarn add --dev ${name}`
   }
@@ -89,6 +98,10 @@ class PNPM implements PackageManager {
     return 'npm install -g pnpm && pnpm install'
   }
 
+  i(): string {
+    return this.ci()
+  }
+
   installDevDependency(name: string): string {
     return `pnpm add --save-dev ${this.workspace ? '-w ' : ''}${name}`
   }

src/packageManager.ts

@@ -101,3 +101,26 @@ test('should generate in the root of pnpm workspace', async ({ run, packageManag
   expect(fs.existsSync(path.join(dir, 'package.json'))).toBeTruthy();
   expect(fs.existsSync(path.join(dir, 'playwright.config.ts'))).toBeTruthy();
 });
+
+test('should install with "npm ci" in GHA when using npm with package-lock enabled', async ({ dir, run, packageManager }) => {
+  test.skip(packageManager !== 'npm');
+  
+  await run([], { installGitHubActions: true, testDir: 'tests', language: 'JavaScript', installPlaywrightDependencies: false, installPlaywrightBrowsers: true });
+  expect(fs.existsSync(path.join(dir, '.github/workflows/playwright.yml'))).toBeTruthy();
+
+  const workflowContent = fs.readFileSync(path.join(dir, '.github/workflows/playwright.yml'), 'utf8');
+  expect(workflowContent).not.toContain('run: npm i');
+  expect(workflowContent).toContain('run: npm ci');
+});
+
+test('should install with "npm i" in GHA when using npm with package-lock disabled', async ({ dir, run, packageManager }) => {
+  test.skip(packageManager !== 'npm');
+
+  fs.writeFileSync(path.join(dir, '.npmrc'), 'package-lock=false');
+  await run([], { installGitHubActions: true, testDir: 'tests', language: 'JavaScript', installPlaywrightDependencies: false, installPlaywrightBrowsers: true });
+  expect(fs.existsSync(path.join(dir, '.github/workflows/playwright.yml'))).toBeTruthy();
+
+  const workflowContent = fs.readFileSync(path.join(dir, '.github/workflows/playwright.yml'), 'utf8');
+  expect(workflowContent).toContain('run: npm i');
+  expect(workflowContent).not.toContain('run: npm ci');
+});