Moodle plugin skeleton generator
Admin tools ::: tool_pluginskel
Maintained by David Mudrák
Allows developers to quickly generate code skeleton for a new Moodle plugin.
Moodle plugin skeleton generator 1.5.2
Moodle 3.9, 3.10, 3.11
Released: Monday, June 14, 2021, 8:46 PM
Code prechecksHTML | XML
- Single class (instance, trait) files do not need file-level phpDocs block even if they have side-effect and load other libraries manually.
- Monolog logger update to the latest version 2.2 as we now require Moodle 3.9 so PHP is always 7.2 or higher.
- Plugin types in the wizard form selector are now alphabetically ordered - credit goes to Daniel Neis Araujo and Jonathan Champ.
- Added tests for Moodle 3.11 and ability to set 3.11 as required Moodle version.
- Fixed coding style issues detected by phpcs in the plugin as well as in the generated code.
- New recipe section
templatesallowing to generate mustache templates.
- Fixed standard boilerplate of all custom skeleton templates and re-enabled CI prechecks for them.
- New recipe section
externalcan be used to describe external functions provided by the plugin.
- New recipe section
servicescan be used to describe pre-built web services provided by the plugin.
--recipeargument has been deprecated. The path to the recipe file should be newly provided via positional argument of the generate.php script.
- CLI generator script now also supports relative paths to files as arguments.
--list-filesargument allows to display list of to-be generated files.
--fileargument allows to display the contents of given generated file.
--decodeargument allows to display decoded structure of given YAML file.
- Added ability to generate single declaration files that have no side effects.
- Travis-CI prechecks were replaced with Github Actions.
- Github Actions are also used to precheck generated skeletons, not only the tool itself. Various detected coding style issues were fixed in both places.
- Generated README files now contain information about how and where the generated plugin should be installed to. Credit goes to Jan Dageförde.
- Generated install.xml files fixed to contain EOL at EOF. This reflects the upstream fix MDL-70931.
- Spyc library replaced with Symfony Yaml component for recipe files parsing.
- Fixed deprecation warnings in unit tests under Moodle 3.10. Credit goes to @ewallah.
- Fixed tests syntax to be compatible with PHPUnit 8.5.
- Added support for generating version.php code requiring Moodle 3.10.
- Added support for generating contenttype plugin templates. Credit goes to Ferran Recio (@ferranrecio).
- Moodle versions 3.8 and 3.9 can be selected as required versions.
- URLs in boilerplates use the HTTPS protocol explicitly.
- Fixed typos and errors. Credit goes to @kritisingh1.
- Fixed generating skeletons for activity modules. Credit goes to Leo Auri (@leoauri) for the fix.
- Fixed travis-ci configuration. Credit goes to Jonathan Champ (@jrchamp).
- Added support for generating minimal db/install.xml files for activity modules.
- Added support for generating version.php code requiring Moodle 3.7
- Fixed bug - auth plugins not setting the authtype property. Credit goes to Geoffrey Van Wyk (@systemovich) for the report and the fix suggestion.
- Fixed bug #90 - the name of the XMLDB upgrade function for activity modules.
- Added support for generating version.php code requiring Moodle 3.6.
- Privacy API implemented. The plugin does not store any personal data.
- Fixed bug #87 - invalid language file name for activity modules.
- Fixed a bug leading to generating the provider.php file with a syntax error in some cases.
- Added support to generate privacy API related code (refer to cli/example.yaml). Special thanks to Michael Hughes for the initial implementation.
- Improved the component type and name fields usability - autodisplay the plugin type prefix so that it is more intuitive what the name field should hold.
- Added support to generate plugins requiring Moodle 3.4 and 3.5
- Make mustache loader path configurable, allowing better integration with moosh. Credit goes to Tomasz Muras.
- Added support to generate plugins requiring Moodle 3.3 and 3.2.
- Added support for setting default values of some recipe file form fields
- Fixed the risk of having the generated ZIP file corrupted with debugging data
- Fixed some formal coding style violations
- Initial version submitted to the Moodle plugins directory as a result of GSOC 2016
- Version build number
- Version release name
- Stable version
- MD5 Sum
- Supported software
- Moodle 3.9, Moodle 3.10, Moodle 3.11
Version control information
- Version control system (VCS)
- VCS repository URL
- VCS tag
Default installation instructions for plugins of the type Admin tools
- Make sure you have all the required versions.
- Download and unpack the module.
- Place the folder (eg "mytool") in the "admin/tool" subdirectory.
- Visit http://yoursite.com/admin to finish the installation