csv-faker-generator 2.0.1 → 2.1.0

package/README.md

@@ -13,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
@@ -33,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
@@ -51,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
@@ -202,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
 
@@ -283,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) {
@@ -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.1",
-  "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": {
@@ -37,7 +37,10 @@
     "test-data",
     "prototyping",
     "iban",
-    "banking"
+    "banking",
+    "json",
+    "ndjson",
+    "fixtures"
   ],
   "author": "Manoj Kengudelu",
   "license": "MIT",