sysprom 1.2.0 → 1.2.2

package/dist/src/text.js

@@ -1,20 +1,37 @@
-/** Normalise a text field (string | string[]) to a single string, joining with newlines.
+/**
+ * Normalise a text field (string | string[]) to a single string, joining with newlines.
  * @param value - The text field to normalise.
  * @returns A single string.
+ * @example
+ * ```ts
+ * textToString(["line 1", "line 2"]) // => "line 1\nline 2"
+ * textToString("hello") // => "hello"
+ * ```
  */
 export function textToString(value) {
     return Array.isArray(value) ? value.join("\n") : value;
 }
-/** Normalise a text field to an array of lines.
+/**
+ * Normalise a text field to an array of lines.
  * @param value - The text field to normalise.
  * @returns An array of lines.
+ * @example
+ * ```ts
+ * textToLines("hello") // => ["hello"]
+ * textToLines(["a", "b"]) // => ["a", "b"]
+ * ```
  */
 export function textToLines(value) {
     return Array.isArray(value) ? value : [value];
 }
-/** Format a text field for Markdown output — each line becomes a paragraph.
+/**
+ * Format a text field for Markdown output — each line becomes a paragraph.
  * @param value - The text field to format.
  * @returns Markdown-formatted string.
+ * @example
+ * ```ts
+ * textToMarkdown(["para 1", "para 2"]) // => "para 1\npara 2"
+ * ```
  */
 export function textToMarkdown(value) {
     return textToLines(value).join("\n");
@@ -22,9 +39,13 @@ export function textToMarkdown(value) {
 /**
  * Parse a Markdown text block back into the canonical text representation.
  * Single-line content stays as a string; multiline becomes an array.
- *
  * @param block - The Markdown text block to parse.
  * @returns A string for single-line content, or an array of lines for multiline.
+ * @example
+ * ```ts
+ * markdownToText("single line") // => "single line"
+ * markdownToText("line 1\nline 2") // => ["line 1", "line 2"]
+ * ```
  */
 export function markdownToText(block) {
     const lines = block.split("\n");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sysprom",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "SysProM — System Provenance Model CLI and library",
   "author": "ExaDev",
   "homepage": "https://exadev.github.io/SysProM",
@@ -76,6 +76,7 @@
     "conventional-changelog-conventionalcommits": "9.3.0",
     "eslint": "10.1.0",
     "eslint-config-prettier": "10.1.8",
+    "eslint-plugin-jsdoc": "62.8.0",
     "eslint-plugin-prettier": "5.5.5",
     "husky": "9.1.7",
     "prettier": "3.8.1",