README-ES.md

eXecutor

Una poderosa herramienta de atajos para vos como para tu equipo!

[ english [ spanish ]

---

TL;DR

Este herramienta te va a permitir ahorrar gran cantidad de tiempo de escritura de comandos con atajos totalmente personalizados, con la finalidad de compartirlo con un proyecto, tanto para que lo usen personas como máquinas, manteniéndose unificado y en un único lugar. #agile #needForSpeed.

Como scripts de package.json pero con esteroides.

Notes: La idea no es dejar de usar la consola, es la de optimizarla.

Features

• Multi-plataforma: Único código, funciona en todas las plataformas. Powered by nodejs
• Templates para su fácil reutilización.
• No importa el tipo de proyecto, si escribís comandos esta herramienta te puede ser útil.
• Utilización de variables predefinidas, ambiente, package.json, template y de otros 'shortcuts' (atajos).
• Devs y DevOps pueden ser amigos con esta tool, ya que comparten sus comandos.
• Errores de tipeos en comandos largos, son problemas del pasado!
• Pare de sufrir! Basta de cientos de scripts similares en tu package.json!
  (build, build-ci, build-prod, build-prod-ci, build-qa, build-qa-ci, build-ci-cache, etc...)
• Sin dependencias de otros módulos de node!

---

Documentation

Spoiler

En package.json

Antes

"scripts": {
  "build": "docker run --rm -it -p 4200:4200 -v /choclo:... --name myProject-dev myProject ng build",
  "build-prod": "docker run --rm -it -p 4200:4200 -v /choclo:... --name myProject-dev myProject ng build --prod",
  "server": "docker run --rm -it -p 4200:4200 -v /choclo:... --name myProject-dev myProject ng serve"
}

Executor

"templates": {
  "docker-common": "docker run --rm -it -p 4200:4200 -v /choclo:... --name ${pkg.name}-dev ${pkg.name}" 
},
"shortcuts": {
  "build": "${docker-common} ng build",
  "build-prod": "${docker-common} ng build --prod",
  "server": "${docker-common} ng serve"
}

Table of content

• Intro
• Por que?
• Instalacion
• Configuracion
  • Fuentes
  • Configuracion
    • opciones
    • datos
      • predefinidos (def)
      • ambiente (env)
      • package.json (pkg)
      • templates
      • atajos
• Bonus track
• contribucion

---

• Changelog

Y recorda! RTFM! :)

Installation

npm i -g executor

Test de correcta instalación y funcionamiento:

x hello

Debería mostrar un mensaje con la versión instalada.

Mas info sobre la instalacion

---

MIT © 2018 Crystian, hecho con amor para vos <3! y espero que te sea tan útil como lo es para mi.