Skip to content

Latest commit

 

History

History
71 lines (45 loc) · 2.74 KB

readme.md

File metadata and controls

71 lines (45 loc) · 2.74 KB
Raw

coder-ipsum

Coder Ipsum is a programming-inspired ipsum generator. You can see it live at coder-ipsum.tech//. This npm package exposes the API to use in your projects directly.

Installing

npm install coder-ipsum

Usage

Importing

ES5:

const phrase = require('coder-ipsum').phrase
const sentence = require('coder-ipsum').sentence
const paragraph = require('coder-ipsum').paragraph
const madLib = require('coder-ipsum').madLib

ES6:

import { phrase, sentence, paragraph, madLib } from 'coder-ipsum'

API

The API includes 4 functions:

  • phrase - Returns a String of a set of unformatted coder ipsum "words". Optionally input the number of "words" to include.
  • sentence - Returns a String of a set of coder ipsum "words" in the format of a sentence - with capitalization and period punctionation. Optionally input the number of "words" to include.
  • paragraph - Returns a String of a set of coder ipsum "words" in the format of a paragraph with multiple sentences, including capitalization and period punctionation. Optionally input the number of sentences to include. Sentences will have 6-10 "words" each.
  • madLib - Returns a string of a Mad-Libs-like fake sentence with nouns, verbs, adjectives, etc., using the same base word set of coder-inspired language.

Note that some "words" are more than one word like "Lil' Bobby Tables".

Both phrase and sentence will randomly pick 6-10 "words" if no input is given. paragraph will randomly generate 3-5 sentences within the paragraph if no input is given.

Examples:

const myPhrase = phrase(4)
// => JQuery pairing tech debt queue

const mySentence = sentence(7)
// => XML perf matters public Safari transpile tabs vs spaces OTP.

const myParagraph = paragraph(2)
// => Byzantine fault tolerance S3 homebrew spy object library callback hell flexbox idiosyncratic contexts scale gradle. Mock dynamic types GraphQL domain specific language modern bundle terminal proof of stake AWS responsive.

const madLibs = paragraph(2)
// => If we promise the void, we can get to the S3 module through the stateless big O microservice!

The Story

So what had happened was...

I was building a dumb web app to teach people how to make it faster, but none of the existing ipsums really felt right for a workshop for developers. I got together with some friends and brainstormed computer science thought-leadership synergistic words, and this is what came out.

Contributing

Yes, you can contribute! If you have ideas, feel free to contact me on Twitter.

Thanks

Thanks to Chas McMahon and Chris Guzman for the initial synergy.