type-lang/printer

Library for rendering TypeLange AST nodes into it's string representation

1.2.1 2024-10-08 16:03 UTC

Requires

• php: ^8.1
• type-lang/parser: ^1.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.53
• phpstan/extension-installer: ^1.4
• phpstan/phpstan: ^1.11
• phpstan/phpstan-strict-rules: ^1.6
• phpunit/phpunit: ^10.5|^11.0
• rector/rector: ^1.1

MIT

• php
• language
• render
• printer

README

Reference implementation for TypeLang Printer.

Resources

• Documentation

Installation

TypeLang Printer is available as Composer repository and can be installed using the following command in a root of your project:

composer require type-lang/printer

Quick Start

$parser = new \TypeLang\Parser\Parser();
$type = $parser->parseType(<<<'PHP'
    array{
        field1: (callable(Example,int):mixed),
        field2: list<Some>,
        field3: iterable<array-key, array{int, non-empty-string}>,
        Some::CONST_*,
        "\njson_flags": \JSON_*,
        ...
    }
    PHP);

// Print Statement

$native = new \TypeLang\Printer\NativeTypePrinter();
echo $native->print($type);

// Expected Output:
// array

$phpdoc = new \TypeLang\Printer\PrettyPrinter();
echo $phpdoc->print($type);

// Expected Output:
// array{
//     field1: callable(Example, int): mixed,
//     field2: list<Some>,
//     field3: iterable<array-key, array{
//         int,
//         non-empty-string
//     }>,
//     Some::CONST_*,
//     "\njson_flags": \JSON_*,
//     ...
// }