MokoConsulting/MokoJoomHero
1
0
Fork 0
Code Issues 1 Pull Requests 1 Releases 1 Wiki Activity
Files
rc
MokoJoomHero/CLAUDE.md
T
Jonathan Miller 4d67a32cb0
Generic: Repo Health / Site Health (push) Has been cancelled
Details
Generic: Repo Health / Access control (push) Has been cancelled
Details
Generic: Repo Health / Scripts governance (push) Has been cancelled
Details
Generic: Repo Health / Repository health (push) Has been cancelled
Details
Generic: Repo Health / Report Issues (push) Has been cancelled
Details
feat: article content source, per-slide content, remove license check (#56, #57) 
Add content source selector — manual editor or Joomla article with
optional article title override. Add per-slide unique content via
subform repeatable field with heading, body, link, and link text per
slide, swapped in sync with background transitions using safe DOM
methods. Remove license key check from system plugin and plugin
dependency from module — extension is now free. Language strings in
all locales.

Authored-by: Moko Consulting
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-06-04 07:45:23 -05:00

2.6 KiB
Raw Permalink Blame History

CLAUDE.md

This file provides guidance to Claude Code when working with this repository.

Project Overview

MokoJoomHero -- Random hero image slideshow/video with content overlay for Joomla

Field Value
Platform joomla
Language PHP
Default branch main
License GPL-3.0-or-later
Wiki MokoJoomHero Wiki
Standards MokoStandards

Common Commands

make build        # Build the project
make lint         # Run linters
make validate     # Validate structure
make release      # Full release pipeline
make minify       # Minify CSS/JS assets
make clean        # Clean build artifacts

composer install  # Install PHP dependencies

Architecture

This is a Joomla package extension (pkg_mokojoomhero) containing two sub-extensions:

mod_mokojoomhero (Site Module)

  • Random hero image slideshow or background video with content overlay
  • Supports image folders, YouTube, Vimeo, local video, solid colour, gradient
  • Configurable overlay, text alignment, card animation, parallax, content animations
  • Works independently — no plugin dependency required

plg_system_mokojoomhero (System Plugin)

  • Placeholder for future system-level features
  • Auto-enabled on package install via pkg_script.php
  • Namespace: Joomla\Plugin\System\MokoJoomHero

Key files

  • src/pkg_mokojoomhero.xml — package manifest
  • src/pkg_script.php — auto-enables system plugin on install
  • src/packages/mod_mokojoomhero/ — hero module source
  • src/packages/plg_system_mokojoomhero/ — system plugin source
  • updates.xml — Joomla update server (includes legacy module entries for migration)

Rules

  • Workflow directory: .mokogitea/ (not .gitea/ or .github/)
  • Never commit .claude/, .mcp.json, TODO.md, or *.min.css/*.min.js
  • Attribution: use Authored-by: Moko Consulting in commits
  • Branch strategy: develop on dev, merge to main for release
  • Minification: handled at build time (CI)
  • Wiki: documentation lives in the Gitea wiki, not in docs/ files
  • Standards: this repo follows MokoStandards

Coding Standards

  • PHP 8.1+ minimum
  • Joomla 5/6 DI container pattern: services/provider.php → Extension class
  • Legacy stub .php file required for plugin loader but empty
  • SubscriberInterface for event subscription (not on* method naming)
  • SPDX license headers on all PHP files
Reference in New Issue View Git Blame Copy Permalink