Code-checker

General plugins (Local) ::: 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 2012030100

Moodle 2.2
Released: Monday, 2 April 2012, 9:19 PM
This Moodle plugin uses the Pear CodeSniffer library to check that code follows
the Moodle coding guidelines http://docs.moodle.org/en/Development:Coding_style

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

To install 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
https://github.com/moodlehq/moodle-local_codechecker/zipball/master
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
Site administration -> Development -> Code checker in the settings block.

We hope you find this tool useful. Please feel free to enhance it.


Tip for Eclipse users:

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

Version information

Version build number
2012030100
Can be updated from
2011040400
Can be updated to
2.2.1 (2012040800), 2.2.2 (2012061600), 2.2.6 (2013031200), 2.2.7 (2013060600), 2.2.8 (2013071300), 2.3.0 (2014021700), 2.3.2 - Candelaria, mojo's paradise! (2014081500)
Maturity
Unknown
MD5 Sum
688e281e7388da60bc4223f5377f1266
Supported software
PHP 5.3, Moodle 2.2

Version control information

Version control system (VCS)
GIT
VCS repository URL
VCS branch
master

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.