docuconf for PHP (Laravel)

composer config repositories.docuconf vcs https://github.com/Docuconf/docuconf-php
composer require docuconf/docuconf:dev-main

<?php

use Docuconf\Laravel\Env;

// Env:: is env() with a type, rules and a description. Each call returns the
// typed value, and the app refuses to boot if any of them is wrong.

return [
    'port' => Env::int('PORT', 'HTTP listen port', default: 8080, min: 1, max: 65535),

    // ORDERS_, not LOG_LEVEL: Laravel's own config/logging.php reads LOG_LEVEL.
    'log_level' => Env::enum('ORDERS_LOG_LEVEL', 'Minimum level the orders code logs', ['debug', 'info', 'warn', 'error'], default: 'info'),

    // A secret: never printed, and the platform must supply it from a Secret.
    'database_url' => Env::url('DATABASE_URL', 'Orders database connection string', required: true, schemes: ['postgres', 'postgresql'], secret: true, maxLength: 2048),

    'allowed_origins' => Env::list('ALLOWED_ORIGINS', 'Origins allowed to call the API (CORS)', default: ['http://localhost:3000'], minItems: 1),

    // A Docuconf\Duration; written "30s", "1m30s" in the env. The PHPDoc
    // comment documents it: its first paragraph is the description, and the
    // rest is exported as details, for `docuconf docs`.

    /**
     * Timeout for each request.
     *
     * Raise it when clients upload large order batches. Keep it below the
     * load balancer's idle timeout, or the client sees a reset rather than
     * a `504`.
     */
    'request_timeout' => Env::duration('REQUEST_TIMEOUT', default: '30s', min: '1s', max: '5m'),

    'worker_count' => Env::int('WORKER_COUNT', 'Number of background workers', default: 4, min: 1, max: 64),
];

// The typed configuration, with the secret shown as "***".
Route::get('/config', fn (Values $config) => $config->redacted());

DATABASE_URL=postgres://orders:pw@localhost:5432/orders php artisan serve

$ PORT=0 php artisan serve
docuconf: 2 configuration problems:
  - PORT [out_of_range]: must be at least 1 (got "0")
  - DATABASE_URL [missing_required]: required, but not set

<?php

use Docuconf\Declaration;
use Illuminate\Foundation\Testing\TestCase;

// With APP_ENV=testing the app skips its boot check; check() takes an explicit environment instead.
final class ConfigTest extends TestCase
{
    public function test_accepts_a_valid_environment(): void
    {
        $result = $this->app->make(Declaration::class)->check(['DATABASE_URL' => 'postgres://orders@db/orders']);
        $this->assertSame([], $result->violations);
    }

    public function test_reports_every_problem(): void
    {
        $result = $this->app->make(Declaration::class)->check(['PORT' => '70000']);
        $this->assertSame(
            ['PORT:out_of_range', 'DATABASE_URL:missing_required'],
            array_map(fn ($v) => "{$v->input}:{$v->code}", $result->violations),
        );
    }
}

APP_ENV=testing vendor/bin/phpunit tests/ConfigTest.php

php artisan docuconf:export --output=contract.cue

// Code generated by docuconf. DO NOT EDIT.
package orders

import "docuconf.dev/contract"

contract.#Contract & {
	apiVersion: "docuconf.dev/v1alpha1"
	kind:       "ConfigContract"
	metadata: {
		name: "orders"
		generator: {
			language: "php"
			sdk:      "docuconf/docuconf"
			version:  "0.1.0"
		}
	}
	vars: {
		ALLOWED_ORIGINS: {
			type:        "list"
			description: "Origins allowed to call the API (CORS)"
			items:       "string"
			encoding:    "csv"
			separator:   ","
			minItems:    1
			default: ["http://localhost:3000"]
		}
		DATABASE_URL: {
			type:        "url"
			description: "Orders database connection string"
			required:    true
			secret:      true
			schemes: ["postgres", "postgresql"]
			maxLength: 2048
		}
		ORDERS_LOG_LEVEL: {
			type:        "enum"
			description: "Minimum level the orders code logs"
			values: ["debug", "info", "warn", "error"]
			default: "info"
		}
		PORT: {
			type:        "int"
			description: "HTTP listen port"
			min:         1
			max:         65535
			default:     8080
		}
		REQUEST_TIMEOUT: {
			type:        "duration"
			description: "Timeout for each request"
			details:     "Raise it when clients upload large order batches. Keep it below the\nload balancer's idle timeout, or the client sees a reset rather than\na `504`."
			encoding:    "go"
			min:         "1s"
			max:         "5m"
			default:     "30s"
		}
		WORKER_COUNT: {
			type:        "int"
			description: "Number of background workers"
			min:         1
			max:         64
			default:     4
		}
	}
}