https://github.com/moodlehq/moodle-local_moodlecheck

Checks style of phpdocs in moodle source file
https://github.com/moodlehq/moodle-local_moodlecheck

Last synced: 2 months ago
JSON representation

Checks style of phpdocs in moodle source file

• Host: GitHub
• URL: https://github.com/moodlehq/moodle-local_moodlecheck
• Owner: moodlehq
• Created: 2012-01-13T04:03:16.000Z (about 13 years ago)
• Default Branch: main
• Last Pushed: 2024-05-18T16:09:03.000Z (8 months ago)
• Last Synced: 2024-05-18T17:25:29.306Z (8 months ago)
• Language: PHP
• Homepage:
• Size: 290 KB
• Stars: 26
• Watchers: 22
• Forks: 31
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Moodle PHPdoc Checker

=====================

[![Moodlecheck CI](https://github.com/moodlehq/moodle-local_moodlecheck/actions/workflows/ci.yml/badge.svg)](https://github.com/moodlehq/moodle-local_moodlecheck/actions/workflows/ci.yml)

Important note:

---------------

This plugin is becoming deprecated and, soon, [moodle-cs](https://github.com/moodlehq/moodle-cs) will get

the baton about all the PHPDoc checks. The switch is planned to be implemented progressively. For more

details, see the [announcement](https://moodle.org/mod/forum/discuss.php?d=455786) and the

[tracking issue](https://github.com/moodlehq/moodle-cs/issues/30).

Installation:

-------------

Install the source into the local/moodlecheck directory in your moodle

Log in as admin and select:

Settings

  Site administration

    Development

      Moodle PHPdoc check

Enter paths to check and select rules to use.

Customization:

--------------

You can add new rules by adding new php files in rules/ directory,

they will be included automatically.

Look at other files in this directory for examples.

Please note that if you register the rule with code 'mynewrule',

the rule registry will look in language file for strings

'rule_mynewrule' and 'error_mynewrule'. If they are not present,

the rule code will be used instead of the rule name and

default error message appears.