forme/framework

An MVC framework for WordPress.

v3.8.6 2024-01-09 16:12 UTC

Requires

• php: ^8.1
• cakephp/core: ^5.0
• http-interop/response-sender: ^1.0
• illuminate/config: ^9.52 || ^10.0
• illuminate/database: ^9.52 || ^10.0
• illuminate/view: ^9.52.9 || ^10.0
• laminas/laminas-diactoros: ^3.0
• league/plates: ^3.5
• log1x/sage-directives: ^2.0
• monolog/monolog: ^3.3
• papertower/wp-rest-api-psr7: ^0.8.0
• php-di/php-di: ^7.0.2
• ramsey/uuid: ^4.7.4
• rareloop/psr7-server-request-extension: ^2.1
• relay/relay: ^2.1.2
• robmorgan/phinx: ^0.15
• spatie/enum: ^3.13
• symfony/string: ^6.3
• symfony/yaml: ^6.3
• twig/twig: ^3.6.1
• vlucas/phpdotenv: ^5.5

Requires (Dev)

• fakerphp/faker: ^1.23
• filp/whoops: ^2.15.2
• mockery/mockery: ^1.6.2
• nunomaduro/mock-final-classes: dev-master
• pestphp/pest: ^2.0.0
• php-stubs/acf-pro-stubs: ^6.0.6
• php-stubs/woocommerce-stubs: ^8.1
• php-stubs/wp-cli-stubs: ^2.8
• phpstan/phpstan: ^1.10.18
• ramsey/conventional-commits: ^1.5
• rector/rector: ^0.18.3
• symfony/var-dumper: ^6.3
• szepeviktor/phpstan-wordpress: ^1.3.0
• yoast/wp-test-utils: dev-JRF/update-for-polyfills-2.0

MIT

• Moussa Clarke

README

Forme WordPress Framework

Forme is an MVC framework for WordPress. This is the core Forme Framework library, which is used by the Plugin, Theme and CodeGen components.

Click here for Documentation

Development

For development run phive install --force-accept-unsigned followed by composer install.

Tools are in ./tools rather than ./vendor/bin

You also need git cliff for generating changelogs and pcov to generate coverage stats for infection to measure against.

The useful ones are set up as composer scripts. Tests should run automatically on commit.

composer test # run pest
composer test:setup # set up WP installation for integration testing
composer stan # run phpstan on src
composer rector:check # rector dry run on src
composer rector:fix # rector on src
composer cs:check # php cs fixer dry run on src
composer cs:fix # php cs fixer on src
composer changelog # run git cliff
composer hooks # install git hooks (will run on composer install automatically)
composer bump:version # bump to the next patch version - can also take argument "minor" or "major"
composer infection # run infection on src
composer infection:log # run infection on src and log to infection.html