Documentando Directivas de AngularJS

Me encontraba en la necesidad de documentar el código de Tubular para que sea visible todos los atributos y hermosos controles que tenemos. Apenas estaba pensando que quizás solo haría un montón de documentos planos y que Pikachu guiara mi camino de dolor a la salvación. Pero me dije, si AngularJS tiene documentación no tan mal, seguramente algo estan haciendo.

Llegue al documento de AngularJS en Github titulado Writing-AngularJS-Documentation que explican, nada claro, como realizar la documentación por medio. Para realizar la documentación necesitas comenzar con escribir en tu código todo lo que necesitas explicar usando ngDoc que es un sabor extendido de jsDoc. Es lo mismo pero solo con unos campos adicionales especificos para AngularJS.

Ya con tus archivos JS llenos de comentarios relevantes y detalles que casi nadie lee. Es momento que comience lo bueno, pues hay que montar un paquete llamado Dgeni (nota: por favor instala el Dgeni-packages porque Dgeni por si mismo hace nada) y comenzar a escribir un Javascript que debera procesar los comentarios jsDoc.

Dgeni soporta muchas formas de exportar el contenido, y en los paquetes trae soporte para nunjunks que es una especie de template engine, no tan cool, que puedes usar para generar unos lindos HTML con todo. La verdad que al principio configurar dgeni es un poco raro, por eso mejor les dejo el siguiente ejemplo que use para comenzar https://github.com/petebacondarwin/dgeni-angular. El archivo "dgeni-conf.js" es donde sucede gran parte de la magía.

Finalmente ya puedes mover tu monton de archivos HTML con links internos, o como yo que los bote para usar un método de AngularJS acoplado a un controller que hice. El resultado se puede ver ya en línea: Tubular Documentation. Falta terminar de detallar, pero ya tenemos API DOC!

Novedades Tubular

El desarrollo de Tubular continua  y ahora ya tenemos un nuevo y elegante generador usando la plataforma de Yeoman, que funciona con NodeJS. Las tareas que se pueden hacer con el generator-tubular son:

• Iniciar un nuevo proyecto Tubular (con AngularJS y Bootstrap) que puede usar tanto Bower como un CDN para cargar las librerías.
• Crear vistas de ejemplo o desde un archivo JSON.
• Generar una vista de Grid directamente a tu proyecto actual usando un OData, con opciones para personalizar (similares a las del generador en línea).
• Generar una vista de Form, igual con un servicio OData.

Faltan detalles, pero está luciendo bastante bien. Ya no me da tanto "flojera" programar con NodeJS, no es tan feo después de todo.

Novedades DEV

Ya termine una herramienta que empece en la raspberry pi, despues de morir al intentar instalar nodejs. Que dificil es tener herramientas de desarrollo actualizadas hoy en día. En fin la herramienta hace un simple backup de las imagenes publicadas en un blog de Ghost. Dado que la supuesta funcionalidad de backup que tiene no te deja bajarlas. El código se encuentra en https://github.com/geoperez/ghost_tools y es la primer herramienta que hago en NodeJS y no estoy orgulloso.

Lo que si esta quedando realmente guapo es el Tubular Web Generator que permite generar todo el markup para un grid de Tubular desde un modelo JSON, hasta te permite exportar todo tu diseño a Plunker para mandarlo a Git o que se yo.