Skip to content

Latest commit

 

History

History
83 lines (64 loc) · 3.5 KB

README.md

File metadata and controls

83 lines (64 loc) · 3.5 KB
Raw

php-converter Latest Version on Packagist Tests PHPStan Total Downloads

Screen Shot 2022-10-07 at 09 04 35

Generates TypeScript & Dart out of your PHP DTO classes.

Why?

Statically typed languages like TypeScript or Dart are great because they allow catching bugs without even running your code. But unless there are well-defined contracts between the API and consumer apps, you may find yourself frequently adjusting outdated typings whenever the API changes. This library generates types for you, enabling you to move faster and encounter fewer bugs.

Requirements

PHP 8.0 or above

Quick start

  1. Installation
composer require riverwaysoft/php-converter --dev

If the installation leads to dependency conflicts, consider using the standalone Phar version of the package.

  1. Mark a few classes with the #[Dto] annotation to convert them into TypeScript or Dart.
use Riverwaysoft\PhpConverter\Filter\Attributes\Dto;

#[Dto]
class UserOutput
{
    public string $id;
    public int $age;
    public ?UserOutput $bestFriend;
    /** @var UserOutput[] */
    public array $friends;
}
  1. Run the CLI command to generate TypeScript
vendor/bin/php-converter --from=/path/to/project/src --to=.

This will generate a file generated.ts with the following content:

type UserOutput = {
  id: string;
  age: number;
  bestFriend: UserOutput | null;
  friends: UserOutput[];
}

Features

  • Supports all PHP data types including union types, nullable types, and enums.
  • Supports PHP DocBlock types, e.g., User[], int[][]|null, and generics thanks to phpstan/phpdoc-parser
  • Custom type resolvers (for instance, for DateTimeImmutable).
  • Generate a single output file or multiple files (1 type per file).
  • Option to override the generation logic.
  • Flexible class filters with the option to use your own filters.
  • Generate API client from Symfony or API Platform code.

Customization

If you'd like to customize the conversion process, you need to copy the config script to your project folder:

cp vendor/riverwaysoft/php-converter/bin/default-config.php config/ts-config.php

Now you can customize this config and run the php-converter using the following script:

vendor/bin/php-converter --from=/path/to/project/src --to=. --config=config/ts-config.php

Documentation