Giter Club home page Giter Club logo

apep's Introduction

Apep

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

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

apep's People

Contributors

mattbierner avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

apep's Issues

Using arrays to express sequencing:

pep.choice(
   'a',
   ['b', 'c'],
   'd');

Should be equal toL

pep.choice(
   pep.str('a'),
   pep.seq(pep.set('b'), pep.str('c')),
   pep.str('d'));

If the current behavior is really desired, you can alway used, pep.str

pep.choice(
   'a',
   pep.str(['b', 'c']),
   'd');

Auto wrapping should throw/error for undefined values?

For larger grammars, it can be hard to track down when an undefined variable is used within a generator. Currently this results in an empty string output, which is difficult to track down and debug.

A better approach would be to throw an error when this happens. Of course you could still yield undefined values with pep.lit(undefined), but you would have to be explicit about it.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.