moai-adk 0.34.0__py3-none-any.whl → 1.1.0__py3-none-any.whl

moai_adk/templates/.claude/skills/moai-workflow-testing/modules/trust5-validation.md

@@ -0,0 +1,428 @@
+# TRUST 5 Validation Framework
+
+> Module: Complete TRUST 5 validation implementation with category-specific analysis and scoring
+> Parent: [Automated Code Review](./automated-code-review.md)
+> Complexity: Advanced
+> Time: 20+ minutes
+> Dependencies: Python 3.8+, ast, Context7 MCP
+
+## Quick Reference
+
+### TRUST 5 Categories
+
+Truthfulness (25% weight):
+- Code correctness validation
+- Logic error detection
+- Unreachable code identification
+- Comparison issue checking
+- Data flow analysis
+
+Relevance (20% weight):
+- Requirements fulfillment
+- TODO/FIXME comment tracking
+- Dead code detection
+- Feature completeness validation
+- Purpose alignment checking
+
+Usability (25% weight):
+- Maintainability assessment
+- Code complexity analysis
+- Documentation completeness
+- Naming convention validation
+- Code organization review
+
+Safety (20% weight):
+- Security vulnerability detection
+- Error handling validation
+- Exception safety checking
+- Resource leak detection
+- Input validation review
+
+Timeliness (10% weight):
+- Performance optimization opportunities
+- Deprecated code identification
+- Modern practices adoption
+- Technology currency validation
+- Standards compliance checking
+
+### Core Implementation
+
+```python
+from enum import Enum
+from dataclasses import dataclass
+from typing import Dict, List, Any
+
+class TrustCategory(Enum):
+    """TRUST 5 framework categories."""
+    TRUTHFULNESS = "truthfulness"
+    RELEVANCE = "relevance"
+    USABILITY = "usability"
+    SAFETY = "safety"
+    TIMELINESS = "timeliness"
+
+@dataclass
+class CodeIssue:
+    """Individual code issue found during review."""
+    id: str
+    category: TrustCategory
+    severity: str  # critical, high, medium, low, info
+    issue_type: str
+    title: str
+    description: str
+    file_path: str
+    line_number: int
+    column_number: int
+    code_snippet: str
+    suggested_fix: str
+    confidence: float  # 0.0 to 1.0
+    rule_violated: str = None
+    external_reference: str = None
+```
+
+---
+
+## Implementation Guide
+
+### Truthfulness Analysis
+
+Truthfulness validation focuses on code correctness and logic accuracy:
+
+```python
+def _analyze_truthfulness(self, file_path: str, tree: ast.AST) -> List[CodeIssue]:
+    """Analyze code for correctness and logic issues."""
+    issues = []
+
+    # Check for unreachable code
+    for node in ast.walk(tree):
+        if isinstance(node, (ast.FunctionDef, ast.AsyncFunctionDef)):
+            unreachable_issues = self._check_unreachable_code(file_path, node)
+            issues.extend(unreachable_issues)
+
+    # Check for logic issues
+    logic_issues = self._check_logic_issues(file_path, tree)
+    issues.extend(logic_issues)
+
+    return issues
+```
+
+Unreachable Code Detection:
+- Identifies code after return statements
+- Detects code after raise statements
+- Finds code after break/continue in loops
+- Reports dead code with confidence scores
+
+Logic Issue Detection:
+- Checks for None comparison patterns (use 'is None' instead of '== None')
+- Identifies constant conditions in if statements
+- Detects tautological comparisons
+- Finds contradictory conditions
+
+### Relevance Analysis
+
+Relevance analysis validates requirements fulfillment and purpose alignment:
+
+```python
+def _analyze_relevance(self, file_path: str, content: str) -> List[CodeIssue]:
+    """Analyze code for relevance and requirements fulfillment."""
+    issues = []
+
+    # Check for TODO/FIXME comments
+    lines = content.split('\n')
+    for line_num, line in enumerate(lines, 1):
+        if 'TODO:' in line or 'FIXME:' in line:
+            issue = CodeIssue(
+                id=f"todo_{line_num}",
+                category=TrustCategory.RELEVANCE,
+                severity="low",
+                issue_type="documentation_issue",
+                title="Unresolved TODO",
+                description=f"TODO/FIXME comment found: {line.strip()}",
+                file_path=file_path,
+                line_number=line_num,
+                column_number=line.find('TODO') if 'TODO' in line else line.find('FIXME'),
+                code_snippet=line.strip(),
+                suggested_fix="Address the TODO/FIXME item or remove the comment",
+                confidence=0.6,
+                rule_violated="UNRESOLVED_TODO"
+            )
+            issues.append(issue)
+
+    return issues
+```
+
+Relevance Checks:
+- TODO/FIXME comment tracking
+- Dead code identification (unused imports, variables, functions)
+- Feature completeness validation
+- Documentation alignment with implementation
+
+### Usability Analysis
+
+Usability assessment focuses on maintainability and code quality:
+
+```python
+def _analyze_usability(self, file_path: str, content: str, tree: ast.AST) -> List[CodeIssue]:
+    """Analyze code for usability and maintainability."""
+    issues = []
+
+    # Check for docstring presence
+    for node in ast.walk(tree):
+        if isinstance(node, (ast.FunctionDef, ast.AsyncFunctionDef)):
+            if not ast.get_docstring(node):
+                issue = CodeIssue(
+                    id=f"no_docstring_{node.lineno}",
+                    category=TrustCategory.USABILITY,
+                    severity="low",
+                    issue_type="documentation_issue",
+                    title="Missing Docstring",
+                    description=f"Function '{node.name}' is missing a docstring",
+                    file_path=file_path,
+                    line_number=node.lineno,
+                    column_number=1,
+                    code_snippet=f"def {node.name}(...):",
+                    suggested_fix=f"Add a docstring to '{node.name}' explaining its purpose, parameters, and return value",
+                    confidence=0.7,
+                    rule_violated="MISSING_DOCSTRING"
+                )
+                issues.append(issue)
+
+    return issues
+```
+
+Usability Metrics:
+- Function length analysis (default max: 50 lines)
+- Cyclomatic complexity calculation (default max: 10)
+- Nesting depth assessment (default max: 4 levels)
+- Documentation completeness
+- Naming convention validation
+
+### Safety Analysis
+
+Safety validation detects security vulnerabilities and error handling issues:
+
+```python
+def _analyze_safety(self, file_path: str, tree: ast.AST) -> List[CodeIssue]:
+    """Analyze code for safety and error handling."""
+    issues = []
+
+    # Check for bare except clauses
+    for node in ast.walk(tree):
+        if isinstance(node, ast.ExceptHandler):
+            if node.type is None:
+                issue = CodeIssue(
+                    id=f"bare_except_{node.lineno}",
+                    category=TrustCategory.SAFETY,
+                    severity="medium",
+                    issue_type="code_smell",
+                    title="Bare Except Clause",
+                    description="Bare except clause can hide unexpected errors",
+                    file_path=file_path,
+                    line_number=node.lineno,
+                    column_number=1,
+                    code_snippet="except:",
+                    suggested_fix="Specify exception types or use 'except Exception:' with logging",
+                    confidence=0.8,
+                    rule_violated="BARE_EXCEPT"
+                )
+                issues.append(issue)
+
+    return issues
+```
+
+Safety Checks:
+- Bare except clause detection
+- Exception handling validation
+- Resource leak detection (file handles, database connections)
+- Input validation review
+- Context manager usage validation
+
+### Timeliness Analysis
+
+Timeliness assessment identifies performance and modernization opportunities:
+
+```python
+def _analyze_timeliness(self, file_path: str, content: str) -> List[CodeIssue]:
+    """Analyze code for timeliness and performance."""
+    issues = []
+
+    # Check for deprecated imports
+    deprecated_imports = {
+        'StringIO': 'io.StringIO',
+        'cStringIO': 'io.StringIO'
+    }
+
+    lines = content.split('\n')
+    for line_num, line in enumerate(lines, 1):
+        for old_import, new_import in deprecated_imports.items():
+            if f"import {old_import}" in line or f"from {old_import}" in line:
+                issue = CodeIssue(
+                    id=f"deprecated_import_{line_num}",
+                    category=TrustCategory.TIMELINESS,
+                    severity="low",
+                    issue_type="import_issue",
+                    title="Deprecated Import",
+                    description=f"Using deprecated import '{old_import}', should use '{new_import}'",
+                    file_path=file_path,
+                    line_number=line_num,
+                    column_number=line.find(old_import),
+                    code_snippet=line.strip(),
+                    suggested_fix=f"Replace '{old_import}' with '{new_import}'",
+                    confidence=0.9,
+                    rule_violated="DEPRECATED_IMPORT",
+                    auto_fixable=True
+                )
+                issues.append(issue)
+
+    return issues
+```
+
+Timeliness Indicators:
+- Deprecated import detection
+- Performance anti-pattern identification
+- Modern Python features adoption
+- Standards compliance checking
+- Technology currency validation
+
+---
+
+## Score Calculation
+
+### Category Score Algorithm
+
+```python
+def _calculate_trust_scores(self, issues: List[CodeIssue], metrics: Dict[str, Any]) -> Dict[str, Any]:
+    """Calculate TRUST 5 scores."""
+    category_scores = {}
+    category_weights = {
+        TrustCategory.TRUTHFULNESS: 0.25,
+        TrustCategory.RELEVANCE: 0.20,
+        TrustCategory.USABILITY: 0.25,
+        TrustCategory.SAFETY: 0.20,
+        TrustCategory.TIMELINESS: 0.10
+    }
+
+    # Group issues by category
+    issues_by_category = {category: [] for category in TrustCategory}
+    for issue in issues:
+        issues_by_category[issue.category].append(issue)
+
+    # Calculate scores for each category
+    for category in TrustCategory:
+        category_issues = issues_by_category[category]
+
+        # Calculate penalty based on severity and number of issues
+        penalty = 0.0
+        for issue in category_issues:
+            severity_penalty = {
+                'critical': 0.5,
+                'high': 0.3,
+                'medium': 0.1,
+                'low': 0.05,
+                'info': 0.01
+            }
+            penalty += severity_penalty.get(issue.severity, 0.1) * issue.confidence
+
+        # Apply penalties (max penalty of 1.0)
+        score = max(0.0, 1.0 - min(penalty, 1.0))
+        category_scores[category] = score
+
+    # Calculate overall score
+    overall_score = sum(
+        category_scores[cat] * category_weights[cat]
+        for cat in TrustCategory
+    )
+
+    return {
+        'overall': overall_score,
+        'categories': category_scores
+    }
+```
+
+### Score Interpretation
+
+0.9 - 1.0: Excellent quality, minimal issues
+0.8 - 0.9: Good quality, some minor issues
+0.7 - 0.8: Acceptable quality, moderate issues
+0.6 - 0.7: Needs improvement, significant issues
+0.0 - 0.6: Poor quality, critical issues present
+
+---
+
+## Advanced Customization
+
+### Custom Category Weights
+
+Adjust category weights to match project priorities:
+
+```python
+reviewer.category_weights = {
+    TrustCategory.TRUTHFULNESS: 0.30,  # Increase emphasis on correctness
+    TrustCategory.RELEVANCE: 0.15,
+    TrustCategory.USABILITY: 0.20,
+    TrustCategory.SAFETY: 0.30,        # Increase emphasis on security
+    TrustCategory.TIMELINESS: 0.05
+}
+```
+
+### Custom Severity Penalties
+
+Modify penalty values for severity levels:
+
+```python
+reviewer.severity_penalties = {
+    'critical': 0.7,  # Stricter penalties
+    'high': 0.4,
+    'medium': 0.15,
+    'low': 0.05,
+    'info': 0.0
+}
+```
+
+### Custom Rule Configuration
+
+Add custom validation rules:
+
+```python
+class CustomTruthfulnessAnalyzer:
+    """Custom truthfulness validation rules."""
+
+    def analyze_custom_patterns(self, file_path: str, tree: ast.AST) -> List[CodeIssue]:
+        """Add project-specific truthfulness checks."""
+        issues = []
+
+        # Add custom logic validation
+        # Add project-specific correctness checks
+        # Add domain-specific validation rules
+
+        return issues
+
+# Integrate custom analyzer
+reviewer.custom_analyzers[TrustCategory.TRUTHFULNESS] = CustomTruthfulnessAnalyzer()
+```
+
+---
+
+## Best Practices
+
+1. Category Balance: Maintain balanced category weights appropriate for project context
+2. Severity Calibration: Adjust severity penalties to match team quality standards
+3. Custom Rules: Add project-specific validation rules for domain-specific concerns
+4. Regular Updates: Update validation patterns to reflect evolving best practices
+5. Team Alignment: Ensure category weights align with team priorities and project goals
+6. Consistent Application: Apply TRUST 5 validation consistently across entire codebase
+7. Actionable Feedback: Provide clear, implementable suggestions for each issue detected
+8. Progressive Enhancement: Start with basic validation, progressively add advanced rules
+
+---
+
+## Related Modules
+
+- [Security Analysis](./security-analysis.md): Detailed security vulnerability detection
+- [Quality Metrics](./quality-metrics.md): Code quality and complexity analysis
+- [automated-code-review/trust5-framework.md](./automated-code-review/trust5-framework.md): Deep dive into TRUST 5 methodology
+
+---
+
+Version: 1.0.0
+Last Updated: 2026-01-06
+Module: `modules/trust5-validation.md`

