Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/janit/typescriptgeneratorbundle
A Symfony Bundle that adds a command to extract TypeScript interfaces from PHP classes
https://github.com/janit/typescriptgeneratorbundle
php symfony typescript
Last synced: 2 months ago
JSON representation
A Symfony Bundle that adds a command to extract TypeScript interfaces from PHP classes
- Host: GitHub
- URL: https://github.com/janit/typescriptgeneratorbundle
- Owner: janit
- License: mit
- Created: 2017-11-04T11:54:38.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-06-09T18:23:37.000Z (over 4 years ago)
- Last Synced: 2024-11-08T15:54:26.005Z (3 months ago)
- Topics: php, symfony, typescript
- Language: PHP
- Size: 11.7 KB
- Stars: 16
- Watchers: 3
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
PHP Classes to TypeScript Interfaces Generator Bundle
======
A Symfony bundle that adds a command to extract [TypeScript interface](https://www.typescriptlang.org/docs/handbook/interfaces.html) from PHP classes. Based on [the example from Martin Vseticka](https://stackoverflow.com/questions/33176888/export-php-interface-to-typescript-interface-or-vice-versa?answertab=votes#tab-top) this bundle uses [the PHP-Parser library](https://github.com/nikic/PHP-Parser) and annotations. This is currently very basic feature wise, but it does work.
TypeScript is a superscript of JavaScript that adds strong typing and other features on top of JS. Automatically generated classes can be useful, for example when using a simple JSON API to communicate to a JavaScript client. This way you can get typing for your API responses in an easy way.
This is currently tightly coupled to the Symfony Framework, but could be extracted. Feel free to build on this or use as inspiration to build something completely different.
## Installation
As a Symfony bundle you'll need to start by add the package to your project with composer:
```
$ composer req janit/typescript-generator-bundle
```
After this you'll need to activate the bundle in your `app/AppKernel.php` file:
```
new Janit\TypeScriptGeneratorBundle\TypeScriptGeneratorBundle()
```
Once this is done you should have the added command in place in your console and you can run:
```
$ php bin/console typescript:generate-interfaces
```
This will yield an error because the command expects `fromDir` as a parameter on where to scan for PHP classes.
NOTE: These instructions are for Symfony Standard Edition (3.3), but the bundle should work with Symfony Flex as well.
## Usage
The command scans directories recursively for all `.php` files. It will only generate Type Definitions (interfaces) for files with appropriate annotations.
To generate interfaces, create a new class in `src/AppBundle/Entity/Person.php` and enter the following:
```php