Merge branch '266-postinstall-moet-correct-gedraaid-worden' into 'main'

Resolve "Postinstall moet correct gedraaid worden."

See merge request elgentos/magento2-playwright!38

Author: Myron van Velsen

.npmignore

@@ -6,6 +6,7 @@ node_modules/
 /test-results/
 /auth-storage/
 /playwright-report/
+/base-tests/
 
 #files
 /*.config.ts

README.md

@@ -53,12 +53,30 @@ npm init -y
 
 3. **Install the test suite package**
 
-Lastly, simply run the command to install the elgentos Magento2 Playwright package, and the installation script will set things up for you! You will be prompted to input values for the `.env` variables, but these also come with default values.
+Lastly, simply run the command to install the elgentos Magento2 Playwright package, and the installation script will set things up for you! 
 
 ```bash
 npm install @elgentos/magento2-playwright
 ```
 
+4. **Generate .env file and add playwright to .gitignore (optional)**
+
+Normally, you should be prompted to provide values for the .env variables during installation.
+Each variable also comes with sensible default values.
+
+<mark>⚠️ Due to limitations in how npm runs dependency install scripts, the install.js script is not executed automatically when this package is installed as a dependency.</mark>
+
+If you want to (re)generate the .env file and configure your environment variables, run the following command manually from your playwright root folder:
+
+```bash
+node node_modules/@elgentos/magento2-playwright/install.js
+```
+
+After running the command, you will be asked:
+
+- Do you want to customize environment variables? (y/N)
+- Do you want to add lines to the .gitignore of your project? (y/N)
+
 ---
 
 ## ⏸️ Before you run

install.js

@@ -11,7 +11,7 @@ class Install {
   currentUser = '';
   isCi = false;
   useDefaults = false;
-  pathToMagentoRoot = '../../../../../../../../../../'; // default: when installed via npm
+  pathToMagentoRootGitignore = '../../../../../../../'; // default: when installed via npm
   envVars = {};
 
   rulesToAddToIgnore = [
@@ -29,7 +29,7 @@ class Install {
     const isLocalDev = fs.existsSync(path.resolve(__dirname, '.git'));
 
     if (isLocalDev) {
-      this.pathToMagentoRoot = './'; // we're in the root of the dev repo
+      this.pathToMagentoRootGitignore = './'; // we're in the root of the dev repo
     }
 
     this.envVars = {
@@ -51,7 +51,6 @@ class Install {
       'MAGENTO_COUPON_CODE_WEBKIT': { default: 'WEBKIT321' }
     }
 
-
     this.rl = readline.createInterface({
       input: process.stdin,
       output: process.stdout
@@ -61,25 +60,28 @@ class Install {
   }
 
   async init() {
+    await this.setEnvVariables();
+    await this.appendToGitIgnore();
 
-    console.log(this.envVars);
-
-
-    // Check if user
-    if (!this.isCi) {
-      const initialAnswer = await this.askQuestion('Do you want to customize environment variables? (y/N): ');
-      this.useDefaults = initialAnswer.trim().toLowerCase() !== 'y';
-    }
+    console.log('\nInstallation completed successfully!');
+    console.log('\nFor more information, please visit:');
+    console.log('https://wiki.elgentos.nl/doc/stappenplan-testing-suite-implementeren-voor-klanten-hCGe4hVQvN');
 
-    await this.appendToGitIgnore();
-    await this.setEnvVariables();
+    // Close rl when no questions are asked
+    this.rl.close();
   }
 
   async askQuestion(query) {
     return new Promise((resolve) => this.rl.question(query, resolve))
   }
 
   async setEnvVariables() {
+    // Check if user
+    if (!this.isCi) {
+      const initialAnswer = await this.askQuestion('Do you want to customize environment variables? (y/N): ');
+      this.useDefaults = initialAnswer.trim().toLowerCase() !== 'y';
+    }
+
     // Read and update .env file
     const envPath = path.join('.env');
     let envContent = '';
@@ -93,18 +95,19 @@ class Install {
     }
 
     fs.writeFileSync(envPath, envContent);
-
-    console.log('\nInstallation completed successfully!');
-    console.log('\nFor more information, please visit:');
-    console.log('https://wiki.elgentos.nl/doc/stappenplan-testing-suite-implementeren-voor-klanten-hCGe4hVQvN');
-
-    this.rl.close();
   }
 
   async appendToGitIgnore() {
+    if (!this.isCi) {
+      const initialAnswer = await this.askQuestion('Do you want to add lines to gitignore of your project? (y/N): ');
+      if (initialAnswer.trim().toLowerCase() !== 'y') {
+        return;
+      }
+    }
+
     console.log('Checking .gitignore and adding lines if necessary...');
 
-    const gitignorePath = path.join(this.pathToMagentoRoot, '.gitignore');
+    const gitignorePath = path.join(this.pathToMagentoRootGitignore, '.gitignore');
 
     // Read existing content if file exists
     let existingLines = [];

package-lock.json

@@ -1,11 +1,11 @@
 {
   "name": "@elgentos/magento2-playwright",
-  "version": "2.2.0",
+  "version": "2.2.2",
   "author": "elgentos",
   "license": "ISC",
   "description": "A Playwright End-To-End (E2E) testing suite for Magento 2 with Hyva that helps you find (potential) issues on your webshop.",
   "scripts": {
-    "postinstall": "node build.js && npx playwright install && node install.js",
+    "postinstall": "node build.js; node install.js; npx playwright install",
     "translate": "node translate-json.js nl_NL"
   },
   "dependencies": {