Skip to content

Latest commit

 

History

History
141 lines (100 loc) · 4.76 KB

readme.md

File metadata and controls

141 lines (100 loc) · 4.76 KB

WaffleGenerator

Build status NuGet Status NuGet Status

Produces text which, on first glance, looks like real, ponderous, prose; replete with clichés.

See Milestones for release notes.

Example content:

The Aesthetic Of Economico-Social Disposition

"In this regard, the underlying surrealism of the take home message should not 
divert attention from The Aesthetic Of Economico-Social Disposition"
(Humphrey Yokomoto in The Journal of the Total Entative Item (20044U))

On any rational basis, a particular factor, such as the functional baseline, the 
analogy of object, the strategic requirements or the principal overriding programming 
provides an interesting insight into the complementary functional derivation. 
This trend may dissipate due to the mensurable proficiency.

This output can be used in similar way to Lorem ipsum content, in that it is useful for producing text for build software and producing design mockups.

Based on the awesome work by Andrew Clarke outlined in The Waffle Generator.

Code based on SDGGenerators - Red Gate SQL Data Generator Community Generators.

Blazor App

The Blazing Waffles app allows the generation of waffle text online.

Main Package - WaffleGenerator

https://nuget.org/packages/WaffleGenerator/

Usage

The WaffleEngine can be used to produce Html, text or Markdown:

Html

var text = WaffleEngine.Html(
    paragraphs: 2,
    includeHeading: true,
    includeHeadAndBody: true);
Debug.WriteLine(text);

snippet source | anchor

Text

var text = WaffleEngine.Text(
    paragraphs: 1,
    includeHeading: true);
Debug.WriteLine(text);

snippet source | anchor

Markdown

var markdown = WaffleEngine.Markdown(
    paragraphs: 1,
    includeHeading: true);
Debug.WriteLine(markdown);

snippet source | anchor

WaffleGenerator.Bogus

Extends Bogus to use WaffleGenerator.

https://nuget.org/packages/WaffleGenerator.Bogus/

Usage

The entry extension method is WaffleHtml() or WaffleText() or WaffleMarkdown():

var faker = new Faker<Target>()
    .RuleFor(
        property: u => u.Title,
        setter: (f, u) => f.WaffleTitle())
    .RuleFor(
        property: u => u.Property1,
        setter: (f, u) => f.WaffleHtml())
    .RuleFor(
        property: u => u.Property2,
        setter: (f, u) => f.WaffleHtml(
            paragraphs: 4,
            includeHeading: true))
    .RuleFor(
        property: u => u.Property3,
        setter: (f, u) => f.WaffleText())
    .RuleFor(
        property: u => u.Property4,
        setter: (f, u) => f.WaffleText(
            paragraphs: 4,
            includeHeading: false));

var target = faker.Generate();
Debug.WriteLine(target.Title);
Debug.WriteLine(target.Property1);
Debug.WriteLine(target.Property2);
Debug.WriteLine(target.Property3);
Debug.WriteLine(target.Property4);

snippet source | anchor

Icon

Waffle designed by Made by Made from The Noun Project