ZnunyCodePolicy
Freeby Znuny GmbHcompany
A development utility for Znuny and OTRS that checks extension packages for compliance with coding standards and best practices.
ZnunyCodePolicy is an essential tool for developers creating extensions for Znuny or OTRS. It provides an automated suite of checks to ensure that code complies with official development guidelines. The tool inspects Perl code (via Perl::Tidy), validates SOPM package descriptions, checks XML system configurations, and verifies translation files. It is a standard tool in the Znuny ecosystem and is required for all contributions to the core project. It can be used manually via the command line or automated within CI/CD pipelines and as a git hook.
Features
Perl Code Quality
Checks Perl files for syntax errors and compliance with the Znuny coding style using Perl::Tidy.
SOPM Validation
Validates .sopm files for correct structure and required tags (e.g., transition from otrs_package to package).
XML SysConfig Check
Verifies XML configuration files for well-formedness and adherence to SysConfig schemas.
Translation Check
Ensures that translation files (.pot) are complete and correctly formatted.
Git Integration
Can be configured as a git pre-commit hook to enforce code checks before every commit.