Advertisement

What is a good workflow for developing a component? Topic is solved

For Joomla! 4.x Coding related discussions, you could also use: http://groups.google.com/group/joomla-dev-general

Moderators: ooffick, General Support Moderators

Forum rules
Forum Rules
Absolute Beginner's Guide to Joomla! <-- please read before posting, this means YOU.
Forum Post Assistant - If you are serious about wanting help, you will use this tool to help you post.
Windows Defender SmartScreen Issues <-- please read this if using Windows 10.
Post Reply
JanoD
Joomla! Apprentice
Joomla! Apprentice
Posts: 28
Joined: Tue May 07, 2024 5:12 pm

What is a good workflow for developing a component?

Post by JanoD » Tue May 07, 2024 7:02 pm

Hello,

I am new to Joomla v4.x and would like to confirm whether my understanding concerning a workflow of developing a component is correct.

Reading https://docs.joomla.org/Absolute_Basics ... _Functions and https://docs.joomla.org/J4.x:Developing ... troduction suggest that a component is developed in a directory outside of Joomla site and after each change to a source code, whole component is zipped and installed using Joomla administration (e.g. localhost/administration in case of having Joomla locally). This can be an automated CI/CD process I believe.

Is this a best practice or do I rather create a skeleton of a component and then develop directly in Joomla site directory structures?

Thanks!

Advertisement
User avatar
ceford
Joomla! Hero
Joomla! Hero
Posts: 2869
Joined: Mon Feb 24, 2014 10:38 pm
Location: Edinburgh, Scotland
Contact:

Re: What is a good workflow for developing a component?

Post by ceford » Tue May 07, 2024 8:25 pm

Three things you can read:

https://jdocmanual.org/jdocmanual?manua ... -primer.md
https://manual.joomla.org/docs/get-started/
https://www.dionysopoulos.me/book.html

My tips:
  • Set up a development environment on your laptop/workstation.
  • Keep your own extension code in a git repo and separate from your local Joomla test installation.
  • Use VSCode or VSCodium - after initial install, copy changed files to the test site - quicker than install.
  • Aim for Joomla 5
I could add more and I guess others have different workflow preferences.

JanoD
Joomla! Apprentice
Joomla! Apprentice
Posts: 28
Joined: Tue May 07, 2024 5:12 pm

Re: What is a good workflow for developing a component?

Post by JanoD » Wed May 08, 2024 8:25 am

Thanks a lot for all the tips! I thought that https://docs.joomla.org/ must be outdated or there must be some better documentation somewhere and apparently there is.

I use VSCode already and indeed the setup you are referring to makes sense (copying changed files is simply quicker that installing).

Do you think that migrating an existing J3 component directly to J5 (and skipping over J4) is a good idea?

Thanks!
Last edited by JanoD on Wed May 08, 2024 8:43 am, edited 1 time in total.

User avatar
ceford
Joomla! Hero
Joomla! Hero
Posts: 2869
Joined: Mon Feb 24, 2014 10:38 pm
Location: Edinburgh, Scotland
Contact:

Re: What is a good workflow for developing a component?

Post by ceford » Wed May 08, 2024 8:29 am

JanoD wrote: Wed May 08, 2024 8:25 am Do you think that migrating J3 component directly to J5 (and skipping over J4) is a good idea?
Yes - there is precious little difference from the Developer point of view. Migrating from J3 to J4/J5 is the big step. Depending on what your component does it may be better to rewrite from scratch.

JanoD
Joomla! Apprentice
Joomla! Apprentice
Posts: 28
Joined: Tue May 07, 2024 5:12 pm

Re: What is a good workflow for developing a component?

Post by JanoD » Wed May 08, 2024 8:46 am

Thanks again for the tip. I will try to aim for J5 then.

Advertisement

Post Reply

Return to “Joomla! 4.x Coding”