type-lang/printer

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

1.0.0 2024-04-15 01:57 UTC

This package is auto-updated.

Last update: 2024-05-17 19:25:58 UTC


README

dark.png?raw=true

PHP 8.1+ Latest Stable Version Latest Unstable Version License MIT

badge.svg

Reference implementation for TypeLang Printer.

Resources

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_*,
//     ...
// }