Vai al contenuto principale

​
Cos’è il file squarecloud.ignore?

Il file squarecloud.ignore elenca i file e le cartelle da escludere quando carichi o esegui il commit di un’applicazione. La CLI di Square Cloud (upload, commit e zip) e l’estensione di Square Cloud per VS Code leggono lo stesso file, con le stesse regole e gli stessi valori predefiniti, quindi un progetto viene impacchettato allo stesso modo da entrambe. Usa la sintassi di .gitignore: commenti, caratteri jolly, regole solo per cartelle e solo per la radice, e ! per reincludere un file.

​
Creare il file

Crea un file chiamato squarecloud.ignore nella radice del progetto.
Il file deve chiamarsi esattamente squarecloud.ignore. .gitignore non viene letto al suo posto: spesso elenca file di cui l’applicazione ha bisogno per funzionare, come .env.

​
Sempre esclusi

Questi percorsi vengono ignorati prima delle tue regole, quindi non devi elencarli:
  • node_modules
  • .git, .github e .vscode
  • package-lock.json, pnpm-lock.yaml e yarn.lock
Puoi reincludere ognuno di essi con una regola !.

​
Lockfile

I lockfile restano fuori dallo zip per impostazione predefinita, così Square Cloud installa le dipendenze a partire dagli intervalli di versione di package.json. Quando ti servono le versioni esatte bloccate dal lockfile, reincludilo:

​
Sintassi

Ogni riga è una regola. Il file o la cartella corrispondente viene escluso dal caricamento. Come vengono applicate le regole:
  • Vince l’ultima riga corrispondente, quindi metti le regole ! dopo quelle che devono annullare.
  • Un file dentro una cartella ignorata non può essere reincluso. Per mantenere un solo file di una cartella, ignora il contenuto della cartella (logs/*) invece della cartella stessa (logs/), poi aggiungi !logs/keep.log.
  • Il confronto non distingue tra maiuscole e minuscole: Dist/ corrisponde anche a dist.
  • Da una regola vengono rimossi solo gli spazi finali, mai le tabulazioni. Per mantenere uno spazio finale, eseguine l’escape con \ .
Usa / come separatore delle cartelle nei pattern, anche su Windows.

​
Esempi comuni

Escludi strumenti di sviluppo e file generati, mantenendo tutto ciò che serve all’applicazione per funzionare:
Non ignorare un file che la tua applicazione legge durante l’esecuzione. Se il tuo codice carica i segreti da un file .env e tu elenchi .env qui, l’applicazione si avvia senza di essi e un bot fallisce con un token non valido. Sposta prima quei valori nelle variabili d’ambiente dell’applicazione; dopodiché, escludere .env dall’upload è sicuro.

​
Come viene applicato

La CLI e l’estensione per VS Code leggono squarecloud.ignore quando preparano i file per il caricamento o il commit. I file che corrispondono a una regola vengono esclusi dallo zip inviato a Square Cloud.
  • Un link simbolico a un file viene caricato come il file a cui punta. I link a cartelle e i link non validi vengono saltati.
  • La CLI legge ancora i nomi precedenti (.squareignore, .squarecloudignore e square.ignore) quando squarecloud.ignore manca, e ti chiede di rinominare il file.
Tieni fuori dai percorsi ignorati i file necessari durante l’esecuzione, come quello definito in MAIN nel file di configurazione. L’upload dalla dashboard non legge questo file: quando crei tu lo zip, lascia fuori quei file.