Creating Plugins

Community plugins are essential for offering additional features to the Pest community, while the Pest team prioritizes keeping the framework's core small and fast. In this chapter, we'll discuss how to create your own plugins and share them with the community.

The simplest way to develop your own plugin is to begin with the pest-plugin-template. To generate a new repository from the template repository, click on GitHub's "Use this template" button and name your new repository "pest-plugin-".

After cloning the repository, make sure to modify the "name" and "description" fields in the composer.json file to suit your plugin.

Pest plugins are capable of exposing custom test methods via the $this variable, adding namespaced functions, defining custom expectations, and offering custom CLI options.

Adding Methods

Let's start building our plugin by making new test methods available via the $this variable. To accomplish this, define a PHP trait in your plugin.

1namespace YourGitHubUsername\PestPluginName;
3trait MyPluginTrait
5 public function myPluginMethod()
6 {
7 //
8 }

In order to make this trait method invokable via Pest, we must inform Pest that it should make it available. This can be accomplished creating an Autoload.php file within your plugin with the following content.

1use YourGitHubUsername\PestPluginName\MyPluginTrait;

Lastly, we need to update our plugin's composer.json file to load our Autoload.php file as well as our plugin source code.

1"autoload": {
2 "psr-4": {
3 "YourGitHubUsername\\PestPluginName\\": "src/"
4 },
5 "files": ["src/Autoload.php"]

After you publish your plugin to Packagist, users will be able to install your plugin via Composer. Once installed, they will be able to access your plugin's functions within their test closures.

1test('plugin example', function () {
2 $this->myPluginMethod();
4 //

Adding Functions

A plugin can also define additional namespaced functions, which are typically declared within the plugin's Autoload.php file.

1namespace YourGitHubUsername\PestPluginName;
3function myPluginFunction(): void
5 //

Within your plugins functions, you can access the current $this variable that would typically be available to test closures by invoking the test() function with no arguments.

1namespace YourGitHubUsername\PestPluginName;
3use PHPUnit\Framework\TestCase;
5function myPluginFunction(): TestCase
7 return test(); // Same as `return $this;`

Once you modify your plugin's composer.json file to autoload the Autoload.php file, users can easily access your function within their tests.

1use function YourGitHubUsername\PestPluginName\{myPluginFunction};
3test('plugin example', function () {
4 myPluginFunction();
6 // ...

Adding Custom Expectations

Custom expectations can be incorporated into your plugin's Autoload.php file. For information on how to build custom expectations, please refer to the comprehensive documentation on Custom Expectations.

As you can see, crafting plugins on Pest can serve as a fantastic starting point for your open-source endeavors! In the next chapter, we will explore the concept of "Higher Order Testing": Higher Order Testing