moai_adk/templates/.claude/skills/moai-workflow-worktree/SKILL.md

@@ -0,0 +1,228 @@
+---
+name: "moai-workflow-worktree"
+description: "Git worktree management for parallel SPEC development with isolated workspaces, automatic registration, and seamless MoAI-ADK integration"
+version: 1.1.0
+category: "workflow"
+modularized: true
+user-invocable: false
+tags: ['git', 'worktree', 'parallel', 'development', 'spec', 'isolation']
+updated: 2026-01-08
+status: "active"
+allowed-tools:
+  - Read
+  - Write
+  - Grep
+  - Glob
+  - mcp__context7__resolve-library-id
+  - mcp__context7__get-library-docs
+---
+
+# MoAI Worktree Management
+
+Git worktree management system for parallel SPEC development with isolated workspaces, automatic registration, and seamless MoAI-ADK integration.
+
+Core Philosophy: Each SPEC deserves its own isolated workspace to enable true parallel development without context switching overhead.
+
+## Quick Reference (30 seconds)
+
+What is MoAI Worktree Management?
+A specialized Git worktree system that creates isolated development environments for each SPEC, enabling parallel development without conflicts.
+
+Key Features:
+- Isolated Workspaces: Each SPEC gets its own worktree with independent Git state
+- Automatic Registration: Worktree registry tracks all active workspaces
+- Parallel Development: Multiple SPECs can be developed simultaneously
+- Seamless Integration: Works with /moai:1-plan, /moai:2-run, /moai:3-sync workflow
+- Smart Synchronization: Automatic sync with base branch when needed
+- Cleanup Automation: Automatic cleanup of merged worktrees
+
+Quick Access:
+- CLI commands: Refer to Worktree Commands Module at modules/worktree-commands.md
+- Management patterns: Refer to Worktree Management Module at modules/worktree-management.md
+- Parallel workflow: Refer to Parallel Development Module at modules/parallel-development.md
+- Integration guide: Refer to Integration Patterns Module at modules/integration-patterns.md
+- Troubleshooting: Refer to Troubleshooting Module at modules/troubleshooting.md
+
+Use Cases:
+- Multiple SPECs development in parallel
+- Isolated testing environments
+- Feature branch isolation
+- Code review workflows
+- Experimental feature development
+
+---
+
+## Implementation Guide (5 minutes)
+
+### 1. Core Architecture - Worktree Management System
+
+Purpose: Create isolated Git worktrees for parallel SPEC development.
+
+Key Components:
+
+1. Worktree Registry - Central registry tracking all worktrees
+2. Manager Layer - Core worktree operations including create, switch, remove, and sync
+3. CLI Interface - User-friendly command interface
+4. Models - Data structures for worktree metadata
+5. Integration Layer - MoAI-ADK workflow integration
+
+Registry Structure:
+
+The registry file stores worktree metadata in JSON format. Each worktree entry contains an identifier, file path, branch name, creation timestamp, last sync time, status (active or merged), and base branch reference. The config section defines the worktree root directory, auto-sync preference, and cleanup behavior for merged branches.
+
+File Structure:
+
+The worktree system creates a dedicated directory structure. At the worktree root (typically ~/worktrees/ProjectName/), you will find the central registry JSON file and individual directories for each SPEC. Each SPEC directory contains a .git file for worktree metadata and a complete copy of all project files.
+
+Detailed Reference: Refer to Worktree Management Module at modules/worktree-management.md
+
+---
+
+### 2. CLI Commands - Complete Command Interface
+
+Purpose: Provide intuitive CLI commands for worktree management.
+
+Core Commands:
+
+To create a new worktree for a SPEC, use the new command followed by the SPEC ID and description. To list all worktrees, use the list command. To switch to a specific worktree, use the switch command with the SPEC ID. To get the worktree path for shell integration, use the go command with eval. To sync a worktree with its base branch, use the sync command. To remove a worktree, use the remove command. To clean up merged worktrees, use the clean command. To show worktree status, use the status command. For configuration management, use the config command with get or set subcommands.
+
+Command Categories:
+
+1. Creation: The new command creates an isolated worktree
+2. Navigation: The list, switch, and go commands enable browsing and navigating
+3. Management: The sync, remove, and clean commands maintain worktrees
+4. Status: The status command checks worktree state
+5. Configuration: The config command manages settings
+
+Shell Integration:
+
+For switching to a worktree directory, two approaches work well. The switch command directly changes to the worktree directory. The go command outputs a cd command that can be evaluated by the shell, which is the recommended pattern for shell scripts and automation.
+
+Detailed Reference: Refer to Worktree Commands Module at modules/worktree-commands.md
+
+---
+
+### 3. Parallel Development Workflow - Isolated SPEC Development
+
+Purpose: Enable true parallel development without context switching.
+
+Workflow Integration:
+
+During the Plan Phase using /moai:1-plan, the SPEC is created and the worktree new command sets up automatic worktree isolation.
+
+During the Development Phase, the isolated worktree environment provides independent Git state with zero context switching overhead.
+
+During the Sync Phase using /moai:3-sync, the worktree sync command ensures clean integration with conflict resolution support.
+
+During the Cleanup Phase, the worktree clean command provides automatic cleanup with registry maintenance.
+
+Parallel Development Benefits:
+
+1. Context Isolation: Each SPEC has its own Git state, files, and environment
+2. Zero Switching Cost: Instant switching between worktrees
+3. Independent Development: Work on multiple SPECs simultaneously
+4. Safe Experimentation: Isolated environment for experimental features
+5. Clean Integration: Automatic sync and conflict resolution
+
+Example Workflow:
+
+First, create a worktree for SPEC-001 with a description like "User Authentication" and switch to that directory. Then run /moai:2-run SPEC-001 to develop in isolation. Next, navigate back to the main repository and create another worktree for SPEC-002 with description "Payment Integration". Switch to that worktree and run /moai:2-run SPEC-002 for parallel development. When needed, switch between worktrees and continue development. Finally, sync both worktrees when ready for integration.
+
+Detailed Reference: Refer to Parallel Development Module at modules/parallel-development.md
+
+---
+
+### 4. Integration Patterns - MoAI-ADK Workflow Integration
+
+Purpose: Seamless integration with MoAI-ADK Plan-Run-Sync workflow.
+
+Integration Points:
+
+During Plan Phase Integration with /moai:1-plan, after SPEC creation, create the worktree using the new command with the SPEC ID. The output provides guidance for switching to the worktree using either the switch command or the shell eval pattern with the go command.
+
+During Development Phase with /moai:2-run, worktree isolation provides a clean development environment with independent Git state preventing conflicts and automatic registry tracking.
+
+During Sync Phase with /moai:3-sync, before PR creation run the sync command for the SPEC. After PR merge, run the clean command with the merged-only flag to remove completed worktrees.
+
+Auto-Detection Patterns:
+
+The system detects worktree environments by checking for the registry file in the parent directory. When detected, the SPEC ID is extracted from the current directory name. The status command with sync-check option automatically identifies worktrees that need synchronization.
+
+Configuration Integration:
+
+The MoAI configuration supports worktree settings including auto_create for automatic worktree creation, auto_sync for automatic synchronization, cleanup_merged for automatic cleanup of merged branches, and worktree_root for specifying the worktree directory location with project name substitution.
+
+Detailed Reference: Refer to Integration Patterns Module at modules/integration-patterns.md
+
+---
+
+## Advanced Implementation (10+ minutes)
+
+### Multi-Developer Worktree Coordination
+
+Shared Worktree Registry:
+
+Configure team worktree settings by setting the registry type to team mode and specifying a shared registry path accessible to all team members. For developer-specific worktrees within the shared environment, use the developer flag when creating worktrees to prefix entries with the developer name. The list command with all-developers flag shows worktrees from all team members, and the status command with team-overview provides a consolidated team view.
+
+### Advanced Synchronization Strategies
+
+Selective Sync Patterns:
+
+The sync command supports selective synchronization with include and exclude patterns to sync only specific directories or files. For conflict resolution, choose between auto-resolve for simple conflicts, interactive resolution for manual conflict handling, or abort to cancel the sync operation.
+
+### Worktree Templates and Presets
+
+Custom Worktree Templates:
+
+Create worktrees with specific setups using the template flag. A frontend template might include npm install and eslint setup with pre-commit hooks. A backend template might include virtual environment creation, activation, and dependency installation. Configure custom templates through the config command by setting template-specific setup commands.
+
+### Performance Optimization
+
+Optimized Worktree Operations:
+
+For faster worktree creation, use the shallow flag with a depth value for shallow clones. The background flag enables background synchronization. The parallel flag with all option enables parallel operations across all worktrees. Enable caching through configuration with cache enable and cache TTL settings for faster repeated operations.
+
+---
+
+## Works Well With
+
+Commands:
+- moai:1-plan - SPEC creation with automatic worktree setup
+- moai:2-run - Development in isolated worktree environment
+- moai:3-sync - Integration with automatic worktree sync
+- moai:9-feedback - Worktree workflow improvements
+
+Skills:
+- moai-foundation-core - Parallel development patterns
+- moai-workflow-project - Project management integration
+- moai-workflow-spec - SPEC-driven development
+- moai-git-strategy - Git workflow optimization
+
+Tools:
+- Git worktree - Native Git worktree functionality
+- Rich CLI - Formatted terminal output
+- Click framework - Command-line interface framework
+
+---
+
+## Quick Decision Guide
+
+For new SPEC development, use the worktree isolation pattern with auto-setup. The primary approach is worktree isolation and the supporting pattern is integration with /moai:1-plan.
+
+For parallel development across multiple SPECs, use multiple worktrees with shell integration. The primary approach is maintaining multiple worktrees and the supporting pattern is fast switching between them.
+
+For team coordination in shared environments, use shared registry with developer prefixes. The primary approach is the shared registry pattern and the supporting pattern is conflict resolution.
+
+For code review workflows, use isolated review worktrees. The primary approach is worktree isolation for reviews and the supporting pattern is clean sync after review completion.
+
+For experimental features, use temporary worktrees with auto-cleanup. The primary approach is creating temporary worktrees and the supporting pattern is safe experimentation with automatic removal.
+
+Module Deep Dives:
+- Worktree Commands: Refer to modules/worktree-commands.md for complete CLI reference
+- Worktree Management: Refer to modules/worktree-management.md for core architecture
+- Parallel Development: Refer to modules/parallel-development.md for workflow patterns
+- Integration Patterns: Refer to modules/integration-patterns.md for MoAI-ADK integration
+- Troubleshooting: Refer to modules/troubleshooting.md for problem resolution
+
+Full Examples: Refer to examples.md
+External Resources: Refer to reference.md