Download the PHP package vinatis/typescript-generator without Composer
On this page you can find all versions of the php package vinatis/typescript-generator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download vinatis/typescript-generator
More information about vinatis/typescript-generator
Files in vinatis/typescript-generator
Package typescript-generator
Short Description Bundle to generate TypeScript elements based on a Symfony project
License EUPL-1.1
Informations about the package typescript-generator
TypeScriptGeneratorBundle
Ce bundle génère des éléments TypeScript basés sur un projet Symfony.
PHP ^8.4 — Symfony ^7.4
Installation
Ce bundle est disponible sur Packagist :
Commandes disponibles
- Générer des interfaces
- Générer un package
- Tout générer
Générer des interfaces
Cette fonctionnalité permet de créer des interfaces TypeScript à partir de classes PHP conçues pour fonctionner comme des entités Doctrine.
Les interfaces sont générées en se basant sur les propriétés de ces classes. Il existe 3 façons d'obtenir le type de chaque propriété :
- Typage fort de la propriété (disponible depuis PHP 7.4)
-
private int $id;
-
- Typage dans le commentaire de la propriété
-
@var int
-
- Typage via les annotations ou attributs Doctrine
-
@ORM\Column(type="integer")ou#[ORM\Column(type: 'integer')]
-
Si aucun type n'est trouvé, l'interface sera générée avec le type unknown.
La génération des interfaces s'effectue avec la commande suivante :
Ce commande accepte 2 paramètres, dont un obligatoire et un optionnel.
output-dir (Obligatoire) : Répertoire où les interfaces seront créées.
entities-dir (Optionnel) : Répertoire des entités à utiliser pour générer les interfaces. Par défaut : src/Entity/.
Pour qu'une entité soit convertie en interface, ajoutez l'attribut #[TypeScriptMe] dans la définition de la classe :
Types personnalisés
Pour forcer un type TypeScript personnalisé sur une propriété, utilisez l'attribut #[TypeScriptCustomType] :
Types supportés
| TypeScript | PHP / Doctrine |
|---|---|
number |
int, integer, smallint, bigint, decimal, float |
string |
string, text, guid, date, time, datetime, datetimetz |
boolean |
boolean |
Interface |
Interface liée dans une relation one-to-one |
Interface[] |
Tableau d'interfaces dans une relation one-to-many |
unknown |
Tout autre type non reconnu |
Si les annotations Doctrine définissent
nullable=true, ou si le typage PHP utilise?avant le type, la propriété sera marquée comme optionnelle (?) dans l'interface TypeScript générée.
Exemple
Entité PHP :
Interface TypeScript générée :
Pour faciliter l'utilisation des interfaces, le fichier models.d.ts est généré automatiquement avec l'export de toutes les interfaces :
Générer un package
Cette commande génère un fichier package.json avec les données de base pour publier dans un dépôt npm privé.
À chaque exécution, la version patch est incrémentée par défaut. Il est possible de passer une version spécifique ou d'indiquer patch, minor ou major.
Exemple de package.json généré :
Tout générer
Exécute les deux commandes précédentes en une seule fois.
Publier dans un dépôt npm privé
Pour publier dans un dépôt privé, il faut avoir préalablement généré le fichier package.json et avoir npm installé.
1) Se connecter à npm
2) Publier / mettre à jour les interfaces
All versions of typescript-generator with dependencies
symfony/console Version ^7.0
symfony/filesystem Version ^7.0
symfony/finder Version ^7.0
phlak/semver Version ^3.0.1
symfony/dependency-injection Version ^7.0
symfony/config Version ^7.0
symfony/http-kernel Version ^7.0