sysprom 1.2.0 → 1.2.1

package/dist/src/speckit/project.d.ts

@@ -28,18 +28,27 @@ export interface SpecKitFeature {
 /**
  * Detect Spec-Kit project structure from a directory.
  * Looks for .specify/ and specs/ subdirectories.
+ * @param dir - Directory to scan.
+ * @returns Detected project structure.
  */
 export declare function detectSpecKitProject(dir: string): SpecKitProject;
 /**
  * List all features in the specs/ directory, sorted by number.
+ * @param project - The detected project.
+ * @returns Sorted list of features.
  */
 export declare function listFeatures(project: SpecKitProject): SpecKitFeature[];
 /**
  * Get a specific feature by number or name.
  * Matches "001", "001-feature-name", or "feature-name".
+ * @param project - The detected project.
+ * @param idOrName - Feature ID, number, or name.
+ * @returns The matching feature, or null.
  */
 export declare function getFeature(project: SpecKitProject, idOrName: string): SpecKitFeature | null;
 /**
  * Resolve the constitution.md file, checking .specify/memory/ first, then root.
+ * @param project - The detected project.
+ * @returns Path to constitution.md, or null.
  */
 export declare function resolveConstitution(project: SpecKitProject): string | null;

package/dist/src/speckit/project.js

@@ -3,6 +3,8 @@ import { join } from "node:path";
 /**
  * Detect Spec-Kit project structure from a directory.
  * Looks for .specify/ and specs/ subdirectories.
+ * @param dir - Directory to scan.
+ * @returns Detected project structure.
  */
 export function detectSpecKitProject(dir) {
     const specifyDir = checkDir(join(dir, ".specify"));
@@ -30,6 +32,8 @@ export function detectSpecKitProject(dir) {
 }
 /**
  * List all features in the specs/ directory, sorted by number.
+ * @param project - The detected project.
+ * @returns Sorted list of features.
  */
 export function listFeatures(project) {
     if (!project.specsDir) {
@@ -63,6 +67,9 @@ export function listFeatures(project) {
 /**
  * Get a specific feature by number or name.
  * Matches "001", "001-feature-name", or "feature-name".
+ * @param project - The detected project.
+ * @param idOrName - Feature ID, number, or name.
+ * @returns The matching feature, or null.
  */
 export function getFeature(project, idOrName) {
     const features = listFeatures(project);
@@ -83,12 +90,16 @@ export function getFeature(project, idOrName) {
 }
 /**
  * Resolve the constitution.md file, checking .specify/memory/ first, then root.
+ * @param project - The detected project.
+ * @returns Path to constitution.md, or null.
  */
 export function resolveConstitution(project) {
     return project.constitutionPath;
 }
 /**
  * Check if a directory exists, return path or null.
+ * @param path - Path to check.
+ * @returns The path if it exists as a directory, or null.
  */
 function checkDir(path) {
     try {
@@ -101,6 +112,9 @@ function checkDir(path) {
 }
 /**
  * Parse a feature directory and extract metadata and file paths.
+ * @param dir - Directory to search.
+ * @param dirName - Subdirectory name pattern.
+ * @returns Array of matching directory paths.
  */
 function parseFeatureDirectory(dir, dirName) {
     // Parse the directory name format: "NNN-feature-name"
@@ -128,6 +142,9 @@ function parseFeatureDirectory(dir, dirName) {
 }
 /**
  * Check if a file exists in a directory, return path or null.
+ * @param dir - Directory to search.
+ * @param filename - File name to find.
+ * @returns Array of matching file paths.
  */
 function checkFile(dir, filename) {
     const path = join(dir, filename);

package/dist/src/text.d.ts

@@ -1,14 +1,17 @@
-/** 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.
  */
 export declare function textToString(value: string | string[]): string;
-/** 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.
  */
 export declare function textToLines(value: string | string[]): string[];
-/** 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.
  */
@@ -16,7 +19,6 @@ export declare function textToMarkdown(value: string | string[]): string;
 /**
  * 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.
  */

package/dist/src/text.js

@@ -1,18 +1,21 @@
-/** 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.
  */
 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.
  */
 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.
  */
@@ -22,7 +25,6 @@ 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.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sysprom",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "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",