phpbb/epv

A extension validator for phpBB extensions. Extensions are required to pass the validator when submitted to the extension database.

0.0.12 2023-09-22 13:06 UTC

Requires

• php: >=7.0
• composer/composer: ^1.5
• gitonomy/gitlib: 0.1.*@dev
• nikic/php-parser: ~3.0
• sensiolabs/ansi-to-html: ~1.1
• symfony/console: ^3.0|^4.0|^5.0
• symfony/finder: ^3.0|^4.0|^5.0
• symfony/process: ^3.0|^4.0|^5.0
• symfony/yaml: ^3.0|^4.0|^5.0

Requires (Dev)

• phpunit/phpunit: ~5.4
• phpunit/phpunit-mock-objects: ~3.2

GPL-2.0-only

• Paul Sohier

README

This repository contains the extension pre-validator, used for pre validating extensions when submittion to the database at phpBB.com.

Please note that EPV requires at least PHP 7.2

Using EPV

1. Clone your fork of this repository.
2. Install composer dependencies:

   $ php composer.phar install

3. Run EPV on a phpBB extension from the CLI:

   # Run EPV on a Git repository (at any repository hosting site)
   php src/EPV.php run --git="https://github.com/repo-org/repo-name.git"
   
   # Run EPV on a GitHub repository
   php src/EPV.php run --github="repo-org/repo-name"
   
   # Run EPV on a local directory
   php src/EPV.php run --dir="/path/to/extension"

The --branch option can target a specific branch of a repository.

The --debug option will output additional debugging information.

You can also use EPV online at phpBB.com

phpBB's Customisation Database (Titania) will run EPV on any submissions at phpBB.com as well.

Maintenance and contributing

To contribute fork the repo, make your changes in a feature branch and send a pull request.

The site is maintained by the phpBB Extensions Team

Should you wish to report a bug report it at Issue tracker

License

GNU General Public License v2

By contributing you agree to assign copyright of your code to phpBB Limited.

See LICENSE for the full license.