moodle-standards
将Moodle编码标准(PSR-12及例外)应用于PHP代码。验证样式、命名约定、PHPDoc和类型提示。
📖 中文导读:将Moodle编码标准(PSR-12及例外)应用于PHP代码。验证样式、命名约定、PHPDoc和类型提示。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。
name: moodle-standards description: Apply Moodle coding standards (PSR-12 with exceptions) to PHP code. Validates style, naming conventions, PHPDoc, and type hints.
Moodle Standards Skill
Apply Moodle coding standards (PSR-12 + exceptions) to PHP code.
Trigger
- PHP files in Moodle plugin directories
- User requests code review or formatting
- New file creation in Moodle context
Actions
1. Validate Code Style
Check code against Moodle standards:
- Line length (132 ideal, 180 max)
- Array syntax (
[]only) else ifnotelseif- No closing
?>tag - 4-space indentation
2. Fix Naming
Ensure proper naming:
- Variables:
$lowercase(no underscores between words) - Functions:
component_function_name()(Frankenstyle) - Classes:
lowercase_with_underscores - Constants:
COMPONENT_CONSTANT_NAME
3. Add PHPDoc
Generate required documentation:
- File header with GPL
@packagetag (MANDATORY)@paramwith types@returndescription
4. Type Hints
Add mandatory type declarations:
- Parameter types
- Return types
- Nullable types (
?type)
Validation Command
vendor/bin/phpcs --standard=moodle path/to/file.php
Quick Fixes
Missing Package Tag
/**
* @package mod_myplugin
*/
Wrong Array Syntax
// Before
$arr = array('a', 'b');
// After
$arr = ['a', 'b'];
Wrong Else If
// Before
} elseif ($x) {
// After
} else if ($x) {