Passer au contenu principal

​
Qu’est-ce que le fichier squarecloud.ignore ?

Le fichier squarecloud.ignore liste les fichiers et dossiers à exclure lorsque vous envoyez une application ou effectuez son commit. La CLI Square Cloud (upload, commit et zip) et l’extension Square Cloud pour VS Code lisent le même fichier, avec les mêmes règles et les mêmes valeurs par défaut : un projet est donc empaqueté de la même façon par les deux. Il utilise la syntaxe de .gitignore : commentaires, caractères génériques, règles limitées aux dossiers ou à la racine, et ! pour réintégrer un fichier.

​
Créer le fichier

Créez un fichier nommé squarecloud.ignore à la racine du projet.
Le fichier doit s’appeler exactement squarecloud.ignore. .gitignore n’est pas lu à sa place : il liste souvent des fichiers dont l’application a besoin pour s’exécuter, comme .env.

​
Toujours exclus

Ces chemins sont ignorés avant vos propres règles, vous n’avez donc pas besoin de les lister :
  • node_modules
  • .git, .github et .vscode
  • package-lock.json, pnpm-lock.yaml et yarn.lock
Réintégrez n’importe lequel d’entre eux avec une règle !.

​
Fichiers de verrouillage

Les fichiers de verrouillage restent hors du zip par défaut : Square Cloud installe donc vos dépendances à partir des plages de versions de package.json. Si vous avez besoin des versions exactes figées par votre fichier de verrouillage, réintégrez-le :

​
Syntaxe

Chaque ligne est une règle. Le fichier ou le dossier correspondant est exclu de l’envoi. Application des règles :
  • La dernière ligne correspondante l’emporte : placez donc les règles ! après les règles qu’elles annulent.
  • Un fichier situé dans un dossier ignoré ne peut pas être réintégré. Pour conserver un seul fichier d’un dossier, ignorez le contenu du dossier (logs/*) plutôt que le dossier lui-même (logs/), puis ajoutez !logs/keep.log.
  • La correspondance ignore la casse : Dist/ correspond aussi à dist.
  • Seuls les espaces de fin sont retirés d’une règle, jamais les tabulations. Échappez avec \ un espace de fin que vous voulez conserver.
Utilisez / comme séparateur de dossiers dans les motifs, y compris sous Windows.

​
Exemples courants

Excluez les outils de développement et les fichiers générés tout en conservant tout ce dont l’application a besoin pour s’exécuter :
N’ignorez pas un fichier que votre application lit à l’exécution. Si votre code charge ses secrets depuis un fichier .env et que vous listez .env ici, l’application démarre sans eux et un bot échoue avec un token invalide. Déplacez d’abord ces valeurs dans les variables d’environnement de l’application ; ensuite, vous pouvez exclure .env de l’envoi sans risque.

​
Fonctionnement

La CLI et l’extension VS Code lisent squarecloud.ignore lorsqu’elles préparent les fichiers pour un envoi ou un commit. Les fichiers correspondant à une règle sont exclus du zip envoyé à Square Cloud.
  • Un lien symbolique vers un fichier est envoyé comme le fichier vers lequel il pointe. Les liens vers des dossiers et les liens cassés sont ignorés.
  • La CLI lit encore les anciens noms (.squareignore, .squarecloudignore et square.ignore) lorsque squarecloud.ignore est absent, et vous demande de renommer le fichier.
Conservez hors des chemins ignorés les fichiers nécessaires à l’exécution, comme le fichier défini par MAIN dans votre fichier de configuration. L’envoi depuis le tableau de bord ne lit pas ce fichier : lorsque vous créez le zip vous-même, laissez ces fichiers en dehors.