diff --git a/README.md b/README.md index bab357a..cb05c85 100644 --- a/README.md +++ b/README.md @@ -103,6 +103,20 @@ If upgrading from a prior version, Joomla will safely overwrite files - **Color Scheme**: Toggle light/dark defaults. - **Analytics/GTM**: Enable/disable optional expansions. +### Custom Color Palettes + +Moko-Cassiopeia supports custom color schemes for both light and dark modes: + +- **Standard**: Default Joomla Cassiopeia colors +- **Alternative**: Alternative color palette +- **Custom**: Create your own custom colors by adding `colors_custom.css` files + +To use custom colors: +1. Create `src/media/css/colors/light/colors_custom.css` for light mode +2. Create `src/media/css/colors/dark/colors_custom.css` for dark mode +3. Define your CSS variables in these files (see existing `colors_standard.css` for reference) +4. Select "Custom" in template settings under **Variables & Palettes** + ### Font Awesome 7 - Fully integrated into Joomla's asset manager. diff --git a/docs/JOOMLA_DEVELOPMENT.md b/docs/JOOMLA_DEVELOPMENT.md index b42431b..4c14bb4 100644 --- a/docs/JOOMLA_DEVELOPMENT.md +++ b/docs/JOOMLA_DEVELOPMENT.md @@ -41,16 +41,7 @@ All requirements are automatically installed in CI/CD pipelines. Package the Joomla template as a distributable ZIP file: ```bash -./scripts/release/package_extension.sh [output_dir] [version] -``` - -**Parameters:** -- `output_dir` (optional): Output directory for the ZIP file (default: `dist`) -- `version` (optional): Version string to use (default: extracted from manifest) - -**Example:** -```bash -./scripts/release/package_extension.sh dist 3.5.0 +make package ``` This creates a ZIP file in the `dist` directory with all necessary template files, excluding development files. @@ -246,7 +237,7 @@ phpcs --config-set installed_paths ~/.composer/vendor/phpcompatibility/php-compa 3. Run checks: ```bash # PHP syntax check -./scripts/validate/php_syntax.sh +make validate-required # CodeSniffer phpcs --standard=phpcs.xml src/ @@ -266,7 +257,7 @@ Use the package script to create a distribution: ```bash # Create package -./scripts/release/package_extension.sh dist 3.5.0 +make package # Upload to server scp dist/moko-cassiopeia-3.5.0-template.zip user@server:/path/to/joomla/ diff --git a/docs/QUICK_START.md b/docs/QUICK_START.md index 93b467b..6b63364 100644 --- a/docs/QUICK_START.md +++ b/docs/QUICK_START.md @@ -34,13 +34,7 @@ composer global require "phpcompatibility/php-compatibility:^9.0" composer global require codeception/codeception ``` -### 3. Install Git Hooks (Optional but Recommended) - -```bash -./scripts/git/install-hooks.sh -``` - -### 4. Validate Everything Works +### 3. Validate Everything Works ```bash # Quick validation @@ -111,9 +105,6 @@ make phpcompat # Package with auto-detected version make package -# Or specify directory and version -./scripts/release/package_extension.sh dist 03.05.00 - # Check package contents ls -lh dist/ unzip -l dist/moko-cassiopeia-*.zip @@ -157,13 +148,6 @@ moko-cassiopeia/ │ ├── media/ # Assets (CSS, JS, images) │ ├── language/ # Language files │ └── administrator/ # Admin files -├── scripts/ # Automation scripts -│ ├── validate/ # Validation scripts -│ ├── fix/ # Fix/update scripts -│ ├── release/ # Release scripts -│ ├── run/ # Execution scripts -│ ├── git/ # Git hooks -│ └── lib/ # Shared libraries ├── tests/ # Test suites ├── docs/ # Documentation ├── .github/workflows/ # CI/CD workflows @@ -177,7 +161,6 @@ moko-cassiopeia/ 1. **Read the Workflow Guide**: [docs/WORKFLOW_GUIDE.md](./WORKFLOW_GUIDE.md) 2. **Review Joomla Development**: [docs/JOOMLA_DEVELOPMENT.md](./JOOMLA_DEVELOPMENT.md) -3. **Check Scripts Documentation**: [scripts/README.md](../scripts/README.md) ### Creating Your First Feature @@ -234,10 +217,6 @@ Use the Release Pipeline workflow to promote between stages. ```bash make fix-permissions -# Or manually: -chmod +x scripts/**/*.sh -``` - ### PHPStan/PHPCS Not Found ```bash @@ -246,29 +225,12 @@ make install composer global require "squizlabs/php_codesniffer:^3.0" phpstan/phpstan ``` -### Pre-commit Hook Fails - -```bash -# Run manually to see details -./scripts/git/pre-commit.sh - -# Quick mode (skip some checks) -./scripts/git/pre-commit.sh --quick - -# Skip quality checks -./scripts/git/pre-commit.sh --skip-quality - -# Bypass hook (not recommended) -git commit --no-verify -``` - ### CI Workflow Fails 1. Check the workflow logs in GitHub Actions -2. Run the same checks locally: +2. Run validation locally: ```bash - ./scripts/validate/manifest.sh - ./scripts/validate/php_syntax.sh + make validate-required make quality ``` @@ -326,7 +288,6 @@ make test ```bash # Setup make dev-setup # Initial setup -./scripts/git/install-hooks.sh # Install hooks # Development make validate-required # Quick validation @@ -342,7 +303,6 @@ make fix-permissions # Fix script permissions # Help make help # Show all commands -./scripts/run/validate_all.sh --help # Script help ``` --- diff --git a/docs/WORKFLOW_GUIDE.md b/docs/WORKFLOW_GUIDE.md index 5465a11..ab690a8 100644 --- a/docs/WORKFLOW_GUIDE.md +++ b/docs/WORKFLOW_GUIDE.md @@ -244,8 +244,7 @@ git checkout dev/X.Y.Z vim src/templates/index.php # 4. Validate locally -./scripts/validate/php_syntax.sh -./scripts/validate/manifest.sh +make validate-required # 5. Commit and push git add -A @@ -257,23 +256,19 @@ git push origin dev/X.Y.Z ```bash # Run comprehensive validation suite -./scripts/run/validate_all.sh +make validate-required -# Run with verbose output -./scripts/run/validate_all.sh -v - -# Run smoke tests -./scripts/run/smoke_test.sh +# Run quality checks +make quality ``` ### Creating a Release Package ```bash # Package with auto-detected version -./scripts/release/package_extension.sh - -# Package with specific version -./scripts/release/package_extension.sh dist 03.05.00 +```bash +# Package with auto-detected version +make package # Verify package contents unzip -l dist/moko-cassiopeia-*.zip @@ -283,21 +278,12 @@ unzip -l dist/moko-cassiopeia-*.zip ```bash # Via GitHub Actions (recommended) -# Actions → Create version branch - -# Or manually with scripts -./scripts/fix/versions.sh 03.05.00 +# Actions → Release Management workflow ``` ### Updating CHANGELOG -```bash -# Add new version entry -./scripts/release/update_changelog.sh 03.05.00 - -# Update release dates -./scripts/release/update_dates.sh 2025-01-15 03.05.00 -``` +Update CHANGELOG.md manually or via pull request following the existing format. ## Troubleshooting @@ -309,8 +295,8 @@ unzip -l dist/moko-cassiopeia-*.zip # Check specific file php -l src/templates/index.php -# Run validation script -./scripts/validate/php_syntax.sh +# Run validation +make validate-required ``` #### Manifest Validation Failed @@ -326,22 +312,12 @@ php -l src/templates/index.php #### Version Alignment Issues ```bash -# Check version in manifest matches CHANGELOG -./scripts/validate/version_alignment.sh - -# Fix versions -./scripts/fix/versions.sh 03.05.00 +# Check version consistency +make validate-required ``` ### Workflow Failures -#### "Permission denied" on scripts - -```bash -# Fix script permissions -chmod +x scripts/**/*.sh -``` - #### "Branch already exists" ```bash @@ -454,7 +430,6 @@ phpcs --standard=phpcs.xml --report=source src/ - [Main README](../README.md) - Project overview - [Joomla Development Guide](./JOOMLA_DEVELOPMENT.md) - Testing and quality -- [Scripts README](../scripts/README.md) - Script documentation - [CHANGELOG](../CHANGELOG.md) - Version history - [CONTRIBUTING](../CONTRIBUTING.md) - Contribution guidelines