Usine JS : générer votre squelette de projet Javascript & Express.js avec GIMME

Dès que vous voulez créer un projet javascript de webapp, il faut créer une arborescence, aller chercher les librairies javascript qui vont bien à droite à gauche sur internet … C’est ennuyeux.

Pour régler ce petit tracas, je vous conseille l’utilisation du “ingeniously simple” Gimme de @mklabs que vous trouverez ici : https://github.com/mklabs/gimme-assets avec un article d’explication en français par son auteur : http://blog.mklog.fr/articles/just-gimme-web-assets-please/.

Eh! Mais qu’est ce que c’est ? Alors Gimme c’est un utilitaire en mode commande qui permet d’aller télécharger les librairies javascript référencées sur des repositories officiels, vous permettant d’avoir les dernières versions et cela sans aucun effort.

Comment ça marche ? … je résume

Problématique :

Je veux installer dans le répertoire lib de ma webapp mes frameworks js préférés : jQuery, Underscore, Backbone et Tempo (pour le templating, je le préfère à Mustache).

Solution : … avec Gimme

Tapez simplement ceci :

gimme install jquery underscore.js backbone.js tempo -o ./lib

Remarque : dès fois il y a “.js” à la fin et dès fois non ! C’est normal, tout dépend de comment les librairies ont été référencées dans les repositories auxquels se connectent Gimmme, pour avoir l’ensemble des noms vous pouvez tapez la commande gimme list.

Oui mais moi mon projet c’est du Express.js, ça va pas le faire !?

Ben si !, un des petits trucs sympathique de Gimme, c’est que vous pouvez écrire vos propres commandes (allez lire l’article de @mklabs c’est très bien expliqué.

Problématique :

Je veux :

• générer une application express.js
• mettre à jour les dépendances
• installer ejs (pour le templating, je préfère à jade)
• installer toutes mes libs clients dans le répertoire /public/javascripts du projet express.js

Solution : … avec Gimme

Dans le répertoire ` ~/.gimme/commands (si commands n'existe pas créez le), créez un fichier mystack.js` avec le code suivant :

module.exports = mystack_cmd;

var fs = require('fs')
	, path = require('path')
	, exec = require('child_process').exec;


mystack_cmd.usage = "gimme mystack <appname>";
mystack_cmd.description = ['my personnal express.js boilerplate', "@k33g_org"];

function launch(cmd, cb) {
	exec(cmd, function(err, stdout, stderr) {
	    if (err) {
			console.log(err);
			throw err;
		}
	    else {
			console.log(cmd+ " -> OK");
			if(cb) cb();
		}
	});
}

function mystack_cmd (opts, cb) {
	var appname = opts.argv.remain.slice(1)[0];
	launch("express " + appname, function() {
		launch("cd " + appname + " && npm install -d", function(){
			launch("cd " + appname + " && npm install ejs", function() {
				console.log(appname + " has been created.")
			});
		});
	});
}

Et maintenant pour générer mon application “bobistheking”, en mode commande :

gimme mystack bobistheking
gimme install jquery underscore.js backbone.js tempo -o ./bobistheking/public/javascripts

Et voilà !!! En quelques secondes votre projet d’application est prêt, et vous pouvez utiliser votre nouvelle commande à volonté.

Pistes d’amélioration

• vous pourriez tout mettre ensuite dans un script shell
• faire une commande qui vous génère les pages html de démarrage de votre projet
• etc. …

En tous les cas, dites vous que vous avez gagné du temps et que vos projets seront tous structurés de la même façon.

@+