https://github.com/irontec/typescript-generator-bundle

Bundle to generate TypeScript elements based on a Symfony project
https://github.com/irontec/typescript-generator-bundle

doctrine entity symfony symfony-bundle typescript

Last synced: 9 days ago
JSON representation

Bundle to generate TypeScript elements based on a Symfony project

• Host: GitHub
• URL: https://github.com/irontec/typescript-generator-bundle
• Owner: irontec
• License: eupl-1.1
• Created: 2020-01-10T08:37:13.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-02-15T09:30:05.000Z (9 months ago)
• Last Synced: 2024-04-10T13:56:15.907Z (7 months ago)
• Topics: doctrine, entity, symfony, symfony-bundle, typescript
• Language: PHP
• Size: 33.2 KB
• Stars: 2
• Watchers: 15
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# TypeScriptGeneratorBundle

Este bundle genera complementeos para usar en TypeScript, basados en un proyecto symfony.

# Install

````bash

composer require irontec/typescript-generator-bundle

````

> PHP *>=7.4*

# Commands

[Generate Interface](#generate-interface)

[Generate Package](#generate-package)

[Generate All](#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:

````bash

bin/console typescript:generate:interface output-dir [entities-dir]

````

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**" en la definición de la clase, Ejemplo:

````php

 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.

````php

// src/Entity/User.php

 [Librería con la que se gestionan las versiones](https://github.com/PHLAK/SemVer)

## Generate All

````bash

bin/console typescript:generate:all output-dir [entities-dir] [package-name] [version]

````

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](https://github.com/nvm-sh/nvm#installing-and-updating)

1) Iniciar sesión en NPM

````bash

npm adduser --registry https://npm.example.com

````

2) Publicar/Actualizar los cambios en las interfaces

````bash

npm publish --registry https://npm.example.com

````