Download the PHP package irontec/typescript-generator-bundle without Composer
On this page you can find all versions of the php package irontec/typescript-generator-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download irontec/typescript-generator-bundle
More information about irontec/typescript-generator-bundle
Files in irontec/typescript-generator-bundle
Package typescript-generator-bundle
Short Description Bundle to generate TypeScript elements based on a Symfony project
License EUPL-1.1
Homepage https://www.irontec.com
Informations about the package typescript-generator-bundle
TypeScriptGeneratorBundle
Este bundle genera complementeos para usar en TypeScript, basados en un proyecto symfony.
Install
`
PHP >=8.0
Commands
Generate Interface Generate Package Generate All
Generate Interface
Este funcionalidad consiste, en crear interfaces de TypeScript basandose clases PHP pensadas en funcionar como entidades de doctrine.
Estas interfaces se crean teniendo en cuenta las propiedades de estas clases. Como tal se tiene 3 formas de obtener el tipo de cada propiedad.
- Definición del tipado de la propiedad fuerte, disponible desde PHP 7.4
-
private int $id;
-
- Definición del tipado de la propiedad, en el comentario de esta
-
@var int
-
- Definición del tipado de la propiedad, en anotaciones de doctrine
-
@ORM\Column(type="integer")
-
En caso de no encontrar un tipo, se generara la interface con el tipo "unknown".
La generación de interfaces se hace ejecutando el siguiente comando:
`
Este comando acepta 2 parametros, los cuales uno es obligatorio y otro opcional.
output-dir [Obligatorio]: Directorio donde se crearan las interfaces entities-dir [Opcional]: Directorio de las entidades que se usaran para generar las interfaces. Por defecto se busca en "src/Entity/"
Para volver una entidad en una interface, es necesario escribir el comentario "#TypeScriptMe" o atributo #[TypeScriptMe]
en la definición de la clase, Ejemplo:
``
``
Tipado en TypeScript
Listado de tipados soportados:
TypeScript | PHP/Doctrine |
---|---|
number | int - integer - smallint - bigint - decimal - float |
string | string - text - guid - date - time - datetime - datetimetz |
boolean | boolean |
interface | Interface de una interface relacionada en un uno a uno |
interface[] | Array de interfaces, en una relación uno a muchos |
unknown | Cuando no es ninguna de las anteriores |
Si se usan las anotaciones de dotrine y se tiene definido "nullable=true" o en el tipado fuerte de la propiedad esta definido el ? antes del tipo, se aplica el ? despues del nombre de la propiedad, que se interpreta como un parametro optativo.
Example
Entidad en PHP y con anotaciones.
``
Interface de TypeScript generada
`
Para facilitar el uso de las interfaces, se general el fichero "models.d.ts" en el que se hace el export de todas las interfaces.
`
Generate Package
`
Con este comando se genera un fichero package.json con los datos básicos para publicar en un reposiorio privado de npm.
Cada vez que se ejecute el generador de package, por defecto se actualiza la versión "Patch" de este, con la opción de pasar una versión en concreto o subir de "patch", "minor" o "major".
Ejemplo del package.json que se genera:
`
Generate All
`
Ejecuta los comandos anteriores.
Publicar en un repositorio privado de NPM
Para publicar en un repositorio privado, es necesario generar previamente el fichero package.json y tener instalado npm
1) Iniciar sesión en NPM
`
2) Publicar/Actualizar los cambios en las interfaces
`
All versions of typescript-generator-bundle with dependencies
symfony/console Version ^6.4
symfony/filesystem Version ^6.4|^7
symfony/finder Version ^6|^7
phlak/semver Version ^3.0.1
symfony/dependency-injection Version ^6.4
symfony/config Version ^6.4
symfony/http-kernel Version ^6.4