Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

Plugin code prechecks: Difference between revisions

From MoodleDocs
(Start a new page on plugins code prechecks)
 
m (Protected "Plugin code prechecks": Developer Docs Migration ([Edit=Allow only administrators] (indefinite)))
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
In the Moodle Plugins directory, uploaded plugins versions are automatically tested against a set of formal criteria. These tests typically do not check the actual plugin functionality, security or code correctness. They are more focused on formal aspects of the coding style. As such, they are most valuable for the plugin maintainers themselves.
{{Template:Migrated|newDocId=/general/community/plugincontribution/codeprechecks}}
 
Plugin version with no detected errors or warnings has a label like this displayed:
 
[[Image:plugin-codeprechecks-success.png]]
 
If there are some formal errors or warnings detected, a label like this is displayed:
 
[[Image:plugin-codeprechecks-error.png]]
 
The first of the two numbers gives the total number of detected errors, the second number shows the number of warnings. If there are no errors but some warnings, the label is displayed in orange colour. In case of some errors, the label is displayed in red.
 
Clicking the code prechecks label takes you to a page with details on particular tests executed. Individual labels are displayed for each of the test, with the same formatting rules as described above.
 
[[Image:plugin-codeprechecks-details.png]]
 
Finally, clicking some of these individual test labels takes you to a page with detailed raw output of the test system.

Latest revision as of 05:13, 11 August 2023

Important:

This content of this page has been updated and migrated to the new Moodle Developer Resources. The information contained on the page should no longer be seen up-to-date.

Why not view this page on the new site and help us to migrate more content to the new site!