Skip to main content

Test-Friendly Compiler Mode

Compile safely, preview freely โ€” without impacting live Joomla sites

JCBโ€™s Test-Friendly Compiler Mode allows developers to compile components in a non-destructive, isolated way. Instead of building the full ZIP and triggering a live Joomla install or overwriting production files, this mode lets you inspect the component structure, view logs, and confirm correctness โ€” without deploying.

Itโ€™s ideal for blueprint testing, code review, debugging, or validating changes before syncing to Git or installing in Joomla. You can treat this mode as a โ€œdry-runโ€ build โ€” perfect for safe iterations during component development.

๐Ÿงฐ Key Features

  • ๐Ÿงช Safe โ€œDry-Runโ€ Compilation
    Generate the full structure of your component โ€” files, folders, configs โ€” without packaging or installing it.
  • ๐Ÿ“‚ Output Directory for Review
    The compiler builds the component into a local output folder (e.g., /media/zips or /tmp/...), allowing you to inspect:
    • Manifest XML
    • Helper classes
    • MVC folders
    • Snippets, templates, layouts
    • Language files, config, install scripts
  • ๐Ÿ“˜ Debug-Enhanced Logs
    Gain visibility into:
    • File inclusion steps
    • Tag insert/replace actions
    • PHP errors or logic problems
    • Field or view processing issues
  • ๐Ÿ” Compare Output with Previous Builds
    Detect changes in structure, line count, or packaging logic between builds โ€” especially helpful in Git workflows.
  • โš™๏ธ No System Installation Required
    Skip Joomlaโ€™s installer entirely โ€” no plugins registered, no menus created, no database tables imported.
  • ๐Ÿง  Ideal for Blueprint Validation
    Quickly test whether a new or imported blueprint is structurally valid before compiling or installing in Joomla.

โฑ๏ธ When to Use It

  • ๐Ÿ”ง Debugging a field or layout issue before deploying
  • ๐Ÿงช Verifying the output of a newly imported blueprint
  • ๐Ÿ” Testing insert tags, compiler hooks, or super power class generation
  • ๐Ÿ“ค Preparing for Git commits without triggering version bloat
  • ๐Ÿšซ Avoiding Joomla install conflicts during early dev

๐Ÿš€ How to Activate It

  1. Go to the JCB Component List (where your projects are listed).
  2. Click the โ€œBuildโ€ button dropdown next to your component.
  3. Choose Compile โ†’ Test Mode or Compile โ†’ Dry Run.
    (Label may vary depending on UI version.)
  4. Wait for the compiler to complete.
  5. View the output folder or logs.

Optional:

  • Enable additional debug logging in global JCB settings.
  • Use CLI: joomla jcb:build --test --component=mycomponent

๐Ÿ“ Conclusion

Test-Friendly Compiler Mode offers a safe space to experiment, verify, and debug your components without affecting your live Joomla environment. Whether reviewing a community blueprint or refining a complex snippet system, itโ€™s your shield against unnecessary rebuilds or accidental installs.