txtgen

Lightweight util for generating random sentences, paragraphs and articles in English. Inspired by Sentencer and metaphorpsum.com.

!CodeQL

Demo

- Want to see how it works?

Setup

- Node.js

``bash
npm i txtgen

# pnpm
pnpm i txtgen

# yarn
yarn add txtgen
`

- CDN

- ES6 Module: txtgen.esm.js
- CommonJS: txtgen.js
- For old browsers: txtgen.min.js




Usage

$3

`js
import {
sentence
} from 'txtgen'

// with CommonJS environment
// const { sentence } = require('txtgen/dist/cjs/txtgen.js')

sentence()
`

$3

Currently, ECMAScript modules work fine on almost all browsers:

`html

`

With outdated browsers, we can use the traditional method:

`html



`

APIs

- .sentence()
- .paragraph([Number totalSentences])
- .article([Number totalParagraphs])
- .addNouns(Array nouns)
- .addAdjectives(Array adjectives)
- .addTemplates(Array sentenceTemplates)
- .setNouns(Array nouns)
- .setAdjectives(Array adjectives)
- .setTemplates(Array sentenceTemplates)
- .getNouns()
- .getAdjectives()
- .getTemplates()
- .lorem([Number min [, Number max]])


As their name suggests, we have 4 groups of methods:

- sentence(), paragraph(), article(): generate text by given grammatical unit
- addNouns(), addAdjectives(), addTemplates(): add more samples to current sample set
- setNouns(), setAdjectives(), setTemplates(): replace current sample set with new ones
- getNouns(), getAdjectives(), getTemplates(): get current sample set


The set and get methods were added in v2.2.3 to help you customize your sample data.

In addition, we've added lorem() method since v3.0.5 to generate lorem ipsum text.

$3

If you want to add more kinds of sentences, just use the .addTemplates() method; it expects a list of sentence templates.
Each sentence template is an English sentence, containing placeholders that can be replaced with any alternative word.

For example:

`js
import {
addTemplates
} from 'txtgen'

const templates = [
'{{a_noun}} is {{a_noun}} from the right perspective',
'the {{noun}} of {{a_noun}} becomes {{an_adjective}} {{noun}}'
]

addTemplates(templates)
`

Here are the available placeholders:

- noun
- nouns
- a_noun
- adjective
- an_adjective




$3

Syntax:

`js
lorem() // generate a random phrase with length from 2 to 24 words of lorem ipsum
lorem(Number min) // set the minimum number of words
lorem(Number min, Number max)// set the minimum/maximum number of words
`

Example:

`js
import { lorem } from 'txtgen'

const phrase = lorem()
console.log(phrase) // => nisi blandit feugiat tempus imperdiet etiam eu mus augue
`

Test

`bash
git clone https://github.com/ndaidong/txtgen.git
cd txtgen
npm install
npm test
``

License

The MIT License (MIT)