Utiliser haxeLib

You are viewing an old version of this entry, click here to see latest version.

Haxe est distribuée haxelib, un outils qui permet au développeurs de partager leurs code et librairies dans un repository commun.

haxelib est un outil en ligne de commande, vous avez donc besoin de le lancer dans la console. Les commandes suivantes sont disponibles :

  haxelib search word

Liste les projets qui ont un nom ou une description contenant le mot spécifié.

  haxelib info project-name

Donne les informations sur un projet donné.

  haxelib install project-name [version]

Installe un projet donné. Il est possible de spécifier une version spécifique à installer. Par défaut, la dernière version disponible sera installée.

  haxelib remove project-name [version]

Supprime un projet entier, ou seulement une version spécifié, si spécifié.

  haxelib list

Liste tout les projets installés et leurs versions. Pour chaque projet, la version entourée par des parenthèses est la version courante.

  haxelib upgrade

Mets à jour tout les projets installés à leur dernière version. Cette commande demande une confirmation pour chaque projet pouvant être mis à jour.

  haxelib set project-name version

Cela change la version utilisé pour un projet donné. La version doit être au préalable installée.

  haxelib run project-name [arguments...]

Cela lance le projet donné, si un run script est fourni. Soyez sur de pouvoir faire confiance au projet que vous lancez, car le script pourrait causer des dommages à votre système.

Utiliser un projet installé avec Haxe

Une fois que le projet est installé, vous pouvez simplement utiliser le paramètre "-lib" du compilateur Haxe pour l'utiliser à partir de votre application :

  haxe -lib project-name ...

Par défaut, c'est la version actuel du projet qui est utilisée. Si vous voulez utiliser une version spécifique du projet, ajoutez le nom de la version séparé par le caractère ":".

  haxe -lib project-name:version ...

Téléchargement derrière un Pare-feu

Il n'y a aucune interface Web pour haxelib pour le moment, mais vous pouvez facilement installer un package haxelib depuis un fichier ZIP. Ça peut être utile si vous vous trouvez derrière un proxy/firewall qui empêche haxelib de télécharger le package. Parcourez simplement http://lib.haxe.org/files pour télécharger le fichier/la version dont vous avez besoin, et sauvegardez ceci sur votre disque dur local. Vous pouvez ensuite lancer la commande suivante pour l'installer :

  haxelib test <zip-file>

Créer un package haxelib

Si vous voulez ajouter votre propre projet, il vous suffit simplement de créer un fichier nommé haxelib.xml. Voici un exemple :

<project name="myproject" url="http://myproject.org" license="GPL">
    <user name="mylogin"/>
    <description>This project is an example of an haxelib project</description>
    <version name="1.0">Initial release, everything is working correctly</version>
</project>

Les informations suivantes sont nécessaires :

  • project name : Ceci est le nom haxelib de votre projet, il doit au moins contenir 3 caractères parmi les suivants : [A-Za-z0-9_-.]. En particulier, les espaces ne sont pas autorisés.
  • project url : Ceci est l'adresse du site. Veuillez au moins spécifier l'adresse du repository de votre projet, ou mieux la page personnel si vous en avez une.
  • license : haxelib n'autorise seulement que les projets open-source à être ajouter au repository. Les noms de licence suivants sont accepté : GPL, LGPL, BSD, Public (pour Public Domain).
  • user : C'est le nom de votre compte d'utilisateur. La première fois que vous proposer un de vos projet, il vous sera demandé de créer ce compte. Le nom d'utilisateur obéit aux mêmes règles que le nom de projet. Les mots de passes sont envoyés de manière cryptée (MD5) sur le serveur et seule la version crypté y est laissé. Vous pouvez avoir plusieurs utilisateurs pour un même projet si vous le désirez.
  • description : La description du projet. Essayé de faire bref, seulement 2-3 phrases expliquant ce que le projet fait. Plus d'informations seront disponibles sur la page de projet de toute façon.
  • version : Ce sont les informations à propos de la versions que vous envoyez. Le nom de la version doit suivre les mêmes règles que le nom de projet. Une description de la version est demandée, afin de décrire les changements effectués. Essayé de même de faire au plus court possible.

