csv-faker-generator 2.0.0 → 2.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Manoj Kengudelu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,5 +1,10 @@
 # CSV Faker Generator
 
+[![npm version](https://img.shields.io/npm/v/csv-faker-generator.svg)](https://www.npmjs.com/package/csv-faker-generator)
+[![npm downloads](https://img.shields.io/npm/dm/csv-faker-generator.svg)](https://www.npmjs.com/package/csv-faker-generator)
+[![CI](https://github.com/manojkken/csv-faker-generator/actions/workflows/ci.yml/badge.svg)](https://github.com/manojkken/csv-faker-generator/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
 Generate CSV files with realistic fake data using customizable headers and data types. Perfect for testing, prototyping, and development.
 
 ## Features
@@ -8,6 +13,7 @@ Generate CSV files with realistic fake data using customizable headers and data
 - **Advanced data generation**: Alphanumeric strings, pick from custom values, formula-based calculated fields
 - **Flexible number formatting**: Control decimal precision and ranges
 - **Custom delimiters**: Support for comma, semicolon, tab, pipe
+- **Multiple output formats**: CSV, JSON arrays, and newline-delimited JSON
 - **Simple CLI interface**: Generate CSV files from command line
 - **Programmatic API**: Use in Node.js/TypeScript projects
 - **Full TypeScript support**: Complete type definitions included
@@ -28,6 +34,10 @@ npx csv-faker -c id:uuid,name:name,email:email -r 100 -o users.csv
 
 # With custom delimiter
 npx csv-faker -c id:uuid,name:name,email:email --delimiter ";" -r 50 -o contacts.csv
+
+# JSON and NDJSON (also inferred from .json and .ndjson output extensions)
+npx csv-faker -c id:uuid,name:name,email:email -r 100 -o users.json
+npx csv-faker -c id:uuid,name:name,email:email -r 100 -f ndjson -o users.data
 ```
 
 ### Programmatic Usage
@@ -46,6 +56,20 @@ await generateCSV({
 });
 ```
 
+Set `format` to `'json'` for an array of row objects or `'ndjson'` for one row object per line. It defaults to `'csv'` in programmatic usage.
+
+```typescript
+await generateCSV({
+  columns: [
+    { header: 'id', type: 'uuid' },
+    { header: 'active', type: 'boolean' },
+  ],
+  rows: 100,
+  output: 'users.json',
+  format: 'json',
+});
+```
+
 ## Advanced Features
 
 ### 1. Alphanumeric Type
@@ -197,6 +221,7 @@ await generateCSV({
 - `--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)
+- `--format, -f` - Output format: `csv`, `json`, or `ndjson` (default: inferred from `.json` / `.ndjson` extension, otherwise `csv`)
 - `--delimiter, -d` - Field delimiter (default: `,`) [options: `,` `;` `|` `\t`]
 - `--help, -h` - Show help message
 
@@ -278,6 +303,7 @@ interface GenerateOptions {
   columns: ColumnDefinition[];
   rows: number;
   output: string;
+  format?: 'csv' | 'json' | 'ndjson'; // Default: 'csv'
   delimiter?: string;        // Default: ','
 }
 

package/dist/cli.js

@@ -1,7 +1,41 @@
 #!/usr/bin/env node
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 const index_1 = require("./index");
+const path = __importStar(require("node:path"));
 const args = process.argv.slice(2);
 function showHelp() {
     console.log(`
@@ -14,6 +48,7 @@ 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)
+  --format, -f     Output format: csv, json, or ndjson (default: inferred from output extension)
   --delimiter, -d  Field delimiter (default: ,) [options: , ; | \\t]
   --help, -h       Show this help message
 
@@ -31,12 +66,15 @@ Examples:
   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
   csv-faker -c id:uuid,name:name,email:email --delimiter ";" -r 50 -o contacts.csv
+  csv-faker -c id:uuid,name:name -r 50 -o users.json
+  csv-faker -c id:uuid,name:name -r 50 -f ndjson -o users.data
 `);
 }
 function parseArgs() {
     let columnsStr = '';
     let rows = 10;
     let output = 'output.csv';
+    let format;
     let delimiter = ',';
     for (let i = 0; i < args.length; i++) {
         const arg = args[i];
@@ -57,6 +95,13 @@ function parseArgs() {
         else if (arg === '--output' || arg === '-o') {
             output = args[++i];
         }
+        else if (arg === '--format' || arg === '-f') {
+            const value = args[++i];
+            if (value !== 'csv' && value !== 'json' && value !== 'ndjson') {
+                throw new Error(`Invalid format: ${value}. Expected csv, json, or ndjson`);
+            }
+            format = value;
+        }
         else if (arg === '--delimiter' || arg === '-d') {
             delimiter = args[++i];
             // Handle common escape sequences
@@ -71,7 +116,13 @@ function parseArgs() {
         process.exit(1);
     }
     const columns = columnsStr.split(',').map(index_1.parseColumnString);
-    return { columns, rows, output, delimiter };
+    if (!format) {
+        const extension = path.extname(output).slice(1).toLowerCase();
+        if (extension === 'json' || extension === 'ndjson') {
+            format = extension;
+        }
+    }
+    return { columns, rows, output, format, delimiter };
 }
 async function main() {
     try {

package/dist/index.d.ts

@@ -14,6 +14,7 @@ export interface GenerateOptions {
     columns: ColumnDefinition[];
     rows: number;
     output: string;
+    format?: 'csv' | 'json' | 'ndjson';
     delimiter?: string;
 }
 export declare function generateCSV(options: GenerateOptions): Promise<void>;

package/dist/index.js

@@ -4,6 +4,7 @@ exports.generateCSV = generateCSV;
 exports.parseColumnString = parseColumnString;
 const faker_1 = require("@faker-js/faker");
 const csv_writer_1 = require("csv-writer");
+const promises_1 = require("node:fs/promises");
 function generateValue(column, row) {
     const { type, min, max, length, uppercase, values, decimals } = column;
     switch (type) {
@@ -36,9 +37,9 @@ function generateValue(column, row) {
         case 'jobTitle':
             return faker_1.faker.person.jobTitle();
         case 'number': {
-            const num = faker_1.faker.number.int({ min: min || 1, max: max || 1000 });
+            const num = faker_1.faker.number.int({ min: min ?? 1, max: max ?? 1000 });
             if (decimals !== undefined) {
-                const float = faker_1.faker.number.float({ min: min || 1, max: max || 1000, fractionDigits: decimals });
+                const float = faker_1.faker.number.float({ min: min ?? 1, max: max ?? 1000, fractionDigits: decimals });
                 return parseFloat(float.toFixed(decimals));
             }
             return num;
@@ -86,15 +87,7 @@ function generateValue(column, row) {
     }
 }
 async function generateCSV(options) {
-    const { columns, rows, output, delimiter = ',' } = options;
-    const csvWriter = (0, csv_writer_1.createObjectCsvWriter)({
-        path: output,
-        header: columns.map((col) => ({
-            id: col.header,
-            title: col.header,
-        })),
-        fieldDelimiter: delimiter,
-    });
+    const { columns, rows, output, format = 'csv', delimiter = ',' } = options;
     const records = [];
     for (let i = 0; i < rows; i++) {
         const record = {};
@@ -112,7 +105,24 @@ async function generateCSV(options) {
         }
         records.push(record);
     }
-    await csvWriter.writeRecords(records);
+    if (format === 'json') {
+        await (0, promises_1.writeFile)(output, `${JSON.stringify(records, null, 2)}\n`);
+    }
+    else if (format === 'ndjson') {
+        const content = records.map((record) => JSON.stringify(record)).join('\n');
+        await (0, promises_1.writeFile)(output, content ? `${content}\n` : '');
+    }
+    else {
+        const csvWriter = (0, csv_writer_1.createObjectCsvWriter)({
+            path: output,
+            header: columns.map((col) => ({
+                id: col.header,
+                title: col.header,
+            })),
+            fieldDelimiter: delimiter,
+        });
+        await csvWriter.writeRecords(records);
+    }
     console.log(`✓ Generated ${rows} rows in ${output}`);
 }
 function parseColumnString(columnStr) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "csv-faker-generator",
-  "version": "2.0.0",
-  "description": "Generate CSV files with fake data: 27+ data types, alphanumeric strings, pick from custom values, formula fields, decimal precision, custom delimiters. Perfect for testing and prototyping.",
+  "version": "2.1.0",
+  "description": "Generate CSV, JSON, or NDJSON files with fake data: 27+ data types, alphanumeric strings, pick from custom values, formula fields, decimal precision, custom delimiters. Perfect for testing and prototyping.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "bin": {
@@ -9,7 +9,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/manojkken/csv-faker-generator.git"
+    "url": "git+https://github.com/manojkken/csv-faker-generator.git"
   },
   "homepage": "https://github.com/manojkken/csv-faker-generator#readme",
   "bugs": {
@@ -18,7 +18,7 @@
   "scripts": {
     "build": "tsc",
     "prepare": "npm run build",
-    "test": "node dist/example.js"
+    "test": "npm run build && node --test test/index.test.js"
   },
   "keywords": [
     "csv",
@@ -37,13 +37,19 @@
     "test-data",
     "prototyping",
     "iban",
-    "banking"
+    "banking",
+    "json",
+    "ndjson",
+    "fixtures"
   ],
   "author": "Manoj Kengudelu",
   "license": "MIT",
   "files": [
     "dist",
-    "README.md"
+    "!dist/example.*",
+    "!dist/test-advanced.*",
+    "README.md",
+    "LICENSE"
   ],
   "dependencies": {
     "@faker-js/faker": "^10.1.0",
@@ -53,4 +59,4 @@
     "@types/node": "^24.10.1",
     "typescript": "^5.9.3"
   }
-}
+}

package/dist/example.d.ts

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

package/dist/example.js

@@ -1,55 +0,0 @@
-"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/test-advanced.d.ts

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

package/dist/test-advanced.js

@@ -1,110 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const index_1 = require("./index");
-async function testAdvancedFeatures() {
-    console.log('Testing Advanced Features...\n');
-    // Test 1: Alphanumeric with length and uppercase
-    console.log('Test 1: Alphanumeric type with custom length and uppercase...');
-    await (0, index_1.generateCSV)({
-        columns: [
-            { header: 'product_code', type: 'alphanumeric', length: 10, uppercase: true },
-            { header: 'sku', type: 'alphanumeric', length: 15 },
-            { header: 'name', type: 'name' },
-        ],
-        rows: 5,
-        output: 'test-alphanumeric.csv',
-    });
-    // Test 2: Pick type for enum values
-    console.log('\nTest 2: Pick type for predefined values...');
-    await (0, index_1.generateCSV)({
-        columns: [
-            { header: 'product', type: 'name' },
-            { header: 'tax_rate', type: 'pick', values: [0, 7, 19] },
-            { header: 'status', type: 'pick', values: ['active', 'pending', 'inactive'] },
-            { header: 'unit', type: 'pick', values: ['g', 'kg', 'Stück', 'Meter'] },
-        ],
-        rows: 5,
-        output: 'test-pick.csv',
-    });
-    // Test 3: Formula fields (calculated values)
-    console.log('\nTest 3: Formula type for calculated fields...');
-    await (0, index_1.generateCSV)({
-        columns: [
-            { header: 'product', type: 'company' },
-            { header: 'netto', type: 'number', min: 10, max: 200, decimals: 2 },
-            { header: 'tax', type: 'pick', values: [0, 7, 19] },
-            {
-                header: 'brutto',
-                type: 'formula',
-                formula: (row) => {
-                    const netto = row.netto;
-                    const tax = row.tax;
-                    return parseFloat((netto * (1 + tax / 100)).toFixed(2));
-                },
-            },
-        ],
-        rows: 5,
-        output: 'test-formula.csv',
-    });
-    // Test 4: Custom delimiter (semicolon)
-    console.log('\nTest 4: Custom delimiter (semicolon)...');
-    await (0, index_1.generateCSV)({
-        columns: [
-            { header: 'id', type: 'uuid' },
-            { header: 'name', type: 'name' },
-            { header: 'email', type: 'email' },
-        ],
-        rows: 5,
-        delimiter: ';',
-        output: 'test-semicolon.csv',
-    });
-    // Test 5: Number with decimal precision
-    console.log('\nTest 5: Number type with decimal precision...');
-    await (0, index_1.generateCSV)({
-        columns: [
-            { header: 'price', type: 'number', min: 10, max: 200, decimals: 2 },
-            { header: 'weight', type: 'number', min: 0.1, max: 99.9, decimals: 1 },
-            { header: 'quantity', type: 'number', min: 1, max: 1000, decimals: 0 },
-        ],
-        rows: 5,
-        output: 'test-decimals.csv',
-    });
-    // Test 6: Complete E-commerce Article Example
-    console.log('\nTest 6: Complete e-commerce article example (the dogfooding use case)...');
-    await (0, index_1.generateCSV)({
-        columns: [
-            { header: 'Artikelnummer*', type: 'alphanumeric', length: 15 },
-            { header: 'Bezeichnung*', type: 'company' },
-            { header: 'Beschreibung', type: 'company' },
-            { header: 'Verkaufspreis netto in €', type: 'number', min: 10, max: 200, decimals: 2 },
-            { header: 'Steuersatz', type: 'pick', values: [0, 7, 19] },
-            {
-                header: 'Verkaufspreis brutto in €',
-                type: 'formula',
-                formula: (row) => {
-                    const netto = row['Verkaufspreis netto in €'];
-                    const tax = row['Steuersatz'];
-                    return parseFloat((netto * (1 + tax / 100)).toFixed(2));
-                },
-            },
-            { header: 'Einkaufspreis netto in €', type: 'number', min: 5, max: 100, decimals: 2 },
-            { header: 'Einheit', type: 'pick', values: ['Stück', 'kg', 'g', 'Meter', 'Liter'] },
-            { header: 'Bestand', type: 'number', min: 0, max: 1000, decimals: 0 },
-            { header: 'Kategorie', type: 'pick', values: ['Electronics', 'Food', 'Clothing', 'Books'] },
-        ],
-        rows: 10,
-        output: 'test-articles-complete.csv',
-    });
-    console.log('\n✓ All advanced feature tests completed successfully!');
-    console.log('\nGenerated files:');
-    console.log('  - test-alphanumeric.csv (alphanumeric with length/uppercase)');
-    console.log('  - test-pick.csv (pick from predefined values)');
-    console.log('  - test-formula.csv (calculated fields)');
-    console.log('  - test-semicolon.csv (custom delimiter)');
-    console.log('  - test-decimals.csv (decimal precision)');
-    console.log('  - test-articles-complete.csv (complete e-commerce example)');
-}
-testAdvancedFeatures().catch((error) => {
-    console.error('Error running advanced tests:', error);
-    process.exit(1);
-});