cypress-playwright-data-gen 1.0.7 → 1.0.9

package/README.md

@@ -20,109 +20,82 @@ import 'cypress-playwright-data-gen/cypress/commands';
 
 Then you can use the custom commands anywhere in your tests:
 
+/**
+ * Just an example — OrangeHRM doesn’t have public signup,
+ * so let’s imagine we were testing a form or registration flow:
+ */
 it('uses generated user data for a signup-style test', () => {
-    cy.generateUser().then((user) => {
-     /** Just an example — OrangeHRM doesn’t have public signup, so let’s imagine we were testing a form or registration flow: **/
-      cy.visit('https://example.com/register');
-      cy.get('#firstName').type(user.firstName);
-      cy.get('#lastName').type(user.lastName);
-      cy.get('#email').type(user.email);
-      cy.get('#password').type(user.password);
-      cy.get('#submit').click();
-      cy.log(`Generated user: ${user.firstName} ${user.lastName}, email: ${user.email}`);
-    });
+  cy.generateUser().then((user) => {
+    cy.visit('https://example.com/register');
+    cy.get('#firstName').type(user.firstName);
+    cy.get('#lastName').type(user.lastName);
+    cy.get('#email').type(user.email);
+    cy.get('#password').type(user.password);
+    cy.get('#submit').click();
+    cy.log(`Generated user: ${user.firstName} ${user.lastName}, email: ${user.email}`);
   });
+});
 
-  it('generates card data for payment-related tests', () => {
-    cy.generateCard().then((card) => {
-      cy.log(`Card Number: ${card.number}`);
-      cy.log(`Expiry: ${card.expiryMonth}/${card.expiryYear}`);
-      cy.log(`CVV: ${card.cvv}`);
-    });
+/**
+ * Just an example
+ */
+it('generates card data for payment-related tests', () => {
+  cy.generateCard().then((card) => {
+    cy.log(`Card Number: ${card.number}`);
+    cy.log(`Expiry: ${card.expiryMonth}/${card.expiryYear}`);
+    cy.log(`CVV: ${card.cvv}`);
   });
+});
 
 
 ##############################################################################
 
 🧪 Usage In Playwright
 
-Import the utility functions in your test file (or a setup file):
-import { generateUser, generateCard, generateAddress, generateTransaction, generateInstitution } from 'cypress-playwright-data-gen/playwright/utils';
+import { generateUser, generateCard, generateAddress, generateTransaction, generateInstitution } 
+  from 'cypress-playwright-data-gen/playwright/utils';
 
 
 Then you can use them anywhere in your Playwright tests:
+
 import { test, expect } from '@playwright/test';
 import { generateUser, generateCard } from 'cypress-playwright-data-gen/playwright/utils';
-  /** Just an example — OrangeHRM doesn’t have public signup, so let’s imagine we were testing a form or registration flow: **/
-  test('uses generated user data for a signup-style test', async ({ page }) => {
-    const user = generateUser();
-    await page.goto('https://example.com/register');
-    await page.fill('#firstName', user.firstName);
-    await page.fill('#lastName', user.lastName);
-    await page.fill('#email', user.email);
-    await page.fill('#password', user.password);
-    await page.click('#submit');
-    console.log(`Generated user: ${user.firstName} ${user.lastName}, email: ${user.email}`);
-  });
+
+/** 
+ * Just an example — OrangeHRM doesn’t have public signup, 
+ * so let’s imagine we were testing a form or registration flow:
+ */
+test('uses generated user data for a signup-style test', async ({ page }) => {
+  const user = generateUser();
+  await page.goto('https://example.com/register');
+  await page.fill('#firstName', user.firstName);
+  await page.fill('#lastName', user.lastName);
+  await page.fill('#email', user.email);
+  await page.fill('#password', user.password);
+  await page.click('#submit');
+  console.log(`Generated user: ${user.firstName} ${user.lastName}, email: ${user.email}`);
+});
 
 /**
  * Just an example
  */
-  test('generates card data for payment-related tests', async () => {
-    const card = generateCard();
-    console.log(`Card Number: ${card.number}`);
-    console.log(`Expiry: ${card.expiryMonth}/${card.expiryYear}`);
-    console.log(`CVV: ${card.cvv}`);
-  });
+test('generates card data for payment-related tests', async () => {
+  const card = generateCard();
+  console.log(`Card Number: ${card.number}`);
+  console.log(`Expiry: ${card.expiryMonth}/${card.expiryYear}`);
+  console.log(`CVV: ${card.cvv}`);
+});
 
 
 
 ##############################################################################
 
 
-🧩 Available Generators & Their Attributes:
-
-🧍‍♂️generateUser()
-fullName
-firstName
-lastName
-username
-password
-userId
-avatar
-email
-phone
-address
-
-💳 generateCard()
-cardNumber
-cvv
-expiry
-
-🏠 generateAddress()
-street
-city
-state
-postalCode
-country
-
-🏦 generateInstitution()
-institutionId
-name
-type
-country
-branchCode
-contactEmail
-phone
-
-💰 generateTransaction()
-amount
-currency
-type
-date
-merchant
-transactionId
-status
-
-
-
+## 🧩 Available Generators
+| Generator | Attributes |
+|------------|-------------|
+| 👤 **generateUser()** | fullName, firstName, lastName, username, password, userId, avatar, email, phone, address |
+| 💳 **generateCard()** | cardNumber, cvv, expiry |
+| 🏠 **generateAddress()** | street, city, state, postalCode, country |
+| 🏦 **generateInstitution()** | institutionId, name, type, country, branchCode, contactEmail, phone |
+| 💰 **generateTransaction()** | amount, currency, type, date, merchant, transactionId, status |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-playwright-data-gen",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "A simple Cypress & Playwright plugin for generating realistic test data using Faker.js.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",