ipsumify 0.0.0-stage → 2.6.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ipsumify
+
+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.

package/README.md

@@ -1,3 +1,162 @@
-# Temporary Holding Version
+# ipsumify
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Lorem ipsum for the command line and Node: markdown-ready placeholder text with themes, seeds, and plain text, HTML, or JSON output.
+
+```bash
+npx ipsumify
+```
+
+![Terminal output of npx ipsumify with a theme, headings, and a list](https://raw.githubusercontent.com/ICJIA/ipsumify-next-2026/main/documentation/screenshot-cli.png)
+
+With no arguments it prints five paragraphs of classic lorem ipsum. Nothing to install, no dependencies, Node 18.3 or later.
+
+It uses the same engine as [ipsumify.com](https://ipsumify.com) and its API: the same theme, block count, seed, and options give the same text in all three.
+
+### Options
+
+| Option | Short | What it does |
+| ------ | ----- | ------------ |
+| `--blocks <n>` | `-b` | Number of paragraphs, 1–20. Default 5. Also accepted as the first argument (`npx ipsumify 3`) or as `--paragraphs` / `-p`; give it one way only |
+| `--theme <id>` | `-t` | `lorem` (default), `dog`, `cat`, `baked`, `bbq` |
+| `--seed <n>` | `-s` | Whole number from 0 to 2,147,483,647. The same seed always gives the same text. Random when omitted |
+| `--headings` | | Add markdown headings (also `--headers`) |
+| `--code` | | Add code snippets |
+| `--quotes` | | Add blockquotes |
+| `--lists` | | Add bullet lists |
+| `--links` | | Add links |
+| `--all` | `-a` | All five markdown elements |
+| `--md <list>` | | The same, comma-separated, as the API takes them: `--md headings,lists` |
+| `--lower` | | Lowercase everything |
+| `--no-linebreaks` | | Everything on one line (also `--nowrap`) |
+| `--format <name>` | `-f` | `markdown` (default), `text`, `html`, `json` |
+| `--themes` | | List the themes |
+| `--help` | `-h` | Show help |
+| `--version` | `-v` | Show the version |
+
+Code snippets appear before every third block, blockquotes before every second, lists before the third, sixth, and so on, and links before every fourth, so a short run may not include every element you asked for.
+
+Invalid input prints a message to stderr and exits with code 1.
+
+### Examples
+
+One paragraph. `--seed` makes it repeatable; leave it off for different text each run:
+
+```console
+$ npx ipsumify 1 --seed 42
+Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris.
+```
+
+A theme, with headings and a list:
+
+```console
+$ npx ipsumify 3 --theme bbq --headings --lists --seed 7
+# Building the Perfect Fire
+
+Brisketum planum puntum totum, pinguem capsum updownum debatum. Fumus annulus roseum halum, probatum technicum igneum. Sectum contra granum semper, humidus macer finibus ustum. Pullum femur quartum totum, pellis crispum carnem sucum. Alabama salsamentum album, acetum Carolina moppum stylum. Tractum fumatum grillum optiones, gallinaceum rectum bonum.
+
+Fumus surgit caminus ascendit, linea formatur mane fidelis. Venditum signum timendum, mane avis obtinet carneum. Dignum omnis expectatio minutum, pitmasterus ars respectum. Fricatum siccum pasta humidum, pernoctem frigidarium marinatum requiem. Sal piper simplex Texanum, complexum Memphis mixtum secretum. Applicare generosum aequum tegmen, cortex formatur pulchre.
+
+- Smoky goodness
+- Fall off the bone
+- Worth the wait
+
+Lateribus fabae coleslavium paniscornum, caseum macaroni salatum tuberosum. Pickledus cepae jalapeñus, panisalbus butyrum sectum. Completum plateum aequilibratum prandium, carneum stella lateribus sustentum.
+```
+
+One line, lowercase — handy for seed data:
+
+```console
+$ npx ipsumify 1 --theme cat --no-linebreaks --lower --seed 3
+himalayan persicum pointus fluffium, exotic shorthair teddybearum calmicus. ragamuffin largeum sweeticus docilum, selkirk rex curlycoatum sheepii patientum. laperm curlicus wavium uniqueum.
+```
+
+Rendered HTML:
+
+```console
+$ npx ipsumify 1 --all --format html --seed 42
+<h1>Key Concepts</h1>
+<pre><code class="language-javascript">const example = &#39;code&#39;;
+</code></pre>
+<p><a href="https://example.com">Learn more</a> Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris.</p>
+```
+
+Plain text, with the markdown syntax stripped:
+
+```console
+$ npx ipsumify 1 --all --format text --seed 42
+Key Concepts
+
+Learn more Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris.
+```
+
+JSON, in the same shape the API returns. `output` holds each paragraph's body text; `seed` reports the seed that was used, so a random run can be reproduced:
+
+```console
+$ npx ipsumify 2 --format json --seed 42
+{
+  "theme": "lorem",
+  "blocks": 2,
+  "seed": 42,
+  "format": "json",
+  "options": {
+    "headers": false,
+    "codeSnippets": false,
+    "blockquotes": false,
+    "lists": false,
+    "links": false,
+    "capitalize": true,
+    "noWrap": false
+  },
+  "output": [
+    "Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris.",
+    "Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus, omnis voluptas assumenda est. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt."
+  ],
+  "markdown": "Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris.\n\nSed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus, omnis voluptas assumenda est. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt."
+}
+```
+
+Into a file or the clipboard:
+
+```bash
+npx ipsumify 10 --all > placeholder.md
+npx ipsumify | pbcopy
+```
+
+### Use from JavaScript
+
+```bash
+npm install ipsumify
+```
+
+```js
+import ipsumify, { paragraphs, themes } from 'ipsumify'
+
+ipsumify()                                          // five paragraphs, random
+ipsumify({ blocks: 2, theme: 'dog', seed: 42 })     // repeatable
+ipsumify({ headers: true, lists: true })            // markdown elements
+ipsumify({ format: 'html' })                        // or 'text'
+
+paragraphs({ blocks: 3 })                           // ['…', '…', '…']
+themes                                              // [{ id: 'lorem', label: 'Lorem Ipsum' }, …]
+```
+
+| Option | Type | Default | |
+| ------ | ---- | ------- | - |
+| `theme` | string | `'lorem'` | `lorem`, `dog`, `cat`, `baked`, `bbq` |
+| `blocks` | number | `5` | 1–20 |
+| `seed` | number | random | 0–2,147,483,647 |
+| `headers`, `code`, `quotes`, `lists`, `links` | boolean | `false` | Markdown elements |
+| `lowercase` | boolean | `false` | Lowercase everything |
+| `noWrap` | boolean | `false` | Everything on one line |
+| `format` | string | `'markdown'` | `markdown`, `text`, `html` |
+
+An unknown theme or format, or a `blocks` or `seed` out of range, throws a `RangeError`. Options that are not an object, or a switch that is not `true` or `false`, throw a `TypeError`. `paragraphs()` ignores `format`. The package is ESM only and ships its own TypeScript types.
+
+## Links
+
+- Web app: https://ipsumify.com
+- Source and issues: https://github.com/ICJIA/ipsumify-next-2026
+
+## License
+
+MIT

package/dist/cli.js

@@ -0,0 +1,184 @@
+#!/usr/bin/env node
+import {
+  DEFAULT_BLOCKS,
+  DEFAULT_THEME,
+  FORMATS,
+  MAX_BLOCKS,
+  MAX_SEED,
+  MIN_BLOCKS,
+  ipsumify,
+  paragraphs,
+  randomSeed,
+  themes
+} from "./shared-B3DMJ5UC.js";
+
+// packages/ipsumify/src/run.ts
+import { parseArgs } from "node:util";
+var CLI_FORMATS = [...FORMATS, "json"];
+var HELP = `ipsumify \u2014 lorem ipsum generator
+
+Usage
+  npx ipsumify [blocks] [options]
+
+  With no arguments, prints ${DEFAULT_BLOCKS} paragraphs of lorem ipsum.
+
+Content
+  -b, --blocks <n>      Number of paragraphs, ${MIN_BLOCKS}-${MAX_BLOCKS} (default ${DEFAULT_BLOCKS}).
+                        Also accepted as the first argument, or as --paragraphs.
+  -t, --theme <id>      ${themes.map((t) => t.id).join(", ")} (default ${DEFAULT_THEME})
+  -s, --seed <n>        Whole number, 0-${MAX_SEED}. The same seed always
+                        gives the same text. Random when omitted.
+
+Markdown elements
+      --headings        Add headings (also --headers)
+      --code            Add code snippets
+      --quotes          Add blockquotes
+      --lists           Add bullet lists
+      --links           Add links
+  -a, --all             All five of the above
+      --md <list>       The same, comma-separated: --md headings,lists
+
+Formatting
+      --lower           Lowercase everything
+      --no-linebreaks   Everything on one line (also --nowrap)
+  -f, --format <name>   markdown (default), text, html, json
+
+Other
+      --themes          List the themes
+  -h, --help            Show this help
+  -v, --version         Show the version
+
+Examples
+  npx ipsumify
+  npx ipsumify 2
+  npx ipsumify --theme dog --blocks 3
+  npx ipsumify --headings --lists --seed 42
+  npx ipsumify 1 --no-linebreaks --lower
+  npx ipsumify --all --format html > sample.html
+  npx ipsumify | pbcopy
+`;
+var MD_NAMES = /* @__PURE__ */ new Map([
+  ["headings", "headers"],
+  ["headers", "headers"],
+  ["code", "code"],
+  ["quotes", "quotes"],
+  ["lists", "lists"],
+  ["links", "links"]
+]);
+function fail(message) {
+  return { code: 1, stdout: "", stderr: `ipsumify: ${message}
+Run "ipsumify --help" for usage.
+` };
+}
+function wholeNumber(name, value) {
+  if (!/^\d{1,10}$/.test(value)) {
+    throw new RangeError(`Invalid ${name} "${value}". Must be a whole number.`);
+  }
+  return Number(value);
+}
+function run(argv, version = "0.0.0") {
+  let parsed;
+  try {
+    parsed = parseArgs({
+      args: argv,
+      allowPositionals: true,
+      options: {
+        "blocks": { type: "string", short: "b" },
+        "paragraphs": { type: "string", short: "p" },
+        "theme": { type: "string", short: "t" },
+        "seed": { type: "string", short: "s" },
+        "headings": { type: "boolean" },
+        "headers": { type: "boolean" },
+        "code": { type: "boolean" },
+        "quotes": { type: "boolean" },
+        "lists": { type: "boolean" },
+        "links": { type: "boolean" },
+        "all": { type: "boolean", short: "a" },
+        "md": { type: "string" },
+        "lower": { type: "boolean" },
+        "nowrap": { type: "boolean" },
+        "no-linebreaks": { type: "boolean" },
+        "format": { type: "string", short: "f" },
+        "themes": { type: "boolean" },
+        "help": { type: "boolean", short: "h" },
+        "version": { type: "boolean", short: "v" }
+      }
+    });
+  } catch (error) {
+    return fail(error.message);
+  }
+  const { values, positionals } = parsed;
+  if (values.help) return { code: 0, stdout: HELP, stderr: "" };
+  if (values.version) return { code: 0, stdout: `${version}
+`, stderr: "" };
+  if (values.themes) {
+    const width = Math.max(...themes.map((t) => t.id.length));
+    return { code: 0, stdout: themes.map((t) => `${t.id.padEnd(width)}  ${t.label}`).join("\n") + "\n", stderr: "" };
+  }
+  try {
+    if (positionals.length > 1) {
+      throw new RangeError(`Unexpected argument "${positionals[1]}".`);
+    }
+    const blockCounts = [values.blocks, values.paragraphs, positionals[0]].filter((value) => value !== void 0);
+    if (blockCounts.length > 1) {
+      throw new RangeError("The number of blocks is given more than once. Use one of: a first argument, --blocks, --paragraphs.");
+    }
+    const blocksArg = blockCounts[0];
+    const options = {
+      theme: values.theme,
+      blocks: blocksArg === void 0 ? void 0 : wholeNumber("blocks", blocksArg),
+      // Chosen here, not inside the library, so the json output can report it
+      seed: values.seed === void 0 ? randomSeed() : wholeNumber("seed", values.seed),
+      headers: values.all || values.headings || values.headers,
+      code: values.all || values.code,
+      quotes: values.all || values.quotes,
+      lists: values.all || values.lists,
+      links: values.all || values.links,
+      lowercase: values.lower,
+      noWrap: values.nowrap || values["no-linebreaks"]
+    };
+    if (values.md !== void 0) {
+      for (const name of values.md.split(",").map((part) => part.trim()).filter(Boolean)) {
+        const key = MD_NAMES.get(name);
+        if (!key) {
+          throw new RangeError(`Invalid --md value "${name}". Valid values: headings, code, quotes, lists, links`);
+        }
+        options[key] = true;
+      }
+    }
+    const format = values.format ?? "markdown";
+    if (!CLI_FORMATS.includes(format)) {
+      throw new RangeError(`Invalid format "${format}". Valid formats: ${CLI_FORMATS.join(", ")}`);
+    }
+    if (format === "json") {
+      const markdown = ipsumify(options);
+      const json = {
+        theme: options.theme ?? DEFAULT_THEME,
+        blocks: options.blocks ?? DEFAULT_BLOCKS,
+        seed: options.seed,
+        format,
+        options: {
+          headers: !!options.headers,
+          codeSnippets: !!options.code,
+          blockquotes: !!options.quotes,
+          lists: !!options.lists,
+          links: !!options.links,
+          capitalize: !options.lowercase,
+          noWrap: !!options.noWrap
+        },
+        output: paragraphs(options),
+        markdown
+      };
+      return { code: 0, stdout: JSON.stringify(json, null, 2) + "\n", stderr: "" };
+    }
+    return { code: 0, stdout: ipsumify({ ...options, format }) + "\n", stderr: "" };
+  } catch (error) {
+    return fail(error.message);
+  }
+}
+
+// packages/ipsumify/src/cli.ts
+var result = run(process.argv.slice(2), "2.6.0");
+if (result.stdout) process.stdout.write(result.stdout);
+if (result.stderr) process.stderr.write(result.stderr);
+process.exitCode = result.code;

package/dist/index.d.ts

@@ -0,0 +1,56 @@
+export type Format = 'markdown' | 'text' | 'html'
+
+export interface IpsumifyOptions {
+  /** Theme id: lorem (default), dog, cat, baked, bbq */
+  theme?: string
+  /** Number of blocks (paragraphs), 1 to 20. Default 5 */
+  blocks?: number
+  /** Whole number from 0 to 2147483647. The same seed gives the same text. Random when omitted */
+  seed?: number
+  /** Add markdown headings */
+  headers?: boolean
+  /** Add code snippets */
+  code?: boolean
+  /** Add blockquotes */
+  quotes?: boolean
+  /** Add bullet lists */
+  lists?: boolean
+  /** Add links */
+  links?: boolean
+  /** Lowercase everything */
+  lowercase?: boolean
+  /** Put everything on one line, with no line breaks */
+  noWrap?: boolean
+  /** markdown (default), text (markdown syntax stripped), or html */
+  format?: Format
+}
+
+export declare const MIN_BLOCKS: number
+export declare const MAX_BLOCKS: number
+export declare const DEFAULT_BLOCKS: number
+export declare const DEFAULT_THEME: string
+export declare const MAX_SEED: number
+export declare const FORMATS: readonly Format[]
+
+/** The available themes. */
+export declare const themes: readonly { id: string, label: string }[]
+
+/** A seed chosen at random. */
+export declare function randomSeed(): number
+
+/**
+ * Generates placeholder text.
+ * @throws {RangeError} For an unknown theme or format, or blocks or seed out of range
+ * @throws {TypeError} If options is not an object, or a switch is not a boolean
+ */
+export declare function ipsumify(options?: IpsumifyOptions): string
+
+/**
+ * Generates the body paragraphs as an array, one string per block, without markdown elements.
+ * `format` is ignored.
+ * @throws {RangeError} For an unknown theme, or blocks or seed out of range
+ * @throws {TypeError} If options is not an object, or a switch is not a boolean
+ */
+export declare function paragraphs(options?: IpsumifyOptions): string[]
+
+export default ipsumify

package/dist/index.js

@@ -0,0 +1,26 @@
+import {
+  DEFAULT_BLOCKS,
+  DEFAULT_THEME,
+  FORMATS,
+  MAX_BLOCKS,
+  MAX_SEED,
+  MIN_BLOCKS,
+  ipsumify,
+  paragraphs,
+  randomSeed,
+  src_default,
+  themes
+} from "./shared-B3DMJ5UC.js";
+export {
+  DEFAULT_BLOCKS,
+  DEFAULT_THEME,
+  FORMATS,
+  MAX_BLOCKS,
+  MAX_SEED,
+  MIN_BLOCKS,
+  src_default as default,
+  ipsumify,
+  paragraphs,
+  randomSeed,
+  themes
+};