メインコンテンツへスキップ
AMPL/ dev
開発系講座一覧

送ってはいけないもの

記録に入れないファイルの名前を書いておく帳面が .gitignore です。鍵を書いたファイルや、取り込んだ部品の大きなフォルダ node_modules は、ここに書いて、最初から記録に入れないようにします。

公開の前に調べてもらうと、Claude からこう返ってきました。「作業フォルダに、.DS_Store というファイルがあります。作品とは関係のないファイルです」。佐藤さん(会社員で、実家の和菓子店を手伝う、架空の人物)には、作った覚えがありません。

問い

佐藤さんの疑問

送らなくていいものを、最初から記録に入れないようにするには、どうすればいいんだろう。

ボウルにのせた目の細かいざるに、小さなかたまりがいくつか残っている挿絵。

前の回で、公開リポジトリ(誰でも見られる作品の置き場)では、それまでの記録も見えることを見ました。

いちばん確かなのは、送ってはいけないものを、最初から記録に入れないことです。この回では、その仕組みを見ていきます。

.gitignore:記録に入れないものの一覧

Git(作品の変更を記録する道具)に、「このファイルは記録しないで」と伝えておく帳面があります。それが、.gitignore(ギット・イグノア)という名前のファイルです。ignore は、英語で「無視する」という意味です。

GitHub の公式の説明には、こう書かれています。

DOCUMENTATION

“You can create a .gitignore file in your repository's root directory to tell Git which files and directories to ignore when you make a commit.”

リポジトリのいちばん上のフォルダに .gitignore というファイルを作ると、コミットのときに、どのファイルやフォルダを無視するかを Git に伝えられます。

GitHubIgnoring files(GitHub Docs)

名前が「.」(点の記号)で始まるので、第1部の第5回で見た隠しファイルと同じく、Mac ではふだん見えません。中を見たいときは、Claude に「.gitignore の中身を見せて」と頼みます。中身は、記録しないファイルやフォルダの名前を、1行に1つずつ書いた一覧です。

何を書いておくか

作品によって違いますが、よく書くのは次のようなものです。

書いておくもの理由
.env など、鍵を書いたファイル(.env で始まる名前のファイルすべて。.env* と書く)API キー(サービスを使うための秘密の鍵)が、人に見られてしまう。第6部で扱います
node_modules取り込んだ部品が入るフォルダ。大きく、あとで入れ直せる
.DS_Store などパソコンが勝手に作るファイル。作品とは関係がない

鍵を書くファイルの名前は、作品の作り方によって、.env.local のように変わることがあります。.env で始まる名前のファイルをすべて対象にするには、.gitignore に .env* と書きます。

node_modules(ノードモジュールズ)は、第4部の第11回で見た、取り込んだ部品が入るフォルダです。中に数千のファイルがあることもあり、送ると重くなります。部品の一覧さえ記録しておけば、あとで同じ部品を入れ直せます。

送るものと、送らないもの

佐藤さんの作業フォルダ

記録に入れて、送るもの index.html 骨組み style.css 見た目 app.js 動き README.md 説明書 作品そのもののファイル .gitignore に書いて、送らないもの .env 鍵が書いてある node_modules あとで入れ直せる .DS_Store パソコンが勝手に作る 記録に入れて、送るもの index.html 骨組み style.css 見た目 app.js 動き README.md 説明書 作品そのもののファイル .gitignore に書いて、送らないもの .env 鍵が書いてある node_modules あとで入れ直せる .DS_Store パソコンが勝手に作る
図1.gitignore に書いたものは、最初から記録に入りません。

Claude に作ってもらい、自分で確かめる

いちばんよいのは、最初のコミットの前に作ることです。もう何度かコミットしていても、いまから作れば、これから先の記録には入らなくなります。

佐藤さんは、こう頼みました。

.gitignore を作ってもらう例
この作品に合った .gitignore を作ってください。鍵を書くファイル(.env など)と、node_modules は、必ず入れてください。作ったら、中身を1行ずつ、何のための行か、ふつうの言葉で説明してください。そのあと、いまコミットしようとすると記録に入るファイルの一覧を見せてください。これまでのコミットに、.env や node_modules が入っていないかも調べてください。

この依頼文は、説明のための架空の例です。

最後の一覧を、自分の目で見ます。知らない名前のファイルや、鍵、人の情報が入っていそうなファイルがあれば、「これは何? 記録に入れて大丈夫?」と聞きます。

送ってはいけないものは、.gitignore に書いて、最初から記録に入れません。記録に入るファイルの一覧は、自分の目でも確かめます。

注意

ただし、もう記録に入ったものは、書き足しても消えない

.gitignore は、これから記録するものを止める仕組みです。すでにコミットしてしまったファイルは、あとから .gitignore に書き足しても、記録から消えません。GitHub の公式の説明にも、すでに記録しているファイルを無視したいときは、先にそのファイルの記録をやめてから、無視する行を足すように書かれています。

記録をやめるのも、Claude に頼めます。「(ファイル名)を、Git の記録から外してください。ファイルそのものは消さないでください」と頼みます。それでも、それまでの記録には残っています。だから、.gitignore は、できるだけ早く作ります。もし、鍵をコミットしてしまったと気づいたら、前の回で見たとおり、まず、その鍵を使えなくします。

次回の問い

佐藤さんの次の疑問です。GitHub の作品のページを開いた人に、最初に何を伝えればよいのでしょうか。

参考

ファイルを無視する(GitHub Docs)
.gitignore の作り方と、すでに記録したファイルの扱い。日本語。
GitHub Docs · docs.github.com
Vibe Coding 用語集:.gitignore
.gitignore の説明と、頼み方の例。
AMPL · Web

このレッスンは役に立ちましたか?