Nearly Perpendicular Macaroons

    satzbau
    TypeScript icon, indicating that this package has built-in type declarations

    2.1.0 • Public • Published

    🏗
    Satzbau

    natural language generation tool for german

    /ˈzatsˌbaʊ/, german: "sentence construction"

    License: MIT

    · Report Bug / Request Feature ·

    Table of Contents

    About

    satzbau allows you to generate natural sounding texts in German.

    It allows you to:

    • decline words (including articles and adjectives)
    • define evenly distributed synonyms for words
    • automatically render lists as text
    • use a handy tagged template string syntax to format sentences (it's like magic 🪄)
    • create dynamic sentences with properties

    It's pretty small and does not need a dictionary.

    However, it can't (yet):

    • automatically detect the correct cases
    • conjugate verbs

    Install

    npm

    npm install satzbau

    Usage

    Note: satzbau provides pure functions, meaning every function call will not change the object in-place, but instead return a new object.

    satzbau is written in typescript, so I recommend to use typescript or an IDE that supports autocomplete for in-code documentation.

    Define words

    import { noun } from 'satzbau';
    
    // provide it with a string, containing:
    // 1. an article
    // 2. the word in nominative singular, sg. plural and genitive singular
    let phone = noun('das telefon, die telefone, des telefons');
    
    // or if you're lazy:
    phone = noun('das telefon,-e,-s');
    
    console.log(phone.write()); // => "ein Telefon"

    Decline words

    console.log(phone.plural().specific().genitive().write()); // => "der Telefone"

    Add adjectives

    phone = phone.attributes('laut');
    
    console.log(phone.dative().write()); // => "einem lauten Telefon"

    Create synonyms

    import { synonyms } from 'satzbau';
    
    let mobilePhone = synonyms(
    	noun('das mobiltelefon,-e,-s'),
    	noun('das handy,-s,-s'),
    	noun('das smartphone,-s,-s')
    ).attributes('klein');
    
    console.log(mobilePhone.plural().genitive().write()); // => e.g. "der kleinen Mobiltelefone"

    Count words

    console.log(mobilePhone.count(3).write()); // drei kleine Mobiltelefone
    console.log(mobilePhone.negated().write()); // kein kleines Handy

    Construct a sentence

    const items = [
    	noun('der schlüssel,-,-s'),
    	mobilePhone,
    	noun('das feuerzeug,-e,-s').count(2),
    ];
    const bag = synonyms(
    	noun('die tasche,-n,-'),
    	noun('der rucksack, rucksäcke, -s')
    );
    const inMyBag = sentence`
    	Ich habe ${items.map((i) => i.accusative())}
    	in ${bag.specific().dative()}
    `;
    
    console.log(inMyBag.write()); // -> Ich habe einen Schlüssel, ein kleines Mobiltelefon und zwei Feuerzeuge in der Tasche.
    console.log(inMyBag.shout().write()); // -> Ich habe einen Schlüssel, ein kleines Handy und zwei Feuerzeuge im Rucksack!

    Pass properties to sentences

    const describeCloud = sentence`
    	die Wolke sieht aus wie
    	${({ cloud, adjective }) => (adjective ? cloud.attributes(adjective) : cloud)}
    `;
    
    console.log(
    	describeCloud.write({
    		cloud: noun('der pinguin,-e,-s'),
    		adjective: 'fliegend',
    	})
    );
    // => "Die Wolke sieht aus wie ein fliegender Pinguin."
    
    console.log(describeCloud.shout().write({ cloud: noun('der affe,-en,-') }));
    // => "Die Wolke sieht aus wie ein Affe!"

    Note: For typescript, you need to provide types:

    const describeCloud = sentence`
    	die Wolke sieht aus wie
    	${({ cloud, adjective }: { cloud: Noun; adjective?: string }) =>
    		adjective ? cloud.attributes(adjective) : cloud}
    `;
    // or
    const describeCloud = sentence<{ cloud: Noun; adjective?: string }>`
    	die Wolke sieht aus wie
    	${({ cloud, adjective }) => (adjective ? cloud.attributes(adjective) : cloud)}
    `;

    More examples

    import {
    	adjective,
    	into,
    	list,
    	noun,
    	sentence,
    	synonyms,
    	text,
    	to,
    	variants,
    } from 'satzbau';
    
    const color = synonyms(adjective('rot'), adjective('blau'), adjective('gelb'));
    
    const car = synonyms(
    	noun('das auto, die autos, des autos'),
    	noun('der PKW, die PKWs, des PKWs'),
    	noun('die karre, die karren, der karre')
    )
    	.specific()
    	.attributes(color);
    
    const train = synonyms(noun('der zug,züge,-s'), noun('die bahn,-en,-'));
    
    const animals = [
    	noun('der elefant,-en,-en').attributes('gutmütig'),
    	noun('die maus,mäuse,-').attributes('weiß'),
    	noun('der kakadu,-s,-s').attributes('lachend'),
    ];
    
    const door = noun('die tür,-en,-').specific();
    
    const move = variants('eilte', 'rannte', 'lief');
    
    const heEnters = variants(
    	sentence`er stieg ${(object) => into(object)}`,
    	sentence`eilig betrat er ${(object) => object.accusative()}`,
    	sentence`er öffnete ${door.accusative()} ${(object) => object.genitive()}`,
    	sentence`er ${move} ${(object) => to(object)}`
    );
    
    console.log(heEnters.write(car));
    console.log(heEnters.write(car));
    console.log(heEnters.write(car));
    console.log(heEnters.write(train));
    
    console.log(sentence`${animals} erwarteten ihn bereits`.write());
    console.log(
    	text`
    		${sentence`
    			${list(animals).any()}
    		`.ask()}
    		${sentence`er wusste es nicht mehr so genau...`}
    	`.write()
    );
    
    /*
    	Output:
    	
    	Er öffnete die Tür des blauen Autos.
    	Er eilte zum roten Wagen.
    	Er stieg in den gelben PKW.
    	Er rannte zu einer Bahn.
    	Ein gutmütiger Elefant, eine weiße Maus und ein lachender Kakadu erwarteten ihn bereits.
    	Ein gutmütiger Elefant, eine weiße Maus oder ein lachender Kakadu? Er wusste es nicht mehr so genau...
    */

    Again, provide types when using typescript:

    const heEnters = variants<Noun>(
    	sentence`er stieg ${(object) => into(object)}`,
    	sentence`eilig betrat er ${(object) => object.accusative()}`,
    	sentence`er öffnete ${door.accusative()} ${(object) => object.genitive()}`,
    	sentence<Noun>`er ${move} ${(object) => to(object)}`
    	// notice, how we need to provide the type explicitly in the last sentence
    	// this is because "move" has no properties and typescript defaults to "void"
    );

    Development

    Run tests

    yarn run test

    Contact

    👤 Timo Bechtel

    🤝 Contributing

    Contributions, issues and feature requests are welcome!

    1. Check issues
    2. Fork the Project
    3. Create your Feature Branch (git checkout -b feat/AmazingFeature)
    4. Test your changes yarn run test
    5. Commit your Changes (git commit -m 'feat: add amazingFeature')
    6. Push to the Branch (git push origin feat/AmazingFeature)
    7. Open a Pull Request

    Commit messages

    This project uses semantic-release for automated release versions. So commits in this project follow the Conventional Commits guidelines. I recommend using commitizen for automated commit messages.

    Show your support

    Give a ⭐️ if this project helped you!


    This README was generated with ❤️ by readme-md-generator

    Install

    npm i satzbau

    DownloadsWeekly Downloads

    0

    Version

    2.1.0

    License

    MIT

    Unpacked Size

    55.1 kB

    Total Files

    18

    Last publish

    Collaborators

    • timobechtel