benqoder / laravel-typescript-generator
A laravel package to generate typescript interfaces from laravel responses using GPT-3.5
Requires
- php: ^8.0
- illuminate/contracts: ^9.28|^10.0
- spatie/laravel-package-tools: ^1.14.0
Requires (Dev)
- laravel/pint: ^1.0
- nunomaduro/collision: ^7.9
- nunomaduro/larastan: ^2.0.1
- orchestra/testbench: ^8.0
- pestphp/pest: ^2.0
- pestphp/pest-plugin-arch: ^2.0
- pestphp/pest-plugin-laravel: ^2.0
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.0
- spatie/laravel-ray: ^1.26
This package is auto-updated.
Last update: 2024-05-09 04:27:43 UTC
README
This package for laravel converts your json responses to typescript types and interfaces using GPT-3.5 then stores them in the specified directory.
Installation
You can install the package via composer:
composer require benqoder/laravel-typescript-generator
You can publish the config file with:
php artisan vendor:publish --tag="laravel-typescript-gen-config"
This is the contents of the published config file:
return [ 'enabled' => env('TYPESCRIPT_GENERATOR_ENABLED', false), 'openai_api_key' => env('OPENAI_API_KEY', ''), 'output_path' => env('TYPESCRIPT_GENERATOR_OUTPUT_PATH', '.typescript-generator'), ];
Usage
Register Typescript generator middleware as the last middleware in app/Http/Kernel.php
protected $middleware = [ ... \BenQoder\TypescriptGenerator\Middleware\TypescriptGenerator::class, ];
When you send request and the response header specifies content-type as "application/json" the Typesceipt interfaces will be generated and placed in "/.typescript-generator" directory or the custom direcory you specify in the config file.
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.