Escribir un script

Introducción

Puedes definir y ejecutar scripts para el Client y las Functions de tu proyecto. Puedes ejecutar comandos del Catalyst CLI y comandos de terminal de tu entorno local a través de scripts.

Debes escribir los scripts en el campo scripts del ámbito de functions o client en el archivo catalyst.json presente en la raíz del directorio de tu proyecto. Este archivo contiene la configuración e información de destino de los componentes del directorio de tu proyecto. A continuación se muestra una estructura de código de ejemplo del archivo de configuración catalyst.json.

Script de ejemplo

Discutamos el script mostrado en la imagen anterior. El código de este archivo catalyst.json define dos lifecycle scripts y dos custom scripts. La ejecución de los lifecycle scripts ejecutará los custom scripts. Los scripts aquí están incluidos dentro del ámbito del Client, porque están definidos para el componente Client del proyecto.

El código se muestra a continuación:

{
"functions": {
"targets": [
"catly"
],
"ignore": [],
"source": "functions"
},
"client": {
"source": "client/app/build",
"ignore": [],
"scripts": {
"packageJson": "cd client && cp client-package.json app/build/",
"build": "cd client/app && yarn install && yarn build",
"preserve": "catalyst run client:build && catalyst run client:packageJson",
"predeploy": "catalyst run client:build && catalyst run client:packageJson"
}
}
}

Cuando ejecutas un custom script dentro de un lifecycle script usando el comando catalyst run como se muestra en el ejemplo anterior, debes especificar el componente para el cual se está ejecutando. Esto es necesario si, por ejemplo, hay un comando de terminal cd (cambiar directorio) que debe ejecutarse. La raíz del directorio de ese componente se considerará como el directorio desde el cual se ejecuta el comando de cambio de directorio.

El flujo lógico de los scripts escritos anteriormente es el siguiente:

1. Cuando ejecutas el comando catalyst serve o catalyst deploy para el componente Client, los scripts preserve o predeploy se inician respectivamente, antes de ejecutar el comando.

2. Ambos scripts preserve y predeploy contienen las mismas ejecuciones de comandos. La primera acción es el comando catalyst run client:build, que ejecuta el custom script build para el componente Client. La segunda acción es catalyst run client:packageJson , que ejecuta el script packageJson para el componente Client.

3. El custom script build realiza las siguientes acciones en secuencia:

   • La terminal navega al directorio client/app.
   • Se ejecuta el comando yarn install para instalar las dependencias de Node.js usando el gestor de paquetes Yarn.
   • Se ejecuta el comando yarn build para construir la aplicación Client.

4. El custom script packageJson realiza las siguientes acciones una tras otra:

   • La terminal navega al directorio client.
   • El archivo client-package.json se copia del directorio client y se pega en el directorio app/build.

Después de que estos scripts se ejecutan, los componentes se sirven o despliegan.