Generate Plugins Skeleton before starting development using this new Moodle plugin by Alexandru Elisei – GSOC #MoodleDev #gsoc16

September 15th, 2016

Google Summer of Code always bring a lot of fresh projects to the open source projects. Moodle Project who is participating for the 10th time in the GSoC will get 4 new projects very soon contributed by the GSoC participants.

Alexandru Elisei, mentored by David Mudrak, has shared his presentation during the recently concluded Moodle General Developer Meeting on 08th September. The project – “tool_pluginkenobi: Guide to plugin creation” is ready now.

The plugin named “Plugin Skeleton Generator” is a developer tool and will help you to generate a skeleton code for a plugin that the developer can build on. The plugin is accessible from web interface as well as fully support all command line tools.

It can generate the plugin skeleton from the following 3 ways:

  1. Manual generation
  2. uploading a previously created YAML recipe file
  3. writing the recipe by hand in the text area

Generate Plugins Skeleton before starting development using this new Moodle plugin by Alexandru Elisei #MoodleDev #gsoc

The second page of the web interface presents you with all the options needed to generate the complete plugin skeleton. After you have filled the necessary fields, you are given three options:

  1. You can generate the plugin files and download them by clicking on the Download plugin skeleton button. The files will be packaged as a zip archive.
  2. You can choose to generate and save a recipe file in the YAML format from the form input. This is accomplished by clicking on the Download recipe button.
  3. You can view and edit the recipe created from the form by clicking the Show recipe button.

Where to Download

The plugin can be downloaded from the GitHub page of the Project here. Complete documentation about using the plugin skeleton generator can be found on the Moodle docs page here. The plugin is tested with Moodle 3.1 version.

You can also download the presentation delivered during the Dev meeting here.

I believe that this project will make the life easier for new Moodle developers which are often confused because of many plugin types and repetitive formal work.