Crea tu propia CLI con Inquirer
El crear tus propias CLI te puede ayudar a realizar diferentes acciones repetitivas y así ejecutarlas de una manera más cómoda desde una interfaz de consola.

El crear tus propias CLI te puede ayudar a realizar diferentes acciones repetitivas y así ejecutarlas de una manera más cómoda desde una interfaz de consola.
A lo largo de mi carrera como desarrollador Fullstack he creado varios proyectos base para iniciar un proyecto con el setup de herramientas y tecnologías que normalmente uso. Normalmente hago una copia del proyecto base he inicio a partir de ahi. Por lo que he decidido crear un CLI para poder iniciar mis proyectos de una manera mas cómoda.
- Iniciamos creado un proyecto de NodeJs
npm init -y- Instalamos dependencias, en mi caso
npm install --save chalk figlet inquirer nanospinner- Definimos el atributos
typeen nuestro package.json
"type": "module",- Creamos un archivo
index.jsy añadimos el scope debido a que este servirá como un bin file
#!/usr/bin/env node- Escribiré una función que se encargara de ejecutar los los comandos en consola runCommand
import { execSync } from "child_process";
const runCommand = (command) => {
execSync(`${command}`, { stdio: "inherit" });
};- Declaro un par de comandos que usare para traer clonar mis proyectos
//Clonar el repositorio en una carpeta en especifico sin el historial de commits
const gitCommand = (repo, repoName)=>`git clone --depth 1 ${repo} ${repoName}`;
// Instalar dependencias en el proyecto recién clonado
const deepInstall = (repoName) => `cd ${repoName} && yarn install`;
// Eliminar el proyecto clonado en caso de error
const rollBack = (repoName) => `rm -rf ${repoName}`;- Con inquirer creo un prompt para recibir el input del usuario
import inquirer from "inquirer";
const boiler_plates = [
{
name: "ReactTs",
value: "https://github.com/Drakezair/boilerplate-reactts.git",
},
{
name: "NextTs",
value: "https://github.com/Drakezair/nextts-boilerplate.git",
},
];
inquirer
.prompt([
{
type: "input",
message: "name for your app",
name: "repoName",
default: "my-app",
},
{
type: "list",
name: "repo",
message: "What type of project you want",
choices: boiler_plates,
},
])- Creamos una instancia spinner para que se muestre mientras se ejecutan los comandos
import { createSpinner } from "nanospinner";
const spinner = createSpinner("Getting and install boilerplate");- Con figlet crearemos un mensaje en ascii para cuando todo sucede correctamente
import figlet from "figlet";
figlet(`${repoName} is created!`, function (err, data) {
if (err) {
console.log("Something went wrong...");
console.dir(err);
return;
}
console.log(data);
})- Por ultimo manejamos la respuesta de inquirer para ejecutar rutinas
inquirer
.prompt([
{
type: "input",
message: "name for your app",
name: "repoName",
default: "my-app",
},
{
type: "list",
name: "repo",
message: "What type of project you want",
choices: boiler_plates,
},
])
.then(({ repo, repoName }) => {
try {
// Inicia el spinner
spinner.start();
// Clonar repo
runCommand(gitCommand(repo, repoName));
// Instalar dependencias
runCommand(deepInstall(repoName));
// Manejar el output que se le da el usuario
figlet(`${repoName} is created!`, function (err, data) {
if (err) {
console.log("Something went wrong...");
console.dir(err);
return;
}
spinner.success("DONE");
console.log(data);
// Con chalk podemos añadir estilos al output en consola
console.log(chalk.green("Get started"));
console.log(
chalk.blue("Run ") + chalk.bgGray(`cd ${repoName} && yarn storybook`)
);
console.log(chalk.blue(`Go to `) + "http://localhost:6006");
});
} catch (e) {
if (e.message.includes("cd")) {
runCommand(rollBack(repoName));
}
spinner.error({ text: chalk.bgRed("Error:") + " " + e.message });
}
});- Nuestro archivo quedaria así
#!/usr/bin/env node
import inquirer from "inquirer";
import { createSpinner } from "nanospinner";
import chalk from "chalk";
import figlet from "figlet";
import { execSync } from "child_process";
const boiler_plates = [
{
name: "ReactTs",
value: "https://github.com/Drakezair/boilerplate-reactts.git",
},
{
name: "NextTs",
value: "https://github.com/Drakezair/nextts-boilerplate.git",
},
];
const spinner = createSpinner("Getting and install boilerplate");
const runCommand = (command) => {
execSync(`${command}`, { stdio: "inherit" });
};
const gitCommand = (repo, repoName) =>
`git clone --depth 1 ${repo} ${repoName}`;
const deepInstall = (repoName) => `cd ${repoName} && yarn install`;
const rollBack = (repoName) => `rm -rf ${repoName}`;
inquirer
.prompt([
{
type: "input",
message: "name for your app",
name: "repoName",
default: "my-app",
},
{
type: "list",
name: "repo",
message: "What type of project you want",
choices: boiler_plates,
},
])
.then(({ repo, repoName }) => {
try {
spinner.start();
runCommand(gitCommand(repo, repoName));
runCommand(deepInstall(repoName));
figlet(`${repoName} is created!`, function (err, data) {
if (err) {
console.log("Something went wrong...");
console.dir(err);
return;
}
spinner.success("DONE");
console.log(data);
console.log(chalk.green("Get started"));
console.log(
chalk.blue("Run ") + chalk.bgGray(`cd ${repoName} && yarn storybook`)
);
console.log(chalk.blue(`Go to `) + "http://localhost:6006");
});
} catch (e) {
if (e.message.includes("cd")) {
runCommand(rollBack(repoName));
}
spinner.error({ text: chalk.bgRed("Error:") + " " + e.message });
}
});Conclusión:
Crear nuestras propias CLI es algo que aunque al principio pueda parecer complejo debido a que la documentación no es tan clara. Es super sencillo de realizar una vez lo hace la primera vez. Para mí ha sido de mucha utilidad la implementación de este CLI para iniciar mis proyectos con una base.
Ahora puedes utilizar mis templates a través de mi CLI