npm - @pennyfarthing/core - Versions diffs - 9.2.0 → 9.3.0 - Mend

@pennyfarthing/core 9.2.0 → 9.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1039) hide show

package/pennyfarthing-dist/workflows/prd/steps-v/step-v-01-discovery.md DELETED Viewed

@@ -1,224 +0,0 @@
----
-name: 'step-v-01-discovery'
-description: 'Document Discovery & Confirmation - Handle fresh context validation, confirm PRD path, discover input documents'
-# File references (ONLY variables used in this step)
-nextStepFile: './step-v-02-format-detection.md'
-advancedElicitationTask: '{project_root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
-partyModeWorkflow: '{project_root}/_bmad/core/workflows/party-mode/workflow.md'
-prdPurpose: '../data/prd-purpose.md'
----
-# Step 1: Document Discovery & Confirmation
-<purpose>Handle fresh context validation by confirming PRD path, discovering and loading input documents from frontmatter, and initializing the validation report.</purpose>
-<instructions>Confirm PRD file path is valid; load complete PRD document and frontmatter; extract and reload input documents from inputDocuments array; create validation report with PRD metadata; confirm readiness to begin validation checks.</instructions>
-<output>Loaded PRD document with complete context, extracted and verified input documents, initialized validation report with PRD metadata, ready for format detection and validation checks.</output>
-## STEP GOAL:
-Handle fresh context validation by confirming PRD path, discovering and loading input documents from frontmatter, and initializing the validation report.
-## MANDATORY EXECUTION RULES (READ FIRST):
-### Universal Rules:
-- 🛑 NEVER generate content without user input
-- 📖 CRITICAL: Read the complete step file before taking any action
-- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
-- 📋 YOU ARE A FACILITATOR, not a content generator
-- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
-### Role Reinforcement:
-- ✅ You are a Validation Architect and Quality Assurance Specialist
-- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role
-- ✅ We engage in collaborative dialogue, not command-response
-- ✅ You bring systematic validation expertise and analytical rigor
-- ✅ User brings domain knowledge and specific PRD context
-### Step-Specific Rules:
-- 🎯 Focus ONLY on discovering PRD and input documents, not validating yet
-- 🚫 FORBIDDEN to perform any validation checks in this step
-- 💬 Approach: Systematic discovery with clear reporting to user
-- 🚪 This is the setup step - get everything ready for validation
-## EXECUTION PROTOCOLS:
-- 🎯 Discover and confirm PRD to validate
-- 💾 Load PRD and all input documents from frontmatter
-- 📖 Initialize validation report next to PRD
-- 🚫 FORBIDDEN to load next step until user confirms setup
-## CONTEXT BOUNDARIES:
-- Available context: PRD path (user-specified or discovered), workflow configuration
-- Focus: Document discovery and setup only
-- Limits: Don't perform validation, don't skip discovery
-- Dependencies: Configuration loaded from PRD workflow.md initialization
-## MANDATORY SEQUENCE
-**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change.
-### 1. Load PRD Purpose and Standards
-Load and read the complete file at:
-`{prdPurpose}`
-This file contains the BMAD PRD philosophy, standards, and validation criteria that will guide all validation checks. Internalize this understanding - it defines what makes a great BMAD PRD.
-### 2. Discover PRD to Validate
-**If PRD path provided as invocation parameter:**
-- Use provided path
-**If no PRD path provided:**
-"**PRD Validation Workflow**
-Which PRD would you like to validate?
-Please provide the path to the PRD file you want to validate."
-**Wait for user to provide PRD path.**
-### 3. Validate PRD Exists and Load
-Once PRD path is provided:
-- Check if PRD file exists at specified path
-- If not found: "I cannot find a PRD at that path. Please check the path and try again."
-- If found: Load the complete PRD file including frontmatter
-### 4. Extract Frontmatter and Input Documents
-From the loaded PRD frontmatter, extract:
-- `inputDocuments: []` array (if present)
-- Any other relevant metadata (classification, date, etc.)
-**If no inputDocuments array exists:**
-Note this and proceed with PRD-only validation
-### 5. Load Input Documents
-For each document listed in `inputDocuments`:
-- Attempt to load the document
-- Track successfully loaded documents
-- Note any documents that fail to load
-**Build list of loaded input documents:**
-- Product Brief (if present)
-- Research documents (if present)
-- Other reference materials (if present)
-### 6. Ask About Additional Reference Documents
-"**I've loaded the following documents from your PRD frontmatter:**
-{list loaded documents with file names}
-**Are there any additional reference documents you'd like me to include in this validation?**
-These could include:
-- Additional research or context documents
-- Project documentation not tracked in frontmatter
-- Standards or compliance documents
-- Competitive analysis or benchmarks
-Please provide paths to any additional documents, or type 'none' to proceed."
-**Load any additional documents provided by user.**
-### 7. Initialize Validation Report
-Create validation report at: `{validationReportPath}`
-**Initialize with frontmatter:**
-```yaml
----
-validationTarget: '{prd_path}'
-validationDate: '{current_date}'
-inputDocuments: [list of all loaded documents]
-validationStepsCompleted: []
-validationStatus: IN_PROGRESS
----
-```
-**Initial content:**
-```markdown
-# PRD Validation Report
-**PRD Being Validated:** {prd_path}
-**Validation Date:** {current_date}
-## Input Documents
-{list all documents loaded for validation}
-## Validation Findings
-[Findings will be appended as validation progresses]
-```
-### 8. Present Discovery Summary
-"**Setup Complete!**
-**PRD to Validate:** {prd_path}
-**Input Documents Loaded:**
-- PRD: {prd_name} ✓
-- Product Brief: {count} {if count > 0}✓{else}(none found){/if}
-- Research: {count} {if count > 0}✓{else}(none found){/if}
-- Additional References: {count} {if count > 0}✓{else}(none){/if}
-**Validation Report:** {validationReportPath}
-**Ready to begin validation.**"
-### 9. Present MENU OPTIONS
-Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Format Detection
-#### EXECUTION RULES:
-- ALWAYS halt and wait for user input after presenting menu
-- ONLY proceed to next step when user selects 'C'
-- User can ask questions or add more documents - always respond and redisplay menu
-#### Menu Handling Logic:
-- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu
-- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu
-- IF C: Load, read entire file, then execute {nextStepFile} to begin format detection
-- IF user provides additional document: Load it, update report, redisplay summary
-- IF Any other: help user, then redisplay menu
----
-## 🚨 SYSTEM SUCCESS/FAILURE METRICS
-### ✅ SUCCESS:
-- PRD path discovered and confirmed
-- PRD file exists and loads successfully
-- All input documents from frontmatter loaded
-- Additional reference documents (if any) loaded
-- Validation report initialized next to PRD
-- User clearly informed of setup status
-- Menu presented and user input handled correctly
-### ❌ SYSTEM FAILURE:
-- Proceeding with non-existent PRD file
-- Not loading input documents from frontmatter
-- Creating validation report in wrong location
-- Proceeding without user confirming setup
-- Not handling missing input documents gracefully
-**Master Rule:** Complete discovery and setup BEFORE validation. This step ensures everything is in place for systematic validation checks.

