micaherne/phpstan-moodle

Rules and utilities for using PHPStan on Moodle code.

dev-main 2024-04-23 20:40 UTC

Requires

• php: ^8.0
• micaherne/moodle-analysis: dev-main
• phpstan/phpstan: ^1.10

Requires (Dev)

• nikic/php-parser: ^5.0
• phpunit/phpunit: ^11.0
• psr/log: ^3.0
• rector/rector: ^1.0
• symfony/console: ^7.0
• symfony/filesystem: ^7.0
• symfony/finder: ^7.0
• symfony/process: ^7.0

GPL-3.0-or-later

• Michael Aherne

README

This is a plugin for PHPStan that enables analysis of Moodle code.

It currently only supports bootstrapping the classloader - there are no rules as yet.

Installation

To use this plugin, install it with phpstan extension-installer:

Otherwise, require it in Composer:

composer require --dev micaherne/phpstan-moodle

Then create a phpstan.neon file in the root of your project with the following contents:

includes:
    - vendor/micaherne/phpstan-moodle/extension.neon

Usage

Add the following to your phpstan.neon file:

parameters:
    moodle:
        rootDirectory: /path/to/moodle

The rootDirectory parameter must be an absolute path.