Skip to main content

​
squarecloud.ignore ファイルとは？

squarecloud.ignore ファイルでは、アプリケーションをアップロードまたはコミットするときに除外するファイルやフォルダーを指定します。Square Cloud CLI（upload、commit、zip）と Square Cloud の VS Code 拡張機能は同じファイルを、同じルールと同じデフォルトで読み込むため、どちらを使ってもプロジェクトは同じようにパッケージ化されます。 構文は .gitignore と同じです。コメント、ワイルドカード、フォルダーのみ・ルートのみに適用するルール、そしてファイルを元に戻す ! を利用できます。

​
ファイルを作成する

プロジェクトのルートに squarecloud.ignore という名前のファイルを作成します。
ファイル名は正確に squarecloud.ignore としてください。代わりに .gitignore が読み込まれることはありません。.gitignore には、.env のようにアプリケーションの実行に必要なファイルが含まれていることがよくあるためです。

​
常に除外されるもの

次のパスは独自のルールより前に除外されるため、記載する必要はありません:
  • node_modules
  • .git、.github、.vscode
  • package-lock.json、pnpm-lock.yaml、yarn.lock
いずれも ! ルールで元に戻せます。

​
ロックファイル

ロックファイルはデフォルトで zip から除外されるため、Square Cloud は package.json のバージョン範囲をもとに依存関係をインストールします。ロックファイルで固定された正確なバージョンが必要な場合は、元に戻してください。

​
構文

各行が 1 つのルールです。パターンに一致するファイルまたはフォルダーはアップロードから除外されます。 ルールの適用方法:
  • 最後に一致した行が優先されます。 そのため、! ルールは取り消す対象のルールより後に置いてください。
  • 除外されたフォルダー内のファイルは元に戻せません。 フォルダー内の 1 ファイルだけを残すには、フォルダー（logs/）ではなくフォルダーの中身（logs/*）を除外し、そのうえで !logs/keep.log を追加してください。
  • マッチングでは大文字と小文字を区別しません: Dist/ は dist にも一致します。
  • ルールから取り除かれるのは末尾のスペースのみで、タブは取り除かれません。残したい末尾のスペースは \ でエスケープしてください。
パターン内のフォルダー区切りには、Windows でも / を使用してください。

​
よくある例

アプリケーションの実行に必要なものはすべて残したまま、開発ツールと生成ファイルを除外します。
アプリケーションが実行時に読み込むファイルは除外しないでください。コードが .env ファイルから秘密情報を読み込んでいるのに .env をここに記載すると、アプリケーションはそれらの値なしで起動し、ボットは無効なトークンで失敗します。先にそれらの値をアプリケーションの環境変数に移してください。その後であれば、.env をアップロードから除外しても問題ありません。

​
適用方法

CLI と VS Code 拡張機能は、アップロードまたはコミット用のファイルを準備するときに squarecloud.ignore を読み込みます。ルールに一致するファイルは、Square Cloud に送信される zip に含まれません。
  • ファイルへのシンボリックリンクは、リンク先のファイルとしてアップロードされます。フォルダーへのリンクと壊れたリンクはスキップされます。
  • squarecloud.ignore がない場合、CLI は以前の名前（.squareignore、.squarecloudignore、square.ignore）も引き続き読み込み、ファイル名の変更を促します。
設定ファイルの MAIN で指定したファイルなど、実行時に必要なファイルは除外されるパスの外に置いてください。 ダッシュボードからのアップロードではこのファイルは読み込まれません。zip を自分で作成する場合は、それらのファイルを zip に含めないでください。