feat(new tool): Data Faker

Output JSON, YAML, XML, CSV, SQL INSERT from JSON Template
Fix #369
This commit is contained in:
ShareVB committed 2025-05-11 19:41:07 +02:00
1 parent eaa8b5b672
commit dd5ca6f693
4 files changed
+178

No files matched your search

+1
View File
@@ -40,6 +40,7 @@
"@chenfengyuan/vue-barcode": "^2.0.2",
"@date-fns/utc": "^1.2.0",
"@dice-roller/rpg-dice-roller": "^5.5.1",
"@faker-js/faker": "^9.7.0",
"@fortawesome/fontawesome-svg-core": "^6.7.2",
"@fortawesome/free-solid-svg-icons": "^6.7.2",
"@fortawesome/vue-fontawesome": "^3.0.8",
+8
View File
@@ -17,6 +17,9 @@ dependencies:
'@dice-roller/rpg-dice-roller':
specifier: ^5.5.1
version: 5.5.1
'@faker-js/faker':
specifier: ^9.7.0
version: 9.7.0
'@fortawesome/fontawesome-svg-core':
specifier: ^6.7.2
version: 6.7.2
@@ -3585,6 +3588,11 @@ packages:
engines: {node: ^12.22.0 || ^14.17.0 || >=16.0.0}
dev: true
/@faker-js/faker@9.7.0:
resolution: {integrity: sha512-aozo5vqjCmDoXLNUJarFZx2IN/GgGaogY4TMJ6so/WLZOWpSV7fvj2dmrV6sEAnUm1O7aCrhTibjpzeDFgNqbg==}
engines: {node: '>=18.0.0', npm: '>=9.0.0'}
dev: false
/@fortawesome/fontawesome-common-types@6.7.2:
resolution: {integrity: sha512-Zs+YeHUC5fkt7Mg1l6XTniei3k4bwG/yo3iFUtZWd/pMx9g3fdvkSK9E0FOC+++phXOka78uJcYb8JaFkW52Xg==}
engines: {node: '>=6'}
+156
View File
@@ -0,0 +1,156 @@
<script setup lang="ts">
import { type Faker, allFakers } from '@faker-js/faker';
import JSON5 from 'json5';
import { objectArrayToData } from '@/utils/objectarray.export';
import type { ExportFormat } from '@/utils/objectarray.export';
import type { UseValidationRule } from '@/composable/validation';
import { useQueryParamOrStorage } from '@/composable/queryParams';
const jsonInput = useQueryParamOrStorage({
name: 'template',
storageName: 'faker:tmpl',
defaultValue: JSON.stringify({
name: 'faker.person.fullName',
email: 'faker.internet.email',
address: {
street: 'faker.location.streetAddress',
city: 'faker.location.city',
country: 'faker.location.country',
},
phone: 'faker.phone.number',
}, null, 2),
});
const generatedData = ref<string>('');
const itemCount = useQueryParamOrStorage({ name: 'count', storageName: 'faker:c', defaultValue: 1 });
const error = ref('');
const selectedFormat = useQueryParamOrStorage({ name: 'fmt', storageName: 'faker:f', defaultValue: 'json' });
const tableName = ref<string>('TableName');
const nestify = ref(false);
const allLocales = Object.keys(allFakers);
const selectedLocale = useQueryParamOrStorage({ name: 'locale', storageName: 'faker:l', defaultValue: 'en' });
const faker = computed(() => (allFakers as Record<string, Faker>)[selectedLocale.value]);
const formats = [
{ label: 'JSON', value: 'json' },
{ label: 'YAML', value: 'yaml' },
{ label: 'SQL INSERT', value: 'sql' },
{ label: 'CSV (comma)', value: 'csv' },
{ label: 'CSV (semicolon)', value: 'csv_semicolon' },
{ label: 'CSV (tab)', value: 'tsv' },
{ label: 'Markdown', value: 'markdown' },
{ label: 'XML', value: 'xml' },
];
// Extract all faker methods dynamically
const fakerMethods = computed(() => {
const methods: string[] = [];
const fakerObj = (faker as Record<string, any>);
Object.keys(fakerObj).forEach((category) => {
if (typeof fakerObj[category] === 'object') {
Object.keys(fakerObj[category]).forEach((method) => {
methods.push(`faker.${category}.${method}`);
});
}
});
return methods.map(method => ({ label: method, value: method }));
});
// Selected faker method for insertion
const selectedMethod = ref<string>('');
function resolveFakerValue(value: string) {
try {
return value.startsWith('faker.')
? value.split('.').slice(1).reduce((acc: any, prop: string) => acc[prop], faker.value)()
: value;
}
catch {
return value; // Fallback for invalid faker function names
}
}
function generateFakeData(template: Record<string, any>): Record<string, any> {
return Object.entries(template).reduce((result, [key, value]) => {
result[key] = typeof value === 'object' && value !== null
? generateFakeData(value) // Recursive handling for nested objects
: resolveFakerValue(value);
return result;
}, {} as Record<string, any>);
}
function handleGenerate() {
try {
error.value = '';
const parsedTemplate = JSON.parse(jsonInput.value);
generatedData.value = objectArrayToData(
Array.from({ length: itemCount.value },
() => generateFakeData(parsedTemplate)),
selectedFormat.value as ExportFormat, {
tableName: tableName.value,
nestify: nestify.value,
});
}
catch (e: any) {
error.value = e.toString();
}
}
function insertMethodIntoJson() {
if (selectedMethod.value) {
jsonInput.value = jsonInput.value.replace(/\n?\}$/, `,\n "newField": "${selectedMethod.value}"\n}`);
}
}
const rules: UseValidationRule<string>[] = [
{
validator: (v: string) => v === '' || JSON5.parse(v),
message: 'Provided JSON is not valid.',
},
];
</script>
<template>
<NCard title="Fake Data Generator">
<c-input-text v-model:value="jsonInput" label="JSON Template:" multiline mb-1 rows="10" placeholder="Enter JSON template..." :validation-rules="rules" />
<c-card title="Faker Method insertion" mb-1>
<n-space>
<c-select v-model:value="selectedMethod" style="width: 200px" :options="fakerMethods" searchable placeholder="Search Faker Method" />
<NButton @click="insertMethodIntoJson">
Insert Selected Method
</NButton>
</n-space>
</c-card>
<n-space mb-1>
<NFormItem label="Number of objects to generate:" label-placement="left">
<NInputNumber v-model:value="itemCount" :min="1" placeholder="Number of objects to generate" />
</NFormItem>
<n-form-item label="Nestify (handle nested objects)" label-placement="left">
<n-checkbox v-model:checked="nestify" />
</n-form-item>
</n-space>
<c-select v-model:value="selectedLocale" label="Locale:" label-position="left" :options="allLocales" searchable mb-1 placeholder="Search locale version" />
<NFormItem label="Select output format:" label-placement="left" mb-1>
<NSelect v-model:value="selectedFormat" :options="formats" placeholder="Select format" />
</NFormItem>
<c-input-text v-if="selectedFormat === 'sql'" v-model:value="tableName" label="Table Name:" label-placement="left" mb-1 />
<NButton mb-2 mt-2 @click="handleGenerate">
Generate Fake Data
</NButton>
<c-alert v-if="error">
{{ error }}
</c-alert>
<c-card v-if="generatedData" title="Generated data">
<textarea-copyable :value="generatedData" :language="selectedFormat" />
</c-card>
</NCard>
</template>
+13
View File
@@ -0,0 +1,13 @@
import { ArrowsShuffle } from '@vicons/tabler';
import { defineTool } from '../tool';
export const tool = defineTool({
name: 'Data Faker',
path: '/data-faker',
description: 'Generate fake data using JSON template',
keywords: ['data', 'json', 'sample', 'faker'],
component: () => import('./data-faker.vue'),
icon: ArrowsShuffle,
createdAt: new Date('2025-05-01'),
category: 'Development',
});