Dependencies Example

Production Metadata

Like each new project, we start by creating the required fusion.json file in an empty directory of your choice, with the following dummy content:

                {
    "name": "Package",
    "description": "Example package.",
    "id": "valvoid/package",
    "version": "0.1.0",
    "structure": {
        "/state": "stateful",
        "/dependencies": [
            "valvoid.com/valvoid/box/1.0.0"
        ]
    },
    "environment": {
        "php": {
            "version": "8.1.0"
        }
    }
}
            

In addition to all required primitive, structure, and environment entries, our production metadata also defines a nested valvoid.com/valvoid/box/1.0.0 dependency mapped to the custom dependencies directory. To pull this dependency, open a terminal in the project directory and run the build command:

                fusion build
            

Once done, our project directory contains, alongside other files created by Fusion (not shown here for simplicity):

• dependencies
  • valvoid
    • box: Box package
• state
  • PrefixAutoloader.php: Indexed code
  • snapshot.json: Pulled version
• fusion.json

Since the trailing reference segment 1.0.0 in our dependency source is a shortcut version range (>=1.0.0 && <2.0.0), the pulled version stored in the stateful snapshot.json file is essential to ensure the same state across machines.

We follow this recommended approach and ignore both generatable directories while keeping the snapshot.json file tracked by excluding it in the .gitignore file:

                dependencies
state/*
!state/snapshot.json
            

To simulate a cloned repository replication, delete the ignored content according to the .gitignore rules. The project directory should then contain only:

• state
  • snapshot.json: Pulled version
• .gitignore
• fusion.json

Open a terminal in the project directory and run the replicate command:

                fusion replicate
            

The project directory should now contain the same files as the previously built state.

Loadable Dependency Code

As shown above, Fusion not only pulls the dependency into our project, it also indexes loadable code in the generated PrefixAutoloader.php file. Let's add some basic code to verify everything works. For injectable code, create a src directory in the root of the package, and add a file Package.php inside it with the following code:

                namespace Valvoid\Package;

class Package
{
    public function getCodeType(): string
    {
        return "Lazy";
    }
}
            

For executable script, create a cli.php file in the root directory with the following content:

                use Valvoid\Box\Box;
use Valvoid\Package\Package;

require __DIR__ . "/state/PrefixAutoloader.php";

$autoloader = new PrefixAutoloader;
$autoloader->register();

$box = new Box;
$package = $box->get(Package::class);

echo $package->getCodeType() . " code";
            

After this, the project directory looks like:

• dependencies
  • valvoid
    • box
• src
  • Package.php
• state
  • snapshot.dev.json
  • snapshot.json
  • PrefixAutoloader.php
• .gitattributes
• .gitignore
• cli.php
• fusion.json

Open a terminal in the project directory and run the lightweight register command:

                fusion register
            

                Lazy code