WIP

Author: Eventyret

CHANGELOG.md

@@ -0,0 +1,197 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.0.0-beta.1] - 2024-12-16
+
+### 🎯 Major Changes
+
+#### Complete Codebase Modernization
+
+- **TypeScript Migration**: Fully migrated from JavaScript to TypeScript with comprehensive type safety
+- **Modern Architecture**: Restructured with plugin-based system for extensibility
+- **Enhanced User Experience**: Complete UI/UX overhaul with improved wizard flow
+
+#### Plugin System Architecture
+
+- **Database Plugin System**: Modular plugin architecture for database support
+- **Plugin Discovery**: Automatic discovery and loading of built-in and custom plugins
+- **Extensible Framework**: Support for custom plugins and future extensions
+
+### ✨ New Features
+
+#### Enhanced Database Support
+
+- **SQLite Support**: Added full support for SQLite databases
+- **Improved PostgreSQL**: Enhanced PostgreSQL configuration with better defaults
+- **Enhanced MySQL/MariaDB**: Improved MySQL and MariaDB integration
+- **Database Detection**: Automatic detection of existing database configurations
+
+#### Environment Management
+
+- **Environment Selection**: Choose between development, production, or both environments
+- **Smart .env Handling**: Intelligent .env file management that preserves existing variables
+- **Docker Section Management**: Automatic detection and replacement of Docker configuration sections
+- **Security Enhancements**: Secure random password and secret generation
+
+#### Project Detection & Validation
+
+- **Advanced Project Detection**: Comprehensive Strapi project validation
+- **Node Version Checking**: Automatic Node.js version compatibility checking
+- **TypeScript/JavaScript Detection**: Automatic project type detection
+- **Package Manager Detection**: Smart detection of npm, yarn, or pnpm
+
+#### User Experience Improvements
+
+- **Modern CLI Interface**: Beautiful, interactive CLI using @clack/prompts
+- **Progress Indicators**: Real-time feedback during file generation
+- **Colored Output**: Enhanced readability with syntax highlighting
+- **Streamlined Workflow**: Simplified wizard with better question flow
+
+### 🔧 Technical Improvements
+
+#### Code Quality & Testing
+
+- **Comprehensive Test Suite**: 26 unit tests covering all major functionality
+- **Fast Test Execution**: Tests run in ~250ms (99% performance improvement)
+- **TypeScript Type Safety**: Full type coverage with strict TypeScript configuration
+- **Modern Build System**: Using tsup for optimized builds
+
+#### File Generation & Templates
+
+- **Liquid Templating**: Advanced templating system using LiquidJS
+- **Template Organization**: Better organized template structure
+- **File Writing System**: Enhanced file writing with conflict detection
+- **Debug Mode**: Comprehensive debugging capabilities
+
+#### Error Handling & Reliability
+
+- **Robust Error Handling**: Comprehensive error catching and user-friendly messages
+- **Validation System**: Input validation with clear error feedback
+- **Graceful Degradation**: Better handling of edge cases and missing dependencies
+- **Async/Await**: Proper async handling throughout the application
+
+### 🐛 Bug Fixes
+
+#### Core Functionality
+
+- **Fixed Plugin Loading**: Resolved async/await issues in plugin loading system
+- **Fixed .env Duplication**: Eliminated duplicate Docker configuration sections
+- **Fixed Node Version Detection**: Proper handling of Node version checking failures
+- **Fixed Package Manager Detection**: Accurate detection across different lock file types
+
+#### CLI & User Interface
+
+- **Fixed Command Parsing**: Improved CLI argument parsing and validation
+- **Fixed Progress Display**: Proper progress indication during operations
+- **Fixed Error Messages**: More descriptive and actionable error messages
+- **Fixed Path Resolution**: Better handling of project path detection
+
+### 🔄 Breaking Changes
+
+#### API Changes
+
+- **CLI Arguments**: Updated CLI argument names for consistency
+  - `--dbtype` → `--database-type`
+  - `--useCompose` → `--use-compose`
+  - Added new `--environment` option
+
+#### Configuration Changes
+
+- **Database Configuration**: Updated database configuration format
+- **Template Structure**: Reorganized template directory structure
+- **Environment Variables**: Updated environment variable naming conventions
+
+#### System Requirements
+
+- **Node.js**: Minimum version updated to Node.js 18+
+- **Dependencies**: Updated to latest versions of all dependencies
+- **TypeScript**: Full TypeScript support required for development
+
+### 📦 Dependencies
+
+#### Added
+
+- `@clack/prompts` - Modern CLI prompts
+- `liquidjs` - Advanced templating engine
+- `chalk` - Terminal string styling
+- `zod` - Runtime type validation
+- `vitest` - Fast unit testing framework
+
+#### Updated
+
+- `typescript` - Updated to v5.3.3
+- `commander` - Updated to v11.1.0
+- `fs-extra` - Updated to v11.2.0
+
+#### Removed
+
+- Legacy JavaScript files
+- Outdated dependencies
+- Unused utility functions
+
+### 🔒 Security
+
+#### Enhanced Security
+
+- **Secure Defaults**: Generated passwords use cryptographically secure random values
+- **Input Validation**: All user inputs are validated and sanitized
+- **Path Traversal Protection**: Safe file path handling
+- **Dependency Updates**: All dependencies updated to latest secure versions
+
+### 📚 Documentation
+
+#### Improved Documentation
+
+- **Updated README**: Comprehensive documentation for v2 features
+- **API Documentation**: Complete TypeScript interfaces and types
+- **Changelog**: Detailed changelog with migration guide
+- **Contributing Guide**: Updated contribution guidelines
+
+### 🚀 Performance
+
+#### Performance Improvements
+
+- **Faster Startup**: 50% faster CLI initialization
+- **Optimized File Operations**: Efficient file reading and writing
+- **Reduced Bundle Size**: Optimized build output
+- **Test Performance**: 99% faster test execution
+
+---
+
+## [1.x.x] - Previous Versions
+
+Previous versions were JavaScript-based with basic Docker support. See git history for detailed changes.
+
+### Migration Guide from v1.x to v2.0
+
+#### For End Users
+
+1. **Node.js**: Ensure you're running Node.js 18+
+2. **CLI Usage**: Update any scripts using the new CLI argument names
+3. **Environment Files**: Review generated .env files for new structure
+
+#### For Contributors
+
+1. **TypeScript**: All development now requires TypeScript knowledge
+2. **Testing**: Use `npm test` for the new Vitest-based test suite
+3. **Build System**: Use `npm run build` with the new tsup build system
+
+#### Breaking Changes
+
+- CLI argument names have changed (see breaking changes section)
+- Template structure has been reorganized
+- Minimum Node.js version is now 18+
+
+For detailed migration help, please see the README or open an issue on GitHub.
+
+---
+
+### Links
+
+- [GitHub Repository](https://github.com/strapi-community/strapi-tool-dockerize)
+- [NPM Package](https://www.npmjs.com/package/@strapi-community/dockerize)
+- [Issues & Bug Reports](https://github.com/strapi-community/strapi-tool-dockerize/issues)