Posted on by MariaJose

CLI: créela con Javascript y Node.js

CLI

¡Cree su propia CLI con Javascript y Node.js!

Tiene la capacidad de crear su propia CLI impresionante con Node.js que podría automatizar cualquier proceso que actualmente realiza manualmente.

Un consejo que le daré a los nuevos ingenieros de software es: Si no puede encontrar una herramienta para automatizar un proceso que necesita y no puede encontrar una que ya exista, cree una usted mismo.

Lo que necesita tener

  • Comprensión básica de Javascript y Node.js
  • Una terminal basada en Unix
  • Un editor de texto, voy a usar VS Code en este ejemplo

Configurar esta cosa

Vamos a crear el directorio de su proyecto, inicializaremos Node.js y agregaremos los archivos que necesitará para que su proyecto sea compatible con la línea de comando:

1. Mejore su entorno abriendo su terminal e ingresando el siguiente comando y completando el aviso:
mkdir myAwesomeCLI && cd myAwesomeCLI && npm init

Esto creará el directorio de su proyecto, abrirá ese directorio e inicializará su proyecto Node.js.

2. Cree un directorio bin y un archivo de índice, será lo que su proyecto necesitará para su herramienta de línea de comandos, con este comando:
mkdir bin && touch bin/index.js

3. Escriba el shebang en su archivo de índice, el shebang le dirá a su archivo que se puede ejecutar como un script en una herramienta de terminal:
echo '#!/usr/bin/env node' > bin/index.js

4. Si tiene configurado el comando VSCode, abra su proyecto con code.  o abra su proyecto en su editor de texto preferido.

5. Vaya a bin/index.js, agregue console.log("Hello World!"); debajo de su shebang, si está usando VSCode, debería ver algo como esto:

CLI
Ejemplo de archivo index.js abierto con {Hello World!}.

Instalar y ejecutar

Vamos a configurar su proyecto para que pueda instalarse globalmente, instalarlo globalmente y probar la instalación ejecutándolo:

1. Asigne su directorio bin en su paquete JSON agregando la siguiente definición:

"bin": {
"myawesomecli": "./bin/index.js"
}

Ejemplo de un paquete de ejemplo.json a continuación…

2. En su terminal en el directorio de su proyecto, ejecute: npm install --global

3. Pruebe para ver si su instalación escribe el nombre del proyecto, en este caso: myawesomecli y debería imprimir “Hello World!” a la pantalla

CLI
Ejemplo de definición de paquete JSON.

Has creado una herramienta CLI, ¡es usted increíble ! 🎉

Recent Post