csv-faker-generator 1.0.0

package/README.md

@@ -0,0 +1,169 @@
+# CSV Faker Generator
+
+Generate CSV files with realistic fake data using customizable headers and data types. Perfect for testing, prototyping, and development.
+
+## Features
+
+- Generate CSV files with custom column headers
+- Support for 19+ data types (UUID, names, emails, addresses, etc.)
+- Simple CLI interface
+- Programmatic API for Node.js projects
+- TypeScript support with full type definitions
+
+## Installation
+
+```bash
+npm install csv-faker-generator
+```
+
+## Usage
+
+### CLI Usage
+
+Generate a CSV file from the command line:
+
+```bash
+# Basic usage
+npx csv-faker -c id:uuid,name:name,email:email -r 100 -o users.csv
+
+# Generate user data
+npx csv-faker --columns "userId:uuid,firstName:firstName,lastName:lastName,email:email,phone:phone" --rows 50 --output customers.csv
+
+# Generate company data
+npx csv-faker -c id:uuid,company:company,city:city,country:country -r 20
+```
+
+#### CLI Options
+
+- `--columns, -c` - Column definitions (format: `header:type,header:type,...`)
+- `--rows, -r` - Number of rows to generate (default: 10)
+- `--output, -o` - Output file path (default: output.csv)
+- `--help, -h` - Show help message
+
+### Programmatic Usage
+
+Use in your Node.js/TypeScript projects:
+
+```typescript
+import { generateCSV } from 'csv-faker-generator';
+
+await generateCSV({
+  columns: [
+    { header: 'id', type: 'uuid' },
+    { header: 'name', type: 'name' },
+    { header: 'email', type: 'email' },
+    { header: 'address', type: 'address' },
+  ],
+  rows: 100,
+  output: 'users.csv',
+});
+```
+
+#### With Custom Number Ranges
+
+```typescript
+await generateCSV({
+  columns: [
+    { header: 'id', type: 'uuid' },
+    { header: 'age', type: 'number', min: 18, max: 65 },
+    { header: 'salary', type: 'number', min: 30000, max: 150000 },
+  ],
+  rows: 50,
+  output: 'employees.csv',
+});
+```
+
+## Supported Data Types
+
+| Type | Description | Example |
+|------|-------------|---------|
+| `uuid` | UUID v4 | `550e8400-e29b-41d4-a716-446655440000` |
+| `name` | Full name | `John Doe` |
+| `firstName` | First name only | `John` |
+| `lastName` | Last name only | `Doe` |
+| `email` | Email address | `john.doe@example.com` |
+| `phone` | Phone number | `+1-234-567-8900` |
+| `address` | Street address | `123 Main St` |
+| `city` | City name | `New York` |
+| `country` | Country name | `United States` |
+| `zipCode` | Postal code | `10001` |
+| `company` | Company name | `Tech Corp` |
+| `jobTitle` | Job title | `Software Engineer` |
+| `number` | Random number | `42` |
+| `date` | ISO date string | `2024-01-15T10:30:00.000Z` |
+| `boolean` | Boolean value | `true` or `false` |
+| `url` | Website URL | `https://example.com` |
+| `ip` | IP address | `192.168.1.1` |
+| `username` | Username | `john_doe123` |
+| `password` | Password | `aB3$xYz9!qW` |
+
+## Examples
+
+### Example 1: User Database
+
+```bash
+npx csv-faker -c userId:uuid,username:username,email:email,password:password,createdAt:date -r 1000 -o users.csv
+```
+
+### Example 2: E-commerce Orders
+
+```typescript
+import { generateCSV } from 'csv-faker-generator';
+
+await generateCSV({
+  columns: [
+    { header: 'orderId', type: 'uuid' },
+    { header: 'customerName', type: 'name' },
+    { header: 'email', type: 'email' },
+    { header: 'amount', type: 'number', min: 10, max: 500 },
+    { header: 'orderDate', type: 'date' },
+    { header: 'city', type: 'city' },
+    { header: 'country', type: 'country' },
+  ],
+  rows: 500,
+  output: 'orders.csv',
+});
+```
+
+### Example 3: Employee Directory
+
+```bash
+npx csv-faker -c id:uuid,firstName:firstName,lastName:lastName,email:email,phone:phone,jobTitle:jobTitle,company:company -r 200 -o employees.csv
+```
+
+## API Reference
+
+### `generateCSV(options: GenerateOptions): Promise<void>`
+
+Generates a CSV file with fake data.
+
+**Parameters:**
+- `options.columns`: Array of column definitions
+- `options.rows`: Number of rows to generate
+- `options.output`: Output file path
+
+**ColumnDefinition:**
+```typescript
+interface ColumnDefinition {
+  header: string;
+  type: DataType;
+  min?: number;  // For 'number' type
+  max?: number;  // For 'number' type
+}
+```
+
+### `parseColumnString(columnStr: string): ColumnDefinition`
+
+Parses a column string (e.g., "id:uuid") into a ColumnDefinition object.
+
+## License
+
+MIT
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## Issues
+
+Found a bug or have a feature request? Please open an issue on [GitHub](https://github.com/yourusername/csv-faker-generator/issues).

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,72 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("./index");
+const args = process.argv.slice(2);
+function showHelp() {
+    console.log(`
+CSV Faker Generator
+
+Usage:
+  csv-faker [options]
+
+Options:
+  --columns, -c    Column definitions (format: header:type,header:type,...)
+  --rows, -r       Number of rows to generate (default: 10)
+  --output, -o     Output file path (default: output.csv)
+  --help, -h       Show this help message
+
+Data Types:
+  uuid, name, firstName, lastName, email, phone, address, city,
+  country, zipCode, company, jobTitle, number, date, boolean,
+  url, ip, username, password
+
+Examples:
+  csv-faker -c id:uuid,name:name,email:email -r 100 -o users.csv
+  csv-faker -c userId:uuid,firstName:firstName,lastName:lastName,email:email,address:address -r 50
+  csv-faker --columns "id:uuid,company:company,city:city" --rows 20 --output companies.csv
+`);
+}
+function parseArgs() {
+    let columnsStr = '';
+    let rows = 10;
+    let output = 'output.csv';
+    for (let i = 0; i < args.length; i++) {
+        const arg = args[i];
+        if (arg === '--help' || arg === '-h') {
+            showHelp();
+            process.exit(0);
+        }
+        else if (arg === '--columns' || arg === '-c') {
+            columnsStr = args[++i];
+        }
+        else if (arg === '--rows' || arg === '-r') {
+            rows = parseInt(args[++i], 10);
+            if (isNaN(rows) || rows < 1) {
+                console.error('Error: rows must be a positive number');
+                process.exit(1);
+            }
+        }
+        else if (arg === '--output' || arg === '-o') {
+            output = args[++i];
+        }
+    }
+    if (!columnsStr) {
+        console.error('Error: --columns is required\n');
+        showHelp();
+        process.exit(1);
+    }
+    const columns = columnsStr.split(',').map(index_1.parseColumnString);
+    return { columns, rows, output };
+}
+async function main() {
+    try {
+        const options = parseArgs();
+        await (0, index_1.generateCSV)(options);
+    }
+    catch (error) {
+        console.error('Error:', error instanceof Error ? error.message : error);
+        process.exit(1);
+    }
+}
+main();

package/dist/example.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/example.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("./index");
+async function runExamples() {
+    console.log('Running CSV Faker Generator examples...\n');
+    console.log('Example 1: Generating user data...');
+    await (0, index_1.generateCSV)({
+        columns: [
+            { header: 'id', type: 'uuid' },
+            { header: 'name', type: 'name' },
+            { header: 'email', type: 'email' },
+            { header: 'address', type: 'address' },
+            { header: 'phone', type: 'phone' },
+        ],
+        rows: 10,
+        output: 'example-users.csv',
+    });
+    console.log('\nExample 2: Generating employee data with age range...');
+    await (0, index_1.generateCSV)({
+        columns: [
+            { header: 'employeeId', type: 'uuid' },
+            { header: 'firstName', type: 'firstName' },
+            { header: 'lastName', type: 'lastName' },
+            { header: 'email', type: 'email' },
+            { header: 'age', type: 'number', min: 22, max: 65 },
+            { header: 'jobTitle', type: 'jobTitle' },
+            { header: 'company', type: 'company' },
+            { header: 'salary', type: 'number', min: 40000, max: 150000 },
+        ],
+        rows: 15,
+        output: 'example-employees.csv',
+    });
+    console.log('\nExample 3: Generating company data...');
+    await (0, index_1.generateCSV)({
+        columns: [
+            { header: 'companyId', type: 'uuid' },
+            { header: 'companyName', type: 'company' },
+            { header: 'city', type: 'city' },
+            { header: 'country', type: 'country' },
+            { header: 'website', type: 'url' },
+            { header: 'verified', type: 'boolean' },
+        ],
+        rows: 8,
+        output: 'example-companies.csv',
+    });
+    console.log('\n✓ All examples completed successfully!');
+    console.log('\nGenerated files:');
+    console.log('  - example-users.csv (10 rows)');
+    console.log('  - example-employees.csv (15 rows)');
+    console.log('  - example-companies.csv (8 rows)');
+}
+runExamples().catch((error) => {
+    console.error('Error running examples:', error);
+    process.exit(1);
+});

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+export type DataType = 'uuid' | 'name' | 'firstName' | 'lastName' | 'title' | 'email' | 'phone' | 'address' | 'secondaryAddress' | 'city' | 'country' | 'zipCode' | 'company' | 'jobTitle' | 'number' | 'date' | 'boolean' | 'url' | 'ip' | 'username' | 'password' | 'iban' | 'bic' | 'bankName';
+export interface ColumnDefinition {
+    header: string;
+    type: DataType;
+    min?: number;
+    max?: number;
+}
+export interface GenerateOptions {
+    columns: ColumnDefinition[];
+    rows: number;
+    output: string;
+}
+export declare function generateCSV(options: GenerateOptions): Promise<void>;
+export declare function parseColumnString(columnStr: string): ColumnDefinition;
+export { DataType as DataTypes };

package/dist/index.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateCSV = generateCSV;
+exports.parseColumnString = parseColumnString;
+const faker_1 = require("@faker-js/faker");
+const csv_writer_1 = require("csv-writer");
+function generateValue(type, min, max) {
+    switch (type) {
+        case 'uuid':
+            return faker_1.faker.string.uuid();
+        case 'name':
+            return faker_1.faker.person.fullName();
+        case 'firstName':
+            return faker_1.faker.person.firstName();
+        case 'lastName':
+            return faker_1.faker.person.lastName();
+        case 'title':
+            return faker_1.faker.person.prefix();
+        case 'email':
+            return faker_1.faker.internet.email();
+        case 'phone':
+            return faker_1.faker.phone.number();
+        case 'address':
+            return faker_1.faker.location.streetAddress();
+        case 'secondaryAddress':
+            return faker_1.faker.location.secondaryAddress();
+        case 'city':
+            return faker_1.faker.location.city();
+        case 'country':
+            return faker_1.faker.location.country();
+        case 'zipCode':
+            return faker_1.faker.location.zipCode();
+        case 'company':
+            return faker_1.faker.company.name();
+        case 'jobTitle':
+            return faker_1.faker.person.jobTitle();
+        case 'number':
+            return faker_1.faker.number.int({ min: min || 1, max: max || 1000 });
+        case 'date':
+            return faker_1.faker.date.recent().toISOString();
+        case 'boolean':
+            return faker_1.faker.datatype.boolean();
+        case 'url':
+            return faker_1.faker.internet.url();
+        case 'ip':
+            return faker_1.faker.internet.ip();
+        case 'username':
+            return faker_1.faker.internet.username();
+        case 'password':
+            return faker_1.faker.internet.password();
+        case 'iban':
+            return faker_1.faker.finance.iban();
+        case 'bic':
+            return faker_1.faker.finance.bic();
+        case 'bankName':
+            return faker_1.faker.company.name() + ' Bank';
+        default:
+            return faker_1.faker.lorem.word();
+    }
+}
+async function generateCSV(options) {
+    const { columns, rows, output } = options;
+    const csvWriter = (0, csv_writer_1.createObjectCsvWriter)({
+        path: output,
+        header: columns.map((col) => ({
+            id: col.header,
+            title: col.header,
+        })),
+    });
+    const records = [];
+    for (let i = 0; i < rows; i++) {
+        const record = {};
+        for (const column of columns) {
+            record[column.header] = generateValue(column.type, column.min, column.max);
+        }
+        records.push(record);
+    }
+    await csvWriter.writeRecords(records);
+    console.log(`✓ Generated ${rows} rows in ${output}`);
+}
+function parseColumnString(columnStr) {
+    const parts = columnStr.split(':');
+    if (parts.length < 2) {
+        throw new Error(`Invalid column format: ${columnStr}. Expected format: header:type`);
+    }
+    const [header, typeStr] = parts;
+    const type = typeStr;
+    const validTypes = [
+        'uuid', 'name', 'firstName', 'lastName', 'title', 'email', 'phone',
+        'address', 'secondaryAddress', 'city', 'country', 'zipCode', 'company', 'jobTitle',
+        'number', 'date', 'boolean', 'url', 'ip', 'username', 'password',
+        'iban', 'bic', 'bankName'
+    ];
+    if (!validTypes.includes(type)) {
+        throw new Error(`Invalid data type: ${type}. Valid types: ${validTypes.join(', ')}`);
+    }
+    return { header, type };
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "csv-faker-generator",
+  "version": "1.0.0",
+  "description": "Generate CSV files with fake data using custom headers (UUID, names, emails, addresses, etc.)",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "csv-faker": "dist/cli.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/manojkken/csv-faker-generator.git"
+  },
+  "homepage": "https://github.com/manojkken/csv-faker-generator#readme",
+  "bugs": {
+    "url": "https://github.com/manojkken/csv-faker-generator/issues"
+  },
+  "scripts": {
+    "build": "tsc",
+    "prepare": "npm run build",
+    "test": "node dist/example.js"
+  },
+  "keywords": [
+    "csv",
+    "faker",
+    "fake-data",
+    "generator",
+    "uuid",
+    "csv-generator",
+    "mock-data"
+  ],
+  "author": "Manoj Kengudelu",
+  "license": "MIT",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "dependencies": {
+    "@faker-js/faker": "^10.1.0",
+    "csv-writer": "^1.6.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.10.1",
+    "typescript": "^5.9.3"
+  }
+}