gitbook-start-elt

Descripción

Creación de un libro automatizado, nuestro paquete te ayudará a optimizar tiempo en la creación de una estructura para gitbook.

Opciones

gitbook-start [OPTIONS]
    -d nombre del directorio a crear node gitbook-star -d miDirectorio
    -a autor del libro a crear node gitbook-star -a AutorDelLibro
    -r repositorio github contra el que se va a trabajar -r github.com/repo.git
    -i direccion a la que se pueden reportar los bugs (en forma de issues de github) -i github.com/repo/issues
    -f url de la homepage del libro -f github.com/repo#readme.md
    -w direccion web de la wiki en github -w github.com/repo.wiki.git
    -h muestra ayuda sobre las opciones disponibles

Ejemplo

$npm install gitbook-start-ericlucastania

$ gitbook-start -d MiLibro -a Jack

Enlaces interesantes

• Repositorio de la práctica.
• Descripción de la práctica.
• NPM

Datos de partida

• Repositorio Inicial Templates

Componentes del grupo de trabajo

• Eric Ramos
• Lucas Ruiz
• Tania González

Tutorial de como hacer la práctica

Descripción de la misma

Práctica: Creación de un Paquete NPM

El objetivo de esta práctica es crear un package NodeJS y publicarlo en npm. El paquete se construye a partir de el código que haya desarrollado en la práctica anterior.

Se trata de añadir un ejecutable gitbook-start (Véase seccion binen package.json) Este ejecutable construye una plantilla con la estructura inicial del libro y provee a partir de los argumentos que se le pasen los mecanismos para su fácil despliegue en

1. GitHub gh-pages y en
2. https://www.gitbook.com/

Para analizar los argumentos pasados en línea de comandos un buen módulo es minimist

Como deberán darse de alta en el site de npm asegúrense de ponerle a su paquete un nombre único que no coincida con el de los otros alumnos, por ejemplo gitbook-start-team-name

Añada a los otros miembros del equipo como contributors. Véase las seccion people fields de package.json Intente que su paquete funcione independientemente del Sistema Operativo (Linux, MacOS X, Windows, etc.)

Véase la sección Creación de Paquetes y Módulos en NodeJS Véase la secciónGulp Estudie el paquete ejs para la creación de plantillas Estudie los paquetes - como fs - para el manejo de archivos en Node.JS

Pasos Iniciales

Empezamos borrando todo y añadiendo las carpetas bin para meter el script que se iniciará al ejecutar nuestro paquete npm. También metemos la carpeta template que tendrá los ficheros que pasarán a ser la estructura principal de nuestro proyecto.

Usando los templates .ejs

Cambiaremos el nombre del hombre que hizo el repo inicial por una variable que se sustituirá posteriormente para ello, donde está su nombre pondremos <%= variable %>

Cuenta en npm

Empezaremos con esto creandonos una cuenta en npm, una vez creada. Desde la línea de comandos asociaremos nuestro espacio de trabajo con el de la cuenta mediante npm adduser. Una vez asociado podremos enviar nuestro directorio hacia npm mediante el comando npm publish.

Entendiendo minimist

Entendiendo el proceso del minimist.

Una vez instalado el módulo vemos que podemos separar argumentos,y así poder acceder a cada uno de los parámetros, por ahora tenemos esto.

    var argv = require('minimist')(process.argv.slice(2));
    console.dir(argv.a);
    
    
    
    if(argv.a){
        console.log("hola me llamo Idelfonso");
        
    }

Ahora el objetivo sería empezar a planificar el script, y ver que hacemos con los .ejs como podemos traducirlos para que se copien, para ello seguramente tendremos que hacer uso de alguno de los módulos de node que nos permita copiar carpetas. Veamos el módulo Filesystem. fs-extra que es el que nos venía nos permite crear una carpeta con un parámetro que le pasemos, en este caso usamos la a para indicar el nombre.

   var direct = process.cwd() + '/';

   fs.mkdirsSync(direct + argv.a);

Haciendo los anteriores comandos conseguimos que cuanndo cree un nuevo directorio lo cree a partir de la ruta actual en la que está ejecutando el comando

    gitbook-start -a DIR
    

Renderizar los archivos y pasarlos a otra carpeta

Tenemos que renderizar la carpeta template, cuando renderizas, se guardar todo en una variable de tipo string y esa variable usamos para crear un fichero con fs en la nueva carpeta. Hemos usado expresiones regulares para que cuando lo introduzca en la nueva carpeta le borre la extensión ejs. Quedandonos los archivos perfectamente, como al principio.

Problemas con las dependencias

Cuando se instala nuestro paquete en otro espacio de trabajo. Para su correcto funcionamiento es necesario que tenga una serie de paquetes de node. Estos paquetes debemos ponerlos en el apartado dependencies del package.json. Ya que si las ponemos en devDependencies no se instalarán cuando nuestro paquete sea descargado.

Problemas con las rutas(npm install -g)

Una vez instalado correctamente el módulo y comprobado su correcto funcionamiento. Tenemos algunos problemas con las rutas, ya que si se instala desde el npm -g, deberemos acceder a la carpeta donde se encuentre para renderizar los archivos. Para solucionar estos problemas hemos usado el paquete path, que mediante el comando path.join(__dirname) nos da el directorio donde está el script, por otro lado para crear la carpeta donde ubicaremos los scripts renderizados, necesitamos acceder al workspace del usuario, es decir a la carpeta donde esté trabajando. Para ello usamos el comando process.cwd()