package/pennyfarthing-dist/workflows/prd/steps-v/step-v-02-format-detection.md DELETED Viewed

@@ -1,197 +0,0 @@
----
-name: 'step-v-02-format-detection'
-description: 'Format Detection & Structure Analysis - Classify PRD format and route appropriately'
-# File references (ONLY variables used in this step)
-nextStepFile: './step-v-03-density-validation.md'
-altStepFile: './step-v-02b-parity-check.md'
-prdFile: '{prd_file_path}'
-validationReportPath: '{validation_report_path}'
----
-# Step 2: Format Detection & Structure Analysis
-<purpose>Detect if PRD follows BMAD format and route appropriately - classify as BMAD Standard, BMAD Variant, or Non-Standard format.</purpose>
-<instructions>Analyze PRD structure to detect format conformance; identify section presence and order; classify format type; for non-standard formats, offer optional parity check; update validation report with format classification; route to appropriate next validation step.</instructions>
-<output>PRD format classification (BMAD Standard/Variant/Non-Standard), structure analysis summary, validation report updated with format findings, ready for format-specific validation checks.</output>
-## STEP GOAL:
-Detect if PRD follows BMAD format and route appropriately - classify as BMAD Standard / BMAD Variant / Non-Standard, with optional parity check for non-standard formats.
-## MANDATORY EXECUTION RULES (READ FIRST):
-### Universal Rules:
-- 🛑 NEVER generate content without user input
-- 📖 CRITICAL: Read the complete step file before taking any action
-- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
-- 📋 YOU ARE A FACILITATOR, not a content generator
-- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
-### Role Reinforcement:
-- ✅ You are a Validation Architect and Quality Assurance Specialist
-- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role
-- ✅ We engage in collaborative dialogue, not command-response
-- ✅ You bring systematic validation expertise and pattern recognition
-- ✅ User brings domain knowledge and PRD context
-### Step-Specific Rules:
-- 🎯 Focus ONLY on detecting format and classifying structure
-- 🚫 FORBIDDEN to perform other validation checks in this step
-- 💬 Approach: Analytical and systematic, clear reporting of findings
-- 🚪 This is a branch step - may route to parity check for non-standard PRDs
-## EXECUTION PROTOCOLS:
-- 🎯 Analyze PRD structure systematically
-- 💾 Append format findings to validation report
-- 📖 Route appropriately based on format classification
-- 🚫 FORBIDDEN to skip format detection or proceed without classification
-## CONTEXT BOUNDARIES:
-- Available context: PRD file loaded in step 1, validation report initialized
-- Focus: Format detection and classification only
-- Limits: Don't perform other validation, don't skip classification
-- Dependencies: Step 1 completed - PRD loaded and report initialized
-## MANDATORY SEQUENCE
-**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change.
-### 1. Extract PRD Structure
-Load the complete PRD file and extract:
-**All Level 2 (##) headers:**
-- Scan through entire PRD document
-- Extract all ## section headers
-- List them in order
-**PRD frontmatter:**
-- Extract classification.domain if present
-- Extract classification.projectType if present
-- Note any other relevant metadata
-### 2. Check for BMAD PRD Core Sections
-Check if the PRD contains the following BMAD PRD core sections:
-1. **Executive Summary** (or variations: ## Executive Summary, ## Overview, ## Introduction)
-2. **Success Criteria** (or: ## Success Criteria, ## Goals, ## Objectives)
-3. **Product Scope** (or: ## Product Scope, ## Scope, ## In Scope, ## Out of Scope)
-4. **User Journeys** (or: ## User Journeys, ## User Stories, ## User Flows)
-5. **Functional Requirements** (or: ## Functional Requirements, ## Features, ## Capabilities)
-6. **Non-Functional Requirements** (or: ## Non-Functional Requirements, ## NFRs, ## Quality Attributes)
-**Count matches:**
-- How many of these 6 core sections are present?
-- Which specific sections are present?
-- Which are missing?
-### 3. Classify PRD Format
-Based on core section count, classify:
-**BMAD Standard:**
-- 5-6 core sections present
-- Follows BMAD PRD structure closely
-**BMAD Variant:**
-- 3-4 core sections present
-- Generally follows BMAD patterns but may have structural differences
-- Missing some sections but recognizable as BMAD-style
-**Non-Standard:**
-- Fewer than 3 core sections present
-- Does not follow BMAD PRD structure
-- May be completely custom format, legacy format, or from another framework
-### 4. Report Format Findings to Validation Report
-Append to validation report:
-```markdown
-## Format Detection
-**PRD Structure:**
-[List all ## Level 2 headers found]
-**BMAD Core Sections Present:**
-- Executive Summary: [Present/Missing]
-- Success Criteria: [Present/Missing]
-- Product Scope: [Present/Missing]
-- User Journeys: [Present/Missing]
-- Functional Requirements: [Present/Missing]
-- Non-Functional Requirements: [Present/Missing]
-**Format Classification:** [BMAD Standard / BMAD Variant / Non-Standard]
-**Core Sections Present:** [count]/6
-```
-### 5. Route Based on Format Classification
-**IF format is BMAD Standard or BMAD Variant:**
-Display: "**Format Detected:** {classification}
-Proceeding to systematic validation checks..."
-Immediately load and execute {nextStepFile} (step-v-03-density-validation.md)
-**IF format is Non-Standard (< 3 core sections):**
-Display: "**Format Detected:** Non-Standard PRD
-This PRD does not follow BMAD standard structure (only {count}/6 core sections present).
-You have options:"
-Present MENU OPTIONS below for user selection
-### 6. Present MENU OPTIONS (Non-Standard PRDs Only)
-**[A] Parity Check** - Analyze gaps and estimate effort to reach BMAD PRD parity
-**[B] Validate As-Is** - Proceed with validation using current structure
-**[C] Exit** - Exit validation and review format findings
-#### EXECUTION RULES:
-- ALWAYS halt and wait for user input
-- Only proceed based on user selection
-#### Menu Handling Logic:
-- IF A (Parity Check): Load, read entire file, then execute {altStepFile} (step-v-02b-parity-check.md)
-- IF B (Validate As-Is): Display "Proceeding with validation..." then load, read entire file, then execute {nextStepFile}
-- IF C (Exit): Display format findings summary and exit validation
-- IF Any other: help user respond, then redisplay menu
----
-## 🚨 SYSTEM SUCCESS/FAILURE METRICS
-### ✅ SUCCESS:
-- All ## Level 2 headers extracted successfully
-- BMAD core sections checked systematically
-- Format classified correctly based on section count
-- Findings reported to validation report
-- BMAD Standard/Variant PRDs proceed directly to next validation step
-- Non-Standard PRDs pause and present options to user
-- User can choose parity check, validate as-is, or exit
-### ❌ SYSTEM FAILURE:
-- Not extracting all headers before classification
-- Incorrect format classification
-- Not reporting findings to validation report
-- Not pausing for non-standard PRDs
-- Proceeding without user decision for non-standard formats
-**Master Rule:** Format detection determines validation path. Non-standard PRDs require user choice before proceeding.

package/pennyfarthing-dist/workflows/prd/steps-v/step-v-02b-parity-check.md DELETED Viewed

@@ -1,215 +0,0 @@
----
-name: 'step-v-02b-parity-check'
-description: 'Document Parity Check - Analyze non-standard PRD and identify gaps to achieve BMAD PRD parity'
-# File references (ONLY variables used in this step)
-nextStepFile: './step-v-03-density-validation.md'
-prdFile: '{prd_file_path}'
-validationReportPath: '{validation_report_path}'
----
-# Step 2B: Document Parity Check
-<purpose>Analyze non-standard PRD and identify gaps to achieve BMAD PRD parity, presenting user with options for how to proceed.</purpose>
-<instructions>Load and deeply analyze non-standard PRD structure; identify missing sections and gaps relative to BMAD standard; map existing content to BMAD sections; prepare parity analysis with specific recommendations; present user with conversion options (full conversion, selective upgrade, continue as-is).</instructions>
-<output>Detailed parity analysis documenting gaps between current format and BMAD standard, conversion recommendations with effort estimates, and user-selected approach for proceeding with validation.</output>
-## STEP GOAL:
-Analyze non-standard PRD and identify gaps to achieve BMAD PRD parity, presenting user with options for how to proceed.
-## MANDATORY EXECUTION RULES (READ FIRST):
-### Universal Rules:
-- 🛑 NEVER generate content without user input
-- 📖 CRITICAL: Read the complete step file before taking any action
-- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
-- 📋 YOU ARE A FACILITATOR, not a content generator
-- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
-### Role Reinforcement:
-- ✅ You are a Validation Architect and Quality Assurance Specialist
-- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role
-- ✅ We engage in collaborative dialogue, not command-response
-- ✅ You bring BMAD PRD standards expertise and gap analysis
-- ✅ User brings domain knowledge and PRD context
-### Step-Specific Rules:
-- 🎯 Focus ONLY on analyzing gaps and estimating parity effort
-- 🚫 FORBIDDEN to perform other validation checks in this step
-- 💬 Approach: Systematic gap analysis with clear recommendations
-- 🚪 This is an optional branch step - user chooses next action
-## EXECUTION PROTOCOLS:
-- 🎯 Analyze each BMAD PRD section for gaps
-- 💾 Append parity analysis to validation report
-- 📖 Present options and await user decision
-- 🚫 FORBIDDEN to proceed without user selection
-## CONTEXT BOUNDARIES:
-- Available context: Non-standard PRD from step 2, validation report in progress
-- Focus: Parity analysis only - what's missing, what's needed
-- Limits: Don't perform validation checks, don't auto-proceed
-- Dependencies: Step 2 classified PRD as non-standard and user chose parity check
-## MANDATORY SEQUENCE
-**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change.
-### 1. Analyze Each BMAD PRD Section
-For each of the 6 BMAD PRD core sections, analyze:
-**Executive Summary:**
-- Does PRD have vision/overview?
-- Is problem statement clear?
-- Are target users identified?
-- Gap: [What's missing or incomplete]
-**Success Criteria:**
-- Are measurable goals defined?
-- Is success clearly defined?
-- Gap: [What's missing or incomplete]
-**Product Scope:**
-- Is scope clearly defined?
-- Are in-scope items listed?
-- Are out-of-scope items listed?
-- Gap: [What's missing or incomplete]
-**User Journeys:**
-- Are user types/personas identified?
-- Are user flows documented?
-- Gap: [What's missing or incomplete]
-**Functional Requirements:**
-- Are features/capabilities listed?
-- Are requirements structured?
-- Gap: [What's missing or incomplete]
-**Non-Functional Requirements:**
-- Are quality attributes defined?
-- Are performance/security/etc. requirements documented?
-- Gap: [What's missing or incomplete]
-### 2. Estimate Effort to Reach Parity
-For each missing or incomplete section, estimate:
-**Effort Level:**
-- Minimal - Section exists but needs minor enhancements
-- Moderate - Section missing but content exists elsewhere in PRD
-- Significant - Section missing, requires new content creation
-**Total Parity Effort:**
-- Based on individual section estimates
-- Classify overall: Quick / Moderate / Substantial effort
-### 3. Report Parity Analysis to Validation Report
-Append to validation report:
-```markdown
-## Parity Analysis (Non-Standard PRD)
-### Section-by-Section Gap Analysis
-**Executive Summary:**
-- Status: [Present/Missing/Incomplete]
-- Gap: [specific gap description]
-- Effort to Complete: [Minimal/Moderate/Significant]
-**Success Criteria:**
-- Status: [Present/Missing/Incomplete]
-- Gap: [specific gap description]
-- Effort to Complete: [Minimal/Moderate/Significant]
-**Product Scope:**
-- Status: [Present/Missing/Incomplete]
-- Gap: [specific gap description]
-- Effort to Complete: [Minimal/Moderate/Significant]
-**User Journeys:**
-- Status: [Present/Missing/Incomplete]
-- Gap: [specific gap description]
-- Effort to Complete: [Minimal/Moderate/Significant]
-**Functional Requirements:**
-- Status: [Present/Missing/Incomplete]
-- Gap: [specific gap description]
-- Effort to Complete: [Minimal/Moderate/Significant]
-**Non-Functional Requirements:**
-- Status: [Present/Missing/Incomplete]
-- Gap: [specific gap description]
-- Effort to Complete: [Minimal/Moderate/Significant]
-### Overall Parity Assessment
-**Overall Effort to Reach BMAD Standard:** [Quick/Moderate/Substantial]
-**Recommendation:** [Brief recommendation based on analysis]
-```
-### 4. Present Parity Analysis and Options
-Display:
-"**Parity Analysis Complete**
-Your PRD is missing {count} of 6 core BMAD PRD sections. The overall effort to reach BMAD standard is: **{effort level}**
-**Quick Summary:**
-[2-3 sentence summary of key gaps]
-**Recommendation:**
-{recommendation from analysis}
-**How would you like to proceed?**"
-### 5. Present MENU OPTIONS
-**[C] Continue Validation** - Proceed with validation using current structure
-**[E] Exit & Review** - Exit validation and review parity report
-**[S] Save & Exit** - Save parity report and exit
-#### EXECUTION RULES:
-- ALWAYS halt and wait for user input
-- Only proceed based on user selection
-#### Menu Handling Logic:
-- IF C (Continue): Display "Proceeding with validation..." then load, read entire file, then execute {nextStepFile}
-- IF E (Exit): Display parity summary and exit validation
-- IF S (Save): Confirm saved, display summary, exit
-- IF Any other: help user respond, then redisplay menu
----
-## 🚨 SYSTEM SUCCESS/FAILURE METRICS
-### ✅ SUCCESS:
-- All 6 BMAD PRD sections analyzed for gaps
-- Effort estimates provided for each gap
-- Overall parity effort assessed correctly
-- Parity analysis reported to validation report
-- Clear summary presented to user
-- User can choose to continue validation, exit, or save report
-### ❌ SYSTEM FAILURE:
-- Not analyzing all 6 sections systematically
-- Missing effort estimates
-- Not reporting parity analysis to validation report
-- Auto-proceeding without user decision
-- Unclear recommendations
-**Master Rule:** Parity check informs user of gaps and effort, but user decides whether to proceed with validation or address gaps first.