type-lang/printer

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

Maintainers

Details

github.com/php-type-language/printer

Source

Issues

Installs: 14 859

Dependents: 4

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

1.2.1 2024-10-08 16:03 UTC

Requires

Requires (Dev)

MIT 7a9db2f2697bf6a4cbfcf8324c8e5f944c30c14a

phplanguagerenderprinter

This package is auto-updated.

Last update: 2024-11-08 16:22:03 UTC

README

PHP 8.1+ Latest Stable Version Latest Unstable Version License MIT

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