Skip to main content

​
¿Qué es el archivo squarecloud.ignore?

El archivo squarecloud.ignore lista los archivos y carpetas que deben quedar fuera cuando subes o haces commit de una aplicación. La CLI de Square Cloud (upload, commit y zip) y la extensión de Square Cloud para VS Code leen el mismo archivo, con las mismas reglas y los mismos valores por defecto, así que ambas empaquetan un proyecto de la misma forma. Usa la sintaxis de .gitignore: comentarios, comodines, reglas solo para carpetas y solo para la raíz, y ! para recuperar un archivo.

​
Crear el archivo

Crea un archivo llamado squarecloud.ignore en la raíz del proyecto.
El archivo debe llamarse exactamente squarecloud.ignore. .gitignore no se lee en su lugar: suele listar archivos que la aplicación necesita para ejecutarse, como .env.

​
Siempre se excluyen

Estas rutas se ignoran antes que tus propias reglas, así que no necesitas listarlas:
  • node_modules
  • .git, .github y .vscode
  • package-lock.json, pnpm-lock.yaml y yarn.lock
Recupera cualquiera de ellas con una regla !.

​
Lockfiles

Los lockfiles quedan fuera del zip por defecto, así que Square Cloud instala tus dependencias a partir de los rangos de versión de package.json. Cuando necesites las versiones exactas que fija tu lockfile, recupéralo:

​
Sintaxis

Cada línea es una regla. El archivo o carpeta que coincida queda fuera de la subida. Cómo se aplican las reglas:
  • Gana la última línea que coincide, así que pon las reglas ! después de las reglas que deshacen.
  • Un archivo dentro de una carpeta ignorada no se puede recuperar. Para conservar un archivo de una carpeta, ignora el contenido de la carpeta (logs/*) en lugar de la carpeta (logs/) y luego añade !logs/keep.log.
  • La coincidencia no distingue mayúsculas de minúsculas: Dist/ también coincide con dist.
  • Solo se recortan los espacios finales de una regla, nunca las tabulaciones. Escapa con \ un espacio final que quieras conservar.
Usa / como separador de carpetas en los patrones, también en Windows.

​
Ejemplos comunes

Excluye herramientas de desarrollo y archivos generados, manteniendo todo lo que la aplicación necesita para ejecutarse:
No ignores un archivo que tu aplicación lee en tiempo de ejecución. Si tu código carga secretos desde un archivo .env y listas .env aquí, la aplicación inicia sin ellos y un bot falla con un token inválido. Primero pasa esos valores a las variables de entorno de la aplicación; después de eso, dejar .env fuera de la subida es seguro.

​
Cómo se aplica

La CLI y la extensión de VS Code leen squarecloud.ignore al preparar los archivos para la subida o el commit. Los archivos que coinciden con una regla quedan fuera del zip enviado a Square Cloud.
  • Un enlace simbólico a un archivo se sube como el archivo al que apunta. Los enlaces a carpetas y los enlaces rotos se omiten.
  • La CLI todavía lee los nombres antiguos (.squareignore, .squarecloudignore y square.ignore) cuando falta squarecloud.ignore, y te pide que renombres el archivo.
Mantén fuera de las rutas ignoradas los archivos necesarios en tiempo de ejecución, como el archivo definido en MAIN en tu archivo de configuración. La subida desde el dashboard no lee este archivo: cuando armes el zip tú mismo, deja fuera esos archivos.