lorem-ipsum.js: A JavaScript repository from fmnxl

lorem-ipsum.js

lorem-ipsum.js is a Node.js, Component.js, and React Native module for generating passages of lorem ipsum text. Lorem ipsum text is commonly used as placeholder text in publishing, graphic design, and web development.

Using the Module (Node.js)

Install the lorem-ipsum.js module to use the library in your server-side Node.js projects.

cd ~/MyProject
npm install lorem-ipsum

Require the lorem-ipsum.js module and use it to generate a passage of lorem ipsum text.

var loremIpsum = require('lorem-ipsum')
  , output     = loremIpsum();

Using the Module (Component.js)

Install the lorem-ipsum.js module to use the library client-side.

cd ~/MyProject
component install knicklabs/lorem-ipsum.js

Require the lorem-ipsum.js module and use it to generate a passage of lorem ipsum text.

var loremIpsum = require('knicklabs-lorem-ipsum.js')
  , output     = loremIpsum();

Customizing the Output with Options (Node.js/Component.js)

You can pass options to the loremIpsum() function to fine-tune the output. The API is the same on client and server. See below:

...
output = loremIpsum({
    count: 1                      // Number of words, sentences, or paragraphs to generate.
  , units: 'sentences'            // Generate words, sentences, or paragraphs.
  , sentenceLowerBound: 5         // Minimum words per sentence.
  , sentenceUpperBound: 15        // Maximum words per sentence.
  , paragraphLowerBound: 3        // Minimum sentences per paragraph.
  , paragraphUpperBound: 7        // Maximum sentences per paragraph.
  , format: 'plain'               // Plain text or html
  , words: ['ad', 'dolor', ... ]  // Custom word dictionary. Uses dictionary.words (in lib/dictionary.js) by default.
  , random: Math.random           // A PRNG function. Uses Math.random by default
  , suffix: EOL                   // The character to insert between paragraphs. Defaults to default EOL for your OS.
});

Using the CLI (Node.js)

lorem-ipsum.js includes a command line interface for generating passages of lorem ipsum text. Install the module globally to take advantage of this feature.

npm install lorem-ipsum --global

Execute the statement lorem-ipsum from your terminal to generate a passage of lorem ipsum text. You can pass arguments to the program to fine-tune the output.

lorem-ipsum --units words --count 100 --copy --format html

See below for a description of the arguments to the program.

Argument	Description
--count	The number of words, sentences or paragraphs to generate
--units	Generate words, sentences or paragraphs
--copy	Copy the output to the system clipboard
--format	html or plain text format

You may now also use a short form when running lorem-ipsum.js from the command line. Here's some examples:

lorem-ipsum 1 word

lorem-ipsum 15 sentences --copy

lorem-ipsum 5 paragraphs --copy --format html

Notes

The copy feature requires that you have xclip installed if you are using lorem-ipsum.js on Linux. The feature will work out of the box on Mac and Windows systems.

License

This software is licensed under the MIT license.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.