Pular para o conteúdo principal

​
O que é o arquivo squarecloud.ignore?

O arquivo squarecloud.ignore lista os arquivos e pastas que devem ficar de fora quando você envia ou faz commit de uma aplicação. A CLI da Square Cloud (upload, commit e zip) e a extensão da Square Cloud para VS Code leem o mesmo arquivo, com as mesmas regras e os mesmos padrões, então um projeto é empacotado da mesma forma pelas duas. Ele usa a sintaxe do .gitignore: comentários, curingas, regras só para pastas e só para a raiz, e ! para incluir um arquivo de volta.

​
Criando o arquivo

Crie um arquivo chamado squarecloud.ignore na raiz do projeto.
O arquivo deve se chamar exatamente squarecloud.ignore. O .gitignore não é lido no lugar dele: ele costuma listar arquivos que a aplicação precisa para rodar, como o .env.

​
Sempre de fora

Estes caminhos são ignorados antes das suas próprias regras, então você não precisa listá-los:
  • node_modules
  • .git, .github e .vscode
  • package-lock.json, pnpm-lock.yaml e yarn.lock
Inclua qualquer um deles de volta com uma regra !.

​
Lockfiles

Os lockfiles ficam fora do zip por padrão, então a Square Cloud instala as suas dependências a partir das faixas de versão do package.json. Quando você precisar das versões exatas que o seu lockfile fixa, inclua-o de volta:

​
Sintaxe

Cada linha é uma regra. O arquivo ou pasta correspondente fica de fora do envio. Como as regras são aplicadas:
  • A última linha que corresponde vence, então coloque as regras ! depois das regras que elas desfazem.
  • Um arquivo dentro de uma pasta ignorada não pode ser incluído de volta. Para manter um arquivo de uma pasta, ignore o conteúdo da pasta (logs/*) em vez da pasta (logs/) e depois adicione !logs/keep.log.
  • A correspondência ignora maiúsculas e minúsculas: Dist/ também corresponde a dist.
  • Apenas os espaços no final de uma regra são removidos, nunca os tabs. Escape um espaço final que você quer manter com \ .
Use / como separador de pastas nos padrões, inclusive no Windows.

​
Exemplos comuns

Exclua ferramentas de desenvolvimento e arquivos gerados, mantendo tudo o que a aplicação precisa para rodar:
Não ignore um arquivo que a sua aplicação lê em tempo de execução. Se o seu código carrega segredos de um arquivo .env e você lista o .env aqui, a aplicação inicia sem eles e um bot falha com token inválido. Antes, mova esses valores para as variáveis de ambiente da aplicação; depois disso, deixar o .env fora do upload é seguro.

​
Como ele é aplicado

A CLI e a extensão do VS Code leem o squarecloud.ignore ao preparar os arquivos para envio ou commit. Os arquivos que correspondem a uma regra ficam de fora do zip enviado para a Square Cloud.
  • Um link simbólico para um arquivo é enviado como o arquivo para o qual ele aponta. Links para pastas e links quebrados são ignorados.
  • A CLI ainda lê os nomes antigos (.squareignore, .squarecloudignore e square.ignore) quando o squarecloud.ignore não existe, e pede que você renomeie o arquivo.
Mantenha fora dos caminhos ignorados os arquivos necessários em tempo de execução, como o arquivo definido em MAIN no seu arquivo de configuração. O upload pelo dashboard não lê este arquivo: quando você mesmo monta o zip, deixe esses arquivos de fora dele.