apep
v1.3.2
Published
Generate random text from a grammar.
Downloads
53
Maintainers
Readme
Javascript text generation library influenced by the Dada Engine.
// Generate quips for a hacker on a TV show.
const pep = require('apep');
// Declare allows for forward references
const tvHackerQuip = pep.declare(() =>
pep.seq(exlaimation, ' ',
pep.choice(
pep.seq('The ' , subject, " is ", somethingBad, "!"),
pep.seq(evilDoer, ' ', doingSomthingBad, " the ", target, "!"))));
const evilDoer = pep.choice("She's", "He's", "They're");
const subject = pep.choice('CPU', 'HTML', 'GUI', 'IPv6', 'file system', 'ACL');
const somethingBad = pep.choice('on fire', 'doxxed', 'SQL injected', 'double encrypted');
const doingSomthingBad = pep.choice('pinging', 'ROT13ing', 'seg faulting', 'doxxing', 'DDOSing');
const target = pep.choice('NSA', 'CIA', 'FBI', 'mainframe', 'shell', 'cloud');
const exlaimation = pep.seq(
pep.choice('BLARK', 'ARG', 'BARF', 'GROK', 'ACK'),
pep.many1('!'));
// Generate some output
for (var i = 0; i < 10; ++i)
console.log(pep.run(tvHackerQuip))
Which outputs:
ACK! The CPU is double encrypted!
GROK! She's pinging the FBI!
ARG!! They're doxxing the mainframe!
ARG!!! They're ROT13ing the shell!
BARF!! He's doxxing the mainframe!
BARF! The HTML is SQL injected!
ACK!!! The file system is on fire!
BLARK!!! He's DDOSing the shell!
ARG!!!! The IPv6 is on fire!
GROK! He's seg faulting the NSA!
Apep provides a small set of combinators, from which fairly complex grammars can be constructed. All grammars are specified directly in Javascript.
Usage
$ npm install apep
For additionally builtin functionality, check out apep-std. Apep-std is a collection of common generators and combinators that provide many convient operations that are not part of apep-core. The standard library just bundles these all together, but you can also consume the libraries components individually.
Examples
- Exam question generator - Ported from dada engine.
- Fifty Shades of Dispepsia - Fifty Shades of Gray excerpt generator
- Post Apeptide - Port of Andrew C. Bulhak's Post modernism generator Dada Engine Text Generator.
If you've used Apep to generate something awesome, please submit a pull request to add it to the list above. The more absurd the better.
Contributing
Any contributions to Apep are welcome. If you come across any problems, please open an issue.
Apep uses gulp and Babel for building. After forking the repo, run the following to get started building:
$ npm install
$ gulp default
Mocha is used for testing. To run the tests:
$ mocha tests