https://github.com/ndaidong/txtgen
Util for generating random sentences, paragraphs and articles in English
https://github.com/ndaidong/txtgen
content-generator generator javascript nodejs random-text text-generator
Last synced: about 1 year ago
JSON representation
Util for generating random sentences, paragraphs and articles in English
- Host: GitHub
- URL: https://github.com/ndaidong/txtgen
- Owner: ndaidong
- License: mit
- Created: 2016-05-27T10:29:33.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2024-06-23T07:55:59.000Z (almost 2 years ago)
- Last Synced: 2025-03-31T04:07:06.447Z (about 1 year ago)
- Topics: content-generator, generator, javascript, nodejs, random-text, text-generator
- Language: TypeScript
- Homepage: https://ndaidong.github.io/txtgen
- Size: 371 KB
- Stars: 86
- Watchers: 2
- Forks: 17
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# txtgen
Lightweight util for generating random sentences, paragraphs and articles in
English. Inspired by [Sentencer](https://github.com/kylestetz/Sentencer) and
[metaphorpsum.com](http://metaphorpsum.com/).
[](https://github.com/ndaidong/txtgen/actions)
[](https://coveralls.io/github/ndaidong/txtgen)
[](https://www.npmjs.com/package/@ndaidong/txtgen)
[](https://jsr.io/@ndaidong/txtgen)
# Demo
- [Want to see how it works?](https://ndaidong.github.io/txtgen/)
## Setup & Usage
### Deno
https://jsr.io/@ndaidong/txtgen
```sh
deno add @ndaidong/txtgen
# npm (use any of npx, yarn dlx, pnpm dlx, or bunx)
npx jsr add @ndaidong/txtgen
```
```ts
import { sentence } from "@ndaidong/txtgen";
for (let i = 0; i < 5; i++) {
console.log(sentence());
}
```
You can use JSR packages without an install step using `jsr:` specifiers:
```ts
import { sentence } from "jsr:@ndaidong/txtgen";
for (let i = 0; i < 5; i++) {
console.log(sentence());
}
```
You can also use `npm:` specifiers as before:
```ts
import { sentence } from "npm:@ndaidong/txtgen";
for (let i = 0; i < 5; i++) {
console.log(sentence());
}
```
Or import from esm.sh
```ts
import { sentence } from "https://esm.sh/@ndaidong/txtgen";
for (let i = 0; i < 5; i++) {
console.log(sentence());
}
```
### Node.js & Bun
https://www.npmjs.com/package/@ndaidong/txtgen
```bash
npm i @ndaidong/txtgen
# pnpm
pnpm i @ndaidong/txtgen
# yarn
yarn add @ndaidong/txtgen
# bun
bun add @ndaidong/txtgen
```
```js
import { sentence } from "@ndaidong/txtgen";
for (let i = 0; i < 5; i++) {
console.log(sentence());
}
```
You can also use CJS style:
```js
const { sentence } = require("@ndaidong/txtgen");
for (let i = 0; i < 5; i++) {
console.log(sentence());
}
```
### Browsers:
```html
import { sentence } from "https://esm.sh/@ndaidong/txtgen";
// import { sentence } from 'https://unpkg.com/@ndaidong/txtgen/esm/mod.js';
for (let i = 0; i < 5; i++) {
console.log(sentence());
}
```
## 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.
### Template
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 "@ndaidong/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`
### Lorem ipsum
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 "@ndaidong/txtgen";
const phrase = lorem();
console.log(phrase); // => nisi blandit feugiat tempus imperdiet etiam eu mus augue
```
## Development
Since v4.x.x, we switched to [Deno](https://docs.deno.com/runtime/manual/)
platform, and use [DNT](https://github.com/denoland/dnt) to build Node.js
packages.
```bash
git clone https://github.com/ndaidong/txtgen.git
cd txtgen
# test
deno test
# build npm packages
deno task build
cd npm
node test_runner.js
```
# License
The MIT License (MIT)
---