cypress-playwright-data-gen 1.0.9 → 1.0.11

package/README.md

@@ -1,29 +1,39 @@
-cypress-playwright-data-gen 🥰
+# cypress-playwright-data-gen
+
 A lightweight fake data generator for Cypress and Playwright tests — create realistic test data like users, cards, institutions, and more in seconds!
 
-🚀 Installation steps:
+
+[![NPM](https://nodei.co/npm/cypress-playwright-data-gen.svg)](https://nodei.co/npm/cypress-playwright-data-gen/)
+
+
+## Installation steps:
 Install using npm or yarn:
 
+```bash
 npm install cypress-playwright-data-gen
+```
 
-or
 
+```bash
 yarn add cypress-playwright-data-gen
+```
+
 
-##############################################################################
+## Usage In Cypress
 
-🧪 Usage In Cypress
+- Importing - Add the commands in your cypress/support/e2e.js (or commands.js):
 
-Add the commands in your cypress/support/e2e.js (or commands.js):
+```javascript
 import 'cypress-playwright-data-gen/cypress/commands';
+```
 
 
-Then you can use the custom commands anywhere in your tests:
+### 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:
- */
+Just an example — OrangeHRM doesn’t have public signup, so let’s imagine we were testing a form or registration flow:
+
+```javascript
+//Generate user data (Firstname, Lastname, Email, etc)
 it('uses generated user data for a signup-style test', () => {
   cy.generateUser().then((user) => {
     cy.visit('https://example.com/register');
@@ -36,9 +46,7 @@ it('uses generated user data for a signup-style test', () => {
   });
 });
 
-/**
- * Just an example
- */
+//Generate card data (Card number, Cvv, Expiry date)
 it('generates card data for payment-related tests', () => {
   cy.generateCard().then((card) => {
     cy.log(`Card Number: ${card.number}`);
@@ -47,24 +55,29 @@ it('generates card data for payment-related tests', () => {
   });
 });
 
+```
+
+
 
-##############################################################################
+## Usage In Playwright
 
-🧪 Usage In Playwright
+- Importing - Import the generators directly and use them in your Playwright tests:
 
+```javascript
 import { generateUser, generateCard, generateAddress, generateTransaction, generateInstitution } 
   from 'cypress-playwright-data-gen/playwright/utils';
+```
 
 
-Then you can use them anywhere in your Playwright tests:
+### Then you can use them anywhere in your Playwright tests:
 
+Just an example — OrangeHRM doesn’t have public signup, so let’s imagine we were testing a form or registration flow:
+
+```javascript
 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:
- */
+//Generate user data (Firstname, Lastname, Email, etc)
 test('uses generated user data for a signup-style test', async ({ page }) => {
   const user = generateUser();
   await page.goto('https://example.com/register');
@@ -76,9 +89,8 @@ test('uses generated user data for a signup-style test', async ({ page }) => {
   console.log(`Generated user: ${user.firstName} ${user.lastName}, email: ${user.email}`);
 });
 
-/**
- * Just an example
- */
+
+//Generate card data (Card number, Cvv, Expiry date)
 test('generates card data for payment-related tests', async () => {
   const card = generateCard();
   console.log(`Card Number: ${card.number}`);
@@ -86,9 +98,9 @@ test('generates card data for payment-related tests', async () => {
   console.log(`CVV: ${card.cvv}`);
 });
 
+```
 
 
-##############################################################################
 
 
 ## 🧩 Available Generators

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-playwright-data-gen",
-  "version": "1.0.9",
+  "version": "1.0.11",
   "description": "A simple Cypress & Playwright plugin for generating realistic test data using Faker.js.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -36,7 +36,9 @@
     "faker",
     "test-data",
     "automation",
-    "qa"
+    "qa",
+    "software testing",
+    "generator"
   ],
   "author": "Goodness Okoye",
   "license": "MIT",