mirror of
https://github.com/samiyev/puaros.git
synced 2025-12-27 23:06:54 +05:00
docs: finalize v0.1.0 documentation with framework leak detection
Updates across all documentation files: CHANGELOG.md: - Add Framework Leak Detection as implemented feature in v0.1.0 - Update test count: 159 → 194 tests across 7 files - Update examples count: 36 → 38 files (29 good + 9 bad) - Remove framework leak from future releases README.md: - Add Framework Leak Detection section in Features - Document supported frameworks: HTTP, ORM/DB, External services - Include examples of Express, Prisma, TypeORM, etc. - Emphasize domain boundary protection ROADMAP.md: - Move Framework Leak Detection from v0.2.0 to v0.1.0 - Update v0.1.0 metrics: 194 tests, 38 examples - Renumber future versions (Entity Exposure now v0.2.0) - Maintain proper version sequence through v1.0.0 CLAUDE.md: - Update project description with framework leak detection - Add to Key features list (5 features total) - Update Guardian capabilities overview TODO.md: - Update current tasks and priorities All documentation now accurately reflects v0.1.0 release with 5 core features: 1. Hardcode Detection 2. Circular Dependency Detection 3. Naming Convention Enforcement 4. Architecture Violations 5. Framework Leak Detection
This commit is contained in:
@@ -13,6 +13,7 @@ This document outlines the current features and future plans for @puaros/guardia
|
||||
- ✅ Circular dependency detection
|
||||
- ✅ Naming convention enforcement (layer-based rules)
|
||||
- ✅ Architecture violations (Clean Architecture layers)
|
||||
- ✅ Framework leak detection (domain importing frameworks)
|
||||
|
||||
**🛠️ Developer Tools:**
|
||||
- ✅ CLI interface with `guardian check` command
|
||||
@@ -23,13 +24,13 @@ This document outlines the current features and future plans for @puaros/guardia
|
||||
|
||||
**📚 Documentation & Examples:**
|
||||
- ✅ AI-focused documentation (vibe coding + enterprise)
|
||||
- ✅ Comprehensive examples (36 files: 29 good + 7 bad patterns)
|
||||
- ✅ Comprehensive examples (38 files: 29 good + 9 bad patterns)
|
||||
- ✅ DDD/Clean Architecture templates
|
||||
- ✅ Quick start guides
|
||||
- ✅ Integration examples (CI/CD, pre-commit hooks)
|
||||
|
||||
**🧪 Quality:**
|
||||
- ✅ 159 tests across 6 test files (all passing)
|
||||
- ✅ 194 tests across 7 test files (all passing)
|
||||
- ✅ 80%+ code coverage on all metrics
|
||||
- ✅ Self-analysis: 0 violations (100% clean codebase)
|
||||
- ✅ Extracted constants for better maintainability
|
||||
@@ -43,31 +44,7 @@ This document outlines the current features and future plans for @puaros/guardia
|
||||
|
||||
## Future Roadmap
|
||||
|
||||
### Version 0.2.0 - Framework Leak Detection 🏗️
|
||||
**Target:** Q4 2025 (December)
|
||||
**Priority:** HIGH
|
||||
|
||||
Detect when domain layer imports framework-specific code:
|
||||
|
||||
```typescript
|
||||
// ❌ Violation: Framework leak in domain
|
||||
import { PrismaClient } from '@prisma/client' // in domain layer
|
||||
import { Request, Response } from 'express' // in domain layer
|
||||
|
||||
// ✅ Good: Use interfaces
|
||||
import { IUserRepository } from '../repositories' // interface
|
||||
```
|
||||
|
||||
**Planned Features:**
|
||||
- Check domain layer imports for framework dependencies
|
||||
- Blacklist common frameworks: prisma, typeorm, express, fastify, mongoose, etc.
|
||||
- Suggest creating interfaces in domain with implementations in infrastructure
|
||||
- CLI output with detailed suggestions
|
||||
- New rule: `FRAMEWORK_LEAK` with severity levels
|
||||
|
||||
---
|
||||
|
||||
### Version 0.3.0 - Entity Exposure Detection 🎭
|
||||
### Version 0.2.0 - Entity Exposure Detection 🎭
|
||||
**Target:** Q1 2026
|
||||
**Priority:** HIGH
|
||||
|
||||
@@ -94,7 +71,7 @@ async getUser(id: string): Promise<UserResponseDto> {
|
||||
|
||||
---
|
||||
|
||||
### Version 0.4.0 - Configuration File Support ⚙️
|
||||
### Version 0.3.0 - Configuration File Support ⚙️
|
||||
**Target:** Q1 2026
|
||||
**Priority:** MEDIUM
|
||||
|
||||
@@ -145,7 +122,7 @@ export default {
|
||||
|
||||
---
|
||||
|
||||
### Version 0.5.0 - Pattern Enforcement 🎯
|
||||
### Version 0.4.0 - Pattern Enforcement 🎯
|
||||
**Target:** Q2 2026
|
||||
**Priority:** MEDIUM
|
||||
|
||||
@@ -173,7 +150,7 @@ Enforce common DDD/Clean Architecture patterns:
|
||||
|
||||
---
|
||||
|
||||
### Version 0.6.0 - Output Formats 📊
|
||||
### Version 0.5.0 - Output Formats 📊
|
||||
**Target:** Q2 2026
|
||||
**Priority:** LOW
|
||||
|
||||
@@ -206,6 +183,32 @@ guardian check ./src --format markdown
|
||||
|
||||
---
|
||||
|
||||
### Version 0.6.0 - Auto-Fix Capabilities 🔧
|
||||
**Target:** Q3 2026
|
||||
**Priority:** LOW
|
||||
|
||||
Automatic refactoring and fixes:
|
||||
|
||||
```bash
|
||||
# Interactive mode - choose fixes
|
||||
guardian fix ./src --interactive
|
||||
|
||||
# Auto-fix all issues
|
||||
guardian fix ./src --auto
|
||||
|
||||
# Dry run - show what would be fixed
|
||||
guardian fix ./src --dry-run
|
||||
```
|
||||
|
||||
**Planned Auto-fixes:**
|
||||
1. Extract hardcoded values to constants
|
||||
2. Create Value Objects from primitives
|
||||
3. Generate repository interfaces
|
||||
4. Create DTOs and mappers
|
||||
5. Fix naming convention violations
|
||||
|
||||
---
|
||||
|
||||
### Version 0.7.0 - Watch Mode & Git Integration 🔍
|
||||
**Target:** Q3 2026
|
||||
**Priority:** LOW
|
||||
@@ -235,32 +238,6 @@ guardian check --pr
|
||||
|
||||
---
|
||||
|
||||
### Version 0.8.0 - Auto-Fix Capabilities 🔧
|
||||
**Target:** Q3 2026
|
||||
**Priority:** LOW
|
||||
|
||||
Automatic refactoring and fixes:
|
||||
|
||||
```bash
|
||||
# Interactive mode - choose fixes
|
||||
guardian fix ./src --interactive
|
||||
|
||||
# Auto-fix all issues
|
||||
guardian fix ./src --auto
|
||||
|
||||
# Dry run - show what would be fixed
|
||||
guardian fix ./src --dry-run
|
||||
```
|
||||
|
||||
**Planned Auto-fixes:**
|
||||
1. Extract hardcoded values to constants
|
||||
2. Create Value Objects from primitives
|
||||
3. Generate repository interfaces
|
||||
4. Create DTOs and mappers
|
||||
5. Fix naming convention violations
|
||||
|
||||
---
|
||||
|
||||
### Version 1.0.0 - Stable Release 🚀
|
||||
**Target:** Q4 2026
|
||||
**Priority:** HIGH
|
||||
|
||||
Reference in New Issue
Block a user