Construire un Package

Une fois votre fichier haxelib.xml file écrit, vous pouvez créer un package pour votre projet. Un Package consiste en un fichier ZIP contenant l'ensemble des fichiers et répertoires de votre projet. Par exemple, voici comment la structure des répertoires pourrait se présenter :

 |- myproject
     |- haxelib.xml
     |- my
        |- project
           |- MyClass.hx

Le projet contient seulement un unique fichier my.project.MyClass. Le répertoire myproject peut être comprimé dans un ZIP pour créer un package haxelib ((Téléchargez le projet exemple).

Normalement, un utilisateur doit être capable de compiler vos sources en ajoutant simplement à la commande haxe -cp path/to/myproject. Ne surtout PAS mettre les sources destinés à être utilisé par l'utilisateur final dans un package "src" ou toutes autres conventions déjà utilisé. Par exemple, si vous n'avez aucun package, les sources devraient se trouver dans le même répertoire que haxelib.xml.

Tester le package

Une fois que votre package est prêt, vous pouvez le tester en utilisant

  haxelib test <package-zip>

Vérifiez que tout (installation et utilisation) fonctionne correctement avant la soumission du package, car une fois soumis, une version ne peut pas être mis à jour.

Soumettre un Package


Une fois que vous êtes prêt, vous pouvez soumettre un package en lançant la commande suivante :
  haxelib submit myproject.zip

Si le nom d'utilisateur est inconnu, Il vous sera d'abord demander de créer un compte. Si l'utilisateur existe déjà, votre mot de passe sera demandé.

Si le projet n'existe pas encore, il sera créé, mais aucune version ne sera ajoutée. Vous devez le soumettre une deuxième fois pour que votre projet soit ajouté.

Si vous voulez changer l'adresse ou la description de projet, modifiez simplement votre haxelib.xml (En gardant la information de la version inchangé) et soumettez le de nouveau.

Dépendances

Si votre projet dépend d'un autre projet haxelib, vous pouvez spécifier les dépendances dans le fichier haxelib.xml :

<project name="myproject" url="http://myproject.org" license="GPL">
    ...
    <depends name="other-project"/>
    <depends name="specific-project" version="1.2"/>
</project>

Par exemple, on spécifie ici que la version de myproject dépend de la dernière version de la dernière version de other-project et de la version 1.2 de specific-project. Les dépendances sont définies par version, et non par projet, vous pouvez donc changer les dépendances de votre projet quand vous soumettez une nouvelle version.

Projet lançable

Si vous incluez un fichier Haxe/Neko précompilé run.n dans votre package de projet (dans le même répertoire où se trouve haxelib.xml), les utilisateurs seront capable de lancer le projet en utilisant la commande haxelib run. C'est utile si vous voulez que les utilisateurs soient capables de lancer un script post-installation qui configurera certaines choses dans le système.

Inclure des Dlls Neko

Si votre projet et un projet Neko qui inclue des DLLs Neko (fichiers ndll), vous avez besoin de les placer dans un répertoire ndll dans votre package haxelib, suivi d'un répertoire avec le nom du système visé :

 |- myproject
     |- haxelib.xml
     |- my
     |  |- project
     |     |- MyClass.hx
     |- ndll
        |- Linux
        |   |- myproject.ndll
        |- Windows
           |- myproject.ndll

Les systèmes suivant peuvent être utilisé : Windows, Linux, Mac et BSD. Si un répertoire système n'existe pas quand le projet et utiliser par l'utilisateur final, haxelib affichera un message disant que le projet n'est pas supporté par le système.

Pour les Mac, Veuillez fournier les universal binaries de vos fichiers ndll pour qu'ils puissent être utilisé à la fois sur Mac/PCC et sur Mac/Intel.

Veuillez aussi ne pas oublier d'ajouter les sources de vos fichiers ndll dans le package. Même s'ils ne sont pas nécessaires pour utiliser votre projet, il est nécessaire de les inclure afin que tout reste open-source.

version #5100, modified 2008-12-16 00:11:41 by Barry