Code-checker

Local plugins ::: local_codechecker
Maintained by One poor developer...Eloy Lafuente (stronk7), TimTim Hunt, Víctor Déniz Falcón, Sara Arjona Téllez
Part of set Moodle development.
A tool for developers that helps them follow Moodle's coding style.

Code-checker 4.0.7 - Day after Saint Matthew here!

Moodle 3.7, 3.8, 3.9, 3.10, 3.11, 4.0, 4.1, 4.2
Released: Friday, 22 September 2023, 4:51 PM

Moodle Code Checker

Codechecker CI

Changes in version 4.0.7 (20230922) - Day after Saint Matthew here!

Information

This Moodle plugin uses the PHP CodeSniffer tool to check that code follows the Moodle coding style. It uses the Moodle Coding Style 'sniffs' that check many aspects of the code, including the awesome PHPCompatibility ones.

It was created by developers at the Open University, including Sam Marshall, Tim Hunt and Jenny Gray. It is now maintained by Moodle HQ.

Available releases can be downloaded and installed from .

To install it using git, type this command in the root of your Moodle install:

git clone https://github.com/moodlehq/moodle-local_codechecker.git local/codechecker

Then add /local/codechecker to your git ignore.

Additionally, remember to only use the version of PHPCS located in phpcs/bin/phpcs rather than installing PHPCS directly. Add the location of the PHPCS executable to your system path, tell PHPCS about the Moodle coding standard with phpcs --config-set installed_paths /path/to/moodle-local_codechecker and set the default coding standard to Moodle with phpcs --config-set default_standard moodle. You can now test a file (or folder) with: phpcs /path/to/file.php.

Alternatively, download the zip from , unzip it into the local folder, and then rename the new folder to "codechecker".

After you have installed this local plugin, you should see a new option in the settings block:

> Site administration -> Development -> Code checker

We hope you find this tool useful. Feel free to enhance it! Also, you can report any idea or bug using GitHub's issues and pull requests, thanks!

Integrations

Since version v4.0.0 this plugin shouldn't be used as source for any integration with IDEs or tools, and Moodle Coding Style (the new source for the moodle-cs standard) should be used instead.

Please refer to the information available in that repository to know more about how to install, configure and integrate it with your development environment.

Version information

Version build number
2023092200
Version release name
4.0.7 - Day after Saint Matthew here!
Can be updated from
4.0.0 - Welcome moodle-cs (2022082500), 4.0.1 - Dear Windows (2022100700), 4.0.2 - Comp-at-ibility (2023012000), 4.0.3 - Valentine's D (2023021400), 4.0.5 - Forever in my heart, Tina (2023052800), 4.0.6 - Composing our lifes (2023090800)
Can be updated to
4.0.8 - Few hours later (2023092300), 5.0.0 - Cinque, this is cinque! (2023092600), 5.0.1 - Daddy's birthday (2023102000), 5.0.3 - Bumping bumps (2023121900), 5.0.4 - Depend-a-bot (2024012600), 5.0.5 - Fools plus 9 (2024041000), 5.0.6 - Bye, May! (2024053100), 5.0.7 - It's a small world (2024061400), 5.0.8 - Refreshing summer (2024070500)
Maturity
Stable version
MD5 Sum
374c7e1a961ee2a60df227445b5977f0
Supported software
PHP 7.0, PHP 7.1, PHP 7.2, Moodle 3.7, PHP 7.3, PHP 7.4, Moodle 3.8, Moodle 3.9, Moodle 3.10, Moodle 3.11, PHP 8.0, Moodle 4.0, PHP 8.1, Moodle 4.1, Moodle 4.2, PHP 8.2
Change log URL
Alternative download URL

Version control information

Version control system (VCS)
GIT
VCS repository URL
VCS branch
master
VCS tag
v4.0.7

Default installation instructions for plugins of the type Local plugins

  1. Make sure you have all the required versions.
  2. Download and unpack the module.
  3. Place the folder in the "local" subdirectory.
  4. Visit http://yoursite.com/admin to finish the installation.