Code-checker

General plugins (Local) ::: local_codechecker
Maintained by One poor developer...Eloy Lafuente (stronk7), Tim at Lone Pine Koala SanctuaryTim Hunt, Víctor Déniz Falcón, Sara Arjona Téllez
A tool for developers that helps them follow Moodle's coding style.

Code-checker 2.9.8 - Bye and thank you, phpcs 2

Moodle 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 3.10
Released: Friday, October 9, 2020, 7:28 PM

Moodle Code Checker

Build Status

Changes in version 2.9.8 (20201002) - Bye and thank you, phpcs 2.x

  • PR#83 and PR#84: Allow a list of files to be checked (Sam Marshall).
  • PR#80: Remove require of now-deleted coursecatlib.php (Jun Pataleta).
  • Several travis changes:
    • PR#79: Bump to use moodlehq/moodle-plugin-ci v3.
    • PR#81: Add support for 310 branch.
  • Small README changes: information section improved and travis status badge update to show travis.com build status.

Information

This Moodle plugin uses the Pear CodeSniffer library to check that code follows the Moodle coding guidelines, available @ 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.

Available releases can be downloaded and installed from https://moodle.org/plugins/view.php?plugin=local_codechecker.

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.

Additionally, remember to only use the version of PHPCS located in pear/PHP/scripts/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. Please feel free to enhance it. Report any idea or bug in the Tracker, thanks!

IDE Integration

Eclipse:

  1. Outdated!: 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.

Sublime Text

Find documentation here.

After step 3 in the Sublime PHP CS section:

  1. Go in your Sublime Text to Preferences -> Package Control -> Package Control: Install Package
  2. Write 'phpcs' in the search field, if you see Phpcs and SublimeLinter-phpcs, click on them to install them.
  3. If not, check if they are already installed Preferences -> Package Control -> Package Control: Remove Package.
  4. To set your codecheck to moodle standards go to Preferences -> Package Settings -> PHP Code Sniffer -> Settings-User and write:

    { "phpcs_additional_args": {
            "--standard": "moodle",
            "-n": "
        },
    }
    
  5. If you don’t have the auto-save plugin turned on, YOU’RE DONE!

  6. If you have the auto-save plugin turned on, because the codecheck gets triggered on save, the quick panel will keep popping making it impossible to type. To stop quick panel from showing go to Settings-User file and add:

    "phpcs_show_quick_panel": false,
    

    The line with the error will still get marked and if you’ll click on it you’ll see the error text in the status bar.

Version information

Version build number
2020100200
Version release name
2.9.8 - Bye and thank you, phpcs 2
Can be updated from
2.9.3 - Selectivenesses (take #2) (2019011800), 2.9.4 - Late Beorc (2019111200), 2.9.5 - Poisson d'avril (2020040100), 2.9.6 - June's Roentgenium (2020061100), 2.9.7 - Bye bye, JS (2020071800)
Maturity
Stable version
MD5 Sum
6daa22c4f6ddc842ea49bb68a94de64e
Supported software
Moodle 3.2, Moodle 3.3, Moodle 3.4, Moodle 3.5, Moodle 3.6, Moodle 3.7, Moodle 3.8, Moodle 3.9, Moodle 3.10

Version control information

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

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.