docuconf for PHP (Symfony)

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

# Every variable the service reads, written as in contract.cue. Read them
# with %env(docuconf:NAME)%: the value docuconf validated, typed.
docuconf:
    name: orders-symfony
    vars:
        PORT: {type: int, description: HTTP listen port, min: 1, max: 65535, default: 8080}
        LOG_LEVEL: {type: enum, description: Minimum log level, values: [debug, info, warn, error], default: info}
        DATABASE_URL: {type: url, description: Orders database connection string, required: true, secret: true, schemes: [postgres, postgresql], maxLength: 2048}
        ALLOWED_ORIGINS: {type: list, description: Origins allowed to call the API (CORS), items: string, minItems: 1, default: ['http://localhost:3000']}
        REQUEST_TIMEOUT: {type: duration, description: Timeout for each request, min: 1s, max: 5m, default: 30s}
        WORKER_COUNT: {type: int, description: Number of background workers, min: 1, max: 64, default: 4}

parameters:
    orders.port: '%env(docuconf:PORT)%'
    orders.request_timeout_seconds: '%env(docuconf_seconds:REQUEST_TIMEOUT)%'

// The typed configuration, with the secret shown as "***".
#[Route('/config')]
public function config(Values $config): JsonResponse
{
    return new JsonResponse($config->redacted());
}

DATABASE_URL=postgres://orders:pw@localhost:5432/orders php -S 127.0.0.1:8080 -t public

$ PORT=0 bin/console docuconf:check
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\Symfony\Docuconf;
use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;

// check() takes an explicit environment: the process environment is not read or changed.
final class ConfigTest extends KernelTestCase
{
    public function testAcceptsAValidEnvironment(): void
    {
        $result = self::getContainer()->get(Docuconf::class)->check(['DATABASE_URL' => 'postgres://orders@db/orders']);
        self::assertSame([], $result->violations);
    }

    public function testReportsEveryProblem(): void
    {
        $result = self::getContainer()->get(Docuconf::class)->check(['PORT' => '70000']);
        self::assertSame(
            ['PORT:out_of_range', 'DATABASE_URL:missing_required'],
            array_map(fn ($v) => "{$v->input}:{$v->code}", $result->violations),
        );
    }
}

# The test container, for KernelTestCase.
framework:
    test: true

DATABASE_URL=postgres://ci@db/orders APP_ENV=test KERNEL_CLASS='App\Kernel' vendor/bin/phpunit tests/ConfigTest.php

bin/console docuconf:export --output=contract.cue

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

import "docuconf.dev/contract"

contract.#Contract & {
	apiVersion: "docuconf.dev/v1alpha1"
	kind:       "ConfigContract"
	metadata: {
		name: "orders-symfony"
		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
		}
		LOG_LEVEL: {
			type:        "enum"
			description: "Minimum log level"
			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"
			encoding:    "go"
			min:         "1s"
			max:         "5m"
			default:     "30s"
		}
		WORKER_COUNT: {
			type:        "int"
			description: "Number of background workers"
			min:         1
			max:         64
			default:     4
		}
	}
}