Configuration

This page lists every option in phel-config.php, with its default, so you can change how Phel finds, builds, caches and exports your code.

Minimal config#

Phel reads phel-config.php from the project root. It returns a PhelConfig. Most projects need only the factory:

<?php
// phel-config.php
use Phel\Config\PhelConfig;
use Phel\Config\ProjectLayout;

return PhelConfig::forProject(ProjectLayout::Flat, 'my-app.main');

This sets src/ and tests/ as the source and test dirs, and my-app.main as the entry namespace for phel build. Chain with*() methods to change anything else. Each call returns a new config:

return PhelConfig::forProject(ProjectLayout::Flat, 'my-app.main')
    ->withBuildDestDir('dist')
    ->withOptimizationLevel(2)
    ->withFormatExclude(['src/generated/*']);

Run phel config to see the merged result and where each value came from. See CLI commands.

Project layouts#

forProject() and withLayout() take a ProjectLayout. It sets the source, test, format and export dirs in one call, and overwrites any you set before it.

Without a phel-config.php, Phel detects the layout: Nested if src/phel/ or tests/phel/ exists, otherwise Flat.

Local overrides#

An optional phel-config-local.php next to phel-config.php overrides its values. Use it for machine-specific settings. phel init adds it to .gitignore. It returns a PhelConfig or an array keyed by the config keys below:

<?php
// phel-config-local.php
return ['optimization-level' => 0, 'warn-deprecations' => true];

Full reference#

Every method on PhelConfig, the key it sets (what phel config prints and what an array config uses), and its default.

Source and test dirs#

Source, test and vendor dirs must be relative. phel config and phel doctor report absolute ones.

Build#

Export#

phel export writes PHP wrapper classes for functions marked {:export true}. See PHP Interop.

Formatting#

Caches and runtime state#

Diagnostics#

Environment variables#