form-compiler
v1.0.0
Published
<div> <h1 align="center">🚏 FORM COMPILER</h1> <strong> Un transpilador que convierte código de React (legacy) en algo entendible por los navegadores para ser utilizado como formularios embebidos. </strong> </div>
Downloads
2
Readme
Advertencia
⚠️ ⚠️ No actualice ninguna dependencia de este proyecto a menos que sea un minor o un patch version. De lo contrario puede implicar en errores a la hora de compilar el código legacy que se utiliza como fuente. ⚠️ ⚠️
Por qué?
Porque se necesita para poder generar codigo entendible para el navegador. El source está en React, legacy, y de momento no se va a actualizar ese código. Este compiler ayuda en el caso de que se tuviera que cambiar algo de los sources originales, se puedan a volver a generar los bundles sin que afecte el código legacy existente.
Requisitos
Todo estos binarios deben estar disponibles en su PATH
. Para verificar que
están seteados de forma correcta y que tengan las versiones correspondientes,
puede correr en una terminal
lo siguiente:
git --version
node --version
npm --version
Configuración
⚠️ ESTA CONFIGURACIÓN ES SOLO SI QUIERE REALIZAR ALGÚN CAMBIO EN EL PROYECTO DE LO CONTRARIO PASE AL SIGUIENTE PASO (INSTALACIÓN)
Si quiere hacer commit y push de algún cambio en este repositorio tiene que realizar fork primero y luego clonar su fork en lugar de el repositorio directamente.
Después de estar seguro de que tiene los requisitos correctos, puede ejecutar los siguiente comandos para setear el proyecto:
git clone https://github.com/SoinLabs/form-compiler.git
cd form-compiler
npm install
Instalación
Para instalar el binario y poder ejecutarlo, ejecute en la terminal lo siguiente:
npm install -g form-compiler
Para comprobar que realmente se instaló, se puede ejecutar en la terminal lo siguiente:
form-compiler --help
Dará como resultado la lista de opciones para ejecutar con el binario.
Consideraciones
El binario se puede ejecutar desde cualquier lugar, pero la mejor opción sería ejecutarlo donde están los archivos fuentes del formulario que se quiere generar, esta sería la estructura del formulario para un adecuado funcionamiento:
├── src
│ ├── css
│ │ ├── **/*.css
│ ├── App.js
│ ├── Button.js
│ ├── Date.js
│ ├── form.html
│ ├── Dropdown.js
│ └── index.js
└── build
Una vez en el directorio adecuado, se puede ejecutar el binario de la siguiente forma:
form-compiler
Se pueden indicar varias opciones tales como:
-d
o--dev
esta opción es para indicar que queremos que compile los archivos fuentes con base al entorno de develop.-p
o--prd
esta opción es para indicar que queremos que compile los archivos fuentes con base al entorno de producción. Además de inyectar variables de ambiente de producción, minifica el bundle final para que sea más pequeño y eficiente.-s <ruta_del_src>
o--src <ruta_del_src>
esta opción se utiliza para indicar la ruta custom donde se encuentran los archivos sources a compilar, si se sigue la estructura planteada anteriormente, pocas veces se necesita este parámetro
En caso de no indicar ninguna de las opciones anteriormente descritas, se tomará
como default -d
es decir develop y que la ruta de los archivos sources es
directorio_actual/src
.
Una vez ejecutado el binario form-compiler
, el va a ejecutar webpack y creará
el bundle en la carpeta build
, de igual forma si la carpeta build
no existe,
se crea automáticamente. Al final la estructura de archivos queda algo como así:
├── src
│ ├── css
│ │ ├── **/*.css
│ ├── App.js
│ ├── Button.js
│ ├── Date.js
│ ├── form.html
│ ├── Dropdown.js
│ └── index.js
├── build
│ ├── form.html
│ ├── bundle.js
└── └── bundle.js.map