@autheur/generator
Random french sentence generator
Installation
npm i @autheur/generator
Usage
The core function is generate
: it permits to generate a sentence given a pattern
import { generate, determinant, noun, adverb, adjective } from '@autheur/generator';
const sentence = generate([determinant(), noun(), adverb(), adjective()]);
console.log(sentence);
// leurs taille-crayons à demi alourdis
Generators
A generator permits to define a portion of the sentence
determinant
Generate a determinant (un, une, le, les, cette, ...)
import { generate, determinant } from '@autheur/generator';
generate([determinant()]); // mon
You can specify which types of determinant you want between undefined, defined, possessive, demonstrative
import { generate, determinant } from '@autheur/generator';
generate([determinant({ types: ['possessive'] })]); // notre
noun
Generate a noun.
- the noun generated will impose its form (gender + plurality) to the rest of the sentence.
- by default the plurality is randomly chosen
import { generate, noun } from '@autheur/generator';
generate([noun()]); // allumette
You can force the plurality with a parameter
import { generate, determinant } from '@autheur/generator';
generate([noun({ isPlural: true })]); // animaux
generate([noun({ isPlural: false })]); // ampoule
comma
Generate a comma.
import { generate, comma } from '@autheur/generator';
generate([comma()]); // ,
adverb
Generate an adverb.
import { generate, adverb } from '@autheur/generator';
generate([adverb()]); // suffisamment
word
Generate an word that you specify.
import { generate, word } from '@autheur/generator';
generate([word('foobar')]); // foobar
subject
Generate an subject to be used with a verb.
import { generate, subject } from '@autheur/generator';
generate([subject()]); // je
You can specify the gender and/or the plurality
import { generate, subject } from '@autheur/generator';
generate([subject({ isPlural: true })]); // nous, vous, ils, elles
generate([subject({ isPlural: false })]); // je, tu, il, elle, on
generate([subject({ isFeminine: true })]); // je, tu, on, elle, nous, vous, elles
generate([subject({ isFeminine: false })]); // je, tu, on, il, nous, vous, ils
generate([subject({ isFeminine: false, isPlural: false })]); // je, tu, on, elle
oneOf
Get a random word/sentence from a list that you specify.
import { generate, oneOf } from '@autheur/generator';
generate([oneOf(['foobar', 'yolo'])]); // yolo
Other packages
This is a from a monorepo with the following packages:
Package | Description |
---|---|
@autheur/dataset |
Dataset of sorted french words broke down by categories |
@autheur/generator |
The generator itself with they logic |
@autheur/operators |
Utilities to manipulate words (ex: pluralize, feminize, ...) |
Credits
Coded with
License
This project is under the MIT license.