feat: 🎉 prepare for major version release with service architecture

tecnomanu · tecnomanu · commit 3bba84ed3ad7 · 2025-05-07T17:57:55.000-03:00
BREAKING CHANGE: Complete refactoring from helper-based to service-based architecture. Service files are now in cli/services/ instead of cli/utils/
diff --git a/.cursor/rules/07-commit-conventions.mdc b/.cursor/rules/07-commit-conventions.mdc
@@ -0,0 +1,88 @@
+---
+description: 
+globs: 
+alwaysApply: false
+---
+# Commit Conventions
+
+This document outlines the commit conventions used in the Agent Rules Kit project. We use **semantic-release** for automated versioning and CHANGELOG generation.
+
+## Language
+
+**All commits must be written in English**, regardless of your native language. This ensures consistency throughout the project, as all code, documentation, and rules are maintained in English.
+
+## Commit Format
+
+We follow the [Conventional Commits](mdc:https:/www.conventionalcommits.org) specification with emojis:
+
+```
+<emoji> <type>[(scope)]!: <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+## Emojis and Types
+
+Always include an appropriate emoji as the first character of your commit message, followed by the type.
+
+### Versioning Commits (affect semver)
+
+When your changes affect the semantic versioning of the package, use these types:
+
+| Emoji | Type | Description | Versioning Impact |
+|-------|------|-------------|------------------|
+| ✨ | feat | New feature | MINOR |
+| 🐛 | fix | Bug fix | PATCH |
+| 🎉 | feat! or fix! | Breaking change (with exclamation mark) | MAJOR |
+
+For major version bumps (BREAKING CHANGES), you MUST:
+1. Add an exclamation mark `!` before the colon
+2. Include a `BREAKING CHANGE:` section in the footer
+
+Example:
+```
+🎉 feat!: redesign user authentication system
+
+Complete overhaul of authentication flow and API
+
+BREAKING CHANGE: The auth token format has changed and all clients will need to be updated
+```
+
+### Non-versioning Commits
+
+For changes that don't affect the version number:
+
+| Emoji | Type | Description |
+|-------|------|-------------|
+| 📝 | docs | Documentation changes |
+| 🔧 | chore | Maintenance tasks |
+| ♻️ | refactor | Code changes that neither fix bugs nor add features |
+| 🎨 | style | Code style/formatting changes |
+| ⚡️ | perf | Performance improvements |
+| ✅ | test | Adding or correcting tests |
+| 🔨 | build | Build system changes |
+| 🚀 | ci | CI configuration changes |
+
+Example:
+```
+📝 docs: update README with new architecture documentation
+```
+
+## Best Practices
+
+1. Keep the first line (subject) under 72 characters
+2. Use the imperative mood ("add" not "added" or "adds")
+3. Don't capitalize the first letter after the type
+4. No period at the end of the subject line
+5. Separate subject from body with a blank line
+6. Use the body to explain what and why vs. how
+
+## Branch Naming
+
+Follow a similar convention for branch names:
+- `feature/short-description` - For new features
+- `fix/issue-description` - For bug fixes
+- `docs/update-area` - For documentation updates
+- `refactor/component-name` - For refactoring
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Agent Rules Kit
+# Agent Rules Kit v1.0
 
 <p align="center">
   <img src="assets/banner_agent_rules_kit.jpg" alt="Agent Rules Kit Logo" width="729" />
@@ -10,13 +10,26 @@
 
 Agent Rules Kit is a CLI tool that facilitates the installation and configuration of rules for Cursor AI, the AI-powered IDE. The rules help AI agents better understand the structure, patterns, and best practices of different technology stacks.
 
-## Main Features
+## 🎉 New Architecture
+
+We've completely redesigned the internal architecture to provide a more maintainable and extensible system:
+
+-   **Service-Based Architecture**: Replaced the helper-based system with a clean service-oriented architecture
+-   **Automatic Backups**: Automatically creates backups of existing rules before overwriting
+-   **Enhanced Debug Mode**: Better visibility into the rule generation process
+-   **Improved Testing Framework**: More robust testing with better mocking
+-   **React Architecture Options**: Now includes support for atomic design and feature-sliced design
+-   **Better State Management Support**: Enhanced support for various state management libraries
+
+## 🎉 New Features in Version 1.0
 
 -   🚀 Quick setup of rules for different frameworks and stacks
 -   🔍 Automatic framework version detection
 -   🏗️ Support for multiple architectural styles
 -   📚 Mirror documentation generation for human reference
 -   🧩 Modular system for easy expansion to new frameworks
+-   💾 Automatic backups of existing rules
+-   🔄 Version-specific rule overlays
 
 ## Supported Stacks
 
@@ -40,7 +53,7 @@ Agent Rules Kit is a CLI tool that facilitates the installation and configuratio
 | <img src="https://img.shields.io/badge/Next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white" alt="Next.js" width="100"/> | ![80%](https://progress-bar.dev/80) | App & Pages router support, version detection, testing docs |
 | <img src="https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white" alt="Angular" width="100"/>   | ![55%](https://progress-bar.dev/55) | Signals support, base project structure                     |
 | <img src="https://img.shields.io/badge/NestJS-E0234E?style=for-the-badge&logo=nestjs&logoColor=white" alt="NestJS" width="100"/>      | ![45%](https://progress-bar.dev/45) | Base project structure, patterns documentation              |
-| <img src="https://img.shields.io/badge/React-61DAFB?style=for-the-badge&logo=react&logoColor=black" alt="React" width="100"/>         | ![65%](https://progress-bar.dev/65) | Architecture options, state management, testing guidelines  |
+| <img src="https://img.shields.io/badge/React-61DAFB?style=for-the-badge&logo=react&logoColor=black" alt="React" width="100"/>         | ![80%](https://progress-bar.dev/80) | Architecture options, state management, testing guidelines  |
 | <img src="https://img.shields.io/badge/Vue-4FC08D?style=for-the-badge&logo=vue.js&logoColor=white" alt="Vue" width="100"/>            | ![45%](https://progress-bar.dev/45) | Testing guidelines, architecture concepts                   |
 | <img src="https://img.shields.io/badge/Nuxt-00DC82?style=for-the-badge&logo=nuxt.js&logoColor=white" alt="Nuxt" width="100"/>         | ![40%](https://progress-bar.dev/40) | Testing guidelines, architecture concepts                   |
 | <img src="https://img.shields.io/badge/Astro-0D0D0D?style=for-the-badge&logo=astro&logoColor=white" alt="Astro" width="100"/>         | ![20%](https://progress-bar.dev/20) | Basic configuration                                         |
@@ -75,8 +88,8 @@ agent-rules-kit
 ```bash
 git clone https://github.com/tecnomanu/agent-rules-kit.git
 cd agent-rules-kit
