ailabs/puaros
1
0
Fork 0
mirror of https://github.com/samiyev/puaros.git synced 2025-12-27 23:06:54 +05:00
Code Issues Packages Projects Releases Wiki Activity

docs: finalize v0.1.0 documentation with framework leak detection

Browse Source 
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:
imfozilbek
2025-11-24 12:54:48 +05:00
parent 0b7c8796ad
commit 32f5d8dbc5
5 changed files with 70 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
packages/guardian/CHANGELOG.md
View File

@@ -59,6 +59,15 @@ Code quality guardian for vibe coders and enterprise teams - your AI coding comp
- Layer detection from file paths
- Import statement analysis
- 🔌 **Framework Leak Detection**
- Detects framework-specific imports in domain layer
- Identifies coupling between domain and infrastructure concerns
- Checks for HTTP framework leaks (Express, Fastify, Koa, Hapi, NestJS)
- Checks for ORM/Database leaks (Prisma, TypeORM, Sequelize, Mongoose, Drizzle)
- Checks for external service leaks (AWS SDK, Firebase, Stripe, Twilio)
- Reports violations with framework type and suggested fixes
- Helps maintain clean domain boundaries
#### CLI Interface
- 🛠️ **Command-line tool** (`guardian` command)
@@ -98,12 +107,12 @@ Code quality guardian for vibe coders and enterprise teams - your AI coding comp
#### Examples & Documentation
- 📚 **Comprehensive examples** (36 files)
- 📚 **Comprehensive examples** (38 files)
- **Good Architecture** (29 files): Complete DDD/Clean Architecture patterns
- Domain: Aggregates, Entities, Value Objects, Events, Services, Factories, Specifications
- Application: Use Cases, DTOs, Mappers
- Infrastructure: Repositories, Controllers
- **Bad Architecture** (7 files): Anti-patterns to avoid
- **Bad Architecture** (9 files): Anti-patterns to avoid
- Hardcoded values, Circular dependencies, Framework leaks, Entity exposure, Naming violations
- All examples fully documented with explanations
- Can be used as templates for new projects
@@ -111,7 +120,7 @@ Code quality guardian for vibe coders and enterprise teams - your AI coding comp
#### Testing & Quality
- ✅ **Comprehensive test suite**
- 159 tests across 6 test files
- 194 tests across 7 test files
- All tests passing
- 80%+ code coverage on all metrics
- Test fixtures for various scenarios
@@ -183,7 +192,6 @@ Code quality guardian for vibe coders and enterprise teams - your AI coding comp
## Future Releases
Planned features for upcoming versions:
- Framework leaks detection (domain importing from infrastructure)
- Entity exposure detection (domain entities in presentation layer)
- Configuration file support (.guardianrc)
- Custom rule definitions