mirror of
https://github.com/mountain-loop/yaak.git
synced 2026-02-24 08:34:56 +01:00
Move faker plugin back to external (plugins-external/faker)
This commit is contained in:
Gregory Schier
@@ -1,76 +0,0 @@
|
||||
# Yaak Faker Plugin
|
||||
|
||||
This is a template function that generates realistic fake data
|
||||
for testing and development using [FakerJS](https://fakerjs.dev).
|
||||
|
||||
|
||||
|
||||
## Example JSON Body
|
||||
|
||||
Here's an example JSON body that uses fake data:
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "${[ faker.string.uuid() ]}",
|
||||
"name": "${[ faker.person.fullName() ]}",
|
||||
"email": "${[ faker.internet.email() ]}",
|
||||
"phone": "${[ faker.phone.number() ]}",
|
||||
"address": {
|
||||
"street": "${[ faker.location.streetAddress() ]}",
|
||||
"city": "${[ faker.location.city() ]}",
|
||||
"country": "${[ faker.location.country() ]}",
|
||||
"zipCode": "${[ faker.location.zipCode() ]}"
|
||||
},
|
||||
"company": "${[ faker.company.name() ]}",
|
||||
"website": "${[ faker.internet.url() ]}"
|
||||
}
|
||||
```
|
||||
|
||||
This will generate a random JSON body on every request:
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "589f0aec-7310-4bf2-81c4-0b1bb7f1c3c1",
|
||||
"name": "Lucy Gottlieb-Weissnat",
|
||||
"email": "Destiny_Herzog@gmail.com",
|
||||
"phone": "411.805.2871 x699",
|
||||
"address": {
|
||||
"street": "846 Christ Mills",
|
||||
"city": "Spencerfurt",
|
||||
"country": "United Kingdom",
|
||||
"zipCode": "20354"
|
||||
},
|
||||
"company": "Emard, Kohler and Rutherford",
|
||||
"website": "https://watery-detective.org"
|
||||
}
|
||||
```
|
||||
|
||||
## Available Categories
|
||||
|
||||
The plugin provides access to all FakerJS modules and their methods:
|
||||
|
||||
| Category | Description | Example Methods |
|
||||
|------------|---------------------------|--------------------------------------------|
|
||||
| `airline` | Airline-related data | `aircraftType`, `airline`, `airplane` |
|
||||
| `animal` | Animal names and types | `bear`, `bird`, `cat`, `dog`, `fish` |
|
||||
| `color` | Colors in various formats | `human`, `rgb`, `hex`, `hsl` |
|
||||
| `commerce` | E-commerce data | `department`, `product`, `price` |
|
||||
| `company` | Company information | `name`, `catchPhrase`, `bs` |
|
||||
| `database` | Database-related data | `column`, `type`, `collation` |
|
||||
| `date` | Date and time values | `recent`, `future`, `past`, `between` |
|
||||
| `finance` | Financial data | `account`, `amount`, `currency` |
|
||||
| `git` | Git-related data | `branch`, `commitEntry`, `commitSha` |
|
||||
| `hacker` | Tech/hacker terminology | `abbreviation`, `noun`, `phrase` |
|
||||
| `image` | Image URLs and data | `avatar`, `url`, `dataUri` |
|
||||
| `internet` | Internet-related data | `email`, `url`, `ip`, `userAgent` |
|
||||
| `location` | Geographic data | `city`, `country`, `latitude`, `longitude` |
|
||||
| `lorem` | Lorem ipsum text | `word`, `sentence`, `paragraph` |
|
||||
| `person` | Personal information | `firstName`, `lastName`, `fullName` |
|
||||
| `music` | Music-related data | `genre`, `songName`, `artist` |
|
||||
| `number` | Numeric data | `int`, `float`, `binary`, `hex` |
|
||||
| `phone` | Phone numbers | `number`, `imei` |
|
||||
| `science` | Scientific data | `chemicalElement`, `unit` |
|
||||
| `string` | String utilities | `uuid`, `alpha`, `alphanumeric` |
|
||||
| `system` | System-related data | `fileName`, `mimeType`, `fileExt` |
|
||||
| `vehicle` | Vehicle information | `vehicle`, `manufacturer`, `model` |
|
||||
| `word` | Word generation | `adjective`, `adverb`, `conjunction` |
|
||||
@@ -1,24 +0,0 @@
|
||||
{
|
||||
"name": "@yaak/faker",
|
||||
"private": true,
|
||||
"version": "1.1.1",
|
||||
"displayName": "Faker",
|
||||
"description": "Template functions for generating fake data using FakerJS",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/mountain-loop/yaak.git",
|
||||
"directory": "plugins/template-function-faker"
|
||||
},
|
||||
"scripts": {
|
||||
"build": "yaakcli build",
|
||||
"dev": "yaakcli dev",
|
||||
"test": "vitest --run tests"
|
||||
},
|
||||
"dependencies": {
|
||||
"@faker-js/faker": "^10.1.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "^25.0.3",
|
||||
"typescript": "^5.9.3"
|
||||
}
|
||||
}
|
||||
@@ -1,105 +0,0 @@
|
||||
import { faker } from '@faker-js/faker';
|
||||
import type { DynamicTemplateFunctionArg, PluginDefinition } from '@yaakapp/api';
|
||||
|
||||
const modules = [
|
||||
'airline',
|
||||
'animal',
|
||||
'color',
|
||||
'commerce',
|
||||
'company',
|
||||
'database',
|
||||
'date',
|
||||
'finance',
|
||||
'git',
|
||||
'hacker',
|
||||
'image',
|
||||
'internet',
|
||||
'location',
|
||||
'lorem',
|
||||
'person',
|
||||
'music',
|
||||
'number',
|
||||
'phone',
|
||||
'science',
|
||||
'string',
|
||||
'system',
|
||||
'vehicle',
|
||||
'word',
|
||||
];
|
||||
|
||||
function normalizeResult(result: unknown): string {
|
||||
if (typeof result === 'string') return result;
|
||||
return JSON.stringify(result);
|
||||
}
|
||||
|
||||
// Whatever Yaak’s arg type shape is – rough example
|
||||
function args(modName: string, fnName: string): DynamicTemplateFunctionArg[] {
|
||||
return [
|
||||
{
|
||||
type: 'banner',
|
||||
color: 'info',
|
||||
inputs: [
|
||||
{
|
||||
type: 'markdown',
|
||||
content: `Need help? View documentation for [\`${modName}.${fnName}(…)\`](https://fakerjs.dev/api/${encodeURIComponent(modName)}.html#${encodeURIComponent(fnName)})`,
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
name: 'options',
|
||||
label: 'Arguments',
|
||||
type: 'editor',
|
||||
language: 'json',
|
||||
optional: true,
|
||||
placeholder: 'e.g. { "min": 1, "max": 10 } or 10 or ["en","US"]',
|
||||
},
|
||||
];
|
||||
}
|
||||
|
||||
export const plugin: PluginDefinition = {
|
||||
templateFunctions: modules.flatMap((modName) => {
|
||||
const mod = faker[modName as keyof typeof faker];
|
||||
return Object.keys(mod)
|
||||
.filter((n) => n !== 'faker')
|
||||
.map((fnName) => ({
|
||||
name: ['faker', modName, fnName].join('.'),
|
||||
args: args(modName, fnName),
|
||||
async onRender(_ctx, args) {
|
||||
const fn = mod[fnName as keyof typeof mod] as (...a: unknown[]) => unknown;
|
||||
const options = args.values.options;
|
||||
|
||||
// No options supplied
|
||||
if (options == null || options === '') {
|
||||
return normalizeResult(fn());
|
||||
}
|
||||
|
||||
// Try JSON first
|
||||
let parsed: unknown = options;
|
||||
if (typeof options === 'string') {
|
||||
try {
|
||||
parsed = JSON.parse(options);
|
||||
} catch {
|
||||
// Not valid JSON – maybe just a scalar
|
||||
const n = Number(options);
|
||||
if (!Number.isNaN(n)) {
|
||||
parsed = n;
|
||||
} else {
|
||||
parsed = options;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
let result: unknown;
|
||||
if (Array.isArray(parsed)) {
|
||||
// Treat as positional arguments
|
||||
result = fn(...parsed);
|
||||
} else {
|
||||
// Treat as a single argument (option object or scalar)
|
||||
result = fn(parsed);
|
||||
}
|
||||
|
||||
return normalizeResult(result);
|
||||
},
|
||||
}));
|
||||
}),
|
||||
};
|
||||
@@ -1,233 +0,0 @@
|
||||
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
|
||||
|
||||
exports[`template-function-faker > exports all expected template functions 1`] = `
|
||||
[
|
||||
"faker.airline.aircraftType",
|
||||
"faker.airline.airline",
|
||||
"faker.airline.airplane",
|
||||
"faker.airline.airport",
|
||||
"faker.airline.flightNumber",
|
||||
"faker.airline.recordLocator",
|
||||
"faker.airline.seat",
|
||||
"faker.animal.bear",
|
||||
"faker.animal.bird",
|
||||
"faker.animal.cat",
|
||||
"faker.animal.cetacean",
|
||||
"faker.animal.cow",
|
||||
"faker.animal.crocodilia",
|
||||
"faker.animal.dog",
|
||||
"faker.animal.fish",
|
||||
"faker.animal.horse",
|
||||
"faker.animal.insect",
|
||||
"faker.animal.lion",
|
||||
"faker.animal.petName",
|
||||
"faker.animal.rabbit",
|
||||
"faker.animal.rodent",
|
||||
"faker.animal.snake",
|
||||
"faker.animal.type",
|
||||
"faker.color.cmyk",
|
||||
"faker.color.colorByCSSColorSpace",
|
||||
"faker.color.cssSupportedFunction",
|
||||
"faker.color.cssSupportedSpace",
|
||||
"faker.color.hsl",
|
||||
"faker.color.human",
|
||||
"faker.color.hwb",
|
||||
"faker.color.lab",
|
||||
"faker.color.lch",
|
||||
"faker.color.rgb",
|
||||
"faker.color.space",
|
||||
"faker.commerce.department",
|
||||
"faker.commerce.isbn",
|
||||
"faker.commerce.price",
|
||||
"faker.commerce.product",
|
||||
"faker.commerce.productAdjective",
|
||||
"faker.commerce.productDescription",
|
||||
"faker.commerce.productMaterial",
|
||||
"faker.commerce.productName",
|
||||
"faker.commerce.upc",
|
||||
"faker.company.buzzAdjective",
|
||||
"faker.company.buzzNoun",
|
||||
"faker.company.buzzPhrase",
|
||||
"faker.company.buzzVerb",
|
||||
"faker.company.catchPhrase",
|
||||
"faker.company.catchPhraseAdjective",
|
||||
"faker.company.catchPhraseDescriptor",
|
||||
"faker.company.catchPhraseNoun",
|
||||
"faker.company.name",
|
||||
"faker.database.collation",
|
||||
"faker.database.column",
|
||||
"faker.database.engine",
|
||||
"faker.database.mongodbObjectId",
|
||||
"faker.database.type",
|
||||
"faker.date.anytime",
|
||||
"faker.date.between",
|
||||
"faker.date.betweens",
|
||||
"faker.date.birthdate",
|
||||
"faker.date.future",
|
||||
"faker.date.month",
|
||||
"faker.date.past",
|
||||
"faker.date.recent",
|
||||
"faker.date.soon",
|
||||
"faker.date.timeZone",
|
||||
"faker.date.weekday",
|
||||
"faker.finance.accountName",
|
||||
"faker.finance.accountNumber",
|
||||
"faker.finance.amount",
|
||||
"faker.finance.bic",
|
||||
"faker.finance.bitcoinAddress",
|
||||
"faker.finance.creditCardCVV",
|
||||
"faker.finance.creditCardIssuer",
|
||||
"faker.finance.creditCardNumber",
|
||||
"faker.finance.currency",
|
||||
"faker.finance.currencyCode",
|
||||
"faker.finance.currencyName",
|
||||
"faker.finance.currencyNumericCode",
|
||||
"faker.finance.currencySymbol",
|
||||
"faker.finance.ethereumAddress",
|
||||
"faker.finance.iban",
|
||||
"faker.finance.litecoinAddress",
|
||||
"faker.finance.pin",
|
||||
"faker.finance.routingNumber",
|
||||
"faker.finance.transactionDescription",
|
||||
"faker.finance.transactionType",
|
||||
"faker.git.branch",
|
||||
"faker.git.commitDate",
|
||||
"faker.git.commitEntry",
|
||||
"faker.git.commitMessage",
|
||||
"faker.git.commitSha",
|
||||
"faker.hacker.abbreviation",
|
||||
"faker.hacker.adjective",
|
||||
"faker.hacker.ingverb",
|
||||
"faker.hacker.noun",
|
||||
"faker.hacker.phrase",
|
||||
"faker.hacker.verb",
|
||||
"faker.image.avatar",
|
||||
"faker.image.avatarGitHub",
|
||||
"faker.image.dataUri",
|
||||
"faker.image.personPortrait",
|
||||
"faker.image.url",
|
||||
"faker.image.urlLoremFlickr",
|
||||
"faker.image.urlPicsumPhotos",
|
||||
"faker.internet.displayName",
|
||||
"faker.internet.domainName",
|
||||
"faker.internet.domainSuffix",
|
||||
"faker.internet.domainWord",
|
||||
"faker.internet.email",
|
||||
"faker.internet.emoji",
|
||||
"faker.internet.exampleEmail",
|
||||
"faker.internet.httpMethod",
|
||||
"faker.internet.httpStatusCode",
|
||||
"faker.internet.ip",
|
||||
"faker.internet.ipv4",
|
||||
"faker.internet.ipv6",
|
||||
"faker.internet.jwt",
|
||||
"faker.internet.jwtAlgorithm",
|
||||
"faker.internet.mac",
|
||||
"faker.internet.password",
|
||||
"faker.internet.port",
|
||||
"faker.internet.protocol",
|
||||
"faker.internet.url",
|
||||
"faker.internet.userAgent",
|
||||
"faker.internet.username",
|
||||
"faker.location.buildingNumber",
|
||||
"faker.location.cardinalDirection",
|
||||
"faker.location.city",
|
||||
"faker.location.continent",
|
||||
"faker.location.country",
|
||||
"faker.location.countryCode",
|
||||
"faker.location.county",
|
||||
"faker.location.direction",
|
||||
"faker.location.language",
|
||||
"faker.location.latitude",
|
||||
"faker.location.longitude",
|
||||
"faker.location.nearbyGPSCoordinate",
|
||||
"faker.location.ordinalDirection",
|
||||
"faker.location.secondaryAddress",
|
||||
"faker.location.state",
|
||||
"faker.location.street",
|
||||
"faker.location.streetAddress",
|
||||
"faker.location.timeZone",
|
||||
"faker.location.zipCode",
|
||||
"faker.lorem.lines",
|
||||
"faker.lorem.paragraph",
|
||||
"faker.lorem.paragraphs",
|
||||
"faker.lorem.sentence",
|
||||
"faker.lorem.sentences",
|
||||
"faker.lorem.slug",
|
||||
"faker.lorem.text",
|
||||
"faker.lorem.word",
|
||||
"faker.lorem.words",
|
||||
"faker.music.album",
|
||||
"faker.music.artist",
|
||||
"faker.music.genre",
|
||||
"faker.music.songName",
|
||||
"faker.number.bigInt",
|
||||
"faker.number.binary",
|
||||
"faker.number.float",
|
||||
"faker.number.hex",
|
||||
"faker.number.int",
|
||||
"faker.number.octal",
|
||||
"faker.number.romanNumeral",
|
||||
"faker.person.bio",
|
||||
"faker.person.firstName",
|
||||
"faker.person.fullName",
|
||||
"faker.person.gender",
|
||||
"faker.person.jobArea",
|
||||
"faker.person.jobDescriptor",
|
||||
"faker.person.jobTitle",
|
||||
"faker.person.jobType",
|
||||
"faker.person.lastName",
|
||||
"faker.person.middleName",
|
||||
"faker.person.prefix",
|
||||
"faker.person.sex",
|
||||
"faker.person.sexType",
|
||||
"faker.person.suffix",
|
||||
"faker.person.zodiacSign",
|
||||
"faker.phone.imei",
|
||||
"faker.phone.number",
|
||||
"faker.science.chemicalElement",
|
||||
"faker.science.unit",
|
||||
"faker.string.alpha",
|
||||
"faker.string.alphanumeric",
|
||||
"faker.string.binary",
|
||||
"faker.string.fromCharacters",
|
||||
"faker.string.hexadecimal",
|
||||
"faker.string.nanoid",
|
||||
"faker.string.numeric",
|
||||
"faker.string.octal",
|
||||
"faker.string.sample",
|
||||
"faker.string.symbol",
|
||||
"faker.string.ulid",
|
||||
"faker.string.uuid",
|
||||
"faker.system.commonFileExt",
|
||||
"faker.system.commonFileName",
|
||||
"faker.system.commonFileType",
|
||||
"faker.system.cron",
|
||||
"faker.system.directoryPath",
|
||||
"faker.system.fileExt",
|
||||
"faker.system.fileName",
|
||||
"faker.system.filePath",
|
||||
"faker.system.fileType",
|
||||
"faker.system.mimeType",
|
||||
"faker.system.networkInterface",
|
||||
"faker.system.semver",
|
||||
"faker.vehicle.bicycle",
|
||||
"faker.vehicle.color",
|
||||
"faker.vehicle.fuel",
|
||||
"faker.vehicle.manufacturer",
|
||||
"faker.vehicle.model",
|
||||
"faker.vehicle.type",
|
||||
"faker.vehicle.vehicle",
|
||||
"faker.vehicle.vin",
|
||||
"faker.vehicle.vrm",
|
||||
"faker.word.adjective",
|
||||
"faker.word.adverb",
|
||||
"faker.word.conjunction",
|
||||
"faker.word.interjection",
|
||||
"faker.word.noun",
|
||||
"faker.word.preposition",
|
||||
"faker.word.sample",
|
||||
"faker.word.verb",
|
||||
"faker.word.words",
|
||||
]
|
||||
`;
|
||||
@@ -1,12 +0,0 @@
|
||||
import { describe, expect, it } from 'vitest';
|
||||
|
||||
describe('template-function-faker', () => {
|
||||
it('exports all expected template functions', async () => {
|
||||
const { plugin } = await import('../src/index');
|
||||
const names = plugin.templateFunctions?.map((fn) => fn.name).sort() ?? [];
|
||||
|
||||
// Snapshot the full list of exported function names so we catch any
|
||||
// accidental additions, removals, or renames across faker upgrades.
|
||||
expect(names).toMatchSnapshot();
|
||||
});
|
||||
});
|
||||
@@ -1,3 +0,0 @@
|
||||
{
|
||||
"extends": "../../tsconfig.json"
|
||||
}
|
||||
Reference in New Issue
Block a user