-npm install
-npm start
+pnpm install
+pnpm start
 ```
 
 ## Basic Usage
@@ -96,6 +109,7 @@ Follow the interactive instructions to select the stack, architecture, and other
 -   **Cursor Directory**: Specify the location of the Cursor directory
 -   **Project Path**: Define the relative path if the project is not in the root
 -   **Mirror Documentation**: Generate .md files that reflect the rules for human reference
+-   **Debug Mode**: Enable detailed logging for troubleshooting
 
 ### Supported Architectures
 
@@ -143,6 +157,25 @@ docs/
 └── [stack]/
 ```
 
+## Project Architecture
+
+The codebase is organized using a service-oriented architecture:
+
+```
+cli/
+├── index.js                # Entry point
+├── services/               # Services directory
+│   ├── base-service.js     # Base functionality for all services
+│   ├── cli-service.js      # CLI interface management
+│   ├── config-service.js   # Configuration management
+│   ├── file-service.js     # File operations
+│   ├── stack-service.js    # Common stack functionality
+│   ├── laravel-service.js  # Laravel-specific service
+│   ├── nextjs-service.js   # Next.js-specific service
+│   └── react-service.js    # React-specific service
+└── version-detector.js     # Framework version detection
+```
+
 ## Advanced Configuration
 
 ### Template Files
@@ -155,9 +188,11 @@ templates/
 └── stacks/
     ├── laravel/
     │   ├── base/        # Laravel base rules
-    │   ├── v8-9/        # Laravel 8-9 specific rules
-    │   ├── v10-11/      # Laravel 10-11 specific rules
-    │   └── v12/         # Laravel 12 specific rules
+    │   ├── architectures/
+    │   │   ├── standard/  # Standard architecture rules
+    │   │   ├── ddd/       # DDD architecture rules
+    │   │   └── hexagonal/ # Hexagonal architecture rules
+    │   └── v10-11/      # Laravel 10-11 specific rules
     ├── nextjs/
     │   └── ...
     └── ...
@@ -175,23 +210,24 @@ The main configuration is in `templates/kit-config.json`, where it defines:
 
 ### Prerequisites
 
--   Node.js 14+
--   npm or pnpm
+-   Node.js 16+
+-   pnpm (preferred) or npm
 
 ### Development Installation
 
 ```bash
 git clone https://github.com/tecnomanu/agent-rules-kit.git
 cd agent-rules-kit
-npm install
+pnpm install
 ```
 
 ### Available Commands
 
 ```bash
-npm start           # Run the CLI
-npm test            # Run tests
-npm run test -- --update  # Update snapshots
+pnpm start           # Run the CLI
+pnpm test            # Run tests
+pnpm run lint        # Lint code
+pnpm run test -- --update  # Update snapshots
 ```
 
 ## License
