General plugins (Local): Code-checker

local_codechecker
Maintained by Tim at Lone Pine Koala SanctuaryTim Hunt, One poor developer...Eloy Lafuente (stronk7)
A tool for developers that helps them follow Moodle's coding style.

Code-checker 2.5.2 - The March begins

Release notes

Moodle Code Checker

Changes in version 2.5.2 (20160314) - The March begins...

  • MDLSITE-4197: Allow backticks within lang strings. Valid Markdown.
  • CONTRIB-6146: Better handling of indentation in files having multiple PHP blocks.
    • Moving away from our custom indentation Sniff.
    • Using upstream Generic.Whitespace.ScopeIndent, with open/close tags rooting indentation.
    • Added Generic.Whitespace.DisallowTabIndent (to detect tabs within codechecker).
    • Better coverage of indentation tests.
  • NOBUG: Upgrade PHP_CodeSniffer to pre 2.6.0 version (8c5d176).

Information

This Moodle plugin uses the Pear CodeSniffer library to check that code follows the Moodle coding guidelines, available @ .

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 git://github.com/moodlehq/moodle-local_codechecker.git local/codechecker

Then add /local/codechecker to your git ignore.

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. Please feel free to enhance it. Report any idea or bug @ , thanks!

IDE Integration

Eclipse:

  1. If if you use Eclipse for development, you might want to install the PHP CodeSniffer plugin (http://www.phpsrc.org/).
  2. Create a new "CodeSniffer standard" in the preferences page.
  3. Point it at the moodle directory inside the codechecker folder.
  4. Thank Michael Aherne from University of Strathclyde who worked this out!

PhpStorm

  1. Install the phpcs cli tool
  2. Open PhpStorm preferences
  3. Go to PHP > CodeSniffer and supply the path to the phpcs executable
  4. Go to Inspections > PHP > PHP Code Sniffer Validation
  5. In the 'coding standard' dropdown select 'custom' and press the [...] button next to the path to the coding standard. Point is at the moodle directory inside the this plugin directory.
Moodle 2.7, 2.8, 2.9, 3.0, 3.1

Version information

Version build number
2016031400
Version release name
2.5.2 - The March begins
Can be updated from
2.3.0 (2014021700), 2.3.1 - San Fermín release! (2014070700), 2.3.2 - Candelaria, mojo's paradise! (2014081500), 2.5.1 - Valentinius release! (2016021400)
Can be updated to
2.5.3 - Another dent to indent (2016060800), 2.5.4 (2016093000), 2.7.0 - Boosting you! (2017052700), 2.9.2 - Selectivenesses (2019011500), 2.9.3 (2019011800), 2.9.3 (2019011800), 2.9.3 (2019011800), 2.9.3 - Selectivenesses (take #2) (2019011800)
Maturity
Stable version
MD5 Sum
5739e6fc705cad10b1cc25564e232799
Supported software
PHP 5.4, PHP 5.5, Moodle 2.7, PHP 5.6, Moodle 2.8, Moodle 2.9, Moodle 3.0, PHP 7.0, Moodle 3.1

Version control information

Version control system (VCS)
GIT
VCS repository URL
VCS branch
master
VCS tag
v2.5.2

Default installation instructions for plugins of the type General plugins (Local)

  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.