Class docblock transformer

[ragulka]

We've implemented a custom transformer which reads PHP class docblock @property tags and generates the Typescript defintion from these, instead of actual class properties. This is useful in cases where you'd want to transform things like Eloquent models into TS defintions, since there's no simple way to type the actual Eloquent model properties.

Would you be interested in having us contribute this in a PR?

Basically, given something like this:

/**
 * Product
 *
 * @property-read int $id product ID
 * @property string $name product name
 * @property string $description description
 * @property Brand $brand
 * @property ProductCategory[] $categories
 * @property array<string, mixed> $metadata {@ts-optional}
 * @property array<string, mixed> $internal_metadata {@ts-hidden}
 *
 * @typescript
 */
class Product extends Model {};

#[TypeScript]
enum Brand : string {
	case APPLE = 'apple';
	case SAMSUNG = 'samsung';
	case GOOGLE = 'google';
};

#[TypeScript]
enum ProductCategory: string {
	case PHONE = 'phone';
	case TABLET = 'tablet';
	case LAPTOP = 'laptop';
	case WIDGET = 'widget';
};

Will get you this:

export type Release = {
	id: number;
	name: string;
	description: string;
	brand: Brand;
	categories: ProductCategory[];
	metadata?: { [key: string]: any };
}
export type Brand = "apple" | "samsung" | "google";
export type ProductCategory = "phone" | "tablet" | "laptop" | "widget";

Notice how the Product class does not have any PHP types, other than the @property tags in the class docblock. Also, there are a few special docblock description tags - @ts-optional and @ts-hidden, which tell the transformer to make the property optional, or hide it from TS completely.

Using these tags it would also be possible to implement support for literal TS types and Record types.

We've also worked out a way to support unqualified class names in docblocks, so there's no need to use FQCNs.

Would this be something valuable to this package? If so, I can extract the implementation our of our codebase and prepare a PR.