agent-rules-generator
Version:
Interactive CLI tool to generate .agent.md and .windsurfrules files for AI-assisted development
136 lines (108 loc) โข 6.22 kB
Markdown
# Changelog
All notable changes to this project will be documented in this file.
## [1.4.0] - 2024-08-12
### ๐ฏ Major Features Added
- **Modern Cursor MDC Support**: Added support for `.cursor/rules/` directory with modular `.mdc` files
- **Modular Rule Generation**: 5 specialized rule modules for better organization
- **Interactive Module Selection**: Choose which rule modules to generate
- **Path-Scoped Rules**: Context-aware rules for different parts of projects
### ๐ New Templates
- `cursor-coding-standards.mdc` - Language & formatting rules with path scoping
- `cursor-architecture.mdc` - Project structure & architectural patterns
- `cursor-testing.mdc` - Testing guidelines & framework-specific rules
- `cursor-deployment.mdc` - CI/CD & deployment best practices
- `cursor-security.mdc` - Security guidelines & language-specific practices
### ๐ง Enhanced CLI
- New format option: `.cursor/rules/ (Modern Cursor MDC)`
- Maintained backward compatibility with `.agent.md` and `.windsurfrules`
- Enhanced template variable support for new MDC format
- Improved file generation workflow with preview options
### ๐ Technical Improvements
- Added `generateCursorMDC()` function for MDC file generation
- Added `writeMDCFiles()` function for directory structure creation
- Enhanced template placeholder system with language-specific variables
- Added file extension detection based on programming language
### โ
Quality Assurance
- Full test coverage for MDC generation workflow
- Verified template placeholder substitution
- Tested directory structure creation
- Validated modular rule selection functionality
### ๐ Migration Notes
- Existing users can continue using `.agent.md` and `.windsurfrules` formats
- New `.cursor/rules/` format is optional and selectable during generation
- All templates support the same configuration variables
## [1.3.0] - 2024-12-19
### Added
- **Gemini CLI Integration**: Full support for configuring Gemini CLI to use `.agent.md` as context file
- **Multi-Platform Support**: Now supports Cursor AI ๐ต, Windsurf ๐, and Gemini CLI ๐
- **Interactive Gemini Configuration**: Local and global configuration options with status checking
- **Editor Integration**: Built-in editor support for manual configuration file editing
- **Comprehensive Testing**: Added 9 new tests for Gemini Manager functionality
- **Enhanced CLI Commands**: New `configure-gemini` command for CLI usage
- **Platform Icons**: Added visual indicators for supported AI platforms in documentation
### Enhanced
- **README Documentation**: Updated with supported platforms table and platform-specific features
- **Help System**: Extended help text to include Gemini configuration options
- **Configuration Management**: Automatic detection and validation of existing Gemini settings
- **Error Handling**: Graceful handling of file system errors and invalid configurations
### Technical
- **New Module**: `lib/gemini_manager.js` for Gemini CLI configuration management
- **Test Coverage**: Added `test/gemini_manager.test.js` with comprehensive test suite
- **Cross-Platform**: Support for Windows, macOS, and Linux editor detection
- **File System Safety**: Robust directory creation and configuration file management
## [1.2.2] - 2024-12-07
### Fixed
- โ
**Test Suite Improvements**: Fixed scraper integration test with correct file paths and modular architecture detection
- โ
**Bun Test Integration**: Updated package.json to use Bun test runner instead of Jest for better performance
- โ
**GitHub Actions Tests**: Fixed deployment workflow test assertions to match actual configuration
- โ
**Path Resolution**: Corrected all test file path issues for proper cross-platform compatibility
### Changed
- ๐ **Test Runner**: Migrated from Jest to Bun test for faster test execution (181 tests now passing)
- ๐ **Test Architecture**: Updated test documentation to reflect Bun-based testing approach
- ๐ **Integration Tests**: Improved Windsurf scraper integration test accuracy and reliability
### Technical Details
- Fixed `test/scraper_integrate_test.js` path resolution issues
- Updated `test/deployment.test.js` to match actual GitHub Actions workflow
- Corrected `test/test_windsurf_cli_complete.js` module import paths
- All 181 tests now pass with 0 failures across 9 test suites
## [1.2.1] - 2024-12-06
### Added
- ๐ **Windsurf Integration**: Complete Windsurf recipe scraping and caching system
- ๐ **Recipe Management**: Advanced recipe download, validation, and management
- ๐ง **Modular Architecture**: Refactored CLI into specialized manager classes
- ๐งช **Comprehensive Testing**: 181 tests covering all major functionality
### Features
- Windsurf recipe scraping with intelligent caching
- Recipe validation with auto-fix capabilities
- Multi-format support (JSON/YAML) for recipes
- Enhanced project type detection and configuration
- Improved deployment pipeline with automated testing
## [1.2.0] - 2024-12-05
### Added
- ๐ฏ **Project Type System**: Support for 6 project types with conditional question flows
- ๐ฆ **Recipe System**: Pre-built templates for common technology stacks
- ๐ง **Enhanced CLI**: Improved user experience with better navigation
- ๐ **Template System**: Advanced template generation with technology-specific guidelines
### Changed
- Refactored CLI architecture for better maintainability
- Improved error handling and user feedback
- Enhanced documentation and testing coverage
## [1.1.0] - 2024-12-04
### Added
- ๐ **Multi-Platform Support**: Both Cursor AI (.agent.md) and Windsurf (.windsurfrules)
- ๐จ **Interactive CLI**: Guided setup process for configuration
- ๐ **Template Generation**: Automated file generation with best practices
### Features
- Interactive project configuration
- Technology stack detection
- Coding standards setup
- Project structure definition
## [1.0.0] - 2024-12-03
### Added
- ๐ **Initial Release**: Basic agent rules generation
- ๐ **File Generation**: Support for .agent.md files
- ๐ง **CLI Interface**: Command-line tool for rule generation
### Features
- Basic project configuration
- Simple template system
- File output generation